Skip to content
BILLZ for developers

Sales by supplier

GET
/v1/product-sells-by-suppliers-table
curl --request GET \
  --url 'https://api-admin.billz.ai/v1/product-sells-by-suppliers-table?start_date=2026-08-01&end_date=2026-08-31&shop_ids=fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6%2C92302dfb-fa33-4e6a-8d19-87214852b25d&supplier_ids=17c04d85-e7d7-4f8f-8ed6-14bede7d55d4%2C786faa1e-b2be-4cae-a8fd-490c747c2b1f&all_suppliers=0&page=1&limit=10&detalization=day&price_type=0&group_without_shops=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”
start_date
string format: date
Example
2026-08-01

Format YYYY-MM-DD, without time

end_date
string format: date
Example
2026-08-31

Format YYYY-MM-DD, without time

shop_ids
required
Array<string>

Shops; empty value — 400

Example
[
  "fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6",
  "92302dfb-fa33-4e6a-8d19-87214852b25d"
]
supplier_ids
Array<string>

Ignored when all_suppliers=1. The number of elements is limited

Example
[
  "17c04d85-e7d7-4f8f-8ed6-14bede7d55d4",
  "786faa1e-b2be-4cae-a8fd-490c747c2b1f"
]
all_suppliers
integer format: int32
0

1 — take all suppliers of the company + ‘00000000-0000-0000-0000-000000000000’ (no supplier)

page
integer format: int32
default: 1
Example
1
limit
integer format: int32
default: 10
Example
10
detalization
string

Day|week|month|year|empty

Example
day
price_type
integer format: int32
0
group_without_shops
boolean
currency
string

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
products_stats_by_date
Array<object>
object
date
string
supplier_id
string
supplier_name
string
product_id
string
shop_id
string
shop_name
string
product_name
string
product_base_name
string
product_sku
string
product_barcode
string
product_brand_id
string
product_brand_name
string
product_categories
Array<object>
object
id
string
name
string
parent_id
string
company_id
string
level_number
integer
deleted_at
integer
categories_path
Array<string>
level_1
Array<string>
level_2
Array<string>
level_3
Array<string>
level_4
Array<string>
level_5
Array<string>
product_attributes
Array<object>
object
custom_fields
Array<object>
object
product_measurement_unit_id
string
product_measurement_unit_name
string
product_measurement_unit_short_name
string
sold_measurement_value
number
returned_measurement_value
number
net_sold_measurement_value
number
gross_sales
number
returned_sales_sum
number
net_sales
number
net_profit
number
sold_supply_sum
number
average_margin
number
discount
integer
sold_with_discount
integer
sold_without_discount
integer
left_start_date
number
left_start_date_supply_price
number
left_start_date_retail_price
number
left_end_date
number
left_end_date_supply_price
number
left_end_date_retail_price
number
free_price
boolean
used_wholesale_price
boolean
products_stats_total

Absent from the response if the value is empty

object
sold_measurement_value
number
returned_measurement_value
number
net_sold_measurement_value
number
gross_sales
number
returned_sales_sum
number
net_sales
number
net_profit
number
rounding_amount
number
sold_supply_sum
number
average_margin
number
discount
number
sold_with_discount
integer
sold_without_discount
integer
left_start_date
number
left_start_date_supply_price
number
left_start_date_retail_price
number
left_end_date
number
left_end_date_supply_price
number
left_end_date_retail_price
number
count
integer format: int32
Examplegenerated
{
  "products_stats_by_date": [
    {
      "date": "example",
      "supplier_id": "example",
      "supplier_name": "example",
      "product_id": "example",
      "shop_id": "example",
      "shop_name": "example",
      "product_name": "example",
      "product_base_name": "example",
      "product_sku": "example",
      "product_barcode": "example",
      "product_brand_id": "example",
      "product_brand_name": "example",
      "product_categories": [
        {
          "id": "example",
          "name": "example",
          "parent_id": "example",
          "company_id": "example",
          "level_number": 1,
          "deleted_at": 1
        }
      ],
      "categories_path": [
        "example"
      ],
      "level_1": [
        "example"
      ],
      "level_2": [
        "example"
      ],
      "level_3": [
        "example"
      ],
      "level_4": [
        "example"
      ],
      "level_5": [
        "example"
      ],
      "product_attributes": [
        {}
      ],
      "custom_fields": [
        {}
      ],
      "product_measurement_unit_id": "example",
      "product_measurement_unit_name": "example",
      "product_measurement_unit_short_name": "example",
      "sold_measurement_value": 1,
      "returned_measurement_value": 1,
      "net_sold_measurement_value": 1,
      "gross_sales": 1,
      "returned_sales_sum": 1,
      "net_sales": 1,
      "net_profit": 1,
      "sold_supply_sum": 1,
      "average_margin": 1,
      "discount": 1,
      "sold_with_discount": 1,
      "sold_without_discount": 1,
      "left_start_date": 1,
      "left_start_date_supply_price": 1,
      "left_start_date_retail_price": 1,
      "left_end_date": 1,
      "left_end_date_supply_price": 1,
      "left_end_date_retail_price": 1,
      "free_price": true,
      "used_wholesale_price": true
    }
  ],
  "products_stats_total": {
    "sold_measurement_value": 1,
    "returned_measurement_value": 1,
    "net_sold_measurement_value": 1,
    "gross_sales": 1,
    "returned_sales_sum": 1,
    "net_sales": 1,
    "net_profit": 1,
    "rounding_amount": 1,
    "sold_supply_sum": 1,
    "average_margin": 1,
    "discount": 1,
    "sold_with_discount": 1,
    "sold_without_discount": 1,
    "left_start_date": 1,
    "left_start_date_supply_price": 1,
    "left_start_date_retail_price": 1,
    "left_end_date": 1,
    "left_end_date_supply_price": 1,
    "left_end_date_retail_price": 1
  },
  "count": 1
}