Sync addresses for shipping of a customer account under an Organization from external system to OCC

post

/ccadmin/v1/organizations/{id}/customerAccounts/{customerAccountId}/shipTo

Sync addresses for shipping of a customer account under an Organization.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : syncCustomerAccountAddresses_request
Type: object
Show Source
  • itemIds
    External address IDs for addresses to be synced for the provided customer Account ID. If it is not specified or an empty list is specified then 'reconcileExistingAddresses' flag should be set to true to sync/reconcile existing address only.
  • This flag is set to true then existing addresses will also be synced/reconcile along with specified externalIds. Default value is false.
Example:
{
    "itemIds":[
        "1035",
        "1034"
    ],
    "reconcileExistingAddresses":true
}
Nested Schema : itemIds
Type: array
External address IDs for addresses to be synced for the provided customer Account ID. If it is not specified or an empty list is specified then 'reconcileExistingAddresses' flag should be set to true to sync/reconcile existing address only.
Show Source
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : syncCustomerAccountAddresses_response
Type: object
Show Source
Nested Schema : failedItems
Type: array
List of failed addresses of the Customer Account.
Show Source
Nested Schema : resultingItems
Type: array
List of synced addresses of the Customer Account.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "resultingItems":[
        {
            "externalId":"1034",
            "id":"240000"
        },
        {
            "externalId":"1037",
            "id":"230002"
        }
    ],
    "failedItems":[
        {
            "errorMessage":"No country is specified",
            "externalId":"1222"
        },
        {
            "errorMessage":"Not Found",
            "externalId":"1035"
        },
        {
            "errorMessage":"Not Found",
            "externalId":"1036"
        }
    ]
}

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| |------------------|------------------| |59001|If there is an issue while processing addresses for customer account of an organization| |100093|Internal error occurred while adding addresses for customer account of an organization | |58001| Error if selfservice portal is not enabled|
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top