REST API for Oracle Commerce Cloud December 2017 - createOrganization

Previous Next JavaScript must be enabled to correctly display this content

createOrganization

post

/ccadmin/v1/organizations

Create Organization. This operation is used to create an Organization in Oracle Commerce Cloud for a customer.As few properties are site specific they will be mapped to the default site, however if 'x-ccsite' header is sent then site specific properties will be mapped to the site sent in header.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : createOrganization_request


{
    "taxReferenceNumber":"REFNUM123",
    "organizationLogo":"/general/hero-image1.jpg",
    "delegateApprovalManagement":false,
    "secondaryAddresses":[
        {
            "address":{
                "isDefaultBillingAddress":true,
                "country":"US",
                "phoneNumber":"973-974-1234",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "isDefaultShippingAddress":true,
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ],
    "parentOrganization":{
        "id":"100001"
    },
    "type":"none",
    "customerType":"Standard",
    "members":[
        "110000"
    ],
    "paymentMethods":[
        "card",
        "cash"
    ],
    "dunsNumber":"123456789",
    "shippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "dynamicProperty1":"dynamicProperty1 value",
    "contract":{
        "catalogId":"cloudCatalog",
        "priceListGroupId":"defaultPriceGroup",
        "endDate":"2017-10-10T11:44:26.000Z",
        "displayName":"Us Motor Works Contract",
        "description":"This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
        "contract_terms":{
            "terms":"All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract"
        },
        "startDate":"2016-10-10T11:44:26.000Z",
        "externalContractReference":"UMWCUS001"
    },
    "active":true,
    "vatReferenceNumber":"Vat123123",
    "taxExemptionCode":"TAXUQ12345",
    "orderPriceLimit":null,
    "useAllShippingMethodsFromSite":false,
    "approvalRequired":false,
    "useAllPaymentMethodsFromSite":false,
    "name":"Oracle",
    "shippingAddress":null,
    "useExternalApprovalWebhook":false,
    "billingAddress":null,
    "uniqueId":"TestIDNumber"
}

active: Type: boolean

Active status of an Organization. Should be true or false. By default the value is set to true. If passed null then no action will be performed.
approvalRequired: Type: boolean

Approval flag is required for the organization, by default it is set to false
billingAddress: Type: object billingAddress

Additional Properties Allowed:

Default Billing Address
contract: Type: object contract

Additional Properties Allowed:

Contract Info
customerType: Type: string

Customer Type for an Organization. Accepts one of these values [Standard, Preferred, Enterprise, OEM, Distributor, Supplier]
delegateApprovalManagement: Type: boolean

This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
description: Type: string

Description for Organization
dunsNumber: Type: string

DUNS Number for Organization. Should be 9 digit number
dynamicProperty: Type: object dynamicProperty

Additional Properties Allowed:

The value of the dynamic Property
members: Type: array members

Additional Properties Allowed:

List of contact ids associated with an Organization
name: Type: string

Required: true

The name for Organization
orderPriceLimit: Type: number

Its order limit value for the organization, if order limit is more than this value then approval is needed for the order
organizationLogo: Type: string

File path of an Organization logo image
parentOrganization: Type: object parentOrganization

Additional Properties Allowed:

Parent Organization.
paymentMethods: Type: array paymentMethods

Additional Properties Allowed:

Payment methods associated for organization.
secondaryAddresses: Type: array secondaryAddresses

Additional Properties Allowed:

List of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

Default Shipping Address
shippingMethods: Type: array shippingMethods

Additional Properties Allowed:

Shipping methods associated for organization.
taxExemptionCode: Type: string

Tax exemption code for Organization
taxReferenceNumber: Type: string

Tax Reference number for Organization
type: Type: string

Type for Organization. Accepts one of these values [none, company, division, department, group]
uniqueId: Type: string

Unique Id of an Organization
useAllPaymentMethodsFromSite: Type: boolean

Flag to use all the payment methods available for site. If this request parameter is not avaliable, defualt value for this flag will be true while creating a contract for Principal Accounts.
useAllShippingMethodsFromSite: Type: string

Flag to use all the shipping methods available for site. If this request parameter is not avaliable, defualt value for this flag will be true while creating a contract for Principal Accounts.
vatReferenceNumber: Type: string

Vat reference number of an Organization

Nested Schema : billingAddress

Type: object

Default Billing Address

repositoryId: Type: string

Repository Id of the address.

Nested Schema : contract

Type: object

Contract Info

catalogId: Type: string

Required: true

Catalog Id of the contract associated with account
contract_terms: Type: object contract_terms

Additional Properties Allowed:

Terms & Conditions for contract
description: Type: string

Description for contract
displayName: Type: string

Required: true

Display name for contract
endDate: Type: string

Contract end date time stamp
externalContractReference: Type: string

External contract reference
priceListGroupId: Type: string

Required: true

Price list group Id associated with account
startDate: Type: string

Contract start date time stamp

Nested Schema : dynamicProperty

Type: object

The value of the dynamic Property

Nested Schema : members

Type: array

List of contact ids associated with an Organization

Type: string

Nested Schema : parentOrganization

Type: object

Parent Organization.

id: Type: string

Id of the parent organization.

Nested Schema : paymentMethods

Type: array

Payment methods associated for organization.

Type: string

Nested Schema : secondaryAddresses

Type: array

List of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

Default Shipping Address

repositoryId: Type: string

Repository Id of the address.

Nested Schema : shippingMethods

Type: array

Shipping methods associated for organization.

Type: object items

Additional Properties Allowed:

Nested Schema : contract_terms

Type: object

Terms & Conditions for contract

terms: Type: string

Terms & Conditions

Nested Schema : items

Type: object

address: Type: object address

Additional Properties Allowed:

Address created for the Organization.
addressType: Type: string

Required: true

Address type represents nick name of account if present else repository ID of address item. This is a mandatory field

Nested Schema : address

Type: object

Address created for the Organization.

address1: Type: string

Required: true

The address1 of the secondary address. This is a mandatory field.
address2: Type: string

The address2 of the secondary address
city: Type: string

Required: true

The city of the secondary address. This is a mandatory field.
companyName: Type: string

Required: true

Company name of the secondary address. This is a mandatory field
country: Type: string

Required: true

The country of the address. This is a mandatory field.
isDefaultBillingAddress: Type: boolean

Marks an address as default billing address. Default value is false. Accepts true or false
isDefaultShippingAddress: Type: boolean

Marks an address as default shipping address. Default value is false. Accepts true or false
phoneNumber: Type: string

Required: true

Phone Number of the address. This is a mandatory field
postalCode: Type: string

Required: true

Postal Code of the address. This is a mandatory field
state: Type: string

Required: true

The State of the address. This is a mandatory field

Nested Schema : items

Type: object

id: Type: string

Repository Id of the shipping method.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : createOrganization_response

active: Type: boolean

Active status of an Organization. Should be true or false. By default the value is set to true
ancestorOrganizations: Type: array ancestorOrganizations

Additional Properties Allowed:

List of ancestors for the Organization
approvalRequired: Type: boolean

Approval flag is required for the organization, by default it is set to false
billingAddress: Type: object billingAddress

Additional Properties Allowed:

The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.
contract: Type: object contract

Additional Properties Allowed:

Contract
customerType: Type: string

Customer Type for Organization
delegateApprovalManagement: Type: boolean

This flag indicates if the delegated admin has the provision of approval management, if set merchant admin cannot do any approval management.
derivedBillingAddress: Type: object derivedBillingAddress

Additional Properties Allowed:

The derived default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default billing address.
derivedBillingAddressType: Type: string

Address type for derived billing address
derivedContract: Type: object derivedContract

Additional Properties Allowed:

Derived Contract
derivedCustomerType: Type: string

Derived Customer type of the Organization
derivedDescription: Type: string

Drived description of the Organization
derivedDunsNumber: Type: string

Derived dunsNumber of the Organization
derivedOrganizationLogo: Type: string

derived oragnizationLogo of the Organization
derivedPaymentMethods: Type: array derivedPaymentMethods

Additional Properties Allowed:

Derived payment methods associated for organization.
derivedShippingAddress: Type: object derivedShippingAddress

Additional Properties Allowed:

The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.
derivedShippingAddressType: Type: string

Address type for derived shipping address
derivedShippingMethods: Type: array derivedShippingMethods

Additional Properties Allowed:

Derived shipping methods associated for organization.
derivedTaxExemptionCode: Type: string

Derived taxExemptionCode of the Organization
derivedTaxReferenceNumber: Type: string

Derived taxReferenceNumber of the Organization
derivedType: Type: string

Derived type of the Organization
derivedUniqueId: Type: string

Derived unique Id of the Organization
derivedUseAllPaymentMethodsFromSite: Type: boolean

Derived flag to use all the payment methods available for site.
derivedUseAllShippingMethodsFromSite: Type: string

Derived flag to use all the shipping methods available for site.
derivedVatReferenceNumber: Type: string

derivedVatReferenceNumber of the Organization
description: Type: string

Description for Organization
dunsNumber: Type: string

DUNS Number for Organization.
dynamicProperty: Type: object dynamicProperty

Additional Properties Allowed:

The value of the dynamic Property
id: Type: string

Id of the Organization
members: Type: array members

Additional Properties Allowed:

List of contact ids associated with an Organization
name: Type: string

The name for Organization
orderPriceLimit: Type: number

Its order limit value for the organization, if order limit is more than this value then approval is needed for the order
organizationLogo: Type: string

File path of organization logo.
organizationLogoURL: Type: string

Full URL of organization logo.
parentOrganization: Type: object parentOrganization

Additional Properties Allowed:

Parent organization Info.
paymentMethods: Type: array paymentMethods

Additional Properties Allowed:

Payment methods associated for organization.
relativeRoles: Type: array relativeRoles

Additional Properties Allowed:

List of organization roles.
repositoryId: Type: string

repository Id of the Organization
secondaryAddresses: Type: array secondaryAddresses

Additional Properties Allowed:

List of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

The default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.
shippingMethods: Type: array shippingMethods

Additional Properties Allowed:

Shipping methods associated for organization.
taxExemptionCode: Type: string

Tax exemption code for Organization
taxReferenceNumber: Type: string

Tax Reference number for Organization
type: Type: string

Type for Organization
uniqueId: Type: string

Unique Id of the Organization
useAllPaymentMethodsFromSite: Type: boolean

Flag to use all the payment methods available for site.
useAllShippingMethodsFromSite: Type: string

Flag to use all the shipping methods available for site.
useExternalApprovalRequired: Type: boolean

Flag to enable/disable Order Approval check from External Webhook
vatReferenceNumber: Type: string

Vat reference number for the organization

Nested Schema : ancestorOrganizations

Type: array

List of ancestors for the Organization

Type: object items

Additional Properties Allowed:

Nested Schema : billingAddress

Type: object

The default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute.

address1: Type: string

the address1 of the address
address2: Type: string

the address2 of the address
city: Type: string

the city of the address
companyName: Type: string

the company name of the address
country: Type: string

the country of the address
phoneNumber: Type: string

the phone Number of the company address
postalCode: Type: string

the postal Code of the address
repositoryId: Type: string

repository Id of the address
state: Type: string

the state of the address

Nested Schema : contract

Type: object

Contract

catalog: Type: object catalog

Additional Properties Allowed:

Catalog associated with contract
creationDate: Type: string

Contract creation date time stamp
description: Type: string

Description for contract
displayName: Type: string

Display name for contract
endDate: Type: string

Contract end date time stamp
externalContractReference: Type: string

External contract reference
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:

Price ListGroup associated with contract
repositoryId: Type: string

Repository Id of the contract
startDate: Type: string

Contract start date time stamp
terms: Type: object terms

Additional Properties Allowed:

Terms and Conditions

Nested Schema : derivedBillingAddress

Type: object

The derived default billing address for the Organization. This a read only attribute. This will come if property 'isDefaultBillingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default billing address.

address1: Type: string

the address1 of the address
address2: Type: string

the address2 of the address
city: Type: string

the city of the address
companyName: Type: string

the company name of the address
country: Type: string

the country of the address
phoneNumber: Type: string

the phone Number of the company address
postalCode: Type: string

the postal Code of the address
repositoryId: Type: string

repository Id of the address
state: Type: string

the state of the address

Nested Schema : derivedContract

Type: object

Derived Contract

catalog: Type: object catalog

Additional Properties Allowed:

Catalog associated with contract
creationDate: Type: string

Contract creation date time stamp
description: Type: string

Description for contract
displayName: Type: string

Display name for contract
endDate: Type: string

Contract end date time stamp
externalContractReference: Type: string

External contract reference
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:

Price ListGroup associated with contract
repositoryId: Type: string

Repository Id of the contract
startDate: Type: string

Contract start date time stamp
terms: Type: object terms

Additional Properties Allowed:

Terms and Conditions

Nested Schema : derivedPaymentMethods

Type: array

Derived payment methods associated for organization.

Type: string

Nested Schema : derivedShippingAddress

Type: object

The derived default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute or if parent has default shipping address.

address1: Type: string

the address1 of the address
address2: Type: string

the address2 of the address
city: Type: string

the city of the address
companyName: Type: string

the company name shipping address
country: Type: string

the country of the address
phoneNumber: Type: string

the phone Number of the company address
postalCode: Type: string

the postal Code of the address
repositoryId: Type: string

repository Id of the address
state: Type: string

the state of the address

Nested Schema : derivedShippingMethods

Type: array

Derived shipping methods associated for organization.

Type: object items

Additional Properties Allowed:

Nested Schema : dynamicProperty

Type: object

The value of the dynamic Property

Nested Schema : members

Type: array

List of contact ids associated with an Organization

Type: object items

Additional Properties Allowed:

Nested Schema : parentOrganization

Type: object

Parent organization Info.

active: Type: boolean

Active flag of the parent Organization.
id: Type: string

Id of the parent Organization.
name: Type: string

Name of the parent organization.
repositoryId: Type: string

Repository Id of the parent organization.

Nested Schema : paymentMethods

Type: array

Payment methods associated for organization.

Type: string

Nested Schema : relativeRoles

Type: array

List of organization roles.

Type: object items

Additional Properties Allowed:

Nested Schema : secondaryAddresses

Type: array

List of all the addresses associated with an Organization, if property like 'isDefaultShippingAddress' or 'isDefaultBillingAddress' is set to 'true', then in response the same address will come as a separate attribute with name 'shippingAddress' or 'billingAddress'

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

The default shipping address for the Organization. This a read only attribute. This will come if property 'isDefaultShippingAddress' is set to 'true' in secondaryAddresses attribute.

address1: Type: string

the address1 of the address
address2: Type: string

the address2 of the address
city: Type: string

the city of the address
companyName: Type: string

the company name shipping address
country: Type: string

the country of the address
phoneNumber: Type: string

the phone Number of the company address
postalCode: Type: string

the postal Code of the address
repositoryId: Type: string

repository Id of the address
state: Type: string

the state of the address

Nested Schema : shippingMethods

Type: array

Shipping methods associated for organization.

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

active: Type: boolean

Active flag of the parent Organization.
id: Type: string

Id of the parent Organization.
name: Type: string

Name of the organization.
repositoryId: Type: string

Repository Id of the organization.

Nested Schema : catalog

Type: object

Catalog associated with contract

displayName: Type: string

Name of the catalog
repositoryId: Type: string

Repository Id of the catalog

Nested Schema : priceListGroup

Type: object

Price ListGroup associated with contract

displayName: Type: string

Name of the price list group
repositoryId: Type: string

Repository Id of the price list group

Nested Schema : terms

Type: object

Terms and Conditions

repositoryId: Type: string

Repository Id of terms and conditions
terms: Type: string

Terms and Conditions

Nested Schema : catalog

Type: object

Catalog associated with contract

displayName: Type: string

Name of the catalog
repositoryId: Type: string

Repository Id of the catalog

Nested Schema : priceListGroup

Type: object

Price ListGroup associated with contract

displayName: Type: string

Name of the price list group
repositoryId: Type: string

Repository Id of the price list group

Nested Schema : terms

Type: object

Terms and Conditions

repositoryId: Type: string

Repository Id of terms and conditions
terms: Type: string

Terms and Conditions

Nested Schema : items

Type: object

id: Type: string

Repository Id of the shipping method.

Nested Schema : items

Type: object

id: Type: string

Id of the contact
repositoryId: Type: string

Contact Id of contact

Nested Schema : items

Type: object

function: Type: string

Function of the role which can be admin, buyer or approver.
repositoryId: Type: string

Repository Id of the role.

Nested Schema : items

Type: object

address: Type: object address

Additional Properties Allowed:

Address created for the Organization.
addressType: Type: string

Address type represents nick name of account if present else repository ID of address item.

Nested Schema : address

Type: object

Address created for the Organization.

address1: Type: string

The address1 of the secondary address
address2: Type: string

The address2 of the secondary address
city: Type: string

The city of the secondary address
companyName: Type: string

Company name of the secondary address
country: Type: string

The country of the address
phoneNumber: Type: string

Phone Number of the address
postalCode: Type: string

Postal Code of the address
repositoryId: Type: string

repository Id of the address
state: Type: string

The State of the address

Nested Schema : items

Type: object

id: Type: string

Repository Id of the shipping method.

Example application/json


{
    "taxReferenceNumber":"REFNUM123",
    "organizationLogo":"/general/hero-image1.jpg",
    "delegateApprovalManagement":false,
    "secondaryAddresses":[
        {
            "address":{
                "country":"US",
                "phoneNumber":"973-974-1234",
                "address2":"Street 2",
                "city":"Montgomery",
                "address1":"600 Dexter Avenue",
                "postalCode":"36130",
                "companyName":"Oracle",
                "repositoryId":"150002",
                "state":"AL"
            },
            "addressType":"Office Address"
        }
    ],
    "type":"none",
    "parentOrganization":{
        "name":"Sample",
        "repositoryId":"100001",
        "active":true,
        "id":"100001"
    },
    "customerType":"Standard",
    "derivedShippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "derivedBillingAddressType":"Office Address",
    "members":[
        {
            "repositoryId":"110000"
        }
    ],
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/organizations"
        }
    ],
    "id":"200003",
    "dunsNumber":"123456789",
    "relativeRoles":[
        {
            "function":"admin",
            "repositoryId":"200004"
        },
        {
            "function":"buyer",
            "repositoryId":"200005"
        },
        {
            "function":"approver",
            "repositoryId":"200006"
        },
        {
            "function":"accountAddressManager",
            "repositoryId":"200007"
        },
        {
            "function":"profileAddressManager",
            "repositoryId":"200008"
        }
    ],
    "dynamicProperty1":"dynamicProperty1 value",
    "derivedTaxReferenceNumber":"REFNUM123",
    "derivedUseAllPaymentMethodsFromSite":false,
    "contract":{
        "terms":{
            "terms":"All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
            "repositoryId":"100002"
        },
        "endDate":"2017-10-10T11:44:26.000Z",
        "catalog":{
            "displayName":"Cloud Catalog",
            "repositoryId":"cloudCatalog"
        },
        "displayName":"Us Motor Works Contract",
        "repositoryId":"100003",
        "description":"This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
        "priceListGroup":{
            "displayName":"Default Price Group",
            "repositoryId":"defaultPriceGroup"
        },
        "creationDate":"2016-04-01T09:34:50.000Z",
        "startDate":"2016-10-10T11:44:26.000Z",
        "externalContractReference":"UMWCUS001"
    },
    "derivedCustomerType":"Standard",
    "active":true,
    "vatReferenceNumber":"Vat123123",
    "taxExemptionCode":"TAXUQ12345",
    "derivedType":"none",
    "useAllShippingMethodsFromSite":false,
    "approvalRequired":false,
    "derivedTaxExemptionCode":"TAXUQ12345",
    "derivedVatReferenceNumber":"Vat123123",
    "name":"Oracle",
    "ancestorOrganizations":[
        {
            "name":"Sample",
            "repositoryId":"100001",
            "active":true,
            "id":"100001"
        }
    ],
    "uniqueId":"TestIDNumber",
    "description":null,
    "derivedBillingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "derivedUniqueId":"TestIDNumber",
    "organizationLogoURL":"http://localhost:9080/file/general/hero-image1.jpg",
    "derivedContract":{
        "terms":{
            "terms":"All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
            "repositoryId":"100002"
        },
        "endDate":"2017-10-10T11:44:26.000Z",
        "catalog":{
            "displayName":"Cloud Catalog",
            "repositoryId":"cloudCatalog"
        },
        "displayName":"Us Motor Works Contract",
        "repositoryId":"100003",
        "description":"This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
        "priceListGroup":{
            "displayName":"Default Price Group",
            "repositoryId":"defaultPriceGroup"
        },
        "creationDate":"2016-04-01T09:34:50.000Z",
        "startDate":"2016-10-10T11:44:26.000Z",
        "externalContractReference":"UMWCUS001"
    },
    "paymentMethods":[
        "card",
        "cash"
    ],
    "derivedShippingAddressType":"Office Address",
    "shippingMethods":[
        {
            "id":"shippingMethodId1"
        }
    ],
    "derivedDunsNumber":123456789,
    "derivedOrganizationLogo":"/general/hero-image1.jpg",
    "orderPriceLimit":null,
    "derivedShippingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "derivedUseAllShippingMethodsFromSite":false,
    "useAllPaymentMethodsFromSite":false,
    "derivedPaymentMethods":[
        "card",
        "cash"
    ],
    "repositoryId":"200003",
    "shippingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "useExternalApprovalWebhook":false,
    "billingAddress":{
        "country":"US",
        "phoneNumber":"973-974-1234",
        "address2":"Street 2",
        "city":"Montgomery",
        "address1":"600 Dexter Avenue",
        "postalCode":"36130",
        "companyName":"Oracle",
        "repositoryId":"150002",
        "state":"AL"
    },
    "derivedDescription":null
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |100073|If the catalog id is required| |100052|If the organization logo is not found| |100074|If the pricelist group id is required| |20187|If the pricelist group id is invalid| |100053|If the organization invalid default billing address value| |100064|If the catalog id is invalid| |100075|If external reference number is invalid| |100054|If the organization invalid default shipping address value| |22002|If invalid profile/member id is given| |100002|If the input is Invalid| |100003|If Organization name passed is empty| |100005|If there is already an organization with given name| |100006|If there was any internal error while creating the organization| |100104|If the taxExemption code passed is invalid.| |100120|If the useAllPaymentMethodsFromSite property value is invalid.| |100118|If the paymentMethods passed in the input is invalid.| |100121|If the useAllShippingMethodsFromSite property value is invalid.| |100119|If the shippingMethods passed in the input is invalid.|

Body

Root Schema : errorModel

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "taxReferenceNumber": "REFNUM123",
  "organizationLogo": "/general/hero-image1.jpg",
  "delegateApprovalManagement": false,
  "secondaryAddresses": [{
    "address": {
      "isDefaultBillingAddress": true,
      "country": "US",
      "phoneNumber": "973-974-1234",
      "address2": "Street 2",
      "city": "Montgomery",
      "address1": "600 Dexter Avenue",
      "postalCode": "36130",
      "companyName": "Oracle",
      "isDefaultShippingAddress": true,
      "state": "AL"
    },
    "addressType": "Office Address"
  }],
  "parentOrganization": {"id": "100001"},
  "type": "none",
  "customerType": "Standard",
  "members": ["110000"],
  "paymentMethods": [
    "card",
    "cash"
  ],
  "dunsNumber": "123456789",
  "shippingMethods": [{"id": "shippingMethodId1"}],
  "dynamicProperty1": "dynamicProperty1 value",
  "contract": {
    "catalogId": "cloudCatalog",
    "priceListGroupId": "defaultPriceGroup",
    "endDate": "2017-10-10T11:44:26.000Z",
    "displayName": "Us Motor Works Contract",
    "description": "This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
    "contract_terms": {"terms": "All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract"},
    "startDate": "2016-10-10T11:44:26.000Z",
    "externalContractReference": "UMWCUS001"
  },
  "active": true,
  "vatReferenceNumber": "Vat123123",
  "taxExemptionCode": "TAXUQ12345",
  "orderPriceLimit": null,
  "useAllShippingMethodsFromSite": false,
  "approvalRequired": false,
  "useAllPaymentMethodsFromSite": false,
  "name": "Oracle",
  "shippingAddress": null,
  "useExternalApprovalWebhook": false,
  "billingAddress": null,
  "uniqueId": "TestIDNumber"
}

