latestOpenAPI 3.0.02026-08-10234193.3 KB

60e380005037

Registers

Get registries

The method allows the user to get information about their registries or registries related to their profile in the registry.

🔸Registries are automatically filtered by creation source (clientapi or bc) depending on the method used.</br> 🔸Shipments that were removed from the registry are not included in the response.

get/registry

Query parameters

isEURegistryboolean

Indicates that European registries should be returned.

ids[]string[]

Unique registry identifiers for which information should be retrieved. This parameter is required if the numbers parameter is not specified.

numbers[]string[]

Unique registry number for which information should be retrieved. This parameter is required if the ids parameter is not specified.

settlementIds[]string[]

Unique settlement identifier.

withShipmentsInfoboolean

When 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.

createdAtFromstring date

Start 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

createdAtTostring date

End date of the registry filtering period. Used to retrieve records created before this date (exclusive).

pageinteger

Number of page to return.

limitinteger

Max number of items to return on page.

Response

Registries list

current_pageinteger

Indicates the current page number in the paginated response.

last_pageinteger

Total number of available pages calculated.

per_pageinteger

Number of registry records returned per page.

totalinteger

Total number of registries that match the request criteria.