Order Status Payload
The Order Status items returned in the 'data' field of an API response (see Responses) have the following fields:
Key | Type | Description |
order_id | string | Internal OrderSync order ID. |
order_status_id | string | Internal OrderSync status record ID. |
supplier_order_id | string | Supplier/OEM order identifier. |
order_date | ISO 8601 string | Order creation date. |
po_number | string | Purchase order number. More than one record can have the same PO Number in this system. |
item | string | Item title/description. |
customer | string | Customer name. |
customer_email | string (optional) | Custom email if one was provided in the original order. |
supplier | string | Supplier/OEM/Vendor name where the order was placed. |
status | One of the order status values: 'pending', 'invalid', 'submitted', 'shipped', 'in transit', 'complete', 'delivered', 'internal review', 'backorder', 'cancelled' These are explained in the Order Statuses article | |
carrier | string (optional) | A string representing the carrier used to ship this item: fedex, ups, usps, etc.
|
tracking_number | string (optional) | A tracking number for this item. Will only be populate if the item has shipped and we are able to match it to this item. |
tracking_url | string (optional) | A carrier tracking URL for this item. Will only be populate if the item has shipped and we are able to match it to this item. |
eta | string (optional) | String containing the estimate date that the item will be delivered in the format: 'YYYY-MM-DD'
|
delivery_date | ISO 8601 string (optional) | Date the item was delivered (only present if status is 'delivered') |