Skip to main content

Product List

1. Product List​

Endpoint​

GET /api/v6.1/products

Headers​

{
    "Content-Type": "application/json",
    "X-API-KEY": "{your_api_key}"
}

Query Parameters​

| Parameter | Required | Data Type | Description |
|---------|----------|-------------|-------|
| fields | Yes | string | List of data fields to retrieve |
| limit | No | integer | Number of records to retrieve |
| offset | No | integer | Number of records to skip |
| sort | No | string | Sort field (id, created_at, updated_at) and direction (asc, desc) |\

Request Example​

curl --location '/api/v6.1/products?fields=id%2Cproduct_name%2Cproduct_code%2Cprice_online%2Ccreated_at&limit=1' \
--header 'X-API-KEY: {your_api_key}' \
--header 'Cookie: v6_getflycrm_session={your_session_token}'

5. Response Example & Description​

Response Fields​

| Field | Data Type | Description |
|--------|-------------|-------|
| data | Array | List of products |
| id | Integer | Product ID |
| category_id | Integer | Product category ID |
| category_name | String | Product category name |
| origin_id | Integer | Product origin ID |
| origin_name | String | Product origin name |
| unit_id | Integer | Unit of measurement ID |
| unit_name | String | Unit of measurement name |
| manufacturer_id | Integer | Manufacturer ID |
| manufacturer_name | String | Manufacturer name |
| services | Boolean | Whether it is a service product |
| saleoff_price | Float | Promotional price |
| created_at | Timestamp | Product creation date |
| updated_at | Timestamp | Product update date |
| featured_image | String | Featured image URL |
| product_name | String | Product name |
| product_code | String | Product code |
| last_active | Timestamp | Last active time |
| description | String | Product description |
| cover_price | Float | Original price |
| price_wholesale | Float | Wholesale price |
| discount | Float | Discount rate (%) for retail price |
| short_description | String | Short description |
| discount_wholesale | Float | Discount rate (%) for wholesale price |
| price_online | Float | Online selling price |
| discount_online | Float | Online discount rate (%) |
| price_average_in | Float | Average import price |
| discount_in | Float | Import discount rate |
| product_vat | Float | VAT (%) |
| weight | Float | Product weight |
| variant_attribute_values | Array | List of product variant attribute values |
| variant_attributes | Array | List of product variant attributes |
| detail_custom_fields | Object | Detailed custom fields of the product |
| images | Array | List of product images |
| has_more | Boolean | More data available |
| offset | Integer | Current offset value |
| limited | Integer | Number of records retrieved |
| sorted | Object | Sorting criteria |\

Response Example​

{
    "data": [
        {
            "id": 2531,
            "category_id": 2,
            "category_name": "Placebo",
            "origin_id": 1,
            "origin_name": "Japan",
            "unit_id": 18,
            "unit_name": "Cake",
            "manufacturer_id": 1,
            "manufacturer_name": "Black shirt T.c",
            "services": 0,
            "saleoff_price": 10,
            "created_at": "2025-03-13 14:58:11",
            "updated_at": "2025-03-13 14:58:11",
            "featured_image": "https://linhpq.getflycrm.com/uploads/...",
            "product_name": "API Demo Product",
            "product_code": "SP.00192",
            "last_active": "2025-03-13 14:58:11",
            "description": "<p>Long description</p>",
            "cover_price": 19000,
            "price_wholesale": 25000,
            "discount": 5,
            "short_description": "Short description",
            "discount_wholesale": 5,
            "price_online": 21000,
            "discount_online": 5,
            "price_average_in": 15000,
            "discount_in": 10,
            "product_vat": 10,
            "weight": 16,
            "detail_custom_fields": {
                "import_date": "1741798800",
                "number_field": "12",
                "wholesale_price": "111111"
            },
            "variant_attribute_values": [
                { "value_id": 12, "attribute_id": 6, "attribute_name": "Filling type", "value_name": "Egg meat" },
                { "value_id": 31, "attribute_id": 6, "attribute_name": "Filling type", "value_name": "Mixed" },
                { "value_id": 15, "attribute_id": 7, "attribute_name": "Crust", "value_name": "Crispy baked" },
                { "value_id": 16, "attribute_id": 7, "attribute_name": "Crust", "value_name": "Soft" }
            ],
            "variant_attributes": [
                { "attribute_id": 6, "attribute_name": "Filling type" },
                { "attribute_id": 7, "attribute_name": "Crust" }
            ],
            "images": [
                {
                    "id": 5,
                    "file_name": "fixed_sleepy_coder.png",
                    "thumbnail_file": "https://linhpq.getflycrm.com/uploads/...",
                    "created_at": 1741852691,
                    "product_id": 2531
                }
            ]
        }
    ],
    "has_more": true,
    "offset": 0,
    "limited": 1,
    "sorted": {
        "id": "DESC"
    }
}