These docs are for v1.0. Click to read the latest docs for v2024.09.

/shipment/v1/shipments

The Shipment resource is used to create, list, update and delete Shipments.

Before you confirm a shipment and purchase a label, you need to create a shipment, which is where this endpoint comes in.

If you receive an order from a customer, this API is used to create that order as a Shipment on our system. These Shipments will not be confirmed or paid for until the Buy Labels resource is called from the Label endpoint. Once you Buy Labels for a Shipment through the Label API, you will not be able to update or delete it.

📘

If you have already used our Rates API, you can specify a specific Courier ID to already assign a Courier to the Shipment, using the selected_courier_id attribute. If you don’t pass in a Courier ID, we will attach a list of all possible Rates to your new Shipment and assign the best value for money Courier to your Shipment.