Overview
Use the ShipmentListAPIV3 and ShipmentAPIV3 to manage your shipments.
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:
| Status | Description | Possible sub-status |
|---|---|---|
| new | The shipment was just created. | validating_address if enabled, address is being validated. address_invalid if enabled, address check failed. recalled |
| releasing | The shipment is being released to a warehouse. | |
| released | The 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. |
| picking | The items of the shipment are being picked. | |
| packaging | The shipment is being packaged. | label_error: an error occurred while trying to generate the shipment's label and needs to be resolved. 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. | label_created: a label was generated for the shipment. label_uploaded: label was created and shipment is ready to label. waiting_for_pickup: the shipment is waiting for the carrier to collect it. Used for some B2B shipments: label_required: manual label is required to be created. pickup_details_required: pickup details are needed before the shipment can be booked with the carrier. pickup_details_uploaded: pickup details were provided. manual_outbound: shipment is ready to outbound. Used for FBA (Fulfillment by Amazon) shipments: fba_details_required: FBA shipping details are needed. fba_box_label_required: an FBA box label is needed. fba_pallet_label_required: an FBA pallet label is needed. label_error: an error occurred generating the FBA label and needs to be resolved. |
| sent | The carrier picked up the package. | claim_reported: a customer support ticket was opened for this shipment. Otherwise, reflects carrier tracking progress (whichever of a multi-unit shipment's units needs the most attention): failed_delivery: an actual delivery exception occurred, not just a delay. delayed: the carrier still expects to deliver it, just later than planned. out_for_delivery: the shipment is out for delivery. at_pickup_point: the shipment arrived at a pickup point - a shop, locker or post office - and is waiting for the customer to collect it. in_transit: the shipment is moving through the carrier's network. pick_up: the carrier picked up the shipment from the warehouse. |
| 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. |
For a multi-unit shipment, the six tracking sub-statuses above reflect whichever unit needs the most attention. If you want each parcel's own tracking progress rather than the shipment-level summary, see Tracking data.
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.
Updated 19 days ago