Shipments
The Shipments API allows you to create shipment tasks, track status of shipments and retrieve information about shipments.
Last updated
The Shipments API allows you to create shipment tasks, track status of shipments and retrieve information about shipments.
Last updated
address_to
string
Delivery address for shipment.
address_from
string
Pickup address for shipment.
address_return
string
Return address for shipment.
carrier
string
Unique identifier for carrier executing shipment.
delivery_date
string
Delivery date for shipment.
delivery_arranged
string
Date delivery arranged for shipment.
events
array
Array of status updates on shipment provided by carrier.
extras
object
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.
id
string
Unique identifier for shipment.
metadata
object
Provide additional information for a shipment.
parcel
string
Unique identifier of parcel to be shipped.
parcels
string
List of parcels to be shipped for a multi-parcel shipment.
pickup_date
date
Pickup date for shipment.
shipment_id
string
Unique reference for the shipment.
shipment_purpose
string
Purpose of shipment. Options are commercial, personal, sample, return-after-repair, return-for-repair.
rate
string
Unique identifier of rate used in shipment.
status
enum
Status of shipment. Must be one of draft, cancelled, confirmed, pending, delivered or in-transit.
created_at
datetime
Time shipment created.
updated_at
datetime
Time shipment last updated.