Replace Shipment

{ "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'

Path Parameters

string

required

Body

The updated Shipment resource

Class Shipment

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

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" }

return_parcel

boolean

goods_value_currency

string

Pattern: ^[a-zA-Z]{3}$

Example:

"EUR"

recipient_address_details

string

Only shown in DPD AT labels.

reference_number_2

string

Example:

"reference number 2"

cod_reference

string

order_id

string

carrier

object

Class Carrier

Show child attributes

carrier_service

enum<string>

Available options:

standard,

express,

other

Example:

"standard"

recipient_company_name

string

recipient_email

string

recipient_phone

string

weight

number

Response

Shipment resource updated

Class Shipment

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

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

Pattern: ^[a-zA-Z]{3}$

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

Show child attributes

carrier_service

enum<string>

Available options:

standard,

express,

other

Example:

"standard"

recipient_company_name

string

recipient_email

string

recipient_phone

string

weight

number

API Documentation

Orders

Shipments

Claims

Authorizations

Path Parameters

Body

Response