latestOpenAPI 3.0.02026-08-10234193.3 KB

60e380005037

Shipments

Find Shipments List

This API method enables you to retrieve a list of transportation documents (shipments) that you have created. By making a request with this method, you can access the transportation documents that belongs to you or your account. The response will include details of each shipment, such as the shipment ID, number, recipient, cargo detail, and other relevant information.

get/shipments

Query parameters

numbers[]string

Search shipments by transportation document number. Can accept either a single search number or an array of numbers for conducting the search.

ids[]integer

Search shipments by transportation document ids.

limitinteger

Max number of items to return on page.

pageinteger

Number of page to return.

inRegistryboolean

Flag showing whether the shipment is included in the registry. Only for European parcels.

registerNumberstring

Number of the register that lists all shipments in the registry. Only for European parcels.

senderDivisionIdinteger

DivisionId of the shipment sender.

Response

shipments

current_pageinteger

Current page.

last_pageinteger

Total pages found.

per_pageinteger

Current objects` limit for a single page.

totalinteger

Total objects found.

frominteger nullable
tointeger nullable