The new version of the Shipments API simplifies the flow, with a create shipment endpoint that also allows purchasing labels, synchronously or async. We also added new parameters and options, such as multi-parcel shipments, the pre-selection of box dimensions, etc.

Create a Shipment / Update a Shipment

• The origin_address object allows you to pass any origin address in your account’s country
• An address different to the origin address can be set as the sender_address and return_address
• The same address object format is used for all address types, including the destination_address
• You can now pass metadata to store additional information about the shipment
• You can now specify an insured_amount with the insurance object
• The order_data object allows you to set tags (order_tag_list) and notes (seller_notes, buyer_notes) on the shipment
• The courier_selection object allows you to send params like the selected courier, and toggle on or off your shipping rules for rate calculation
• The shipping_settings object contains options to adjust declared units, shipping document formats and page size preferences
• You can now purchase a label at the time of Shipment creation (buy_label option), and specify if you want to retrieve the label asynchronously or synchronously (buy_label_synchronous option)
• You can now pass a quantity for each item
• You can now create a multi-parcel shipment, by sending a list of parcels. We currently only support shipments with multiple parcels when shipping from United States, Hong Kong, United Kingdom and Singapore.
• You can now specify a custom box or courier packaging type for each parcel
• The shipment’s shipping documents are now returned as an array of shipping_documents, where the category refers to the type of document
• The shipment’s tracking information is returned as an array of trackings to support shipments that are handled by multiple couriers
• selected_courier now only contains the id of the selected courier. The id can be used to identify the full selected rate details from the array of rates returned
• discount details are now returned in each rates object

List all Shipments

• Additional filters have been added, including: updated_at_from, updated_at_to, label_paid_at_from and label_paid_at_to

Update Warehouse State

• You can now update up to 100 shipments at a time by passing an array of shipment details
• For each shipment, you can specify a warehouse_state, provide a message and add metadata