List

Returns a paginated list of products based on filter conditions

HTTP Request

[GET] /api/v6/products

Query Parameters

Fields

Fields	Type	Description
id	integer	Identifier
category_id	integer	Product category
origin_id	integer	Origin
unit_id	integer	Unit of measurement
manufacturer_id	integer	Manufacturer
services	bool	Is service product
saleoff_price	float	Online discount
created_at	timestamp	Creation date
updated_at	timestamp	Modification date
featured_image	string	Product logo
product_name	string	Product name
product_code	string	Product code
last_active	timestamp	Last active time
description	string	Description
cover_price	float	Retail price
price_wholesale	float	Wholesale price
discount	float	Product discount
short_description	string	Short description
discount_wholesale	float	Wholesale discount
price_online	float	Online selling price
discount_online	float	Online selling discount
price_average_in	float	Purchase price
discount_in	float	Purchase discount
product_vat	float	Product VAT
images	string[]	Product images
custom_fields	object	Data definition

Filtering

Fields	Support	Type	Description
id	eq,in	integer	Identifier
product_name	eq,contains	string	Product name
product_code	eq,contains	string	Product code
product_vat	eq	float	Product VAT
manufacturer_id	eq	integer	Manufacturer
short_description	eq,contains	string	Short description
description	eq,contains	string	Description
is_affiliate	eq	bool	Is affiliate product
category_id	eq	integer	Product category
origin_id	eq	integer	Origin
unit_id	eq	integer	Unit of measurement
cover_price	eq	float	Retail price
discount	eq	float	Product discount
price_wholesale	eq	float	Wholesale price
discount_wholesale	eq	float	Wholesale discount
price_average_in	eq	float	Purchase price
discount_in	eq	float	Purchase discount
price_online	eq	float	Online selling price
valid	is,in	bool	Valid or not
discount_online	eq,contains,empty	float	Online selling discount
saleoff_price	eq	float	Online discount
services	is	bool	Is service product
last_change	eq	timestamp	Province/City
last_active	eq	timestamp	Last active time
created_at	eq,gte,lte,between	timestamp	Creation date
updated_at	eq,gte,lte,between	timestamp	Modification date
out_of_stock	is	bool	Out of stock

Sort

Sort (field)	Direction
id	asc,desc
created_at	asc,desc
updated_at	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?fields=product_name&limit=1&offset=0&filtering[id]=4 HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json

Status

200 OK

Response

{
  "data": [
    {
      "id": 4,
      "product_name": "TEST PRODUCT API"
    }
  ],
  "has_more": false,
  "offset": 0,
  "limited": 1
}