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
- application/json
Path Parameters
-
customerAccountId(required): string
The ID of the requested Customer Account of an Organization.
-
id(required): string
The ID of the requested Organization.
Root Schema : syncCustomerAccountAddresses_request
Type:
Show Source
object
-
itemIds:
array 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.
-
reconcileExistingAddresses:
boolean
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
-
Array of:
string
Minimum Length:
1
Maximum Length:240
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : syncCustomerAccountAddresses_response
Type:
Show Source
object
-
failedItems:
array failedItems
List of failed addresses of the Customer Account.
-
resultingItems:
array resultingItems
List of synced addresses of the Customer Account.
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:
Show Source
object
-
errorMessage:
string
The error message associated with the failed address item.
-
externalId:
string
The external ID of the failed address item.
Nested Schema : items
Type:
Show Source
object
-
externalId:
string
Address Id of the Customer Account Address
-
id:
string
Repository Id of the Customer Account Address.
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|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
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
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code