Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Відстеження відправлення

BasicTracking

get
/shipments/tracking/history

This API method enables you to retrieve the status of a shipment by providing the transportation document number. By specifying the document number in the request, you can obtain information about the current location or status of the shipment, providing clients with real-time updates on the progress of their cargo. 🔸This method works only with the transportation document number (shipment number) and does not support searching by client order numbers or any external identifiers. 🔸BasicTracking provides a simplified tracking response focused on the shipment’s status history and, optionally, its related shipment numbers. Unlike FullTracking, it does not return detailed routing information, parcel-level data, undelivery reasons, return/redirect records, or extended metadata. This method is intended for quick, lightweight status checks.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Query parameters
numbers[]stringOptional

Shipment`s numbers. Can accept either a single number or an array of numbers.

Example: SHPL1234567890
extendedstringOptional

Parameter responsible for including in the response an array of objects listing all related shipments.

To receive this data in the response, set the value to 1.

Default: 0Example: 1
Responses
200

Tracking response schema

application/json
get
/shipments/tracking/history

FullTracking

get
/shipments/tracking

This API method enables you to retrieve the status of a shipment by providing the transportation document number. By specifying the document number in the request, you can obtain information about the current location or status of the shipment, providing clients with real-time updates on the progress of their cargo.

By default, the response contains the following data blocks:

  • Current status of the shipment;

  • Tracking history;

  • Actual tracking history;

  • Description of the shipment;

  • Extended information about related shipments.

If necessary, additional blocks can be included in the response by passing the appropriate parameters:

  • withUndeliveryReason = true - adds an array of objects with information about the reasons for non-delivery of shipments.

  • withCreatedOnTheBasis = true - adds an array of objects with information about returns or forwarding associated with the shipment.

🔸FullTracking provides a comprehensive tracking response containing detailed shipment status data, full movement history, parcel descriptions, undelivery reasons, and information about related or derivative shipments. Unlike BasicTracking, it offers extended operational details and is designed for cases requiring full visibility into the shipment’s logistics lifecycle.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Query parameters
numbers[]stringOptional

Shipment numbers. Can accept either a single number or an array of numbers.

Example: SHPL1234567890
ids[]integer · int32Optional

Search shipments by transportation document ids. Accepts either a single search id or an array of ids to conduct the search.

Example: 113622
withUndeliveryReasonbooleanOptional

A parameter that controls the inclusion of an array of objects containing information about non-delivery reasons in the response. To receive this data in the response, set the value to true.

Default: falseExample: true
withCreatedOnTheBasisbooleanOptional

Parameter responsible for including in the response an array of objects containing information about related shipments (types: Redirecting, Return, Utilization, Redelivery). To receive this data in the response, set the value to true.

Default: falseExample: true
countryCodestringOptional

Two-letter sender country code according to the ISO 3166-1 Alpha-2 standard. If this parameter is specified, Tracking history and Actual tracking history will be shown only for the specified country. Pattern: ^[A-Z]{2}$

Example: DE
externalstringOptional

Parameter responsible for including in the response an array of objects listing all related shipments, as well as an array containing extended information about those shipments — including the shipment owner’s name, shipment number, and shipment creation date. To receive this data in the response, set the value to 1.

Default: 0Example: 1
trackingByBarcodestringOptional

The system filters aggregated data and returns information only for the specified parcel. This allows tracking the delivery route of a specific parcel within a multi-parcel shipment.

Example: SHRO1452163509
withAllParcelsbooleanOptional

The system aggregates events from all parcel into a single array, grouped by parcel number. This allows tracking the delivery route of each parcel within a multi-parcel shipment.`.

Default: falseExample: true
Responses
200

Tracking response schema

application/json
alternativeNumbersstring[]Optional

An array of objects containing a list of related shipments.

get
/shipments/tracking
ПопередняДрук документівНаступнаProof of delivery

Останнє оновлення