Sign in
shipments

Search for booked shipments

ADD ENDPOINT DESCRIPTION HERE

get/shipments

Query parameters

querystring

Search query to filter the shipments<br/>EX: <code>created:>=2021-05-01 AND created:<2021-05-07</code>

sortstring

Optional sort order for results</br>Enum: <code>asc</code><code>dsc</code>)

pageinteger

Page number when pagination is used

searchAfterstring

ID of the last item from the previous search.

pageSizeinteger

Optional number of entries per page</br> When provided pagination will be enabled

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

Changes