GuidesAPI ReferenceChangelog
API Reference

Recall a shipment

post
https://api.getbyrd.com/v3/shipments//recall

Takes a shipment back from the warehouse while it is still
released, before picking starts, and cancels its fulfilment. The
shipment returns to new with sub-status recalled and can be
released again, to the same or another warehouse.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the shipment (UUID).

Body Params
string | null
enum
Defaults to null

Reason for the recall; optional for you.

  • stock_inaccurate: the stock recorded for an item is wrong
  • stock_expired: the stock of an item has expired
Allowed:
boolean
Defaults to false

Whether to undo the picking and packing of a shipment the warehouse has already started on before recalling it. Reserved for byrd: requests from your account with true are rejected (403).

Responses
200

Empty response content

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago