fulfillment

Box Manifest By Tracking

A box's manifest, reached the way the search result identifies it.

07 §5. by-tracking sits in the path rather than replacing /boxes/{shipment_id}/parcels outright because the print and packaging screens still hold shipment UUIDs; the two coexist and mean the same thing from different directions.

Gated on fulfillment:parcels:read alongside /search, not on fulfillment:read, because it is the same screen: 07 §6's expanded box row IS this call, and a search that returns a box you cannot open answers "where is this parcel" with half a sentence. The sibling route below, /boxes/{shipment_id}/parcels, keeps fulfillment:read — it is reached from the print and packaging stations, which are warehouse surfaces.

q is the search term the box was opened from, when it was: the parcels that match it lead the manifest, so the row the box record tints is on the first page of a 171-parcel box rather than the fourth (ISS-592).

get/api/fulfillment/boxes/by-tracking/{tracking_number}/parcels

Request

  • Base URL: https://api.pigeonly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pigeonly.com/api/fulfillment/boxes/by-tracking/{tracking_number}/parcels
  • Auth: none declared

Path parameters

tracking_numberstring required

Query parameters

limitinteger
offsetinteger
qstring

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.