Skip to main content

Get a filed pickup list

GET 

/fulfillment/pickup-lists/:pickupListId

Read a previously filed pickup list for reprinting without filing again. shipments is every parcel filed on the list; those with isWithdrawn false are still on the run, shipmentCount of them.

Requires orders.read.

Request and response fields at a glance
  • Path parameters: pickupListId (integer, required).
  • 200 response (application/json): pickupListId (integer, required), externalPickupListId (string, required), outcome (string, required), filedAt (string, required), inventoryBranchId (string, required), pickupDate (string or null, required), qrPayload (string or null, required), brandId (integer, required), brandName (string, required), saleChannels (array, required), shipmentCount (integer, required), shipments (array, required), notShipped (array, required).

Request​