StockTakes
Export a Stocktake
This endpoint queues an export of a stocktake for the given site.
get/inventory/stock-takes/{stockTakeId}/queue
Path parameters
stockTakeIdstring uuid required
Identifier of the stocktake whose queued export job status is being fetched. Posting a stocktake kicks off an async job; poll this endpoint until the job reports as complete.
Query parameters
site_idstring uuid required
Filter the StockTake by site.
brand_idsstring[]
A comma-separated list of brand IDs to retrieve stocktake items for.
category_idsstring[]
A comma-separated list of category IDs to retrieve stocktake items for.
supplier_idsstring[]
A comma-separated list of supplier IDs to retrieve stocktake items for.
status'all' | 'uncounted' | 'counted'
The status to filter the stocktake items by.
Response
The job was successfully queued
Example response
{
"data": {
"created_at": "2023-11-07T00:00:00+00:00",
"updated_at": "2023-11-07T01:00:00+00:00"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.