Consignments
List consignments
Return a paginated list of consignments.
🔒 Requires: consignments:read scope
get/consignments
Query parameters
type'SUPPLIER' | 'OUTLET' | 'STOCKTAKE' | 'RETURN' string
The consignment type to search for.
status'OPEN' | 'SENT' | 'DISPATCHED' | 'RECEIVED' | 'STOCKTAKE_IN_PROGRESS' | 'STOCKTAKE_SCHEDULED' | 'STOCKTAKE_IN_PROGRESS_PROCESSED' | 'STOCKTAKE_COMPLETE' | 'CLOSED' | 'CANCELLED' string
The consignment status to search for.
outlet_idstring uuid
Filter response by the ID of the outlet associated with the consignments.
afterinteger
The lower limit for the version numbers to be included in the response.
beforeinteger
The upper limit for the version numbers to be included in the response.
page_sizeinteger
The maximum number of items to be returned in the response.
Response
OK