1. REST API for Oracle Commerce Cloud
  2. Tasks
  3. Webhook
  4. Organization

organization

post

/ccadmin/v1/webhook/organization

The metadata for create/update account webhook.

Request

Supported Media Types
Body ()
The metadata for create/update account webhook.
Root Schema : organization_request
Type: object
The metadata for create/update account webhook.
Show Source
Example:
{
    "organization":{
        "taxReferenceNumber":"678",
        "siteOrganizationProperties":[
        ],
        "organizationLogo":"/general/hero-image1.jpg",
        "description":"Test Account Description",
        "delegateApprovalManagement":false,
        "secondaryAddresses":[
        ],
        "parentOrganization":null,
        "type":"company",
        "derivedBillingAddress":null,
        "derivedUniqueId":"123",
        "customerType":"Standard",
        "derivedShippingMethods":[
        ],
        "organizationLogoURL":"/file/v4724513249321774435/general/hero-image1.jpg",
        "derivedContract":null,
        "paymentMethods":[
        ],
        "members":[
        ],
        "id":"or-300007",
        "relativeRoles":[
            {
                "function":"admin",
                "repositoryId":"400001"
            },
            {
                "function":"buyer",
                "repositoryId":"400002"
            },
            {
                "function":"approver",
                "repositoryId":"400003"
            },
            {
                "function":"accountAddressManager",
                "repositoryId":"400004"
            },
            {
                "function":"profileAddressManager",
                "repositoryId":"400005"
            }
        ],
        "dunsNumber":"123456789",
        "shippingMethods":[
        ],
        "derivedDunsNumber":"123456789",
        "derivedTaxReferenceNumber":"678",
        "derivedUseAllPaymentMethodsFromSite":null,
        "contract":null,
        "derivedCustomerType":"Standard",
        "active":true,
        "derivedOrganizationLogo":"/general/hero-image1.jpg",
        "allSecondaryAddresses":{
        },
        "taxExemptionCode":null,
        "vatReferenceNumber":"34567",
        "orderPriceLimit":null,
        "derivedShippingAddress":null,
        "derivedType":"company",
        "useAllShippingMethodsFromSite":null,
        "derivedUseAllShippingMethodsFromSite":null,
        "derivedTaxExemptionCode":null,
        "useAllPaymentMethodsFromSite":null,
        "approvalRequired":false,
        "derivedPaymentMethods":[
        ],
        "derivedVatReferenceNumber":"34567",
        "name":"TestAccount",
        "shippingAddress":null,
        "ancestorOrganizations":[
        ],
        "useExternalApprovalWebhook":false,
        "billingAddress":null,
        "derivedDescription":"Test Account Description",
        "uniqueId":"123"
    }
}
Nested Schema : organization
Type: object
Show Source
Nested Schema : ancestorOrganizations
Type: array
The ancestor organizations
Show Source
Nested Schema : billingAddress
Type: object
Default billing address of the Organization
Show Source
Nested Schema : contract
Type: object
The contract information associated with this account
Show Source
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.
Show Source
Nested Schema : derivedContract
Type: object
Derived Contract
Show Source
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.
Show Source
Nested Schema : members
Type: array
Primary contact details associated with an organization. The secondary contacts will not be included in the payload. The REST endpoint can be used to fetch the secondary members
Show Source
Nested Schema : parentOrganization
Type: object
Parent organization Info.
Show Source
Nested Schema : paymentMethods
Type: array
Payment methods associated for organization.
Show Source
Nested Schema : relativeRoles
Type: array
The relative roles
Show Source
Nested Schema : secondaryAddresses
Type: array
List of addresses associated with an Organization. This property will be removed from the webhook request payload if the size exceeds the sub entity truncation size value configured for this webhook
Show Source
Nested Schema : secondaryMembers
Type: array
List of users with this organization as secondary organization
Show Source
Nested Schema : shippingAddress
Type: object
Default shipping address of the Organization
Show Source
Nested Schema : shippingMethods
Type: array
Shipping methods associated for organization. This property will be removed from the webhook payload only if includeChangesOnly property is set to true for a specific webhook.
Show Source
Nested Schema : siteOrganizationProperties
Type: array
The site organization properties of the account
Show Source
Nested Schema : items
Type: object
Show Source
  • This property will be added to webhook payload only if includeChangesOnly property is set to true for the specific webhook. Supported values include CREATE, UPDATE and DELETE. This indicates that the corresponding entity is either created or updated or deleted.
  • Whether the account is active
  • The id of the account
  • The name of the account
  • The repository id of the account
Nested Schema : catalog
Type: object
The catalog information
Show Source
Nested Schema : priceListGroup
Type: object
The price list group information
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : catalog
Type: object
Catalog associated with contract
Show Source
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : items
Type: object
Show Source
  • This property will be added to webhook payload only if includeChangesOnly property is set to true for the specific webhook. Supported values include CREATE, UPDATE and DELETE. This indicates that the corresponding entity is either created or updated or deleted.
  • External customer contact Id
  • Repository Id of contact
Nested Schema : items
Type: object
Show Source
  • This property will be added to webhook payload only if includeChangesOnly property is set to true for the specific webhook. Supported values include CREATE, UPDATE and DELETE. This indicates that the corresponding entity is either created or updated or deleted.
  • The function of the account
  • The repository id of the account
Nested Schema : items
Type: object
Show Source
Nested Schema : address
Type: object
Address created for the Organization.
Show Source
Nested Schema : types
Type: array
Types of address. Like SHIPPING, BILLING
Show Source
Nested Schema : items
Type: object
Show Source
  • This property will be added to webhook payload only if includeChangesOnly property is set to true for the specific webhook. Supported values include CREATE, UPDATE and DELETE. This indicates that the corresponding entity is either created or updated or deleted.
  • The name of type of address
  • The id of type of address
  • The repository id of type of address
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : properties
Type: object
The properties of the site
Show Source
Nested Schema : site
Type: object
The site property of the account
Show Source
Nested Schema : contract
Type: object
The contract information associated with this account
Show Source
Nested Schema : paymentMethods
Type: array
Payment methods associated for organization.
Show Source
Nested Schema : shippingMethods
Type: array
Shipping methods associated for organization.
Show Source
Nested Schema : catalog
Type: object
The catalog information
Show Source
Nested Schema : priceListGroup
Type: object
The price list group information
Show Source
Nested Schema : terms
Type: object
Terms and Conditions
Show Source
Nested Schema : items
Type: object
Show Source
  • This property will be added to webhook payload only if includeChangesOnly property is set to true for the specific webhook. Supported values include CREATE, UPDATE and DELETE. This indicates that the corresponding entity is either created or updated or deleted.
  • The name of the shippingMethod
  • The Id of the shipping method.
Back to Top

Response

Supported Media Types

200 Response

No response is returned as this is an event webhook
Body ()
Root Schema : emptyResponse
Show Source
Back to Top