Skip to content
Copy site link for AI

Ship-to Addresses Realtime-enabled — SmartConnect can trigger on changesRealtime-enabled

GETPOSTPATCHDELETETable: Ship-to Address

eOne/core/v1.0/shipToAddresses
This is the customer's reusable address book. To set the delivery/billing address on one specific order instead, use the ship-to / bill-to fields on that document, e.g. Sales Orders exposes shipToCode, shipToOptions, and billToOptions alongside the individual address fields.

Read and write a customer's alternate shipping addresses, the address book eOne integration orders pick a delivery address from. An address belongs to a customer, and customerNumber + code together form the key. Set an integrationId to anchor the address to its external-system record; when you do, code becomes optional on create and is generated for you. Also reachable nested under a customer.

Create a ship-to address

POST/shipToAddresses

{
  "customerNumber": "10000",
  "integrationId": "CRM-778101",
  "name": "West Coast DC",
  "addressLine1": "123 Dockside Rd",
  "city": "Seattle",
  "postalCode": "98101",
  "countryRegionCode": "US"
}
customerNumber is required. Provide either a code or an integrationId: if code is omitted while an integrationId is present, a code is generated automatically (see below). A duplicate code for the same customer is rejected rather than silently overwriting the existing address.

Auto-generated codes

POST with an integrationId but no code and the code is built as the first 8 characters of customerNumber followed by a two-digit sequence, 1000001, then 1000002, taking the first free slot for that customer. A customer can hold up to 99 auto-generated addresses; beyond that, supply your own code. Passing an explicit code always overrides the formula.

Updating the code

Anchor updates on integrationId: locate the address by integrationId, then PATCH. Sending a new code renames the address in place, the record keeps its id and integrationId, and the rename cascades to any open, unposted sales documents that reference the old code. Posted documents keep their original snapshot and are unaffected.

customerId is read-only

customerId is a convenience lookup resolved from customerNumber. It returns the parent customer's GUID but is not writable. Always identify the parent with customerNumber.