Заказы FBS (order)
С помощью методов раздела Заказы FBS (Fulfillment by Seller) вы можете:
- получать информацию о сборочных заданиях и их статусах, отменять сборочные задания, получать стикеры
- добавлять, редактировать и удалять идентификаторы маркировки сборочных заданий
- управлять поставками
- создавать, редактировать и удалять пропуска на склады WB
Вы можете протестировать методы заказов FBS в песочнице. Также в песочнице доступны специальные методы для эмуляции действий пользователя
С помощью методов раздела Заказы FBS (Fulfillment by Seller) вы можете:
- получать информацию о сборочных заданиях и их статусах, отменять сборочные задания, получать стикеры
- добавлять, редактировать и удалять идентификаторы маркировки сборочных заданий
- управлять поставками
- создавать, редактировать и удалять пропуска на склады WB
Вы можете протестировать методы заказов FBS в песочнице. Также в песочнице доступны специальные методы для эмуляции действий пользователя
Когда покупатель заказывает товар, у продавца появляется сборочное задание. Сборочное задание всегда содержит 1 единицу товара. Если покупатель закажет 10 единиц одного товара одной корзиной, у продавца появятся 10 сборочных заданий. Их можно сгруппировать по одинаковому orderUid.
Для работы со сборочными заданиями FBS:
- Получите новые сборочные задания.
- Создайте поставку и добавьте в неё сборочные задания.
- Получите стикеры сборочных заданий, распечатайте их и промаркируйте сборочные задания.
- Если нужно, добавьте к сборочным заданиям код маркировки Честного знака, УИН, IMEI, GTIN, срок годности товара или номер ДТ.
- Если поставка доставляется в пункт выдачи заказов (ПВЗ), переходите к пункту 3 инструкции. Если на склад WB, к пункту 6.
- Уточните, требуется ли пропуск на склад, на который поедет поставка. Если нужен, создайте пропуск.
Получить список новых сборочных заданий{{ /api/v3/orders/new }}
Метод возвращает список всех новых сборочных заданий, которые есть у продавца на момент запроса.
requiredMeta и optionalMeta, влияет только на возможность перевести поставку в доставку. Если ваш товар подлежит обязательной маркировке средствами
идентификации, необходимо указывать идентификаторы маркировки независимо от того, в каком поле они были получены (п. 4.6 Оферты).
Рекомендуем добавлять в сборочные задания все идентификаторы маркировки, полученные в полях
requiredMeta и optionalMeta
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Responses
Response samples
- 200
- 401
- 402
- 403
- 429
{- "orders": [
- {
- "address": {
- "fullAddress": "Челябинская область, г. Челябинск, 51-я улица Арабкира, д. 10А, кв. 42",
- "longitude": 44.519068,
- "latitude": 40.20192
}, - "ddate": "17.05.2024",
- "sellerDate": "02.06.2025",
- "salePrice": 504600,
- "requiredMeta": [
- "uin"
], - "optionalMeta": [
- "sgtin"
], - "deliveryType": "fbs",
- "comment": "Упакуйте в плёнку, пожалуйста",
- "scanPrice": null,
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "offices": [
- "Калуга"
], - "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "officeId": 123,
- "nmId": 123456789,
- "chrtId": 987654321,
- "price": 1014,
- "finalPrice": 1014,
- "convertedPrice": 28322,
- "convertedFinalPrice": 1014,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "crossBorderType": 1,
- "isZeroOrder": false,
- "isPickupPointShipmentAllowed": true,
- "options": {
- "isB2B": true
}
}
]
}Получить информацию о сборочных заданиях{{ /api/v3/orders }}
Метод возвращает информацию о сборочных заданиях, созданных не более 3 месяцев назад, без их актуального статуса.
Чтобы получить данные за период, укажите в запросе даты начала и окончания периода. Максимум 30 календарных дней одним запросом.
В ответе метода будут сборочные задания, созданные в указанный период.
Чтобы получить сборочные задания, созданные более 3 месяцев назад, используйте метод получения списка архивных заказов.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
query Parameters
| limit required | integer [ 1 .. 1000 ] Параметр пагинации. Устанавливает предельное количество возвращаемых данных. |
| next required | integer <int64> Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен |
| dateFrom | integer Дата начала периода в формате Unix timestamp. По умолчанию — дата за 30 дней до запроса. Часовой пояс — UTC |
| dateTo | integer Дата конца периода в формате Unix timestamp. Часовой пояс — UTC |
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "next": 13833711,
- "orders": [
- {
- "address": {
- "fullAddress": "Челябинская область, г. Челябинск, 51-я улица Арабкира, д. 10А, кв. 42",
- "longitude": 44.519068,
- "latitude": 40.20192
}, - "scanPrice": 1500,
- "deliveryType": "fbs",
- "supplyId": "WB-GI-92937123",
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "offices": [
- "Калуга"
], - "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "officeId": 123,
- "nmId": 12345678,
- "chrtId": 987654321,
- "price": 1014,
- "convertedPrice": 28322,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "crossBorderType": 1,
- "comment": "Упакуйте в плёнку, пожалуйста",
- "isZeroOrder": false,
- "trackNumber": "NRU56565656",
- "options": {
- "isB2B": true
}
}
]
}Получить статусы сборочных заданий{{ /api/v3/orders/status }}
Метод возвращает статусы сборочных заданий по их ID.
supplierStatus — статус сборочного задания. Триггер его изменения — действие самого продавца.
Возможные значения supplierStatus:
| Статус | Описание | Как перевести сборочное задание в данный статус |
|---|---|---|
new |
Новое сборочное задание | |
confirm |
На сборке | Добавить сборочное задание к поставке Перевести сборочные задания из доставки на сборку |
complete |
В доставке | Передать поставку в доставку |
cancel |
Отменено продавцом | Отменить сборочное задание |
cancel_carrier |
Отменено перевозчиком Только для трансграничных поставок |
Переводится перевозчиком |
wbStatus — статус системы Wildberries.
Возможные значения wbStatus:
waiting— сборочное задание в работеsorted— сборочное задание отсортированоsold— заказ получен покупателемcanceled— отмена сборочного заданияcanceled_by_client— покупатель отменил заказ при полученииdeclined_by_client— покупатель отменил заказ. Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборкуdefect— отмена заказа по причине бракаready_for_pickup— заказ прибыл на пункт выдачи заказов (ПВЗ)accepted_by_carrier— продавец передал заказ в службу доставки в своей странеsent_to_carrier— заказ отправлен на склад службы доставки в стране продавцаcanceled_by_carrier— заказ отменён перевозчиком. Только для трансграничных поставок
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Request Body schema: application/json
| orders required | Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ] Список ID сборочных заданий |
Responses
Request samples
- Payload
{- "orders": [
- 5632423
]
}Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "orders": [
- {
- "id": 5632423,
- "isCancellable": false,
- "isTransferable": false,
- "supplierStatus": "new",
- "wbStatus": "waiting"
}
]
}Получить все сборочные задания для повторной отгрузки{{ /api/v3/supplies/orders/reshipment }}
Метод возвращает все сборочные задания, требующие повторной отгрузки.
Повторная отгрузка требуется, если поставка была отсканирована в пункте приёмки, но при этом в ней всё ещё есть неотсканированные товары. Спустя определённое время необходимо доставить эти товары заново. Данные сборочные задания можно перевести в другую активную поставку.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "orders": [
- {
- "supplyID": "WB-GI-1234567",
- "orderID": 5632423
}
]
}Отменить сборочное задание{{ /api/v3/orders/{orderId}/cancel }}
Метод отменяет сборочное задание и переводит в статус cancel — отменено продавцом.
isCancellable.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 100 запросов | 600 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 402
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}Получить стикеры сборочных заданий{{ /api/v3/orders/stickers }}
Метод возвращает список стикеров для сборочных заданий в статусах confirm — на сборке и complete — в доставке.
Если за сборочным заданием не закреплён обязательный номер декларации на товары (ДТ), получить стикеры для этого сборочного задания невозможно.
За один запрос можно получить максимум 100 стикеров.
Можно получить стикер в форматах:
- SVG
- ZPLV (вертикальный)
- ZPLH (горизонтальный)
- PNG
Доступны размеры:
- 580x400 px при
width=58&height=40в запросе - 400x300 px при
width=40&height=30в запросе
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
query Parameters
| type required | string Enum: svg zplv zplh png Тип стикера |
| width required | integer Enum: 58 40 Ширина стикера |
| height required | integer Enum: 40 30 Высота стикера |
Request Body schema: application/json
| orders | Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ] Список ID сборочных заданий |
Responses
Request samples
- Payload
{- "orders": [
- 5346346
]
}Response samples
- 200
- 400
- 401
- 402
- 403
- 409
- 429
{- "stickers": [
- {
- "orderId": 5346346,
- "partA": "231648",
- "partB": "9753",
- "barcode": "!uKEtQZVx",
- "file": "iVBORw0KGgoAAAANSUhEUgAAASIAAAEiAQAAAAB1xeIbAAABiElEQVR4nO2YUW6DMAyGbUDaI0g9wI4Sjg5H2Q3IeyZPthNKV03tNiVdtf9/cFvXAvRhkh+z0G2t3R1FRKgqAokikCgCiSKQeDQJzho8yXMsmfmh1/UvqoKoNrsLdgN6S8hzXP2TV8Xc47KMyTPnx+DvX/1zVg1Xmch1z9ih6gv2HLZTuqIPXjX7ftSlPRLJ+prXnONLF9hXZL96q/fE4W1Q+O8XvQ/29djL/lvWiTg/Bt89Voeqn/j7OQ4eTLJY7tz8oEoVSFC28aN9JqKwqbX3kP+VBewrsg/KedE3qmXUn3IMYF/d3zONm38TiqckFKeyEaDv6/W96Nus9b2tPrbw2LOAvq/Pfpfn/Fb4HoA1p9UcU3SHJTLHExk+p8VeK3JwN0Q2UNPmR9+3m2OyDzPjoOFFML9vOMcUin0iHahR2CaGz/mkmo6P5zHtQdD3TeeY5NY++/sKZ+xQdUliNZszqePRkFd+tfvHqhtC1S/nmOQh7eH+Y3WoygKJIpAoAokikChqT+IDIkbb8/8OLskAAAAASUVORK5CYII="
}
]
}Получить стикеры сборочных заданий трансграничных поставок{{ /api/v3/orders/stickers/cross-border }}
Метод возвращает список стикеров сборочных заданий трансграничных поставок в формате PDF.
Для каждого сборочного задания в ответе указывается статус генерации стикера:
awaitingTrackNumber— стикер не готов. Ожидается трек-номер от перевозчика.ready— стикер готов
ready.
Ограничения:
- За один запрос можно получить максимум 100 стикеров.
- Можно получить стикеры только для сборочных заданий, находящихся на сборке или в доставке — статусы
confirm,complete.
В песочнице этот метод всегда возвращает ответ 200.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
Request Body schema: application/json
| orders | Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ] Список ID сборочных заданий |
Responses
Request samples
- Payload
{- "orders": [
- 3869227998
]
}Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "stickers": [
- {
- "orderId": 987654320,
- "status": "awaitingTrackNumber",
- "parcelId": "",
- "file": "",
- "partA": "",
- "partB": "",
- "barcode": ""
}, - {
- "orderId": 123456789,
- "status": "ready",
- "parcelId": "WB0000000001",
- "file": "JVBERi0xLjQKJSBjcmVhdGVkIGJ5IFBpbGxvdyBQREYgZHJpdmVyCjQgMCBvYmo8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgNSAwIFIKPj5lbmRvYmoKNSAwIG9iajw8Ci9UeXBlIC9QYWdlcwovQ291bnQgMQovS2lkcyBbIDIgMCBSIF0KPj5lbmRvYmoKMSAwIG9iajw8Ci9UeXBlIC9YT2JqZWN0Ci9TdWJ0eXBlIC9JbWFnZQovV2lkdGggMjkwCi9IZWlnaHQgMjkwCi9GaWx0ZXIgWyAvQ0NJVFRGYXhEZWNvZGUgXQovRGVjb2RlUGFybXMgWyA8PAovSyAtMQovQmxhY2tJczEgdHJ1ZQovQ29sdW1ucyAyOTAKL1Jvd3MgMjkwCj4+IF0KL0JpdHNQZXJDb21wb25lbnQgMQovQ29sb3JTcGFjZSAvRGV2aWNlR3JheQovTGVuZ3RoIDY2Ngo+PnN0cmVhbQomoLYaX////////////8g2b4gpHITff///////////8nBSkIB8nBS/////////////////////+QgHkNB/IQD////////////////////////////+P//////////////////////////IQ5CHIQ////////////////////////////////jkNB/H/////////////////////4yEOQh+P//////////////////EhoKR//////yDYchDkIchDyBg2E4aCcFL////////////////////////IgFIiAhODQTg0f/////////////////+ThCICEQGgnDQTg0E4NBODZ////////////////////////4k4NESEOJCCP/////////////////8gpHIQ5CCCEEENB8hDyBg2f//////////////////////////xEZKQhOEJwhOB5f//////////////yDZviDQIjkDBS///////////////ycFLEnCCThP//////////////////kIB5CHkQEEnCEQEJwbP///////////////////////////4ycGgnBoIgFL/////////////////////+QhxIQ4kIcg0H////////////////////////8cSEOJCHEhAP//////////////////jIQDIQ+Qh5OE////////////////////////4iIiI/////////////wAQAQJAAABAwABAAAAIgEAAAEBAwABAAAAIgEAAAIBAwABAAAAAQAAAAMBAwABAAAABAAAAAYBAwABAAAAAQAAABEBBAABAAAACAAAABYBAwABAAAAIgEAABcBBAABAAAAKAIAABwBAwABAAAAAQAAAAAAAAAKZW5kc3RyZWFtCmVuZG9iagoyIDAgb2JqPDwKL1Jlc291cmNlcyA8PAovUHJvY1NldCBbIC9QREYgL0ltYWdlQiBdCi9YT2JqZWN0IDw8Ci9pbWFnZSAxIDAgUgo+Pgo+PgovTWVkaWFCb3ggWyAwIDAgMjkwLjAgMjkwLjAgXQovQ29udGVudHMgMyAwIFIKL1R5cGUgL1BhZ2UKL1BhcmVudCA1IDAgUgo+PmVuZG9iagozIDAgb2JqPDwKL0xlbmd0aCA0Nwo+PnN0cmVhbQpxIDI5MC4wMDAwMDAgMCAwIDI5MC4wMDAwMDAgMCAwIGNtIC9pbWFnZSBEbyBRCgplbmRzdHJlYW0KZW5kb2JqCjYgMCBvYmo8PAovQ3JlYXRpb25EYXRlIChEOjIwMjUxMTA3MTMzNTE1WikKL01vZERhdGUgKEQ6MjAyNTExMDcxMzM1MTVaKQo+PmVuZG9iagp4cmVmCjAgNwowMDAwMDAwMDAwIDY1NTM2IGYgCjAwMDAwMDAxNDQgMDAwMDAgbiAKMDAwMDAwMTA1MiAwMDAwMCBuIAowMDAwMDAxMjE0IDAwMDAwIG4gCjAwMDAwMDAwNDAgMDAwMDAgbiAKMDAwMDAwMDA4NyAwMDAwMCBuIAowMDAwMDAxMzA5IDAwMDAwIG4gCnRyYWlsZXIKPDwKL1Jvb3QgNCAwIFIKL1NpemUgNwovSW5mbyA2IDAgUgo+PgpzdGFydHhyZWYKMTM5MQolJUVPRg==",
- "partA": "231648",
- "partB": "9753",
- "barcode": "!uKEtQZVx"
}
]
}История статусов для сборочных заданий трансграничных поставок{{ /api/v3/orders/status/history }}
Метод возвращает историю статусов для сборочных заданий трансграничных поставок.
В песочнице этот метод всегда возвращает ответ 200.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Request Body schema: application/json
| orders | Array of integers [ 1 .. 100 ] items ID сборочных заданий |
Responses
Request samples
- Payload
{- "orders": [
- 123456789,
- 987654321
]
}Response samples
- 200
- 401
- 402
- 403
- 404
- 429
{- "orders": [
- {
- "deliveryDate": "2019-08-24T14:15:22Z",
- "statuses": [
- {
- "date": null,
- "code": "SORTED"
}
], - "orderID": 123456789
}
]
}Заказы с информацией по клиенту{{ /api/v3/orders/client }}
Метод позволяет получать информацию о покупателе по ID сборочного задания.
Только для трансграничных поставок из Турции.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Request Body schema: application/jsonrequired
| orders | Array of integers Список заказов |
Responses
Request samples
- Payload
{- "orders": [
- 987654321,
- 123456789
]
}Response samples
- 200
- 400
- 401
- 402
- 403
- 404
- 429
{- "orders": [
- {
- "firstName": "Иван",
- "fullName": "Андреев Иван Васильевич",
- "lastName": "Андреев",
- "middleName": "Васильевич",
- "orderID": 134567,
- "phone": "79871234567",
- "phoneCode": "0"
}
]
}Получить список архивных сборочных заданий{{ /api/marketplace/v3/fbs/orders/archive }}
Метод возвращает сборочные задания, созданные более 3 месяцев назад.
Часть сборочных заданий попадает в архив позже, чем через 3 месяца после создания, так как поставка переходит в архив только после того, как все заказы в ней будут завершены.
Например, так происходит, если продавец не доставил один из заказов в поставке и заказ был отменён автоматически через несколько дней.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
query Parameters
| year required | integer Example: year=2023 Год создания заказа |
| month required | integer [ 1 .. 12 ] Example: month=2 Месяц создания заказа |
| next required | integer <int64> Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен |
| limit required | integer <int32> [ 100 .. 1000 ] Example: limit=150 Количество сборочных заданий в ответе |
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "next": 0,
- "orders": [
- {
- "cargoType": "mgt",
- "colorCode": "RAL 3017",
- "createdAt": "2022-05-04",
- "crossBorder": {
- "parcel": "1Z999AA10123456784"
}, - "crossBorderType": "crossBorder",
- "id": 1234567890,
- "isZeroOrder": false,
- "metaDetails": [ ],
- "options": {
- "isB2B": false
}, - "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "priceInfo": {
- "convertedCurrencyCode": 643,
- "convertedPrice": 1020,
- "currencyCode": 643,
- "price": 1020
}, - "product": {
- "article": "wv1702fyjh",
- "chrtId": 12345678,
- "nmId": 370870300,
- "skus": [
- "12345Ejf5",
- "12345Ejf6",
- "12345Ejf7"
]
}, - "rid": "f884001e44e511edb8780242ac120002",
- "scanPrice": 5200,
- "status": {
- "supplierStatus": "complete",
- "wbStatus": "sent_to_carrier"
}, - "stickerId": 33811984302,
- "supplyId": "WB-GI-1234588",
- "warehouseId": 55684681
}
]
}С помощью этих методов вы можете получить, удалить и отредактировать идентификаторы маркировки сборочных заданий:
Заполнять идентификаторы маркировки сборочных заданий в песочнице необязательно
Получить идентификаторы маркировки сборочных заданий{{ /api/marketplace/v3/orders/meta }}
Метод возвращает идентификаторы маркировки сборочных заданий и статусы их проверки.
Перечень идентификаторов маркировки, доступных для сборочного задания, можно получить в списке новых сборочных заданий, поля requiredMeta и optionalMeta. Если поля requiredMeta и optionalMeta не содержат какой-либо идентификатор маркировки, значит, у сборочного задания не может быть этого идентификатора — и добавить его нельзя.
Возможные идентификаторы маркировки:
imei— IMEIuin— УИНgtin— GTINsgtin— код маркировки Честного знакаexpiration— срок годности товараcustomsDeclaration— номер ДТ
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Request Body schema: application/jsonrequired
| orders required | Array of integers <= 100 items |
Responses
Request samples
- Payload
{- "orders": [
- 123456,
- 234567,
- 345678
]
}Response samples
- 200
- 400
- 401
- 402
- 403
- 404
- 429
{- "orders": [
- {
- "id": 0,
- "metaDetails": [ ]
}
]
}Удалить идентификаторы маркировки сборочного задания{{ /api/v3/orders/{orderId}/meta }}
Метод удаляет значение идентификаторов маркировки сборочного задания для переданного ключа.
Возможные идентификаторы маркировки:
imei— IMEIuin— УИНgtin— GTINsgtin— код маркировки Честного знакаcustomsDeclaration— номер ДТ
Можно передать только один ключ.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 ID сборочного задания |
query Parameters
| key required | string Enum: imei uin gtin sgtin customsDeclaration Название идентификаторов маркировки для удаления. Передаётся только одно значение. |
Responses
Response samples
- 400
- 401
- 402
- 403
- 409
- 429
{- "code": "IncorrectRequest",
- "message": "Переданы некорректные данные"
}Закрепить код маркировки Честного знака за сборочным заданием{{ /api/v3/orders/{orderId}/meta/sgtin }}
Метод обновляет код маркировки Честного знака в идентификаторах маркировки сборочного задания.
Закрепить код маркировки Честного знака можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле sgtin.
Получить загруженные маркировки можно в идентификаторах маркировки сборочного задания.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 1000 запросов | 60 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Request Body schema: application/jsonrequired
| sgtins required | Array of strings [ 1 .. 100 ] items Массив кодов маркировки Честного знака.
GS-разделители необходимо передавать в кодировке Unicode с экранированием — |
Responses
Request samples
- Payload
{- "sgtins": [
- "0104630568317423215EirD_orEif7X\u001d91EE12\u001d92VygELprJ87wrc/qF/Vq/KEFUVpZm4vDPQt2kqUw308Y="
]
}Response samples
- 400
- 401
- 402
- 403
- 404
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}Закрепить УИН за сборочным заданием{{ /api/v3/orders/{orderId}/meta/uin }}
Метод обновляет УИН, уникальный идентификационный номер, в идентификаторах маркировки сборочного задания.
У одного сборочного задания может быть только один УИН.
Закрепить УИН можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле uin.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 1000 запросов | 60 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Request Body schema: application/jsonrequired
| uin required | string = 16 characters УИН |
Responses
Request samples
- Payload
{- "uin": "1234567890123456"
}Response samples
- 400
- 401
- 402
- 403
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}Закрепить IMEI за сборочным заданием{{ /api/v3/orders/{orderId}/meta/imei }}
Метод обновляет IMEI в идентификаторах маркировки сборочного задания.
У одного сборочного задания может быть только один IMEI. Если у устройства два IMEI — IMEI и IMEI2 или IMEI1 и IMEI2 — укажите только IMEI или IMEI1. IMEI2 указывать не нужно.
Закрепить IMEI можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле imei.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 1000 запросов | 60 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Request Body schema: application/jsonrequired
| imei required | string = 15 characters IMEI |
Responses
Request samples
- Payload
{- "imei": "123456789012345"
}Response samples
- 400
- 401
- 402
- 403
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}Закрепить GTIN за сборочным заданием{{ /api/v3/orders/{orderId}/meta/gtin }}
Метод обновляет GTIN, уникальный ID товара в Беларуси, в идентификаторах маркировки сборочного задания.
У одного сборочного задания может быть только один GTIN.
Закрепить GTIN можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле gtin.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 1000 запросов | 60 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Request Body schema: application/jsonrequired
| gtin required | string = 13 characters GTIN |
Responses
Request samples
- Payload
{- "gtin": "1234567890123"
}Response samples
- 400
- 401
- 402
- 403
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}Закрепить за сборочным заданием срок годности товара{{ /api/v3/orders/{orderId}/meta/expiration }}
Метод закрепляет за сборочным заданием срок годности товара. Товар годен до указанной даты.
Закрепить срок годности можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле expiration.
Получить загруженные данные можно в идентификаторах маркировки сборочного задания.
Чтобы изменить срок годности, отправьте запрос с новой датой. Удалить срок годности сборочного задания невозможно.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 1000 запросов | 60 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Request Body schema: application/jsonrequired
| expiration required | string <date (dd.mm.yyyy)> Дата, до которой годен товар. Не менее 30 дней с текущей даты |
Responses
Request samples
- Payload
{- "expiration": "12.09.2030"
}Response samples
- 400
- 401
- 402
- 403
- 404
- 409
- 429
Указан срок меньше допустимого
{- "code": "LowExpirationDate",
- "message": "Не удалось обновить срок годности. Указан срок меньше допустимого"
}Закрепить номер ДТ за сборочным заданием{{ /api/marketplace/v3/orders/{orderId}/meta/customs-declaration }}
Метод обновляет номер ДТ — декларации на товары — в идентификаторах маркировки сборочного задания. У одного сборочного задания может быть только один номер ДТ.
Закрепить номер ДТ можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле customsDeclaration.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 1000 запросов | 60 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Request Body schema: application/jsonrequired
| customsDeclaration required | string [ 17 .. 29 ] characters Номер ДТ |
Responses
Request samples
- Payload
{- "customsDeclaration": "10704010/010624/0000302"
}Response samples
- 400
- 401
- 402
- 403
- 404
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}Для работы с поставками:
Создайте новую поставку. В ответ вернется ID созданной поставки в формате
WB-GI-1234567.В текущую новую поставку добавьте сборочные задания, которые вы повезёте на склад или ПВЗ. После того, как сборочные задания будут добавлены к поставке, они будут переведены в статус
confirm— на сборке.Получите стикеры грузомест. Распечатайте и наклейте стикеры на грузоместа.
После того как поставка будет укомплектована нужными сборочными заданиями, необходимо передать её в доставку. Если поставка не была передана в доставку, то при сканировании её QR-кода или приёмке первого товара на ПВЗ поставка автоматически закроется. При передаче сборочных заданий в доставку они будут автоматически собраны и переведены в статус
complete— в доставке.Для поставок из стран ЕАЭС добавьте данные СПОТ. Получите список стран ОКСМ для добавления данных СПОТ в поставку. Вы можете получать данные СПОТ для списка поставок и QR-коды СПОТ. Сейчас методы доступны только для продавцов из Кыргызстана. В дальнейшем методы будут доступны продавцам из любой страны ЕАЭС кроме РФ, следите за обновлениями.
Если поставка была отсканирована в пункте приёмки, но при этом в ней всё ещё есть неотсканированные товары, спустя определённое время необходимо доставить их повторно. Проверьте все сборочные задания, требующие повторной отгрузки на данный момент. Данные сборочные задания можно перевести в другую активную поставку. Сборочное задание также будет переведено в статус
confirm— на сборке.
Также вы можете:
- удалить грузоместа из поставки, но только пока поставка находится на сборке
- получить ID всех сборочных заданий, добавленных к поставке
- получить информацию обо всех поставках продавца или о конкретной поставке
- удалить поставку при условии, что она активна и за ней не закреплены сборочные задания
- перемещать сборочные задания между активными поставками. Нельзя перемещать сборочное задание из уже закрытой поставки, только если оно не требует повторной отгрузки
- переводить сборочные задания из доставки на сборку
- получить QR-код поставки в форматах SVG, ZPL или PNG. Доступно только после передачи поставки в доставку
Создать новую поставку{{ /api/v3/supplies }}
Метод создаёт новую поставку.
Ограничения:
- Только для сборочных заданий по модели FBS.
- При добавлении в поставку все передаваемые сборочные задания в статусе
newбудут автоматически переведены в статусconfirm— на сборке. - Если вы переведёте сборочное задание в статус
cancel— отмена продавцом, прикрепленное сборочное задание автоматически удалится из поставки. - Поставку можно собрать только из сборочных заданий (заказов) одного габаритного типа
cargoType. Новая поставка не обладает габаритным признаком, она приобретает габаритный признак первого заказа, добавленного в поставку.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Request Body schema: application/jsonrequired
| name | string [ 1 .. 128 ] characters Наименование поставки |
Responses
Request samples
- Payload
{- "name": "Тестовая поставка"
}Response samples
- 201
- 400
- 401
- 402
- 403
- 429
{- "id": "WB-GI-1234567"
}Получить список поставок{{ /api/v3/supplies }}
Метод возвращает список поставок.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
query Parameters
| limit required | integer [ 1 .. 1000 ] Параметр пагинации. Устанавливает предельное количество возвращаемых данных. |
| next required | integer <int64> Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен |
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "next": 13833711,
- "supplies": [
- {
- "id": "WB-GI-1234567",
- "isB2b": true,
- "isPickupPointShipmentAllowed": true,
- "done": true,
- "createdAt": "2022-05-04T07:56:29Z",
- "closedAt": "2022-05-04T07:56:29Z",
- "scanDt": "2022-05-04T07:56:29Z",
- "name": "Тестовая поставка",
- "cargoType": 1,
- "crossBorderType": 1,
- "destinationOfficeId": 123,
- "recommendedWhId": 123569,
- "shippingDt": "2026-08-31",
- "shippingPointId": 100,
- "shippingType": "selfShipping",
- "waybillUuid": "550e8400-e29b-41d4-a716-384579387429",
- "spotAvailable": true
}
]
}Добавить сборочные задания к поставке{{ /api/marketplace/v3/supplies/{supplyId}/orders }}
Метод добавляет до 100 сборочных заданий к поставке и переводит их в статус confirm — на сборке.
Может перемещать сборочные задания:
- между активными поставками
- из закрытой поставки в активную, если сборочные задания требуют повторной отгрузки
Поставка приобретает признаки первого добавленного в неё сборочного задания из полей:
crossBorderType — трансграничная или внутренняя поставкаcargoType — габаритный типisB2b — B2B-продажаcrossBorderType, cargoType, isB2b, как у поставки.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-1234567 ID поставки |
Request Body schema: application/jsonrequired
| orders | Array of integers [ 1 .. 100 ] items ID сборочных заданий |
Responses
Request samples
- Payload
{- "orders": [
- 5632423,
- 3453452,
- 7654533,
- 4529544
]
}Response samples
- 400
- 401
- 402
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}Перевести сборочные задания из доставки на сборку{{ /api/marketplace/v3/fbs/supplies/{supplyId}/orders/transfer }}
Метод переводит сборочные задания из статуса complete — в доставке в статус confirm — на сборке.
Используйте метод, чтобы переместить сборочное задание из закрытой поставки в открытую.
Сборочное задание можно перевести из доставки на сборку, если выполнены все условия:
- сборочное задание находится в статусе
complete— в доставке - поставка, в которую нужно перенести сборочное задание, не передана в доставку
- сборочное задание ранее не переносили из доставки на сборку
Чтобы проверить, можно ли перевести сборочное задание из доставки на сборку, используйте статусы сборочных заданий, поле
isTransferable.
Authorizations:
path Parameters
| supplyId required | string ID поставки, из которой будут перемещены заказы |
Request Body schema: application/jsonrequired
| orderIds required | Array of integers Список ID сборочных заданий, которые нужно перевести на сборку |
| newSupplyId required | string ID поставки, в которую будут перемещены сборочные задания. Поставка не должна быть в доставке |
Responses
Request samples
- Payload
{- "orderIds": [
- 0
], - "newSupplyId": "string"
}Response samples
- 200
- 400
- 401
- 403
{- "transferredOrders": [
- {
- "error": {
- "detail": "Failed to assign the assembly order to the supply. Make sure that the assembly task and the supply meet all the necessary requirements.",
- "code": 409
}, - "newStickerId": 0,
- "oldStickerId": 0,
- "orderId": 5457166056
}, - {
- "success": true,
- "newStickerId": 1234567890,
- "oldStickerId": 9876543210,
- "orderId": 5678954321
}
]
}Получить информацию о поставке{{ /api/v3/supplies/{supplyId} }}
Метод возвращает подробную информацию о поставке.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-1234567 ID поставки |
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 404
- 429
{- "id": "WB-GI-1234567",
- "isB2b": true,
- "isPickupPointShipmentAllowed": true,
- "done": true,
- "createdAt": "2022-05-04T07:56:29Z",
- "closedAt": "2022-05-04T07:56:29Z",
- "scanDt": "2022-05-04T07:56:29Z",
- "name": "Тестовая поставка",
- "cargoType": 1,
- "crossBorderType": 1,
- "destinationOfficeId": 123,
- "recommendedWhId": 123569,
- "shippingDt": "2026-08-31",
- "shippingPointId": 100,
- "shippingType": "selfShipping",
- "waybillUuid": "550e8400-e29b-41d4-a716-384579387429",
- "spotAvailable": true
}Удалить поставку{{ /api/v3/supplies/{supplyId} }}
Метод удаляет поставку, если она активна и за ней не закреплено ни одно сборочное задание.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-1234567 ID поставки |
Responses
Response samples
- 400
- 401
- 402
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}Получить ID сборочных заданий поставки{{ /api/marketplace/v3/supplies/{supplyId}/order-ids }}
Метод возвращает список ID сборочных заданий, закреплённых за поставкой.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string ID поставки |
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 404
- 429
{- "orderIds": [
- 132334,
- 203984,
- 403543,
- 598349
]
}Передать поставку в доставку{{ /api/v3/supplies/{supplyId}/deliver }}
Метод закрывает поставку и переводит все сборочные задания в ней в статус complete — в доставке. После закрытия поставки добавить новые сборочные задания к ней нельзя.
Если поставка не была передана в доставку, то при приёмке первого товара поставка автоматически закроется.
Передать поставку в доставку можно, только если в ней:
- есть хотя бы одно сборочное задание
- для всех сборочных заданий указана обязательная маркировка
- маркировка всех сборочных заданий прошла проверку
Если поставка содержит сборочные задания с обязательным УИН, убедитесь, что вы заранее создали и загрузили спецификацию с договором на доставку. ГИИС ДМДК требуется около 30 минут для обработки изменений в статусах УИН.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-1234567 ID поставки |
Responses
Response samples
- 400
- 401
- 402
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}Получить QR-код поставки{{ /api/v3/supplies/{supplyId}/barcode }}
Метод возвращает QR-код поставки в форматах:
- SVG
- ZPLV (вертикальный)
- ZPLH (горизонтальный)
- PNG
QR-код поставки можно получить, только если поставка передана в доставку.
Размер — 580x400 px.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-1234567 ID поставки |
query Parameters
| type required | string Enum: svg zplv zplh png Тип стикера |
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 404
- 409
- 429
{- "barcode": "WB-GI-12345678",
- "file": "U3dhZ2dlciByb2Nrcw=="
}Получить список грузомест поставки{{ /api/v3/supplies/{supplyId}/trbx }}
Возвращает список грузомест поставки.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-1234567 ID поставки |
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 404
- 429
{- "trbxes": [
- {
- "id": "WB-TRBX-1234567"
}
]
}Добавить грузоместа к поставке{{ /api/v3/supplies/{supplyId}/trbx }}
Метод добавляет требуемое количество грузомест в поставку.
Грузоместа необходимо добавлять только в поставки, отгружаемые на ПВЗ.
Грузоместа можно добавить только в открытую поставку. В одном грузоместе может быть несколько заказов. Например, если в поставке 10 заказов, распределите их по коробам: система позволит создать не больше 5 грузомест. Для 20 заказов — не больше 10 грузомест, для 100 — не больше 50.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-1234567 ID поставки |
Request Body schema: application/json
| amount required | integer [ 1 .. 1000 ] Количество грузомест, которые необходимо добавить к поставке |
Responses
Request samples
- Payload
{- "amount": 4
}Response samples
- 201
- 400
- 401
- 402
- 403
- 404
- 429
{- "trbxIds": [
- "WB-TRBX-1234567"
]
}Удалить грузоместа из поставки{{ /api/v3/supplies/{supplyId}/trbx }}
Метод удаляет грузоместа из поставки.
Можно удалить только пока поставка на сборке.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-1234567 ID поставки |
Request Body schema: application/json
| trbxIds required | Array of strings Список ID грузомест, которые необходимо удалить |
Responses
Request samples
- Payload
{- "trbxIds": [
- "WB-TRBX-1234567"
]
}Response samples
- 400
- 401
- 402
- 403
- 404
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}Получить стикеры грузомест поставки{{ /api/v3/supplies/{supplyId}/trbx/stickers }}
Метод возвращает QR-стикеры в форматах:
- SVG
- ZPLV (вертикальный)
- ZPLH (горизонтальный)
- PNG
Размер стикеров — 580x400 px.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-1234567 ID поставки |
query Parameters
| type required | string Example: type=png Формат стикера |
Request Body schema: application/json
| trbxIds required | Array of strings Список ID грузомест, по которым необходимо вернуть стикеры |
Responses
Request samples
- Payload
{- "trbxIds": [
- "WB-TRBX-1234567"
]
}Response samples
- 200
- 400
- 401
- 402
- 403
- 404
- 429
{- "stickers": [
- {
- "barcode": "$WBMP:1:123:1234567",
- "file": "^XA\\n^CI28\\n^CF0\\n^LS0"
}
]
}Получить список стран ОКСМ{{ /api/marketplace/v3/fbs/dictionaries/countries/oksm }}
Метод возвращает список стран ОКСМ — Общероссийского классификатора стран мира — с полными названиями и кодами.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
Responses
Response samples
- 200
- 401
- 402
- 403
- 429
{- "countries": [
- {
- "code": "036",
- "name": "Австралия"
}
]
}Добавить данные СПОТ в поставку{{ /api/marketplace/v3/fbs/supplies/{supplyId}/spot }}
Метод добавляет данные СПОТ в поставку.
СПОТ можно добавить только в поставку с признаком "spotAvailable":true.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-123456789 ID поставки |
Request Body schema: application/jsonrequired
| carrierName required | string [ 1 .. 1000 ] characters Наименование перевозчика |
| carrierTaxNumber required | string [ 1 .. 50 ] characters ИНН перевозчика |
| carrierCountryCode required | string = 3 characters Код страны перевозчика по ОКСМ |
| vehicleRegistrationNumber required | string [ 1 .. 30 ] characters Регистрационный номер транспортного средства |
| trailerRegistrationNumber | string [ 1 .. 30 ] characters Регистрационный номер прицепа |
Responses
Request samples
- Payload
{- "carrierName": "ООО СПОТ",
- "carrierTaxNumber": "7588179007",
- "carrierCountryCode": "112",
- "vehicleRegistrationNumber": "А123АА100",
- "trailerRegistrationNumber": "АА000100"
}Response samples
- 400
- 401
- 402
- 403
- 404
- 409
- 429
{- "detail": "Not Found",
- "title": "NotFound"
}Получить данные СПОТ для списка поставок{{ /api/marketplace/v3/fbs/supplies/spot/list }}
Метод возвращает данные СПОТ для списка поставок.
Вы можете получить данные СПОТ, только если выполняются все условия:
- поставка находится на этапе доставки
- продавец зарегистрирован в любой стране ЕАЭС кроме РФ
- склад назначения находится в РФ
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
Request Body schema: application/jsonrequired
| supplyIds required | Array of strings [ 1 .. 100 ] characters Список ID поставок |
Responses
Request samples
- Payload
{- "supplyIds": [
- "WB-GI-123456789"
]
}Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "supplies": [
- {
- "id": "WB-GI-0000001",
- "spot": {
- "carrierTaxNumber": "7588179007",
- "carrierName": "ООО СПОТ",
- "carrierCountryCode": "112",
- "vehicleRegistrationNumber": "А123АА100",
- "trailerRegistrationNumber": "АА000100",
- "status": "completed"
}
}, - {
- "id": "WB-GI-0000002",
- "spot": {
- "carrierTaxNumber": "7588179007",
- "carrierName": "ООО СПОТ",
- "carrierCountryCode": "112",
- "vehicleRegistrationNumber": "А123АА100",
- "trailerRegistrationNumber": "АА000100",
- "status": "failed",
- "errorCode": "doppFailed"
}
}, - {
- "id": "WB-GI-0000003",
- "error": {
- "title": "NotFound",
- "detail": "Not Found"
}
}, - {
- "id": "WB-GI-0000004",
- "error": {
- "title": "SpotActionNotAllowed",
- "detail": "Spot Action Not Allowed"
}
}
]
}Получить QR-код СПОТ{{ /api/marketplace/v3/fbs/supplies/{supplyId}/stickers/spot }}
Метод возвращает сформированный QR-код СПОТ для поставки в формате PNG, кодировка base64.
Вы можете получить QR-код, когда в методе получения данных СПОТ будет признак "status":"completed".
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
path Parameters
| supplyId required | string Example: WB-GI-123456789 ID поставки |
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 404
- 429
{- "qrCode": "U3dhZ2dlciByb2Nrcw=="
}С помощью методов этого раздела вы можете:
Получить список складов, для которых требуется пропуск{{ /api/v3/passes/offices }}
Метод возвращает список складов для привязки к пропуску продавца.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Responses
Response samples
- 200
- 401
- 402
- 403
- 429
[- {
- "name": "Коледино",
- "address": "г. Подольск, д. Коледино, ул. Троицкая",
- "id": 1
}
]Получить список пропусков{{ /api/v3/passes }}
Метод возвращает список всех созданных пропусков продавца.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Responses
Response samples
- 200
- 401
- 402
- 403
- 429
[- {
- "firstName": "Александр",
- "dateEnd": "2022-07-31 17:53:13+00:00",
- "lastName": "Петров",
- "carModel": "Lamborghini",
- "carNumber": "A456BC123",
- "officeName": "Коледино",
- "officeAddress": "г. Подольск, д. Коледино, ул. Троицкая",
- "officeId": 15,
- "id": 1
}
]Создать пропуск{{ /api/v3/passes }}
Метод создаёт пропуск продавца с привязкой к складу WB.
Пропуск действует 48 часов со времени создания.
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
Request Body schema: application/jsonrequired
Общая длина ФИО ограничена от 6 до 100 символов. В номере машины могут быть только буквы и цифры
| firstName required | string non-empty Имя водителя |
| lastName required | string non-empty Фамилия водителя |
| carModel required | string [ 1 .. 100 ] characters Марка машины |
| carNumber required | string [ 6 .. 9 ] characters Номер машины |
| officeId required | integer <int64> >= 1 ID склада |
Responses
Request samples
- Payload
{- "firstName": "Александр",
- "lastName": "Петров",
- "carModel": "Lamborghini",
- "carNumber": "A456BC123",
- "officeId": 15
}Response samples
- 201
- 400
- 401
- 402
- 403
- 404
- 429
{- "id": 2
}Обновить пропуск{{ /api/v3/passes/{passId} }}
Метод обновляет данные пропуска продавца. В том числе, можно обновить данные привязанного склада WB.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| passId required | integer <int64> Example: 45 ID пропуска |
Request Body schema: application/jsonrequired
Общая длина ФИО ограничена от 6 до 100 символов. В номере машины могут быть только буквы и цифры.
| firstName required | string non-empty Имя водителя |
| lastName required | string >= 6 characters Фамилия водителя |
| carModel required | string [ 1 .. 100 ] characters Марка машины |
| carNumber required | string [ 6 .. 9 ] characters Номер машины |
| officeId required | integer <int64> >= 1 ID склада |
Responses
Request samples
- Payload
{- "firstName": "Александр",
- "lastName": "Петров",
- "carModel": "Lamborghini",
- "carNumber": "A456BC123",
- "officeId": 15
}Response samples
- 400
- 401
- 402
- 403
- 404
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}Удалить пропуск{{ /api/v3/passes/{passId} }}
Метод удаляет пропуск продавца из списка.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов.
В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.
Authorizations:
path Parameters
| passId required | integer <int64> Example: 45 ID пропуска |
Responses
Response samples
- 401
- 402
- 403
- 404
- 429
{- "title": "unauthorized",
- "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
- "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
- "requestId": "7b80742415072fe8b6b7f7761f1d1211",
- "origin": "ag-marketplace",
- "status": 401,
- "statusText": "Unauthorized",
- "timestamp": "2024-09-30T06:52:38Z"
}С помощью методов этого раздела вы можете управлять настройками автовозврата малогабаритных товаров:
- получить и обновить настройки автовозврата продавца
- получить и обновить настройки автовозврата товара
- получить список предметов, которые не хранятся на складах WB
Получить настройки автовозврата продавца{{ /api/marketplace/v3/fbs/settings/autoreturns }}
Метод возвращает информацию о настройках автовозврата, установленных продавцом.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
Responses
Response samples
- 200
- 401
- 402
- 403
- 406
- 429
{- "type": "allToWarehouse"
}Обновить настройки автовозврата продавца{{ /api/marketplace/v3/fbs/settings/autoreturns }}
Метод устанавливает настройки автовозврата продавца для малогабаритных товаров — "cargoType":1.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
Request Body schema: application/json
| type required | string Enum: allToWarehouse allToPickupPoint manual Тип автовозврата малогабаритных товаров:
|
Responses
Request samples
- Payload
{- "type": "allToWarehouse"
}Response samples
- 400
- 401
- 402
- 403
- 429
{- "detail": "Not Found",
- "title": "NotFound"
}Получить настройки автовозврата товаров{{ /api/marketplace/v3/fbs/settings/autoreturns/items }}
Метод возвращает настройки автовозврата товаров.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
Request Body schema: application/json
| chrtIds required | Array of integers <uint64> [ 1 .. 1000 ] items [ items <uint64 > ] Список ID размеров товаров в системе WB |
Responses
Request samples
- Payload
{- "chrtIds": [
- 111111,
- 222222
]
}Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "results": [
- {
- "success": true,
- "chrtId": 111111,
- "type": "byWarehouse",
- "changeable": true
}, - {
- "error": [
- {
- "code": 404,
- "detail": "NotFound"
}
], - "chrtId": 222222
}
]
}Обновить настройки автовозврата товаров{{ /api/marketplace/v3/fbs/settings/autoreturns/items }}
Метод устанавливает настройки автовозврата малогабаритных товаров — "cargoType":1.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
Request Body schema: application/json
| chrtIds required | Array of integers <uint64> <= 1000 items [ items <uint64 > ] Список ID размеров товаров в системе WB |
| type required | string Enum: byWarehouse byPickupPoint Тип автовозврата малогабаритных товаров:
|
Responses
Request samples
- Payload
{- "chrtIds": [
- 111111,
- 222222
], - "type": "byWarehouse"
}Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "results": [
- {
- "success": true,
- "chrtId": 111111
}, - {
- "error": [
- {
- "code": 404,
- "detail": "Not Found"
}
], - "chrtId": 222222
}
]
}Получить предметы, которые не хранятся на складах WB{{ /api/marketplace/v3/fbs/settings/autoreturns/subcategories/restricted }}
Метод возвращает список ID предметов, товары которых не могут храниться на складах WB и будут возвращены в ПВЗ автоматически.
| Период | Лимит | Интервал | Всплеск |
|---|---|---|---|
| 1 мин | 300 запросов | 200 мс | 20 запросов |
Один запрос с кодами ответов 4XX учитывается как 10 запросов
Authorizations:
query Parameters
| next required | integer <int64> Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен |
| limit required | integer <int32> [ 100 .. 1000 ] Example: limit=1000 Количество предметов в ответе |
Responses
Response samples
- 200
- 400
- 401
- 402
- 403
- 429
{- "next": 300,
- "data": [
- {
- "subjectId": 406
}, - {
- "subjectId": 3109
}, - {
- "subjectId": 4556
}
]
}