Added shipment registry management methods
Registers in Europe
Restrictions:
are created only for shipments that are in ReadyToShip status;
there is only one shipping point for all shipments in the registry;
the user performing operations with the registry is associated with the sender organization (for legal entities) or is the sender in the shipments;
the maximum number of shipments in the registry is 100.
Creating a new registry with shipment
This method is used to create a client registry for shipments from Europe.
Request
The Method POST v.1.0/registry
{
"description": "My_new_registry",
"shipments": [
"SHPL0462195188"
]
}Response
The state 200 OK Request successful. The server responded as required.
Errors
401
Unauthorized
422
Validation error
503
Connection time-out
Adding a shipment to an existing registry
Description
This method is used to add a shipment to an existing client registry.
Query Parameter
{id} - unique identifier of the registry
Request
The method POST v.1.0/registry/{id}/shipments
Response
The state 200 OK Request successful. The server has responded as required.
Errors
401
Unauthorized
422
Validation error
503
Connection time-out
Removing a shipment from the registry
Description
This method removes a shipment from an existing client registry.
Query Parameter
{id} - unique identifier of the registry
Request
The method DELETE v.1.0/registry/{id}/shipments
Response
The state 200 OK Request successful. The server has responded as required.
Errors
401
Unauthorized
422
Validation error
503
Connection time-out
Deleting the registry
Description
This method completely deletes the client registry, but first you need to delete all shipments.
Query Parameter
{id} - unique identifier of the registry
Request
The method DELETE v.1.0/registry/{id}
Response
Errors
401
Unauthorized
422
Validation error
503
Connection time-out
Renaming the registry
Description
This method renames an existing client registry.
Query Parameter
{id} - unique identifier of the registry
Request
The method PUT v.1.0/registry/{id}/rename
Response
The state 200 OK Request successful. The server has responded as required.
Errors
401
Unauthorized
422
Validation error
503
Connection time-out
Printing the registry
Description
This method returns a file for printing the client registry
Query Parameter
{id} - unique identifier of the registry
Request
The method GET v.1.0/registry/print?id=948086
Response
The state 200 OK Request successful. The server has responded as required.
Errors
401
Unauthorized
422
Validation error
503
Connection time-out
Requesting a list of registries
Description
Цей метод повертає список реєстрів по заданим користувачем фільтрам.
Query Parameter
isEURegistry
boolean
true
Mandatory parameter for European registers.
ids[]
string
Example: 948086
Unique registry identifiers for which information should be obtained.
numbers[]
string
Example: CRPL0000041723
Unique registry number for which information should be obtained.
settlementIds[]
string
Example: 22326
Unique identifier of the settlement.
withShipmentsInfo
boolean
Example: true
When this parameter is specified, the shipment information array will include the shipment ID, shipment number, total weight, total value, invoice currency (if available), and invoice availability. If the parameter is not specified or is set to false, the shipments block will contain only the shipment ID and shipment number.
createdAtFrom
date
Example: 01.05.2026
Start date of the registry filtering period. Used to retrieve records created from this date inclusive. The field createdAtFrom must be a date earlier than createdAtTo
createdAtTo
date
Example: 20.05.2026
End date of the registry filtering period. Used to retrieve records created before this date (exclusive).
page
integer
Example: 1
Page number to return.
limit
integer
Example: 5
Maximum number of items to return per page.
Request
The method GET v.1.0/registry
Last updated