v6

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-09153208467.0 KB
shipments

Search for booked shipments

ADD ENDPOINT DESCRIPTION HERE

get/shipments

Query parameters

querystring

Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.

sortstring

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

pageinteger

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

searchAfterstring

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

pageSizeinteger

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

successful operation

bookedShipmentIdinteger
sellerIdinteger
shippingServiceIdinteger
trackingNumberstring
trackingLinkstring
returnTrackingNumberstring
returnTrackingLinkstring
shipmentIdentifierstring
referencestring
directionstring
shipToCountrystring
shipToZipstring
shipToCompanystring
shipToName1string
shipToName2string
carrierSlugstring
shipFromCountrystring
shipFromZipstring
shipFromCompanystring
shipFromName1string
shipFromName2string
weightnumber

The total weight of the shipment in kg, which is the sum of the weight of the main as well as all additional parcels in this shipment.

volumenumber

The total volume of the shipment in m3, which is the sum of the volume of the main as well as all additional parcels in this shipment.

lengthMnumber

Length of the shipment in meters.

widthMnumber

Width of the shipment in meters.

heightMnumber

Height of the shipment in meters.

codAmountnumber
trackingEnabledboolean
userIdentifierstring
shipmentDatestring date
warehouseNamestring
createdstring date-time
cancelledAtstring date-time