The Shipments API allows you to create shipment tasks, track status of shipments and retrieve information about shipments.
This section describes the different attributes available for a shipment.
Delivery address for shipment.
Pickup address for shipment.
Return address for shipment.
Unique identifier for carrier executing shipment.
Delivery date for shipment.
Date delivery arranged for shipment.
Contains additional information related to shipment e.g. carrier_tracking_url, reference, shipping_label, insurance, commercial_invoice, courier_instructions, tracking_number, tracking_url. See Shipment Extras.
Unique identifier for shipment.
Provides additional information for a shipment.
Unique identifier of parcel to be shipped.
List of parcels to be shipped for a multi-parcel shipment.
Pickup date for shipment.
Unique reference for the shipment.
Purpose of shipment. Options are commercial, personal, sample, return-after-repair, return-for-repair.
Unique identifier of rate used in shipment.
Status of shipment. Must be one of draft, cancelled, confirmed, pending, delivered or in-transit.
Time shipment created.
Time shipment last updated.