Shipments

Shipments are at the core of our API. They contain files such as labels and are used to track the status of the physical shipment being delivered by the carrier.

Attributes

API specification

Attribute Type Description Required
recipient_address address The address of the recipient of the shipment.
return_address address The address the shipment can be returned to when shipment fails.
sender_address address The address of the sender of the shipment.
physical_properties physical-properties Weight and dimensions of the shipment.
pickup_location pickup-dropoff-locations The place where the recipient can pick up their shipment. Required when chosen service has delivery-method pick-up
description string Short custom description that will be printed on the label when possible. Required for international shipments
items array of items The contents of the shipment. Required for international shipments
customs customs Information required for the shipment to pass customs. Required for international shipments
channel string Name of the application (and potentially version number) used to create the shipment.
price price The price of the shipment.
barcode string Textual representation of the barcode present on the label.
tracking_code string Used to request tracking status from the carrier.
tracking_url string Points to the tracking software of the carrier.
register_at integer Unix timestamp for when the shipment will be registered with the carrier. After registration, labels will be made available.
created_at integer Unix timestamp for when the shipment was created.
updated_at integer Unix timestamp for when the shipment resource was last updated.
synced_at integer Unix timestamp for when the shipment status was last checked with the carrier.
Relationship Type Description Required
shop shops The shop the shipment belongs to.
service services The service used to send the shipment. Required for registration with the carrier
contract contracts The contract to use for the chosen service. Required for registration with the carrier
service_options array of service-options The service options chosen for the shipment.
shipment_status shipment-statuses The current shipment status for the shipment.
files array of files The files available for the shipment. Such as the label and possible customs documents.
hook_logs array of hook-logs The logs of the hooks that were applied to this this shipment. Such as updating the service or the contract.

Endpoints

GET /shipments
GET /shipments/{shipment_id}
POST /shipments
PATCH /shipments/{shipment_id}
DELETE /shipments/{shipment_id}
21-06-2019