ShipmentNotification

An individual notification that an order has been shipped

NameTypeNullable?Description
carrier_codestring

The carrier code the order was shipped through

carrier_service_codestring

The shipping service used to ship this order

currencystring

The (ISO 4217) code describing the currency used for all amounts on this payload. @example "USD", "EUR", "NZD"

ext_location_idstring

The order source's identifier for the location that items were shipped from

fulfillment_costnumber

The amount of money it cost to fulfill this shipment

insurance_costnumber

The total amount of insurance purchased

integration_contextany

The integration context specified on the ExportSalesOrders response

items

ShipmentNotificationItem[]

The items shipped in this shipment

notes

Note[]

Additional notes associated with this notification or its sales order

notification_idstring

A unique identifier to correlate this shipment notification with its result in the response

notify_buyerboolean

Indicates whether or not the buyer should be notified that this item has been shipped

order_idstring

The unique identifier of the sales order from the order source

order_numberstring

The customer facing identifier of the sales order

return_address

Address

The return address specified on the shipment

ship_datestring

The (ISO 8601) datetime (UTC) associated with when this item was last modified @example "2021-03-31T18:21:14.858Z"

ship_from

Address

Where the shipment shipped from

ship_to

Address

Where the shipment was shipped to

tracking_numberstring

The identifier provided by the fulfiller for tracking the delivery progress

tracking_urlstring

The url where the shipment can be tracked