REST API for Oracle Commerce Cloud December 2017

organization

post

/ccadmin/v1/webhook/organization

The metadata for create/update account webhook.

Request

Supported Media Types

application/json

Body Parameter

The metadata for create/update account webhook.

Root Schema : organization_request

The metadata for create/update account webhook.

Properties

organization: Type: object organization

Additional Properties Allowed:

Nested Schema : organization

Type: object

Properties

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:

The ancestor organizations
approvalRequired: Type: boolean

Whether approval is required
billingAddress: Type: object billingAddress

Additional Properties Allowed:

Default billing address of the Organization
contract: Type: object contract

Additional Properties Allowed:

The contract information associated with this account
customerType: Type: string

Customer Type for Organization
delegateApprovalManagement: Type: boolean

Whether to delegate 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.
derivedContract: Type: object derivedContract

Additional Properties Allowed:

Derived Contract
derivedCustomerType: Type: string

Derived Customer type of the Organization
derivedDescription: Type: string

The description of the Organization
derivedDunsNumber: Type: string

Derived dunsNumber of the Organization
derivedOrganizationLogo: Type: string

Derived organizationLogo of the Organization
derivedOrganizationLogoURL: Type: string

The organization logo URL
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.
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
derivedVatReferenceNumber: Type: string

Derived VatReferenceNumber of the Organization
description: Type: string

Description for Organization
dunsNumber: Type: string

DUNS Number for Organization.
id: Type: string

Id of the Organization
members: Type: array members

Additional Properties Allowed:

Contact details associated with an Organization
name: Type: string

The name for Organization
orderPriceLimit: Type: string

Order price limit of the account
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:

The relative roles
repositoryId: Type: string

Repository Id of the Organization
secondaryAddresses: Type: array secondaryAddresses

Additional Properties Allowed:

List of addresses associated with an Organization.
shippingAddress: Type: object shippingAddress

Additional Properties Allowed:

Default shipping address of the Organization
shippingMethods: Type: array shippingMethods

Additional Properties Allowed:

Shipping methods associated for organization.
siteOrganizationProperties: Type: array siteOrganizationProperties

Additional Properties Allowed:

The site organization properties of the account
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.
useExternalApprovalWebhook: Type: boolean

Whether to trigger order approval webhook
vatReferenceNumber: Type: string

Vat reference number for the organization

Nested Schema : ancestorOrganizations

Type: array

The ancestor organizations

Items

Type: object items

Additional Properties Allowed:

Nested Schema : billingAddress

Type: object

Default billing address of the Organization

Properties

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 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

The contract information associated with this account

Properties

catalog: Type: object catalog

Additional Properties Allowed:

The catalog information
creationDate: Type: string

The date of creation
derivedDescription: Type: string

Derived description of the Organization
description: Type: string

The description of contract
displayName: Type: string

The name of contract
endDate: Type: string

The end date of contract
externalContractReference: Type: string

The external contract reference of contract
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:

The price list group information
repositoryId: Type: string

The repository Id of contract
startDate: Type: string

The start date of the contract
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.

Properties

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 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

Properties

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 : 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.

Properties

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 : members

Type: array

Contact details associated with an Organization

Items

Type: object items

Additional Properties Allowed:

Nested Schema : parentOrganization

Type: object

Parent organization Info.

Properties

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.

Items

Type: string

Nested Schema : relativeRoles

Type: array

The relative roles

Items

Type: object items

Additional Properties Allowed:

Nested Schema : secondaryAddresses

Type: array

List of addresses associated with an Organization.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : shippingAddress

Type: object

Default shipping address of the Organization

Properties

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 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.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : siteOrganizationProperties

Type: array

The site organization properties of the account

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

active: Type: boolean

Whether the account is active
id: Type: string

The id of the account
name: Type: string

The name of the account
repositoryId: Type: string

The repository id of the account

Nested Schema : catalog

Type: object

The catalog information

Properties

repositoryId: Type: string

The catalog id

Nested Schema : priceListGroup

Type: object

The price list group information

Properties

repositoryId: Type: string

The priceListGroup id

Nested Schema : terms

Type: object

Terms and Conditions

Properties

repositoryId: Type: string
terms: Type: string

Nested Schema : catalog

Type: object

Catalog associated with contract

Properties

repositoryId: Type: string

Repository Id of the catalog

Nested Schema : priceListGroup

Type: object

Price ListGroup associated with contract

Properties

repositoryId: Type: string

Repository Id of the price list group

Nested Schema : terms

Type: object

Terms and Conditions

Properties

repositoryId: Type: string

Repository Id of terms and conditions
terms: Type: string

Terms and Conditions

Nested Schema : items

Type: object

Properties

repositoryId: Type: string

Repository Id of contact

Nested Schema : items

Type: object

Properties

function: Type: string

The function of the account
repositoryId: Type: string

The repository id of the account

Nested Schema : items

Type: object

Properties

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.

Properties

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 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 : items

Type: object

Properties

displayName: Type: string

The name of the shippingMethod
id: Type: string

The Id of the shipping method.

Nested Schema : items

Type: object

Properties

properties: Type: object properties

Additional Properties Allowed:

The properties of the site
site: Type: object site

Additional Properties Allowed:

The site property of the account

Nested Schema : properties

Type: object

The properties of the site

Properties

approvalRequired: Type: boolean

Whether approval is required
contract: Type: object contract

Additional Properties Allowed:

The contract information associated with this account
delegateApprovalManagement: Type: boolean

Whether to delegate approval management
orderPriceLimit: Type: string

Order price limit of the account
paymentMethods: Type: array paymentMethods

Additional Properties Allowed:

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

Additional Properties Allowed:

Shipping methods associated for 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.
useExternalApprovalWebhook: Type: boolean

Whether to trigger order approval webhook

Nested Schema : site

Type: object

The site property of the account

Properties

siteId: Type: string

Id of the site

Nested Schema : contract

Type: object

The contract information associated with this account

Properties

catalog: Type: object catalog

Additional Properties Allowed:

The catalog information
creationDate: Type: string

The date of creation
derivedDescription: Type: string

Derived description of the Organization
description: Type: string

The description of contract
displayName: Type: string

The name of contract
endDate: Type: string

The end date of contract
externalContractReference: Type: string

The external contract reference of contract
priceListGroup: Type: object priceListGroup

Additional Properties Allowed:

The price list group information
repositoryId: Type: string

The repository Id of contract
startDate: Type: string

The start date of the contract
terms: Type: object terms

Additional Properties Allowed:

Terms and Conditions