Returns a list of shipments

get/shipments

Request

  • Base URL: https://api.shipcloud.io/v1
  • URL: https://api.shipcloud.io/v1/shipments
  • Auth: HTTP basic

Response

A list of shipments.

carrier'angel_de' | 'asendia' | 'cargo_international' | 'dhl' | 'dhl_express' | 'dpag' | 'dpd' | 'gls' | 'go' | 'hermes' | 'iloxx' | 'parcel_one' | 'ups' required

acronym of the carrier

service'standard' | 'one_day' | 'one_day_early' | 'returns' | 'asendia_epaq_standard_economy' | 'asendia_epaq_standard_priority' | 'cargo_international_express' | 'dhl_europaket' | 'dhl_prio' | 'dhl_warenpost' | 'dpag_warenpost' | 'dpag_warenpost_signature' | 'dpag_warenpost_untracked' | 'gls_express_0800' | 'gls_express_0900' | 'gls_express_1000' | 'gls_express_1200' | 'ups_express_1200' required

The service that should be used for the shipment.

reference_numberstring

a reference number (max. 30 characters) that you want this shipment to be identified with. You can use this afterwards to easier find the shipment in the shipcloud.io backoffice

descriptionstring

text that describes the contents of the shipment. This parameter is mandatory if you're using UPS and the following conditions are true: from and to countries are not the same; from and/or to countries are not in the EU; from and to countries are in the EU and the shipments service is not standard. The parameter is also mandatory when using DHL Express as carrier.

notification_emailstring

email address that we should notify once there's an update for this shipment (usually the recipients')

incoterm'ddp' | 'ddp_untaxed' | 'dap' | 'dap_cleared' | 'ddu' | 'ddu_cleared'
order_idstring

Identifier of a previously created order.

create_shipping_labelboolean

determines if a shipping label should be created at the carrier (this means you will be charged when using the production api key)

metadataobject

here you can save additional data that you want to be associated with the shipment. Any combination of key-value pairs is possible

idstring required

identifier of the shipment

carrier_tracking_nostring

the original tracking number that can be used on the carriers website

carrier_tracking_urlstring

the original tracking URL of the carrier

created_atstring date-time required

timestamp the shipment was created

label_urlstring

URL where you can download the label in pdf format

pricenumber required

price that we're going to charge you (exl. VAT)

shipper_notification_emailstring

email address of the shipper who should be notified of a change of shipment status by shipcloud

tracking_urlstring required

URL you can send your customers so they can track this shipment

Changes

No recorded changes to this operation across all 1 revision of this API.