Skip to main content

Check Inventory

Get inventory quantity by product code or product ID

Total Product Stock

Get the quantity of a product in all warehouses

HTTP Request

GET /api/v3/products/quantity

Query Parameters

ParameterDefaultDescription
product_id0Filter by product ID
product_codeFilter by product code

Response

{
"quantity": 1942
}

Total Product Stock by Warehouse

Get the quantity of a product in each warehouse

HTTP Request

GET /api/v3/products/store_quantity

Query Parameters

ParameterDefaultDescription
product_id0Filter by product ID
product_codeFilter by product code

Response

[
{
"quantity": "943.000000",
"store_id": "2",
"store_name": "Hanoi Warehouse"
},
{
"quantity": "1000.000000",
"store_id": "4",
"store_name": "Van Phu Warehouse"
},
{
"quantity": "-1.000000",
"store_id": "37",
"store_name": "Thai Ha 1 Warehouse"
}
]

Inventory by Product

Returns a list of products existing in all warehouses

HTTP Request

GET /api/v3/products/inventory

Query Parameters

ParameterTypeDefaultRequireDescription
limitint20Number of records returned per request
offsetint0Starting position of the record to retrieve

Response

{
"data": [
{
"product_id": 21,
"product_code": "SP0021",
"product_name": "facial cleanser",
"cover_price": 800,
"quantity": 1,
"cover_image": "https://xxx.getflycrm.com/assets/images/no-product.jpg"
},
{
"product_id": 40,
"product_code": "SP0040",
"product_name": "Hot mask",
"cover_price": 1,
"quantity": 998,
"cover_image": "https://xxx.getflycrm.com/assets/images/no-product.jpg"
}
],
"meta": {
"offset": 0,
"limit": 20,
"total_record": 210
}
}