Retrieve the parcel journeys for an order or a parcel

A parcel journey contains the full tracking history related to the delivery of a parcel.

It unifies in a normalised format all of the events that have been published for the parcel, both pre-allocation and post-allocation.

These events include deliveries, delivery legs, and carrier tracking events.

SecurityBasicAuth
Request
query Parameters
orderRef
string

Use the order reference to retrieve all parcel journeys for the order.

Note: This parameter is case sensitive.

Example: orderRef=REPLACE-WITH-YOUR-ORDER-REF
trackingIdentifier
string

Use the tracking identifier to retrieve the parcel journey for a specific parcel.

Use this parameter in combination with order reference to ensure that any parcel journeys returned for an order contain at least one delivery leg that matches the specified tracking identifier.

Note: This parameter is case sensitive.

Example: trackingIdentifier=REPLACE-WITH-YOUR-TRACKING-IDENTIFIER
customerRef
string

Unique reference of the customer.

Use this optional parameter to filter parcel journeys for a specific customer when a multi-brand seller can use the same order reference across its brands.

To use this filter, the customer reference must be provided in the delivery and delivery legs for the corresponding order and parcels (order.customer.customerRef).

Note: This parameter is case sensitive.

Example: customerRef=REPLACE-WITH-YOUR-CUSTOMER-REF
postcode
string

The postcode of the parcel recipient.

Use this optional parameter in combination with order reference or tracking identifier to ensure that any parcel journeys returned for an order contain at least one parcel journey that matches the specified parcel recipient postcode (recipient.postCode).

Note: This parameter is case sensitive.

Example: postcode=WC1X 8XZ
header Parameters
User-Agent
string

The name of the client that interacts with the API.

Example: REPLACE-WITH-YOUR-USER-AGENT
Accept-Encoding
string

Enables the compression of the content returned in the response.

Supported content encodings are gzip and deflate.

Example: gzip, deflate
Accept-Language
string

Use this header to retrieve parcel journeys with information localised in the requested language.

The default format used is an ISO 639-1 language code in lowercase hyphenated with a country code in ISO 3166-1 alpha-2 format in UPPERCASE. For example, en-GB will return information localised in UK English whereas en-US will return information localised in US English.

If this header is omitted, the parcel journeys will be returned with information localised in English.

Note: Localised information will be returned only when requesting a supported language.

Enum: "bg-BG" "cs-CZ" "da-DK" "de-DE" "en-GB" "en-US" "es-ES" "fi-FI" "fr-FR" "hr-HR" "hu-HU" "it-IT" "ja-JP" "ko-KR" "nb-NO" "nl-NL" "pl-PL" "pt-PT" "ro-RO" "sv-SE" "tr-TR" "zh-CN"
Example: en-GB
Responses
200

Parcel Journeys have been returned successfully

400

Bad request.

The request failed validation due to missing required information in the parameters or the body of the request.

Error code: PS-0400.

401

Unauthorized.

The request did not provide the credentials required to authorize access to the API.

Error code: PS-0401.

403

Forbidden.

The API user is not authorized to proceed with the processing of the request.

Error code: PS-0403.

500

Internal Server Error.

The processing of the request failed due to an internal problem. The request needs to be retried.

Error code: PS-0500.

get/parcel-journeys
Request samples 
Response samples 
application/json
[
  • {
    }
]