provider

inventory

List Shipments

List shipments with optional filtering.

get/inventory/shipments/list

Query parameters

pageinteger nullable

per_pageinteger nullable

sort_bystring nullable

sort_direction'asc' | 'desc' nullable

location_idstring nullable

Optional ID of the location

idsstring[] nullable

Optional list of IDs of the shipments

stock_idstring nullable

Optional ID of the stock

supplier_idstring nullable

Optional ID of the supplier

skustring nullable

Optional SKU (Stock Keeping Unit)

lot_numberstring nullable

Optional lot number of the shipment

remaining_quantitynumber[] nullable

Optional remaining quantity of the shipment

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

idstring

Unique identifier for the shipment

stockIdstring required

ID of the stock

supplierIdstring required

ID of the supplier

locationIdstring required

ID of the location where the shipment was delivered

lotNumberstring nullable

Optional lot number of the shipment

expiryDatestring date-time nullable

Optional expiry date of the shipment

skustring nullable

Optional SKU (Stock Keeping Unit)

quantitynumber required

Total quantity

remainingQuantitynumber required

Remaining quantity

costinteger nullable

Cost of the shipment in cents

createdDatestring date-time nullable

Date and time the shipment was created

notestring nullable

Optional note for inventory log when updating shipment

locationNamestring nullable required

Get the location name from the related location object

Changes

No recorded changes to this endpoint across all 1 revision of this API.