Skip to main content

File a departure pickup list

POST 

/v1/fulfillment/departures/:departureId/pickup-list

Send eligible parcels to the channel and file a pickup list. Inspect the response outcome: parcels can have shipped even when filing is refused.

Requires orders.write.

Request and response fields at a glance
  • Path parameters: departureId (string, required).
  • 201 response (application/json): pickupListId (mixed, required), externalPickupListId (mixed, required), outcome (string, required), filedAt (mixed, required), inventoryBranchId (string, required), pickupDate (mixed, required), qrPayload (mixed, required), shipments (array, required), notShipped (array, required), failureReason (string).

Request​