Поиск
API docs by Redocly

Заказы FBS (order)

Методы для работы со сборочными заданиями модели DBW (Доставка курьером WB) теперь на отдельном контуре.

В разделе заказов FBS (Fulfillment by Seller) вам доступны методы:

  1. Управления сборочными заданиями: информация о сборочных заданиях, метаданные, стикеры и так далее.
  2. Управления поставками заказов продавца на склады WB.
  3. Заказа пропусков на склады WB.
    Узнать больше о заказах FBS можно в справочном центре

Заказы FBS

Методы для работы со сборочными заданиями модели DBW (Доставка курьером WB) теперь на отдельном контуре.

В разделе заказов FBS (Fulfillment by Seller) вам доступны методы:

  1. Управления сборочными заданиями: информация о сборочных заданиях, метаданные, стикеры и так далее.
  2. Управления поставками заказов продавца на склады WB.
  3. Заказа пропусков на склады WB.
    Узнать больше о заказах FBS можно в справочном центре

Сборочные задания FBS

Для доступа к методам используйте токен для категории Маркетплейс
Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с заказами FBS
Узнать больше о сборочных заданиях можно в справочном центре

Когда покупатель заказывает товар, у продавца появляется сборочное задание. Сборочное задание всегда содержит 1 единицу товара. Если покупатель закажет 10 единиц одного товара одной корзиной, у продавца появятся 10 сборочных заданий. Их можно сгруппировать по одинаковому orderUid.

Для работы со сборочными заданиями FBS:

  1. Получите новые сборочные задания.
  2. Создайте поставку и добавьте в неё сборочные задания.
  3. Получите стикеры сборочных заданий, распечатайте их и промаркируйте сборочные задания.
  4. Если нужно, добавьте к сборочным заданиям код маркировки, УИН, IMEI, GTIN или срок годности товара.
  5. Если поставка доставляется в пункт выдачи заказов (ПВЗ), переходите к пункту 3 инструкции. Если на склад WB, к пункту 6.
  6. Уточните, требуется ли пропуск на склад, на который поедет поставка. Если нужен, создайте пропуск.

Получить список новых сборочных заданий{{ /api/v3/orders/new }}

Описание метода

Метод возвращает список всех новых сборочных заданий, которые есть у продавца на момент запроса.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить информацию о сборочных заданиях{{ /api/v3/orders }}

Описание метода

Метод возвращает информацию о сборочных заданиях без их актуального статуса.

Можно получить данные за заданный период, максимум 30 календарных дней одним запросом.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Параметр пагинации. Устанавливает предельное количество возвращаемых данных.

next
required
integer <int64>

Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноимённого поля в ответе.

dateFrom
integer

Дата начала периода в формате Unix timestamp. По умолчанию — дата за 30 дней до запроса

dateTo
integer

Дата конца периода в формате Unix timestamp

Responses

Response samples

Content type
application/json
{
  • "next": 13833711,
  • "orders": [
    ]
}

Получить статусы сборочных заданий{{ /api/v3/orders/status }}

Описание метода

Метод возвращает статусы сборочных заданий по их ID.

supplierStatus — статус сборочного задания. Триггер его изменения — действие самого продавца.

Возможные значения supplierStatus:

Статус Описание Как перевести сборочное задание в данный статус
new Новое сборочное задание
confirm На сборке Добавить сборочное задание к поставке
complete В доставке Передать поставку в доставку
cancel Отменено продавцом Отменить сборочное задание



wbStatus — статус системы Wildberries.

Возможные значения wbStatus:

  • waiting — сборочное задание в работе
  • sorted — сборочное задание отсортировано
  • sold — заказ получен покупателем
  • canceled — отмена сборочного задания
  • canceled_by_client — покупатель отменил заказ при получении
  • declined_by_client — покупатель отменил заказ. Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборку
  • defect — отмена заказа по причине брака
  • ready_for_pickup — сборочное задание прибыло на пункт выдачи заказов (ПВЗ)
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Получить все сборочные задания для повторной отгрузки{{ /api/v3/supplies/orders/reshipment }}

Описание метода

Метод возвращает все сборочные задания, требующие повторной отгрузки.

