Skip to main content

File a departure pickup list

POST 

/fulfillment/departures/:departureId/pickup-list

Send eligible parcels to the channel and file a pickup list. Inspect the response outcome: parcels can have been sent to the channel even when filing is refused. A parcel on a filed list stays packed until the channel's driver collects the list, then ships at the time of the collection.

Requires orders.write.

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

Request​