Skip to content
BILLZ for developers

Customers

GET
/v1/customer-general-table
curl --request GET \
  --url 'https://api-admin.billz.ai/v1/customer-general-table?start_date=2026-08-01&end_date=2026-08-31&shop_ids=fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6%2C92302dfb-fa33-4e6a-8d19-87214852b25d&page=1&limit=10&price_type=0&currency=UZS' \
  --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
Array<string>
Example
[
  "fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6",
  "92302dfb-fa33-4e6a-8d19-87214852b25d"
]
page
integer format: int32
default: 1
Example
1
limit
integer format: int32
default: 10
Example
10
price_type
integer format: int32
0
currency
string
Example
UZS

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
customer_stats
Array<object>
object
registration_date
string
registration_shop_id
string
registration_shop_name
string
customer_name
string
birth_date
string
free_price
boolean
used_wholesale_price
boolean
customer_id
string
customer_phones
Array<string>
customer_groups
Array<string>
nullable
is_new_client
string
is_returned_client
string
total_values
object
sale_count
integer
exchange_count
integer
return_count
integer
measurement_value
number
purchase_sum
number
average_measurement_value
number
average_purchase_sum
number
average_purchase_discount
number
returned_measurement_value
number
returned_sum
number
retail_sum
number
sale_sum
number
sold_without_return
number
in_period_values
object
sale_count
integer
exchange_count
integer
return_count
integer
measurement_value
number
purchase_sum
number
average_measurement_value
number
average_purchase_sum
number
average_purchase_discount
integer
returned_measurement_value
number
returned_sum
number
retail_sum
number
sale_sum
number
sold_without_return
number
total_stats
object
total_values
object
sale_count
integer
exchange_count
integer
return_count
integer
measurement_value
number
purchase_sum
number
average_measurement_value
number
average_purchase_sum
number
average_purchase_discount
number
returned_measurement_value
number
returned_sum
number
retail_sum
number
sale_sum
number
sold_without_return
number
in_period_values
object
sale_count
integer
exchange_count
integer
return_count
integer
measurement_value
number
purchase_sum
number
average_measurement_value
number
average_purchase_sum
number
average_purchase_discount
number
returned_measurement_value
number
returned_sum
number
retail_sum
number
sale_sum
number
sold_without_return
number
count
integer format: int32
Examplegenerated
{
  "customer_stats": [
    {
      "registration_date": "example",
      "registration_shop_id": "example",
      "registration_shop_name": "example",
      "customer_name": "example",
      "birth_date": "example",
      "free_price": true,
      "used_wholesale_price": true,
      "customer_id": "example",
      "customer_phones": [
        "example"
      ],
      "customer_groups": [
        "example"
      ],
      "is_new_client": "example",
      "is_returned_client": "example",
      "total_values": {
        "sale_count": 1,
        "exchange_count": 1,
        "return_count": 1,
        "measurement_value": 1,
        "purchase_sum": 1,
        "average_measurement_value": 1,
        "average_purchase_sum": 1,
        "average_purchase_discount": 1,
        "returned_measurement_value": 1,
        "returned_sum": 1,
        "retail_sum": 1,
        "sale_sum": 1,
        "sold_without_return": 1
      },
      "in_period_values": {
        "sale_count": 1,
        "exchange_count": 1,
        "return_count": 1,
        "measurement_value": 1,
        "purchase_sum": 1,
        "average_measurement_value": 1,
        "average_purchase_sum": 1,
        "average_purchase_discount": 1,
        "returned_measurement_value": 1,
        "returned_sum": 1,
        "retail_sum": 1,
        "sale_sum": 1,
        "sold_without_return": 1
      }
    }
  ],
  "total_stats": {
    "total_values": {
      "sale_count": 1,
      "exchange_count": 1,
      "return_count": 1,
      "measurement_value": 1,
      "purchase_sum": 1,
      "average_measurement_value": 1,
      "average_purchase_sum": 1,
      "average_purchase_discount": 1,
      "returned_measurement_value": 1,
      "returned_sum": 1,
      "retail_sum": 1,
      "sale_sum": 1,
      "sold_without_return": 1
    },
    "in_period_values": {
      "sale_count": 1,
      "exchange_count": 1,
      "return_count": 1,
      "measurement_value": 1,
      "purchase_sum": 1,
      "average_measurement_value": 1,
      "average_purchase_sum": 1,
      "average_purchase_discount": 1,
      "returned_measurement_value": 1,
      "returned_sum": 1,
      "retail_sum": 1,
      "sale_sum": 1,
      "sold_without_return": 1
    }
  },
  "count": 1
}