Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Authentication

This endpoint requires the user to be authenticated. Refer to the documentation here for more information on how to obtain a valid token to use in your request. 

...

Info
  • Clients using this API should not fail if new optional fields are added to the API. If a new field is added to the request or response on a later stage, existing clients should handle this in a way such as they just ignore the field.

  • Only parcels marked with API Key 124 will possibly provide results. Do not use this API for parcels who do not have that mark.

  • Client should handle empty images URLs, the URL may point to an empty site at any point and will always be empty after 30 days

Request header

Key

Value

Authorization

Code Block
Bearer $SECRET_WS_TOKEN

see Setup

Content-Type

application/json

Request body

Description

Name

Type

Example

Mandatory

Max Length

Path parameters

parameter

Example

Description

shipmentid

70724760120000880

35

Globally unique identifier for the shipment, typically a GINC code. Typically named MessageNumber, DocumentNumber or ConsignorsReference in EDI

trackingreference

370724760120000898

35

Unique identifier for an item/kolli in the shipment. This can be a SSCC code according to gs1, or a UPU S10 identifier.

Typically named TransporterInstructionMark in EDI.

pickupcode

R-12345

10

Optional additional unique identifier, used for pick up parcels

Response

Name

Type

Example

Mandatory

Description

...