Developers: Customer Ship-To
Validation
Ship-To create, update, batch-create, and import requests validate the following fields:
| Field | Requirement |
|---|---|
shipToID |
Must be a GUID when supplied to the API. |
number |
Required. Use this field for an external Ship-To identifier. |
name |
Required. |
address |
Required. |
city |
Required. |
postalCode |
Required. |
country |
Required. Use either an ISO country code or supported country name. |
state |
Required for United States and Canadian addresses. For United States addresses, the state must be a two-character abbreviation. Other countries may use their local state or province abbreviation. |
For example, a Malaysian Ship-To address may use "state": "JOH" for Johor. It is valid because the two-character state rule applies only when country is US or United States.
Import
Ship-To addresses can be imported via the API. The ImportID must be passed as a query parameter to ensure that the results of the background import process can be retrieved later.
Endpoint: POST /v1/customers/shipto/import?ImportID={ImportID}
Parameters:
- ImportID: A unique identifier (GUID recommended) for the import session.
- importfile: The CSV or Excel file containing the Ship-To data.
Retrieving Results
After the import is initiated, you can check the status and retrieve logs using the ImportID.
Summary: GET /v1/customers/shipto/imports/{ImportID}/summary
Logs: GET /v1/customers/shipto/imports/{ImportID}/logs/pages/{page}