Sample Response Payload returned by endpoint:

{
  "taxReferenceNumber": "REFNUM123",
  "organizationLogo": "/general/hero-image1.jpg",
  "delegateApprovalManagement": false,
  "secondaryAddresses": [{
    "address": {
      "country": "US",
      "phoneNumber": "973-974-1234",
      "address2": "Street 2",
      "city": "Montgomery",
      "address1": "600 Dexter Avenue",
      "postalCode": "36130",
      "companyName": "Oracle",
      "repositoryId": "150002",
      "state": "AL"
    },
    "addressType": "Office Address"
  }],
  "type": "none",
  "parentOrganization": {
    "name": "Sample",
    "repositoryId": "100001",
    "active": true,
    "id": "100001"
  },
  "customerType": "Standard",
  "derivedShippingMethods": [{"id": "shippingMethodId1"}],
  "derivedBillingAddressType": "Office Address",
  "members": [{"repositoryId": "110000"}],
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadmin/v1/organizations"
  }],
  "id": "200003",
  "dunsNumber": "123456789",
  "relativeRoles": [
    {
      "function": "admin",
      "repositoryId": "200004"
    },
    {
      "function": "buyer",
      "repositoryId": "200005"
    },
    {
      "function": "approver",
      "repositoryId": "200006"
    },
    {
      "function": "accountAddressManager",
      "repositoryId": "200007"
    },
    {
      "function": "profileAddressManager",
      "repositoryId": "200008"
    }
  ],
  "dynamicProperty1": "dynamicProperty1 value",
  "derivedTaxReferenceNumber": "REFNUM123",
  "derivedUseAllPaymentMethodsFromSite": false,
  "contract": {
    "terms": {
      "terms": "All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
      "repositoryId": "100002"
    },
    "endDate": "2017-10-10T11:44:26.000Z",
    "catalog": {
      "displayName": "Cloud Catalog",
      "repositoryId": "cloudCatalog"
    },
    "displayName": "Us Motor Works Contract",
    "repositoryId": "100003",
    "description": "This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
    "priceListGroup": {
      "displayName": "Default Price Group",
      "repositoryId": "defaultPriceGroup"
    },
    "creationDate": "2016-04-01T09:34:50.000Z",
    "startDate": "2016-10-10T11:44:26.000Z",
    "externalContractReference": "UMWCUS001"
  },
  "derivedCustomerType": "Standard",
  "active": true,
  "vatReferenceNumber": "Vat123123",
  "taxExemptionCode": "TAXUQ12345",
  "derivedType": "none",
  "useAllShippingMethodsFromSite": false,
  "approvalRequired": false,
  "derivedTaxExemptionCode": "TAXUQ12345",
  "derivedVatReferenceNumber": "Vat123123",
  "name": "Oracle",
  "ancestorOrganizations": [{
    "name": "Sample",
    "repositoryId": "100001",
    "active": true,
    "id": "100001"
  }],
  "uniqueId": "TestIDNumber",
  "description": null,
  "derivedBillingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "150002",
    "state": "AL"
  },
  "derivedUniqueId": "TestIDNumber",
  "organizationLogoURL": "http://localhost:9080/file/general/hero-image1.jpg",
  "derivedContract": {
    "terms": {
      "terms": "All copyright, trade marks, design rights, patents and other intellectual property rights (registered and unregistered) belong to Us Motor Works Contract",
      "repositoryId": "100002"
    },
    "endDate": "2017-10-10T11:44:26.000Z",
    "catalog": {
      "displayName": "Cloud Catalog",
      "repositoryId": "cloudCatalog"
    },
    "displayName": "Us Motor Works Contract",
    "repositoryId": "100003",
    "description": "This is a written or spoken agreement, especially one concerning employment, sales, or tenancy, that is intended to be enforceable by law.",
    "priceListGroup": {
      "displayName": "Default Price Group",
      "repositoryId": "defaultPriceGroup"
    },
    "creationDate": "2016-04-01T09:34:50.000Z",
    "startDate": "2016-10-10T11:44:26.000Z",
    "externalContractReference": "UMWCUS001"
  },
  "paymentMethods": [
    "card",
    "cash"
  ],
  "derivedShippingAddressType": "Office Address",
  "shippingMethods": [{"id": "shippingMethodId1"}],
  "derivedDunsNumber": 123456789,
  "derivedOrganizationLogo": "/general/hero-image1.jpg",
  "orderPriceLimit": null,
  "derivedShippingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "150002",
    "state": "AL"
  },
  "derivedUseAllShippingMethodsFromSite": false,
  "useAllPaymentMethodsFromSite": false,
  "derivedPaymentMethods": [
    "card",
    "cash"
  ],
  "repositoryId": "200003",
  "shippingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "150002",
    "state": "AL"
  },
  "useExternalApprovalWebhook": false,
  "billingAddress": {
    "country": "US",
    "phoneNumber": "973-974-1234",
    "address2": "Street 2",
    "city": "Montgomery",
    "address1": "600 Dexter Avenue",
    "postalCode": "36130",
    "companyName": "Oracle",
    "repositoryId": "150002",
    "state": "AL"
  },
  "derivedDescription": null
}