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/v6/products/quantity

Example

HTTP Request

GET api/v6/products/quantity HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json

Status

200 OK

Response

{
  "total_quantity": 299
}

Total Product Stock by Warehouse

Get the quantity of a product in each warehouse

HTTP Request

[GET] /api/v6/products/store_quantity

Example

HTTP Request

GET api/v6/products/store_quantity HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json

Status

200 OK

Response

{
  "data": [
    {
      "id": 2,
      "store_name": "Pheo Warehouse",
      "total_quantity": 299
    }
  ],
  "offset": 0,
  "limited": false,
  "sorted": {
    "id": "DESC"
  }
}

Inventory by Product

Returns a list of products existing in all warehouses

HTTP Request

[GET] /api/v6/products/inventories

Query Parameters

Fields

Fields	Type	Description
id	integer	Identifier
product_id	integer	Product identifier
product_code	string	Product code
product_name	string	Product name
cover_price	float	Product price
quantity	integer	Quantity
cover_image	string	Product image

Filtering

Fields	Support	Type	Description
product_id	eq,in	integer	Product identifier
product_name	eq,contains	string	Product name
product_code	eq	string	Product code

Sort

Sort (field)	Direction
id	asc,desc

Limit & Offset

	Type	Description
Limit	integer	Number of records to retrieve
Offset	integer	Number of records to skip

Example

HTTP Request

GET api/v6/products/inventories HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json

Status

200 OK

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"
    }
  ],
  "has_more": false,
  "offset": 0,
  "limited": 1
}