OrderShipTo
Delivery address written on the POS invoice header. street, city, state and zip are required together; name (or firstName/lastName), street2 and phone are optional. Every part is trimmed; the limits apply after trimming and count characters. A value over its limit, a missing required part, a control character or pickup with a shipTo is a free 400 before billing whose detail names the field and its limit. The address is returned only to the integration that sent it (both order reads are scoped to it) and never in webhook bodies.
Type: object.
| Name | Type | Description |
|---|---|---|
city required | string | City (invoice ShipCity). At most 35 characters. |
state required | string | Two-letter state code (invoice ShipState); stored and returned upper-cased. Pattern: ^[A-Za-z]{2}$ |
street required | string | Street address, first line (invoice ShipAdd1). At most 35 characters. |
zip required | string | ZIP code (invoice ShipZip): up to 10 characters of digits, spaces and dashes, starting and ending with a digit (08701, 08701-1234). At most 10 characters. Pattern: ^[0-9]([0-9 -]*[0-9])?$ |
firstName | string | The recipient's first name. The POS stores lastName, a space and firstName as one ship-to name of at most 35 characters, so the two together must fit in 34. At most 35 characters. |
lastName | string | The recipient's last name (see firstName). At most 35 characters. |
name | string | The recipient as one value (invoice ShipName, 35 characters). Do not send it together with firstName or lastName. At most 35 characters. |
phone | string | Delivery phone (invoice ShipTel): a 10-digit North American number. Spaces, dashes, dots, parentheses and a leading +1 or 1 are formatting and are stripped; it is stored and returned as the 10 digits. Without it the POS uses the customer's phone. |
street2 | string | Street address, second line (invoice ShipAdd2). At most 35 characters. |
No other fields appear.