Повторная отгрузка требуется, если поставка была отсканирована в пункте приёмки, но при этом в ней всё ещё есть неотсканированные товары. Спустя определённое время необходимо доставить эти товары заново. Данные сборочные задания можно перевести в другую активную поставку.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Отменить сборочное задание{{ /api/v3/orders/{orderId}/cancel }}

Описание метода

Метод отменяет сборочное задание и переводит в статус cancel — отменено продавцом.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 100 запросов 600 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить стикеры сборочных заданий{{ /api/v3/orders/stickers }}

Описание метода

Метод возвращает список стикеров для сборочных заданий.

Можно получить стикер в форматах:

  • SVG
  • ZPLV (вертикальный)
  • ZPLH (горизонтальный)
  • PNG

Ограничения:

  • За один запрос можно получить максимум 100 стикеров.
  • Можно получить стикеры только для сборочных заданий, находящихся на сборке — статус confirm.

Доступны размеры:

  • 580x400 px при width=58&height=40 в запросе
  • 400x300 px при width=40&height=30 в запросе
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
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

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "stickers": [
    ]
}

Получить список ссылок на стикеры сборочных заданий, которые требуются при кроссбордере{{ /api/v3/files/orders/external-stickers }}

Описание метода

Метод возвращает список ссылок на стикеры сборочных заданий, которые требуются при кроссбордере.

Ограничения:

  • За один запрос можно получить максимум 100 стикеров.
  • Можно получить стикеры только для сборочных заданий, находящихся в доставке — статус complete.
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ]

Список ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{}

История статусов для сборочных заданий кроссбордера{{ /api/v3/orders/status/history }}

Описание метода

Метод возвращает историю статусов для сборочных заданий кроссбордера.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
Array of integers [ 1 .. 100 ] items

ID сборочных заданий

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Заказы с информацией по клиенту{{ /api/v3/orders/client }}

Описание метода

Метод позволяет получать информацию о покупателе по ID сборочного задания.

Только для кроссбордера из Турции.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

Список заказов

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Метаданные FBS

Для доступа к методам используйте токен для категории Маркетплейс
Узнать больше о метаданных можно в справочном центре

С помощью этих методов вы можете получать, удалять и редактировать метаданные сборочных заданий:

Получить метаданные сборочного задания{{ /api/v3/orders/{orderId}/meta }}

Описание метода

Метод возвращает метаданные сборочного задания.

Перечень метаданных, доступных для сборочного задания, можно получить в списке новых сборочных заданий, поле requiredMeta.

Возможные метаданные:

Если в ответе не вернулись какие-либо из объектов метаданных, значит, у сборочного задания не может быть таких метаданных — и добавить их нельзя.

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Удалить метаданные сборочного задания{{ /api/v3/orders/{orderId}/meta }}

Описание метода

Метод удаляет значение метаданных сборочного задания для переданного ключа.

Возможные метаданные:

Можно передать только один ключ.

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

query Parameters
key
string

Название метаданных для удаления (imei, uin, gtin, sgtin). Передается только одно значение.

Responses

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequest",
  • "message": "Переданы некорректные данные"
}

Закрепить за сборочным заданием код маркировки товара{{ /api/v3/orders/{orderId}/meta/sgtin }}

Описание метода

Метод позволяет закрепить за сборочным заданием код маркировки Честный знак.

Закрепить код маркировки можно только если в метаданных сборочного задания есть поле sgtin, а сборочное задание находится в статусе confirm.

Получить загруженные маркировки можно в метаданных сборочного задания.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
sgtins
Array of strings [ 1 .. 24 ] items

Массив кодов маркировки. Допускается от 16 до 135 символов для кода одной маркировки.

Responses

Request samples

