Кассы

GET

/v1/cash-box

curl --request GET \
  --url 'https://api-admin.billz.ai/v1/cash-box?page=1&limit=100&sort_field=name&sort_direction=asc' \
  --header 'Authorization: Bearer <token>' \
  --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

• Production

id кассы передаётся в поле cashbox_id при создании продажи (POST /v2/order) и при оплате (POST /v2/order-payment/{order_id}).

Коды ошибок: 400 — ошибка валидации входных данных; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.

Authorizations

• BearerAuth

Parameters

Query Parameters

page

integer format: int32

default: 1

Не число — 400

limit

integer format: int32

default: 10

Не число — 400

Example

100

shop_id

string format: uuid

Кассы одного магазина

shop_ids

Array<string>

Кассы нескольких магазинов, идентификаторы через запятую

name

string

Фильтр по названию кассы

with_hq

boolean

При true в список добавляется касса головного офиса

sort_field

string

Allowed values: name created_at

name или created_at; применяется только вместе с sort_direction

sort_direction

string

Allowed values: asc desc

asc или desc; применяется только вместе с sort_field

Header Parameters

accept-language

string

Ru|uz|en, default ru — язык названий типов оплат

platform-id

string

default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Идентификатор платформы. Для интеграций используется статичное значение.

Responses

200

Успешный ответ

Media typeapplication/json

object

count

Общее количество без учёта пагинации

integer format: int32

cash_boxes

Список касс

Array<object>

object

id

string

company_id

string

shop_id

string

shop

Магазин кассы

object

id

string

name

string

phone_numbers

Array<string>

nullable

facebook

string

instagram

string

telegram

string

website

string

working_hours

{id, shop_id, week_day, start_time, end_time, is_active}

Array<object>

nullable

object

name

string

cheque_id

string

payment_types

Типы оплат, подключённые к кассе

Array<object>

object

id

string

company_payment_type_id

id типа оплаты из GET /v1/company-payment-type

string

company_payment_type

Тип оплаты компании

object

is_active

boolean

e_pos

integer format: int32

tariff_limits

object

local_payment_types

boolean

Example^generated

{
  "count": 1,
  "cash_boxes": [
    {
      "id": "example",
      "company_id": "example",
      "shop_id": "example",
      "shop": {
        "id": "example",
        "name": "example",
        "phone_numbers": [
          "example"
        ],
        "facebook": "example",
        "instagram": "example",
        "telegram": "example",
        "website": "example",
        "working_hours": [
          {}
        ]
      },
      "name": "example",
      "cheque_id": "example",
      "payment_types": [
        {
          "id": "example",
          "company_payment_type_id": "example",
          "company_payment_type": {},
          "is_active": true
        }
      ],
      "e_pos": 1,
      "tariff_limits": {},
      "local_payment_types": true
    }
  ]
}