{ "info": { "name": "Инвойсбокс API (v3)", "description": "Публичный контракт Инвойсбокс API. Сгенерировано из OpenAPI портала документации — https://docs.invoicebox.ru/schemas/", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://api.invoicebox.ru" }, { "key": "token", "value": "b37c4c689295904ed21eee5d9a48d42e" }, { "key": "merchantId", "value": "ffffffff-ffff-ffff-ffff-ffffffffffff" }, { "key": "parentOrderId", "value": "" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const d = new Date(Date.now() + 24 * 60 * 60 * 1000);", "pm.collectionVariables.set('expirationDate', d.toISOString().replace(/.d+Z$/, '+00:00'));", "pm.collectionVariables.set('orderId', 'postman-' + Date.now());", "pm.collectionVariables.set('refundId', 'postman-refund-' + Date.now());" ] } } ], "item": [ { "name": "billing", "item": [ { "name": "GET /v3/billing/api/order/order", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/order", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "order" ] }, "description": "Получение списка заказов магазина\n\n Allowed ```_extend[]=``` query param values: ```merchant```\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/create/" } }, { "name": "POST /v3/billing/api/order/order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/order", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "order" ] }, "description": "Создание заказа. Заказ представляет собой заявку на оказание бухгалтерских или юридических услуг. При создании проверяется лимит на сумму заказов для юридического лица, если у контрагента указан ИНН — выполняется проверка КИСП. Если у способа оплаты включена автооплата, оплата создаётся автоматически.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/create/", "body": { "mode": "raw", "raw": "{\n \"merchantId\": \"ffffffff-ffff-ffff-ffff-ffffffffffff\",\n \"merchantOrderId\": \"{{orderId}}\",\n \"amount\": 12000,\n \"vatAmount\": 0,\n \"currencyId\": \"RUB\",\n \"languageId\": \"ru\",\n \"description\": \"Оплата бронирования № 4412\",\n \"expirationDate\": \"{{expirationDate}}\",\n \"successUrl\": \"https://shop.example.com/order/4412?result=success\",\n \"failUrl\": \"https://shop.example.com/order/4412?result=fail\",\n \"returnUrl\": \"https://shop.example.com/order/4412?result=return\",\n \"basketItems\": [\n {\n \"sku\": \"room-deluxe\",\n \"name\": \"Проживание в номере «Делюкс», 2 ночи\",\n \"measure\": \"шт\",\n \"measureCode\": \"796\",\n \"quantity\": 1,\n \"amount\": 12000,\n \"amountWoVat\": 12000,\n \"totalAmount\": 12000,\n \"totalVatAmount\": 0,\n \"vatCode\": \"RUS_VAT0\",\n \"type\": \"service\",\n \"paymentType\": \"full_prepayment\"\n }\n ],\n \"customer\": {\n \"type\": \"legal\",\n \"name\": \"ООО «Ромашка»\",\n \"vatNumber\": \"7701234560\",\n \"taxRegistrationReasonCode\": \"770101001\",\n \"phone\": \"79001112233\",\n \"email\": \"buh@example.invbox.ru\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /v3/billing/api/order/order/{id}", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/order/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "order", "{id}" ] }, "description": "Получение информации о заказе по его идентификатору. Возвращает полный состав заказа, включая позиции, сумму, налог, данные о магазине и статусе.\n\n Allowed ```_extend[]=``` query param values: ```language, merchant, currency```\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/update/" } }, { "name": "PUT /v3/billing/api/order/order/{id}", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/order/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "order", "{id}" ] }, "description": "Редактирование состава заказа. Позволяет изменить позиции в заказе, сумму, описание и другие параметры. Изменения применяются в рамках транзакции.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/update/", "body": { "mode": "raw", "raw": "{\n \"amount\": 15000,\n \"vatAmount\": 0,\n \"description\": \"Оплата бронирования № 4412, продление на ночь\",\n \"basketItems\": [\n {\n \"sku\": \"room-deluxe\",\n \"name\": \"Проживание в номере «Делюкс», 3 ночи\",\n \"measure\": \"шт\",\n \"measureCode\": \"796\",\n \"quantity\": 1,\n \"amount\": 15000,\n \"amountWoVat\": 15000,\n \"totalAmount\": 15000,\n \"totalVatAmount\": 0,\n \"vatCode\": \"RUS_VAT0\",\n \"type\": \"service\",\n \"paymentType\": \"full_prepayment\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /v3/billing/api/order/order/{id}", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/order/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "order", "{id}" ] }, "description": "Отмена заказа. Доступно только для заказов со статусом `created`. При отмене заказ переходит в статус `canceled`, а связанный контейнер заказов и дебетовая накладная обновляются соответствующим образом.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/update/" } }, { "name": "POST /v3/billing/api/order/order-container", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/order-container", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "order-container" ] }, "description": "Создание группы заказов магазина. Группировка заказов позволяет обрабатывать несколько заказов одновременно, что удобно при интеграции с маркетплейсами. Группа заказов содержит заказы с одинаковым магазином, валютой и способом оплаты.\n\n Allowed ```_include[]=``` query param values: ```order```\n\n Always returned ```_include[]=``` values (even if not requested): ```order```\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/create-order-container/", "body": { "mode": "raw", "raw": "{\n \"merchantId\": \"{{merchantId}}\",\n \"originalCurrencyId\": \"string\",\n \"originalAmount\": 100,\n \"originalVatAmount\": 100\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /v3/billing/api/order/correction-order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/correction-order", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "correction-order" ] }, "description": "Создание корректирующего заказа. Статус возвратного заказа(parentId) должен быть draft.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/refund/correction/", "body": { "mode": "raw", "raw": "{\n \"amount\": 12200,\n \"vatAmount\": 2200,\n \"basketItems\": [\n {\n \"sku\": \"string\",\n \"name\": \"string\",\n \"quantity\": 100,\n \"amount\": 12200,\n \"amountWoVat\": 100,\n \"totalAmount\": 100,\n \"totalVatAmount\": 100,\n \"vatCode\": \"RUS_VAT22\",\n \"type\": null\n }\n ],\n \"parentId\": \"string\",\n \"description\": \"Оплата бронирования\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /v3/billing/api/order/refund-order", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/refund-order", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "refund-order" ] }, "description": "Получение списка возвратов\n\n Allowed ```_extend[]=``` query param values: ```merchant, order```\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/refund/create/" } }, { "name": "POST /v3/billing/api/order/refund-order", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/refund-order", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "refund-order" ] }, "description": "Создание возвратного заказа. Родительский заказ должен иметь статус `completed`. Возвратный заказ создаёт кредитную накладну для возврата средств клиенту. Проверяется доступность возврата по родительскому заказу и уникальность позиций в корзине.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/refund/create/", "body": { "mode": "raw", "raw": "{\n \"parentId\": \"{{parentOrderId}}\",\n \"merchantOrderId\": \"{{refundId}}\",\n \"amount\": 12000,\n \"vatAmount\": 0,\n \"description\": \"Возврат по бронированию № 4412\",\n \"basketItems\": [\n {\n \"sku\": \"room-deluxe\",\n \"name\": \"Проживание в номере «Делюкс», 2 ночи\",\n \"measure\": \"шт\",\n \"measureCode\": \"796\",\n \"quantity\": 1,\n \"amount\": 12000,\n \"amountWoVat\": 12000,\n \"totalAmount\": 12000,\n \"totalVatAmount\": 0,\n \"vatCode\": \"RUS_VAT0\",\n \"type\": \"service\",\n \"paymentType\": \"full_prepayment\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /v3/billing/api/order/refund-order/{id}", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/refund-order/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "refund-order", "{id}" ] }, "description": "Редактирование возвратного заказа. Позволяет изменить позиции возврата и сумму. Нельзя изменить возврат, если уже создана кредитная накладная. Проверяется доступность возврата по родительскому заказу.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/refund/get/", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /v3/billing/api/order/refund-order/{id}", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/refund-order/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "refund-order", "{id}" ] }, "description": "Отмена возвратного заказа. Доступно только для возвратов со статусом `created`. При отмене статус меняется на `cancel`. Если существует кредитная накладная, удаление запрещено.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/refund/get/" } }, { "name": "GET /v3/billing/api/order/shipment", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/shipment", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "shipment" ] }, "description": "Получение списка отгрузок магазина\n\n Allowed ```_extend[]=``` query param values: ```merchant```\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/shipment_create/" } }, { "name": "POST /v3/billing/api/order/shipment", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/shipment", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "shipment" ] }, "description": "Создание отгрузки по заказу. Отгрузка фиксирует часть товаров или услуг, переданных клиенту по заказу. Статус заказа должен быть `completed`, `hold` или `expired`. Если отгрузка помечена как последняя (`final`), а отгружено не всё, создаётся автоматическая отмена на оставшиеся позиции.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/shipment_create/", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"string\",\n \"basketItems\": [\n {\n \"sku\": \"string\",\n \"name\": \"string\",\n \"quantity\": 100,\n \"amount\": 12200,\n \"amountWoVat\": 100,\n \"totalAmount\": 100,\n \"totalVatAmount\": 100,\n \"vatCode\": \"RUS_VAT22\",\n \"type\": null\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /v3/billing/api/order/shipment/{id}", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/shipment/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "shipment", "{id}" ] }, "description": "Редактирование состава отгрузки. Позволяет изменить позиции в отгрузке и сумму. Для черновых отгрузок проверяются лимиты и корректность суммы. Для завершённых отгрузок сумма не может быть изменена.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/shipment_update/", "body": { "mode": "raw", "raw": "{\n \"basketItems\": [\n {\n \"sku\": \"string\",\n \"name\": \"string\",\n \"quantity\": 100,\n \"amount\": 12200,\n \"amountWoVat\": 100,\n \"totalAmount\": 100,\n \"totalVatAmount\": 100,\n \"vatCode\": \"RUS_VAT22\",\n \"type\": \"string\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /v3/billing/api/order/shipment/{id}/status", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/shipment/{id}/status", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "shipment", "{id}", "status" ] }, "description": "Изменение статуса отгрузки. Черновую отгрузку можно завершить (`completed`) или отменить (`canceled`). Завершённую отгрузку можно только отменить. При изменении статуса пересчитываются суммы и, при необходимости, создаются автоматические отмены.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/shipment_update/", "body": { "mode": "raw", "raw": "{\n \"status\": \"draft\",\n \"description\": \"Оплата бронирования\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /v3/billing/api/order/order/order-merchant-move", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/order/order/order-merchant-move", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "order", "order", "order-merchant-move" ] }, "description": "Перенос заказа в другой магазин. Доступно только для заказов со статусом `created`. При переносе заказ привязывается к новому магазину и продолжает обрабатываться в его контексте.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/merchant-move/", "body": { "mode": "raw", "raw": "{\n \"merchantId\": \"{{merchantId}}\",\n \"orderId\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /v3/billing/api/payment/confirm", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/payment/confirm", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "payment", "confirm" ] }, "description": "Оплата заказа без прохождения 3-D Secure аутентификации. Создаёт операцию оплаты для заказа, инициируя платёж через подключённый платёжный метод. После успешной оплаты заказ переходит в статус `completed`.\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/recurring/", "body": { "mode": "raw", "raw": "{\n \"orderId\": \"string\",\n \"type\": \"string\",\n \"paymentToken\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /v3/billing/api/merchant/special-offer", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/merchant/special-offer", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "merchant", "special-offer" ] }, "description": "Получение списка спец. предложений\n\n Allowed ```_extend[]=``` query param values: ```merchant```\n\nДокументация: https://docs.invoicebox.ru/docs/marketplace/special-offer/" } }, { "name": "POST /v3/billing/api/merchant/special-offer", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/merchant/special-offer", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "merchant", "special-offer" ] }, "description": "Создание специального предложения для магазина. Спецпредложение привязывается к магазину и действует в течение заданного периода (от `startAt` до `finishAt`). Дата окончания должна быть больше даты начала.\n\nДокументация: https://docs.invoicebox.ru/docs/marketplace/special-offer/", "body": { "mode": "raw", "raw": "{\n \"merchantId\": \"{{merchantId}}\",\n \"active\": true,\n \"startAt\": \"{{expirationDate}}\",\n \"finishAt\": \"{{expirationDate}}\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /v3/billing/api/merchant/special-offer/{id}", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/merchant/special-offer/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "merchant", "special-offer", "{id}" ] }, "description": "Редактирование специального предложения. Проверяется, что дата окончания больше даты начала. Изменения сохраняются в рамках транзакции.\n\nДокументация: https://docs.invoicebox.ru/docs/marketplace/special-offer/", "body": { "mode": "raw", "raw": "{\n \"merchantId\": \"{{merchantId}}\",\n \"active\": true,\n \"startAt\": \"{{expirationDate}}\",\n \"finishAt\": \"{{expirationDate}}\",\n \"name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /v3/billing/api/merchant/special-offer/{id}", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/billing/api/merchant/special-offer/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "billing", "api", "merchant", "special-offer", "{id}" ] }, "description": "Удаление специального предложения. Используется мягкое удаление — устанавливается дата удаления. Предложение больше не учитывается при обработке заказов.\n\nДокументация: https://docs.invoicebox.ru/docs/marketplace/special-offer/" } } ] }, { "name": "filter", "item": [ { "name": "GET /v3/filter/api/order/order", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/filter/api/order/order", "host": [ "{{baseUrl}}" ], "path": [ "v3", "filter", "api", "order", "order" ] }, "description": "Запрашивает список заказов магазина через SDK бэк-офиса. Поддерживает\nфильтрацию стандартными параметрами. Расширяет ответ встроенными данными:\n`order-container` — группа заказа, `merchant` — магазин. Возвращает\nколлекцию заказов с пагинацией.\n\n\n Allowed ```_extend[]=``` query param values: ```merchant```\n\nОтвет — объект { data, metaData: { totalCount, page, pageSize }, extendedData }, а не массив. Фильтры по полям и операторы сравнения: https://docs.invoicebox.ru/docs/api/filters/\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/get/" } }, { "name": "GET /v3/filter/api/order/refund-order", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/filter/api/order/refund-order", "host": [ "{{baseUrl}}" ], "path": [ "v3", "filter", "api", "order", "refund-order" ] }, "description": "Запрашивает список возвратов заказов через SDK бэк-офиса. Поддерживает\nфильтрацию стандартными параметрами. Расширяет ответ встроенными данными:\n`merchant` — магазин, `order` — заказ, `order-container` — группа заказа.\nЧерез `include` доступна подгрузка кредитных счетов (`credit-invoice`).\nВозвращает коллекцию возвратов с пагинацией.\n\n\n Allowed ```_extend[]=``` query param values: ```merchant, order```\n\nОтвет — объект { data, metaData: { totalCount, page, pageSize }, extendedData }, а не массив. Фильтры по полям и операторы сравнения: https://docs.invoicebox.ru/docs/api/filters/\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/refund/get/" } }, { "name": "GET /v3/filter/api/counterparty-detail", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/filter/api/counterparty-detail", "host": [ "{{baseUrl}}" ], "path": [ "v3", "filter", "api", "counterparty-detail" ] }, "description": "Ищет реквизиты организаций тремя способами в зависимости от параметра `type`.\nЗначение `vat` ищет по ИНН через поле `vatNumber` — обращается к DaData.\nЗначение `tinkoff` ищет организации через Tinkoff Open API по параметру `code`.\nЗначение `ids` ищет по массиву внутренних идентификаторов `id`. Для каждого\nнайденного реквизита автоматически обновляются внутренние свойства через\nзарегистрированные провайдеры. При отсутствии результатов или ошибке\nпровайдера возвращается пустой список.\n\n\nОтвет — объект { data, metaData: { totalCount, page, pageSize }, extendedData }, а не массив. Фильтры по полям и операторы сравнения: https://docs.invoicebox.ru/docs/api/filters/\n\nДокументация: https://docs.invoicebox.ru/docs/dictionary/counterparty-detail/" } } ] }, { "name": "security", "item": [ { "name": "GET /v3/security/api/auth/auth", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/security/api/auth/auth", "host": [ "{{baseUrl}}" ], "path": [ "v3", "security", "api", "auth", "auth" ] }, "description": "Проверяет текущую сессию пользователя API. Возвращает идентификатор пользователя,\nпрофиль, данные учётной записи, идентификатор приложения и области действия токена.\n\n\nДокументация: https://docs.invoicebox.ru/docs/api/auth/" } }, { "name": "POST /v3/security/api/auth/auth", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/security/api/auth/auth", "host": [ "{{baseUrl}}" ], "path": [ "v3", "security", "api", "auth", "auth" ] }, "description": "Авторизует пользователя API по паролю. Поддерживает вход по email или телефону (`type: email`\nили `type: phone`). Пользователь должен быть в статусе `active`. После успешной\nаутентификации создаётся сессионный cookie, в ответе возвращаются идентификатор пользователя,\nпрофиль и данные идентификатора учётной записи.\n\n\nДокументация: https://docs.invoicebox.ru/docs/api/auth/", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /v3/security/api/api-user-group/activation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/security/api/api-user-group/activation", "host": [ "{{baseUrl}}" ], "path": [ "v3", "security", "api", "api-user-group", "activation" ] }, "description": "Активирует интеграцию (группу пользователя API) для мерчанта. Возвращает данные\nинтеграции, включая идентификатор мерчанта.\n\n\nДокументация: https://docs.invoicebox.ru/docs/partner/integration/activation/", "body": { "mode": "raw", "raw": "{\n \"activationCode\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "notification", "item": [ { "name": "POST /v3/notification/api/invite", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/notification/api/invite", "host": [ "{{baseUrl}}" ], "path": [ "v3", "notification", "api", "invite" ] }, "description": "Создаёт приглашение в приложение для партнёра. Приглашение может быть\nотправлено на email или номер телефона (`type`). Система регистрирует\nфакт отправки и привязывает его к партнёру (`partnerId`). Роут\nдоступен без аутентификации.\n\n\nДокументация: https://docs.invoicebox.ru/docs/partner/integration/invite/", "body": { "mode": "raw", "raw": "{\n \"identifier\": \"string\",\n \"type\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "processing", "item": [ { "name": "POST /v3/processing/api/payment-token/delete", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/processing/api/payment-token/delete", "host": [ "{{baseUrl}}" ], "path": [ "v3", "processing", "api", "payment-token", "delete" ] }, "description": "Удаляет сохранённый платёжный токен (paymentToken) для указанного клиента (clientId). Используется для отзыва доступа к рекуррентным платежам.\n\n\nДокументация: https://docs.invoicebox.ru/docs/merchant/order/recurring/", "body": { "mode": "raw", "raw": "{\n \"clientId\": \"string\",\n \"paymentToken\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "marketplace", "item": [ { "name": "GET /v3/marketplace/api/shop", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/marketplace/api/shop", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketplace", "api", "shop" ] }, "description": "\n\n Allowed ```_extend[]=``` query param values: ```image, model, brand```\n\n Allowed ```_include[]=``` query param values: ```shop-domain, marketplace-setting```\n\nДокументация: https://docs.invoicebox.ru/docs/marketplace/create/" } }, { "name": "POST /v3/marketplace/api/shop", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/marketplace/api/shop", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketplace", "api", "shop" ] }, "description": "\n\nДокументация: https://docs.invoicebox.ru/docs/marketplace/create/", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /v3/marketplace/api/shop/{id}", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/marketplace/api/shop/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketplace", "api", "shop", "{id}" ] }, "description": "\n\nДокументация: https://docs.invoicebox.ru/docs/marketplace/update/", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /v3/marketplace/api/shop/{id}", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{token}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "User-Agent", "value": "MyApp 1.0" } ], "url": { "raw": "{{baseUrl}}/v3/marketplace/api/shop/{id}", "host": [ "{{baseUrl}}" ], "path": [ "v3", "marketplace", "api", "shop", "{id}" ] }, "description": "Удаляет магазин продавца (мягкое удаление — магазин помечается как удалённый, запись в БД не физически стирается). Доступно менеджеру магазина и менеджеру мерчанта — только для своего магазина.\n\n\nДокументация: https://docs.invoicebox.ru/docs/marketplace/update/" } } ] } ] }