Registers
Authorization JWT-token with a lifetime of 1 hour in header
Indicates that European registries should be returned.
trueUnique registry identifiers for which information should be retrieved. This parameter is required if the numbers parameter is not specified.
85544Unique registry number for which information should be retrieved. This parameter is required if the ids parameter is not specified.
CRPL0000004829Unique settlement identifier.
22326When set to true, the response includes extended shipment information in the shipmentsInfo array.
If omitted or set to false, the response contains only shipmentId and shipmentNumber in the shipments array.
trueStart date of the registry filtering period. Used to retrieve records created from this date onwards (inclusive). The createdAtFrom field must be a date before createdAtTo
23.09.2025End date of the registry filtering period. Used to retrieve records created before this date (exclusive).
25.09.2025Number of page to return.
1Max number of items to return on page.
10Registries list
Indicates the current page number in the paginated response.
Total number of available pages calculated.
Number of registry records returned per page.
Total number of registries that match the request criteria.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Registry creation request
Name of the registry.
Array of unique shipment numbers for World parcels. Each shipment must belong to the same sender.
Registry successfully created.
Unique identifier of the registry.
Registry number in the format:
CR + alpha country code from the first shipment + unique number.
Registry version tracking identifier.
Registry status. After creation, the status is Open.
Registry creation date.
Registry update date.
Registry deletion date.
Registry posting status.
Registry printing status.
Number of shipments in the registry.
Number of shipments pending scanning.
Registry name specified during creation.
Sender company identifier.
Sender company TIN.
Sender phone number.
Sender country code in ISO 3166-1 alpha-2 format.
Sender settlement identifier.
Sender settlement name.
Sender division identifier.
Sender division name.
Full sender address string.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Unique register identifier to which the shipment will be added.
111111Array of shipment identifiers that should be added to the registry. Each shipment must belong to the same sender.
Registry
Unique identifier of the registry.
Registry number.
Registry version number.
Registry status.
Date of registry creation.
Date of registry update.
Date of registry deletion.
Mark of registry post.
Mark of registry print.
Number of shipments in the registry.
User name of the registry.
Sender company identifier.
Sender company TIN.
Sender phone number.
Sender country code.
Sender settlement identifier.
External settlement identifier.
Sender settlement name.
Sender division identifier.
External division identifier.
Sender division name.
Full sender address.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Unique register identifier from which the shipment must be removed.
111111Array of shipment identifiers that should be removed from the registry. Each shipment must belong to the same sender.
Shipment successfully removed from registry.
Unique registry identifier.
Registry number.
Registry version number.
Registry status.
Registry creation date and time.
Registry update date and time.
Registry deletion date and time.
Indicates whether the registry has been posted.
Indicates whether the registry has been printed.
Number of shipments in the registry.
Registry name.
Sender company identifier.
Sender company TIN.
Sender phone number.
Sender country code (ISO Alpha-2).
Sender settlement identifier.
External settlement identifier.
Sender settlement name.
Sender division identifier.
External division identifier.
Sender division name.
Sender address.
Structured sender address.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Unique register identifier.
111111New name of registry.
Request successful. The registry was renamed.
Unique registry identifier.
Registry number.
Registry version number.
Registry status.
Registry creation date and time.
Registry update date and time.
Registry deletion date and time.
Indicates whether the registry has been posted.
Indicates whether the registry has been printed.
Number of shipments in the registry.
Registry name.
Sender company identifier.
Sender company TIN.
Sender phone number.
Sender country code (ISO Alpha-2).
Sender settlement identifier.
External settlement identifier.
Sender settlement name.
Sender division identifier.
External division identifier.
Sender division name.
Sender address.
Structured sender address.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Unique register identifier of the registry to be deleted.
111111Request successful. The registry was deleted.
Indicates whether the registry was successfully deleted.
Unauthorized
The specified resource was not found
Validation error
Connection time-out
Authorization JWT-token with a lifetime of 1 hour in header
Registry identifier in the system.
85544Type of printable document.
Applicable only to Ukrainian registries.
Available values:
international- international shipment documentsinvoice- shipment invoicesmarking- shipment marking labels
internationalPossible values: Marking print size.
Applicable only to Ukrainian registries.
Required for type=marking.
size_100_100Possible values: Number of copies of the printed document.
1Example: 2Generated file.
Unprocessable entity.
Internal Server Error.
Last updated