ShipmentNotification
An individual notification that an order has been shipped
| Name | Type | Nullable? | Description |
|---|---|---|---|
carrier_code | string | ✔ | The carrier code the order was shipped through |
carrier_service_code | string | ✔ | The shipping service used to ship this order |
currency | string | ✔ | The (ISO 4217) code describing the currency used for all amounts on this payload. @example "USD", "EUR", "NZD" |
ext_location_id | string | ✔ | The order source's identifier for the location that items were shipped from |
fulfillment_cost | number | ✔ | The amount of money it cost to fulfill this shipment |
insurance_cost | number | ✔ | The total amount of insurance purchased |
integration_context | any | The integration context specified on the ExportSalesOrders response | |
items | The items shipped in this shipment | ||
notes | Note[] | ✔ | Additional notes associated with this notification or its sales order |
notification_id | string | A unique identifier to correlate this shipment notification with its result in the response | |
notify_buyer | boolean | ✔ | Indicates whether or not the buyer should be notified that this item has been shipped |
order_id | string | The unique identifier of the sales order from the order source | |
order_number | string | ✔ | The customer facing identifier of the sales order |
return_address | ✔ | The return address specified on the shipment | |
ship_date | string | ✔ | The (ISO 8601) datetime (UTC) associated with when this item was last modified @example "2021-03-31T18:21:14.858Z" |
ship_from | ✔ | Where the shipment shipped from | |
ship_to | ✔ | Where the shipment was shipped to | |
tracking_number | string | ✔ | The identifier provided by the fulfiller for tracking the delivery progress |
tracking_url | string | ✔ | The url where the shipment can be tracked |