Jump to

• Request
• Response

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.

Body ()

Root Schema : syncCustomerAccountAddresses_request

Type: object

Show Source

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

{
    "properties":{
        "itemIds":{
            "description":"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.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/stringType"
            }
        },
        "reconcileExistingAddresses":{
            "description":"This flag is set to true then existing addresses will also be synced/reconcile along with specified externalIds. Default value is false.",
            "type":"boolean"
        }
    },
    "example":{
        "itemIds":[
            "1035",
            "1034"
        ],
        "reconcileExistingAddresses":true
    }
}

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

{
    "description":"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.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/stringType"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : syncCustomerAccountAddresses_response

Type: object

Show Source

• failedItems: array failedItems
  List of failed addresses of the Customer Account.
• resultingItems: array resultingItems
  List of synced addresses of the Customer Account.

{
    "properties":{
        "resultingItems":{
            "description":"List of synced addresses of the Customer Account.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "externalId":{
                        "description":"Address Id of the Customer Account Address",
                        "type":"string"
                    },
                    "id":{
                        "description":"Repository Id of the Customer Account Address.",
                        "type":"string"
                    }
                }
            }
        },
        "failedItems":{
            "description":"List of failed addresses of the Customer Account.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "description":"The error message associated with the failed address item.",
                        "type":"string"
                    },
                    "externalId":{
                        "description":"The external ID of the failed address item.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : failedItems

Type: array

List of failed addresses of the Customer Account.

Show Source

• Array of: object items

{
    "description":"List of failed addresses of the Customer Account.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "description":"The error message associated with the failed address item.",
                "type":"string"
            },
            "externalId":{
                "description":"The external ID of the failed address item.",
                "type":"string"
            }
        }
    }
}

Nested Schema : resultingItems

Type: array

List of synced addresses of the Customer Account.

Show Source

• Array of: object items

{
    "description":"List of synced addresses of the Customer Account.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "externalId":{
                "description":"Address Id of the Customer Account Address",
                "type":"string"
            },
            "id":{
                "description":"Repository Id of the Customer Account Address.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• errorMessage: string
  The error message associated with the failed address item.
• externalId: string
  The external ID of the failed address item.

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "description":"The error message associated with the failed address item.",
            "type":"string"
        },
        "externalId":{
            "description":"The external ID of the failed address item.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• externalId: string
  Address Id of the Customer Account Address
• id: string
  Repository Id of the Customer Account Address.

{
    "type":"object",
    "properties":{
        "externalId":{
            "description":"Address Id of the Customer Account Address",
            "type":"string"
        },
        "id":{
            "description":"Repository Id of the Customer Account Address.",
            "type":"string"
        }
    }
}

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

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top