Content type
application/json
{
  • "sgtins": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием УИН{{ /api/v3/orders/{orderId}/meta/uin }}

Описание метода

Метод обновляет УИН в метаданных сборочного задания — уникальный идентификационный номер.

У одного сборочного задания может быть только один УИН.

Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
uin
required
string = 16 characters

УИН

Responses

Request samples

Content type
application/json
{
  • "uin": "1234567890123456"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием IMEI{{ /api/v3/orders/{orderId}/meta/imei }}

Описание метода

Метод обновляет IMEI в метаданных сборочного задания.

У одного сборочного задания может быть только один IMEI. Если у устройства два IMEI — IMEI и IMEI2 или IMEI1 и IMEI2 — укажите только IMEI или IMEI1. IMEI2 указывать не нужно.

Добавлять маркировку можно только для заказов, которые находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
imei
required
string = 15 characters

IMEI

Responses

Request samples

Content type
application/json
{
  • "imei": "123456789012345"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием GTIN{{ /api/v3/orders/{orderId}/meta/gtin }}

Описание метода

Метод обновляет GTIN в метаданных сборочного задания — уникальный ID товара в Беларуси.

У одного сборочного задания может быть только один GTIN.

Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
gtin
required
string = 13 characters

GTIN

Responses

Request samples

Content type
application/json
{
  • "gtin": "1234567890123"
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием срок годности товара{{ /api/v3/orders/{orderId}/meta/expiration }}

Описание метода

Метод закрепляет за сборочным заданием срок годности товара. Товар годен до указанной даты.
Добавить срок годности можно только для заказов, которые доставляются WB и находятся в статусе confirm.

Получить загруженные данные можно в метаданных сборочного задания. Чтобы изменить срок годности, отправьте запрос с новой датой. Удалить срок годности из метаданных сборочного задания невозможно.

Лимит запросов на один аккаунт продавца для всех методов закрепления метаданных FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Request Body schema: application/json
expiration
string <date (dd.mm.yyyy)>

Дата, до которой годен товар. Не менее 30 дней с текущей даты

Responses

Request samples

Content type
application/json
{
  • "expiration": "12.09.2030"
}

Response samples

Content type
application/json
Example

Указан срок меньше допустимого

{
  • "code": "LowExpirationDate",
  • "message": "Не удалось обновить срок годности. Указан срок меньше допустимого"
}

Поставки FBS

Для доступа к методам используйте токен для категории Маркетплейс
Узнать больше о поставках FBS можно в справочном центре

Для работы с поставками:

Пункты 3-5 обязательны к выполнению при доставке поставки на пункт выдачи заказов (ПВЗ).
  1. Создайте новую поставку. В ответ вернется ID созданной поставки в формате WB-GI-1234567.
  2. В текущую новую поставку добавьте сборочные задания, которые вы повезёте на склад или ПВЗ. После того, как сборочные задания будут добавлены к поставке, они будут переведены в статус confirm — на сборке.
  3. Добавьте короба в поставку.
  4. Проверьте список коробов.
  5. Получите стикеры коробов. Распечатайте и наклейте стикеры на короба.
  6. После того как поставка будет укомплектована нужными сборочными заданиями, необходимо передать её в доставку. Если поставка не была передана в доставку, то при сканировании её QR-кода или приёмке первого товара на ПВЗ поставка автоматически закроется. При передаче сборочных заданий в доставку они будут автоматически собраны и переведены в статус complete — в доставке.
  7. Если поставка была отсканирована в пункте приёмки, но при этом в ней всё ещё есть неотсканированные товары, спустя определённое время необходимо доставить их повторно. Проверьте все сборочные задания, требующие повторной отгрузки на данный момент. Данные сборочные задания можно перевести в другую активную поставку. Сборочное задание также будет переведено в статус confirm — на сборке.

Также вы можете:

  1. Удалить короба из поставки, но только пока поставка находится на сборке.
  2. Получить список всех сборочных заданий, добавленных к поставке.
  3. Получить информацию обо всех поставках продавца или о конкретной поставке.
  4. Удалить поставку при условии, что она активна и за ней не закреплены сборочные задания.
  5. Перемещать сборочные задания между активными поставками. Нельзя перемещать сборочное задание из уже закрытой поставки, только если оно не требует повторной отгрузки.
  6. Получить QR-код поставки в форматах SVG, ZPL или PNG. Доступно только после передачи поставки в доставку.

Создать новую поставку{{ /api/v3/supplies }}

Описание метода

Метод создаёт новую поставку.

Ограничения:

  • Только для сборочных заданий по модели FBS.
  • При добавлении в поставку все передаваемые сборочные задания в статусе new будут автоматически переведены в статус confirm — на сборке.
  • Если вы переведёте сборочное задание в статус cancel — отмена продавцом, прикрепленное сборочное задание автоматически удалится из поставки.
  • Поставку можно собрать только из сборочных заданий (заказов) одного габаритного типа cargoType. Новая поставка не обладает габаритным признаком, она приобретает габаритный признак первого заказа, добавленного в поставку.
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
name
string [ 1 .. 128 ] characters

Наименование поставки

Responses

Request samples

Content type
application/json
{
  • "name": "Тестовая поставка"
}

Response samples

Content type
application/json
{
  • "id": "WB-GI-1234567"
}

Получить список поставок{{ /api/v3/supplies }}

Описание метода

Метод возвращает список поставок.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

Параметр пагинации. Устанавливает предельное количество возвращаемых данных.

next
required
integer <int64>

Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноимённого поля в ответе.

Responses

Response samples

Content type
application/json
{
  • "next": 13833711,
  • "supplies": [
    ]
}

Добавить сборочное задание к поставке{{ /api/v3/supplies/{supplyId}/orders/{orderId} }}

Описание метода

Метод добавляет сборочное задание к поставке и переводит его в статус confirm — на сборке.

Может перемещать сборочное задание:

  • между активными поставками.
  • из закрытой поставки в активную, если сборочное задание требует повторной отгрузки.
В пустую поставку можно добавить сборочное задание любого габаритного типа. Поставка приобретает габаритный тип первого добавленного сборочного задания из поля cargoType.
После этого в поставку можно добавить сборочные задания только того же габаритного типа, что и у поставки.
Нельзя добавлять в поставку сборочные задания поступившие на разные склады.
Лимит запросов на один аккаунт продавца для метода добавления сборочных заданий к поставке FBS:
Период Лимит Интервал Всплеск
1 минута 1000 запросов 60 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

orderId
required
integer <int64>
Example: 5632423

ID сборочного задания

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить информацию о поставке{{ /api/v3/supplies/{supplyId} }}

Описание метода

Метод возвращает подробную информацию о поставке.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "id": "WB-GI-1234567",
  • "done": true,
  • "createdAt": "2022-05-04T07:56:29Z",
  • "closedAt": "2022-05-04T07:56:29Z",
  • "scanDt": "2022-05-04T07:56:29Z",
  • "name": "Тестовая поставка",
  • "cargoType": 0,
  • "destinationOfficeId": 123
}

Удалить поставку{{ /api/v3/supplies/{supplyId} }}

Описание метода

Метод удаляет поставку, если она активна и за ней не закреплено ни одно сборочное задание.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить сборочные задания в поставке{{ /api/v3/supplies/{supplyId}/orders }}

Описание метода

Метод возвращает сборочные задания, закреплённые за поставкой.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ]
}

Передать поставку в доставку{{ /api/v3/supplies/{supplyId}/deliver }}

Описание метода

Метод закрывает поставку и переводит все сборочные задания в ней в статус complete — в доставке. После закрытия поставки добавить новые сборочные задания к ней нельзя.

Если поставка не была передана в доставку, то при приёмке первого товара поставка автоматически закроется.

Передать поставку в доставку можно только если в ней:

  • есть хотя бы одно сборочное задания
  • отсутствуют пустые короба
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить QR-код поставки{{ /api/v3/supplies/{supplyId}/barcode }}

Описание метода

Метод возвращает QR-код поставки в форматах:

  • SVG
  • ZPLV (вертикальный)
  • ZPLH (горизонтальный)
  • PNG

QR-код поставки можно получить только если поставка передана в доставку.

Размер — 580x400 px.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Тип стикера

Responses

Response samples

Content type
application/json
{
  • "barcode": "WB-GI-12345678",
  • "file": "U3dhZ2dlciByb2Nrcw=="
}

Получить список коробов поставки{{ /api/v3/supplies/{supplyId}/trbx }}

Описание метода

Возвращает список коробов поставки.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Responses

Response samples

Content type
application/json
{
  • "trbxes": [
    ]
}

Добавить короба к поставке{{ /api/v3/supplies/{supplyId}/trbx }}

Описание метода

Метод добавляет требуемое количество коробов в поставку.

Короба необходимо добавлять только в поставки, отгружаемые на ПВЗ.
Можно добавить только пока поставка на сборке.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Request Body schema: application/json
amount
required
integer [ 1 .. 1000 ]

Количество коробов, которые необходимо добавить к поставке.

Responses

Request samples

Content type
application/json
{
  • "amount": 4
}

Response samples

Content type
application/json
{
  • "trbxIds": [
    ]
}

Удалить короба из поставки{{ /api/v3/supplies/{supplyId}/trbx }}

Описание метода

Метод даляет короба из поставки.

Можно удалить только пока поставка на сборке.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

Request Body schema: application/json
trbxIds
required
Array of strings

Список ID коробов, которые необходимо удалить.

Responses

Request samples

Content type
application/json
{
  • "trbxIds": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "IncorrectParameter",
  • "message": "Передан некорректный параметр"
}

Получить стикеры коробов поставки{{ /api/v3/supplies/{supplyId}/trbx/stickers }}

Описание метода

Метод возвращает QR-стикеры в форматах:

  • SVG
  • ZPLV (вертикальный)
  • ZPLH (горизонтальный)
  • PNG

    Размер стикеров — 580x400 px.
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

query Parameters
type
required
string
Enum: "svg" "zplv" "zplh" "png"

Тип стикера

Request Body schema: application/json
trbxIds
required
Array of strings

Список ID коробов, по которым необходимо вернуть стикеры.

Responses

Request samples

Content type
application/json
{
  • "trbxIds": [
    ]
}

Response samples

Content type
application/json
{
  • "stickers": [
    ]
}

Пропуска FBS

Для доступа к методам используйте токен для категории Маркетплейс

Через эти методы вы можете:

  1. Получать список складов WB, для которых требуется пропуск.
  2. Получать список пропусков.
  3. Создавать новые пропуска.
  4. Обновлять пропуска.
  5. Удалять пропуска.

Получить список складов, для которых требуется пропуск{{ /api/v3/passes/offices }}

Описание метода

Метод возвращает список складов для привязки к пропуску продавца.

Данные, которые возвращает метод, могут меняться. Рекомендуем периодически синхронизировать список
Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получить список пропусков{{ /api/v3/passes }}

Описание метода

Метод возвращает список всех созданных пропусков продавца.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Создать пропуск{{ /api/v3/passes }}

Описание метода

Метод создаёт пропуск продавца с привязкой к складу WB.

Пропуск действует 48 часов со времени создания.

Максимум 1 запрос в 10 минут на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required

Общая длина ФИО ограничена от 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

Content type
application/json
{
  • "firstName": "Александр",
  • "lastName": "Петров",
  • "carModel": "Lamborghini",
  • "carNumber": "A456BC123",
  • "officeId": 15
}

Response samples

Content type
application/json
{
  • "id": 2
}

Обновить пропуск{{ /api/v3/passes/{passId} }}

Описание метода

Метод обновляет данные пропуска продавца. В том числе, можно обновить данные привязанного склада WB.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
passId
required
integer <int64>
Example: 45

ID пропуска

Request Body schema: application/json
required

Общая длина ФИО ограничена от 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

Content type
application/json
{
  • "firstName": "Александр",
  • "lastName": "Петров",
  • "carModel": "Lamborghini",
  • "carNumber": "A456BC123",
  • "officeId": 15
}

Response samples

Content type
application/json
Example
{
  • "code": "IncorrectRequestBody",
  • "message": "Некорректное тело запроса"
}

Удалить пропуск{{ /api/v3/passes/{passId} }}

Описание метода

Метод удаляет пропуск продавца из списка.

Лимит запросов на один аккаунт продавца для методов сборочных заданий, поставок и пропусков FBS:
Период Лимит Интервал Всплеск
1 минута 300 запросов 200 миллисекунд 20 запросов

Один запрос с кодом ответа 409 учитывается как 5 запросов

Authorizations:
HeaderApiKey
path Parameters
passId
required
integer <int64>
Example: 45

ID пропуска

Responses

Response samples

Content type
application/json
{
  • "title": "string",
  • "detail": "string",
  • "code": "string",
  • "requestId": "string",
  • "origin": "string",
  • "status": 0,
  • "statusText": "string",
  • "timestamp": "string"
}