v6

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

Search inbounds

ADD ENDPOINT DESCRIPTION HERE

get/inbounds

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

sellerIdinteger required

Seller ID.

warehouseIdinteger required

Warehouse ID. <br>A list of warehouse identifiers and names can be obtained by executing GET /warehouses

estimatedArrivalTimestring date-time required

Estimated date of arrival

deliverySlipNumberstring required

Delivery slip number

customAttributesobject

Optional custom attributes of this inbound.

movementReferenceNumberstring

Optional movement reference number. Unique identifier assigned to customs declarations within the UK and EU

idinteger
createdstring date-time
completedAtstring date-time
cancelledAtstring date-time
inboundIdentifierstring
trackingLinkstring
trackingNumberstring
carrierstring
createdByLogstaboolean
inboundStatus'PENDING' | 'CREATED' | 'PROCESSING' | 'COMPLETED' | 'CANCELLED'
tagsstring[]