Use the ShipmentListAPIV3 and ShipmentAPIV3 to manage your shipments.


A shipment in byrd is the object composed by a packaging and a product or products that have to be picked and packed in the warehouse to be sent through a carrier to a specific recipient.

Shipment status and sub-status

Once the shipment is created it can go through different status and sub-status:

StatusDescriptionPossible sub-status
newThe shipment was just created.validating_address if enabled, address is being validated.
address_invalid if enabled, address check failed.
releasingThe shipment is being released to a warehouse.
releasedThe shipment was released to a warehouse.reserved:stock is reserved.
allocating: stock is being allocated for picking.
allocated: stock is allocated to a picking action.
assigned: shipment is assigned to a warehouse worker to start picking.
pickingThe items of the shipment are being picked.
packagingThe shipment is being packaged.error_resolved: if an error occurs during packaging, this substatus indicates that was fixed so the warehouse can finish the packaging.
packaged The shipment is already packaged and labeled.Used for some B2B shipments:
label_required: manual label is required to be created.
label_uploaded: label was created and shipment is ready to label.
manual_outbound: shipment is ready to outbound .
sent The carrier picked up the package.claim_reported: a customer support ticket was opened for this shipment
delivered The package was delivered to the recipient.claim_reported: a customer support ticket was opened for this shipment
returning A return shipment was created for this shipment.
returned The return shipment has arrived to the warehouse.
deleted The shipment was deleted.

Shipment types

There are two types of shipments:

  • B2C > shipments sent to end consumers or companies but with no special requirements.
  • B2B > shipments sent to companies or other non byrd warehouses which need special requirements like sending by pallet or fill a whole insurance value for the shipment.