OrderCreateRequest
Type: object.
| Name | Type | Description |
|---|---|---|
externalOrderId required | string | |
lines required | array of OrderCreateLine | At least 1 item. |
customer | string | A 10-digit North American phone number (formatting and a leading 1 are ignored) matches or creates the POS customer; any other value is written as the invoice's ship-to name, of which the POS keeps the first 35 characters, unless shipTo names the recipient. |
notes | string | Free text for the store; it lands in the POS invoice's Remark, which keeps the first 50 characters. Longer notes are accepted (not refused), but only those 50 reach the invoice. |
orderMethod | string | How the customer gets the order. Optional: omit it (or send an empty string) and the store's own default delivery method applies, exactly as before this field existed; with a shipTo and no orderMethod the order is a delivery (the 202 and the reads then say delivery). pickup together with a shipTo is a free 400 (a pickup has no delivery address). Any other value is a free 400 before billing. On a replay of the same Idempotency-Key or externalOrderId the stored order keeps the method it was created with. One of: pickup, delivery. |
shipTo | OrderShipTo | Optional delivery address. With it the order is a delivery; without it (or null) the order is exactly what it was before this field existed. |
No other fields appear.
Used by
- POST
/v1/orders