Доступ ключа интеграции проверяется по списку маршрутов, привязанному к ключу, —
это первый уровень доступа. Второй уровень —
права роли ключа — решает, что вернётся в ответе.
Список ниже — базовый шаблон , который
ключ получает при создании. Доступ конкретного ключа может быть шире — чувствительные
методы открывают отдельно, настройкой прав ключа в BILLZ.
Работа с ключом и токенами доступа.
Метод
Маршрут
POST
/v1/auth/login
POST
/v2/auth/refresh
Читаются на старте и обновляются редко.
Метод
Маршрут
GET
/v1/company
GET
/v1/shop
GET
/v1/user
GET
/v1/supplier
GET
/v2/category
GET
/v2/brand
GET
/v2/product-characteristic
GET
/v2/measurement-unit
GET
/v2/product-type
GET
/v1/cash-box
GET
/v1/company-payment-type
GET
/v2/company-currencies
GET
/v2/company-currency-rates
GET
/v1/transaction-report-payments
GET
/v2/write-off-reason
Выгрузка товаров и правка карточек.
Метод
Маршрут
POST
/v2/product
POST
/v2/product-search-with-filters
PATCH
/v2/product/:id/patch-props
GET
/v2/products
Полный цикл чека — от создания до оплаты.
Метод
Маршрут
POST
/v1/recalculate-order-bill/:order_id
PUT
/v2/order-customer-new/:order_id
POST
/v2/order-manual-discount/:order_id
GET
/v2/order-notes
POST
/v2/order-payment/:order_id
POST
/v2/order-product/:order_id
POST
/v2/order
POST
/v2/order/create_postpone
GET
/v2/order/:id
DELETE
/v2/order/:id
PATCH
/v2/order/:id
POST
/v2/order/return-postpone
Метод
Маршрут
POST
/v1/gift-card/activate-list
GET
/v1/gift-card/search
POST
/v1/order-gift-card-remove/:id
PUT
/v1/order-gift-card/:id
Метод
Маршрут
GET
/v1/client
POST
/v1/client
GET
/v1/client-by-chat-id
POST
/v1/client-card
PUT
/v1/client/:id
GET
/v1/customer/:id
PATCH
/v1/customer/set-balance/:id
PATCH
/v1/customer/bulk
GET
/v1/debt
GET
/v1/debt-stats
Метод
Маршрут
GET
/v2/transfer
POST
/v2/transfer
GET
/v2/transfer-items/:id
DELETE
/v2/transfer/:id
POST
/v2/transfer/:id/add
POST
/v2/transfer/:id/send
PUT
/v2/transfer/finish/:id
PUT
/v2/transfer/update/:id
Метод
Маршрут
POST
/v2/write-off
POST
/v2/write-off/:id/add
PUT
/v2/write-off/cancel/:id
PUT
/v2/write-off/finish/:id
Метод
Маршрут
GET
/v2/import
POST
/v2/product-import/create-with-products
Метод
Маршрут
GET
/v2/supplier-order
POST
/v2/supplier-order
GET
/v2/supplier-order-products/:id
PUT
/v2/supplier-order/add-item
PATCH
/v2/supplier-order/change-status
PUT
/v2/supplier-order/update/:id
Только чтение списка.
Метод
Маршрут
GET
/v2/stocktaking
Методы для получения данных по активности магазина в виде отчётности.
Метод
Маршрут
GET
/v1/customer-general-table
GET
/v1/customer-purchases-table
GET
/v1/general-report-table
GET
/v1/import-report-table
GET
/v1/product-general-table
GET
/v1/product-sells-by-suppliers-table
GET
/v1/profit-and-lose
GET
/v1/report-product-performance-table
GET
/v1/seller-general-table
GET
/v1/stock-report-table
GET
/v1/stocktaking-summary-table
GET
/v1/supplier-order-return-report-table
GET
/v1/transaction-report-table
GET
/v1/transaction-report-totals
GET
/v1/write-off-report-table
Готовый файл Excel вместо постраничного чтения отчёта.
Метод
Маршрут
POST
/v1/cashflow-excel
POST
/v1/customer-general-report-excel
POST
/v1/customer-purchases-report-excel
POST
/v1/general-report-excel
POST
/v1/import-report-excel
POST
/v1/product-general-report-excel
POST
/v1/report-product-performance-excel
POST
/v1/report-profit-and-lose-excel
POST
/v1/seller-general-report-excel
POST
/v1/sells-supplier-report-excel
POST
/v1/stock-report-excel
POST
/v1/stocktaking-summary-table-excel-export
POST
/v1/supplier-order-returned-export
POST
/v1/transaction-report-excel
POST
/v1/transfer-report-excel-export
POST
/v1/write-off-report-table-export
Что делать, если нужного метода нет
Доступ к методу вне списка запрашивается отдельно — с указанием маршрута, HTTP-метода
и назначения. Иногда задачу закрывает другой метод из списка: например, вместо поиска
продаж — отчёт по транзакциям за период.
Метод в списке есть, а данные неполные
Нулевая цена поставки, проигнорированный shop_ids, сброшенный only_deleted
и асинхронный отказ при создании трансфера — права роли ключа .
Разбор 403 — в решении проблем .