Shipment

Each shipment has the following properties and is accessed via /api/shipment.

Properties

Complete details in ShipmentProperties.

id

The unique id for this shipment. It will never change.

wing_object_type

shipment.

tracking_number

The tracking number provided by the carrier to track this shipment.

tracking_url_provider

The tracking URL from the carrier.

Related Objects

See "Related Objects" in Intro for details.

receipt

A Receipt.

Methods

The methods used to fetch and manipulate shipments.

List

 GET /api/shipment

Requires an order manager or production manager session. Standard list pagination applies.

query searches references using the existing text search. A complete numeric query, with optional surrounding whitespace, instead matches the related receipt's order number exactly. All shipments for that order are returned, newest first, with shipment ID breaking ties for stable pagination. An unknown order number returns an empty list rather than similarly numbered orders.

The existing updated_after, updated_before, shipped_status, and shipment_type filters also apply to an exact order-number search.

Fetch

 GET /api/shipment/xxx

session_id

Required. The unique session id provided by a Session method.

Returns:

 {
   "id" : "xxx",
   "tracking_number" : "4301",
   ...
 }