InventoryProducts
List Inventory Products
This endpoint retrieves a list of all the inventory products for the given site.
get/inventory/products
Query parameters
site_idstring uuid required
Filter inventory products by site.
supplier_idsstring uuid
A comma-separated list of supplier IDs to retrieve inventory products for.
category_idsstring uuid
A comma-separated list of category IDs to retrieve inventory products for.
brand_idsstring uuid
A comma-separated list of brand IDs to retrieve inventory products for.
querystring
A search query to filter inventory products by. This will search the product name.
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
Response
The inventory products were successfully retrieved
Example response
{
"data": [
{
"name": "Blissful Body Butter",
"description": "A rich, creamy body butter which deeply nourishes the skin, with essential oils.",
"sku": "BB-001",
"average_cost": 1000,
"currency": "gbp",
"reorder_level": 10,
"stock_level": 50.5,
"stock_value": 5000,
"brand": {
"name": "L'Oréal"
},
"category": {
"name": "Massage oils"
}
}
],
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.