Skip to content
BILLZ for developers

Get Products

GET
/v2/products
curl --request GET \
  --url 'https://api-admin.billz.ai/v2/products?page=1&limit=5&search=Nike&include_empty_stocks=false' \
  --header 'Authorization: Bearer <token>' \
  --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

Error codes: 400 — input validation error; 404 — object not found; 401, 403, 429, 500 — shared by all methods. Body formats and semantics: Response codes and errors.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer format: int32
default: 1

Page number; non-numeric value — 400

limit
integer format: int32
default: 100

Items per page. Non-numeric value -> 400

Example
5
search
string

Search string. Limited in length; repeating patterns are rejected

Example
Nike
fields
Array<string>

Search fields: name, sku, barcode, description, category, brand or custom_field_id. Passed as a comma-separated string

last_updated_date
string

Format yyyy-mm-dd hh:mm:ss, UTC. Invalid format — 400

include_empty_stocks
boolean

String true

Header Parameters

Section titled “Header Parameters”
platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platform identifier. A static value is used for integrations.

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
count

Number of products

integer format: int32
products

List of products

Array<object>
nullable
object
id

Product id

string
parent_id

Parent id (for variations)

string
categories

Product categories

Array<object>
object
id
string
name
string
parent_id
string
brand_id

Brand id

string
brand_name

Brand name

string
is_variative

Whether the product has variations

boolean
name

Name

string
sku

SKU

string
main_image_url

Main photo

string
main_image_url_full
string
barcode

Barcode

string
description

Description

string
updated_at

Last update date

string
measurement_unit

Unit of measure

object
id
string
name
string
short_name
string
product_type_id

Product type id

string
shop_measurement_values

Stock by outlet

Array<object>
object
shop_id
string
shop_name
string
active_measurement_value
number format: double
shop_prices

Prices by outlet

Array<object>
object
shop_id
string
shop_name
string
retail_price
number format: double
retail_currency
string
supply_price
number format: double
supply_currency
string
promo_price
number format: double
promos

Promotions

Array<object>
nullable
object
id
string
external_id
string
name
string
discount_value
number format: double
discount_type
string
shop_ids
Array<string>
product_attributes

Variation attributes

Array<object>
object
attribute_id
string
attribute_value_id
string
attribute_value
string
attribute_name
string
custom_fields

Custom attributes

Array<object>
nullable
object
custom_field_name
string
custom_field_system_name
string
custom_field_id
string
custom_field_value
string
from_parent
boolean
is_marked
boolean
photos

Photos

Array<object>
object
photo_url
string
sequence
integer format: int32
is_main
boolean
supply_price

Supply price

number format: double
supply_currency

Supply currency

string
suppliers

Suppliers

Array<object>
object
id
string
company_id
string
name
string
session_id
string
deleted_at
integer format: int64
product_supplier_stock

Stock by supplier

Array<object>
nullable
object
supplier_id
string
supplier_name
string
shop_id
string
measurement_value
number format: double
min_supply_price
number format: double
max_supply_price
number format: double
retail_price
number format: double
wholesale_price
number format: double
Examplegenerated
{
  "count": 1,
  "products": [
    {
      "id": "example",
      "parent_id": "example",
      "categories": [
        {
          "id": "example",
          "name": "example",
          "parent_id": "example"
        }
      ],
      "brand_id": "example",
      "brand_name": "example",
      "is_variative": true,
      "name": "example",
      "sku": "example",
      "main_image_url": "example",
      "main_image_url_full": "example",
      "barcode": "example",
      "description": "example",
      "updated_at": "example",
      "measurement_unit": {
        "id": "example",
        "name": "example",
        "short_name": "example"
      },
      "product_type_id": "example",
      "shop_measurement_values": [
        {
          "shop_id": "example",
          "shop_name": "example",
          "active_measurement_value": 1
        }
      ],
      "shop_prices": [
        {
          "shop_id": "example",
          "shop_name": "example",
          "retail_price": 1,
          "retail_currency": "example",
          "supply_price": 1,
          "supply_currency": "example",
          "promo_price": 1,
          "promos": [
            {
              "id": "example",
              "external_id": "example",
              "name": "example",
              "discount_value": 1,
              "discount_type": "example",
              "shop_ids": [
                "example"
              ]
            }
          ]
        }
      ],
      "product_attributes": [
        {
          "attribute_id": "example",
          "attribute_value_id": "example",
          "attribute_value": "example",
          "attribute_name": "example"
        }
      ],
      "custom_fields": [
        {
          "custom_field_name": "example",
          "custom_field_system_name": "example",
          "custom_field_id": "example",
          "custom_field_value": "example",
          "from_parent": true
        }
      ],
      "is_marked": true,
      "photos": [
        {
          "photo_url": "example",
          "sequence": 1,
          "is_main": true
        }
      ],
      "supply_price": 1,
      "supply_currency": "example",
      "suppliers": [
        {
          "id": "example",
          "company_id": "example",
          "name": "example",
          "session_id": "example",
          "deleted_at": 1
        }
      ],
      "product_supplier_stock": [
        {
          "supplier_id": "example",
          "supplier_name": "example",
          "shop_id": "example",
          "measurement_value": 1,
          "min_supply_price": 1,
          "max_supply_price": 1,
          "retail_price": 1,
          "wholesale_price": 1
        }
      ]
    }
  ]
}