Создание группы заказов
Для создания группы заказов от разных поставщиков с единым приемом оплаты, необходимо использовать следующий метод API:
- метод:
POST - ресурс:
/v3/billing/api/order/order-container - тело запроса - объект OrderContainerRequest
- тело ответа - объект OrderContainerResponse
- Возможные ошибки
Каждый заказ внутри группы заказов имеет базовую структуру, описанную в документации Создание заказа. Перед использованием данного метода рекомендуется ознакомиться с основной документацией по созданию заказа.
Пример запроса
POST /v3/billing/api/order/order-container
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e
Content-Type: application/json
User-Agent: MyApp 1.0
Accept: application/json
{
"merchantId": "019e207b-b0fe-ae2f-43e7-17054f15913d",
"originalCurrencyId": "RUB",
"originalAmount": 246,
"originalVatAmount": 11.72,
"merchantOrderIdVisible": "zakaz-123",
"returnUrl": "https://marketplace.com#return",
"successUrl": "https://marketplace.com#success",
"failUrl": "https://marketplace.com#fail",
"customer": {
"vatNumber": "7736642031",
"phone": "79045173703",
"email": "gb@invbox.ru",
"taxRegistrationReasonCode": "770901001",
"name": "ООО ЮРлицо",
"registrationAddress": "101000, г. Москва, Лубянский проезд, д.19",
"isLegal": true,
"type": "legal"
},
"orders": [
{
"basketItems": [
{
"sku": "1",
"name": "Позиция заказа магазина маркетплейса",
"type": "service",
"paymentType": "full_payment",
"measureCode": "796",
"quantity": 1,
"vatCode": "RUS_VAT5",
"amount": 123,
"amountWoVat": 117.14,
"totalAmount": 123,
"totalVatAmount": 5.86
}
],
"expirationDate": "2026-05-25T17:11:28+03:00",
"merchantOrderId": "222222/333",
"description": "Оплата заказа магазина маркетплейса",
"amount": 123,
"vatAmount": 5.86,
"merchantId": "019e2094-8403-89f0-1a75-953e2103cfc2",
"currencyId": "RUB"
},
{
"basketItems": [
{
"sku": "1",
"name": "Комиссия маркетплейса",
"type": "service",
"paymentType": "full_payment",
"measureCode": "796",
"quantity": 1,
"vatCode": "RUS_VAT5",
"amount": 123,
"amountWoVat": 117.14,
"totalAmount": 123,
"totalVatAmount": 5.86
}
],
"expirationDate": "2026-05-25T17:11:28+03:00",
"merchantOrderId": "1111/2222",
"description": "Оплата заказа комиссии маркетплейса",
"amount": 123,
"vatAmount": 5.86,
"merchantId": "019e207b-b0fe-ae2f-43e7-17054f15913d",
"currencyId": "RUB"
}
]
}
OrderContainerRequest
| Свойство | Обязательное | Тип | Описание | Пример значения |
|---|---|---|---|---|
| merchantId | да | string(36) | Идентификатор основгонго магазина (маркетплейса или агрегатора) | 019e207b-b0fe-ae2f-43e7-17054f15913d |
| originalCurrencyId | да | string(3) enum | Код валюты группы заказов в соответствии с ISO 4217 | RUB, USD, EUR, GBP |
| originalAmount | да | float | Общая сумма группы заказов | 246.00 |
| originalVatAmount | да | float | Общая сумма НДС группы заказов | 11.72 |
| orders | да | array of Order | Массив заказов, входящих в группу. Структура каждого заказа описана в документации по созданию заказа | |
| customer | нет | Customer | Информация о заказчике (если не указана, плательщик сам заполнит на платежной странице) | |
| merchantOrderIdVisible | нет | string(100) | Идентификатор группового заказа, отображаемый на платежной странице | zakaz-123 |
| returnUrl | нет | string(1000) | Ссылка для возврата на сайт Магазина | |
| successUrl | нет | string(1000) | Ссылка для перехода на сайт Магазина в случае успешной оплаты | |
| failUrl | нет | string(1000) | Ссылка для перехода на сайт Магазина в случае ошибки оплаты | |
| expirationDate | нет | datetime | Срок действия группы заказов | 2026-05-25T17:11:28+03:00 |
| languageId | нет | string(2) enum | Язык интерфейса платежной страницы | ru, en |
| invoiceSetting | нет | InvoiceSetting | Дополнительные настройки параметров оплаты |
OrderContainerResponse
Ответ содержит информацию о созданной группе заказов, включая идентификаторы созданных заказов и ссылки на оплату. Объект повторяет свойства объекта OrderContainerRequest с дополнительными свойствами:
| Свойство | Обязательное | Тип | Описание | Пример значения |
|---|---|---|---|---|
| id | да | string(36) | Идентификатор группы заказов в системе Инвойсбокс | 01771534-1a57-f184-dee3-ebeb91dded75 |
| paymentUrl | да | string(1000) | Ссылка для перехода на платёжный шлюз для оплаты заказа | |
| createdAt | да | datetime | Дата создания заказа | 2020-12-22T00:00:00+00:00 |
| status | да | string(50) enum | Статус заказа, pending - Ожидает оплаты, completed - успешная оплата | completed, pending, |
| paidAt | нет | datetime | Дата оплаты заказа (если оплачен) | 2020-12-22T00:00:00+00:00 |
