Skip to main content
GET
/
v2
/
shipments
Error
A valid request URL is required to generate request examples
[
  {
    "recipient_address": "<string>",
    "recipient_first_name": "<string>",
    "recipient_last_name": "<string>",
    "recipient_zip": "<string>",
    "recipient_city": "<string>",
    "recipient_country": "<string>",
    "id": "<string>",
    "tracking_code": "<string>",
    "reference_number": "<string>",
    "pickup_point_selected": true,
    "planned_pickup_datetime": "2023-11-07T05:31:56Z",
    "comment": "<string>",
    "warehouse_address": "<string>",
    "warehouse": "<string>",
    "shipment_tag": {
      "tag1": "value1",
      "tag2": "value2"
    },
    "recipient_name": "<string>",
    "return_parcel": true,
    "trackable": true,
    "goods_value_currency": "EUR",
    "recipient_address_details": "<string>",
    "reference_number_2": "reference number 2",
    "local_delivery": true,
    "cod_reference": "<string>",
    "order_id": "<string>",
    "carrier_tracking_url": "<string>",
    "carrier": {
      "name": "prime-network",
      "country": "<string>"
    },
    "carrier_service": "standard",
    "recipient_company_name": "<string>",
    "recipient_email": "<string>",
    "recipient_phone": "<string>",
    "weight": 123
  }
]

Authorizations

​
Authorization
string
header
required

We use JWT Tokens for the authorization. Please add an 'Authorization' header for a request. Generate a valid JWT token using user credentials. See Auth - Token section. The value should contain the following:
'Bearer GENERATED_TOKEN'

Query Parameters

​
tracking_code
string
​
reference_number
string
​
pickup_point_selected
boolean
​
recipient_address
string
​
recipient_name
string
​
return_parcel
boolean
​
order_id
string
​
carrier_service
string
​
recipient_company_name
string
​
recipient_email
string
​
recipient_zip
string
​
recipient_city
string
​
recipient_phone
string
​
weight
string
​
planned_pickup_datetime[before]
string

Date filter, example: 2025-04-09T11:47:19+02:00

​
planned_pickup_datetime[after]
string

Date filter, example: 2025-04-09T11:47:19+02:00

​
page
integer

The collection page number

​
itemsPerPage
integer

The number of items per page

Response

Shipment collection response

​
recipient_address
string
required
​
recipient_first_name
string
required
​
recipient_last_name
string
required
​
recipient_zip
string
required
​
recipient_city
string
required
​
recipient_country
string
required
​
id
string
​
tracking_code
string
​
reference_number
string
​
pickup_point_selected
boolean
​
planned_pickup_datetime
string<date-time>
​
comment
string
​
warehouse_address
string
​
warehouse
string
​
shipment_tag
string[]
Example:
{ "tag1": "value1", "tag2": "value2" }
​
recipient_name
string
​
return_parcel
boolean
​
trackable
boolean
​
goods_value_currency
string
Example:

"EUR"

​
recipient_address_details
string

Only shown in DPD AT labels.

​
reference_number_2
string
Example:

"reference number 2"

​
local_delivery
boolean
​
cod_reference
string
​
order_id
string
​
carrier_tracking_url
string
​
carrier
object

Class Carrier

​
carrier_service
enum<string>
Available options:
standard,
express,
other
Example:

"standard"

​
recipient_company_name
string
​
recipient_email
string
​
recipient_phone
string
​
weight
number