API docs by Redocly

Заказы FBS (order)

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

Заказы FBS

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

Склады

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

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

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

Возвращает список всех складов WB для привязки к складам продавца

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получить список складов продавца{{ /api/v3/warehouses }}

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

Возвращает список всех складов продавца

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Создать склад продавца{{ /api/v3/warehouses }}

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

Создает склад продавца.

Нельзя привязывать склад WB, который уже используется

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Имя склада продавца

officeId
required
integer >= 1

ID склада WB

Responses

Request samples

Content type
application/json
{
  • "name": "Склад Коледино",
  • "officeId": 15
}

Response samples

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

Обновить склад{{ /api/v3/warehouses/{warehouseId} }}

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

Обновляет склад продавца.

Изменить выбранный склад WB можно раз в сутки. Нельзя привязывать склад WB, который уже используется

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Request Body schema: application/json
required
name
required
string [ 1 .. 200 ] characters

Имя склада продавца

officeId
required
integer >= 1

ID склада WB

Responses

Request samples

Content type
application/json
{
  • "name": "Склад Коледино",
  • "officeId": 15
}

Response samples

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

Удалить склад продавца{{ /api/v3/warehouses/{warehouseId} }}

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

Удаляет склад продавца

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Responses

Response samples

Content type
application/json
{
  • "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": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

Пропуска

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

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

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

Возвращает список складов для привязки к пропуску продавца. Данные, которые возвращает метод, могут меняться. Рекомендуем периодически синхронизировать список

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Возвращает список всех пропусков продавца

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Создает пропуск продавца. Пропуск действует 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} }}

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

Обновляет данные пропуска продавца

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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} }}

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

Удаляет пропуск продавца

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
passId
required
integer <int64>
Example: 45

ID пропуска

Responses

Response samples

Content type
application/json
{
  • "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": "s2s-api-auth-catalog",
  • "status": 401,
  • "statusText": "Unauthorized",
  • "timestamp": "2024-09-30T06:52:38Z"
}

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

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

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

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

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

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

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 На сборке
Для доставки силами Wildberries fbs и силами продавца dbs		 Для fbs — добавить сборочное задание к поставке
Для dbs — перевести сборочное задание на сборку
complete В доставке
Для доставки силами Wildberries fbs и курьером WB wbgo		 Для fbs — передать поставку в доставку
Для wbgo — перевести сборочное задание в доставку
cancel Отменено продавцом Отменить сборочное задание
cancel_missed_call Отмена заказа по причине недозвона.
Для доставки силами продавца dbs		 Статус меняется автоматически
deliver В доставке
Для доставки силами продавца dbs		 Перевести сборочное задание в доставку
receive Получено клиентом
Для доставки силами продавца dbs и курьером WB wbgo		 Для dbs — сообщить, что сборочное задание принято клиентом
Для wbgo статус меняется автоматически
reject Отказ клиента при получении
Для доставки силами продавца dbs и курьером WB wbgo		 Для dbs — сообщить, что клиент отказался от сборочного задания
Для wbgo статус меняется автоматически

wbStatus — статус сборочного задания в системе WB.

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

  • waiting — сборочное задание в работе
  • sorted — сборочное задание отсортировано
  • sold — сборочное задание получено покупателем
  • canceled — отмена сборочного задания
  • canceled_by_client — покупатель отменил заказ при получении
  • declined_by_client — покупатель отменил заказ. Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборку
  • defect — отмена сборочного задания по причине брака
  • ready_for_pickup — сборочное задание прибыло на пункт выдачи заказов (ПВЗ)
  • canceled_by_missed_call — отмена заказа по причине недозвона. Для схемы Доставка силами продавца dbs
  • postponed_delivery — курьерская доставка отложена
Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 }}

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey

Responses

Response samples

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

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

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

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

Responses

Response samples

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

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

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

Метод позволяет закрепить за сборочным заданием контрольный идентификационный знак (КиЗ) — маркировку Честного знака.

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

Получить загруженные КиЗ можно через метод получения метаданных сборочного задания

Максимум 1 000 запросов в минуту суммарно на один аккаунт продавца:
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием КиЗ (маркировку Честного знака)
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/stickers }}

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

Возвращает список этикеток по массиву сборочных заданий.

Можно получить этикетку в форматах SVG, ZPLV (вертикальный), ZPLH (горизонтальный), PNG.

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

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

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

  • 580x400 px, при параметрах "width": 58, "height": 40
  • 400x300 px, при параметрах "width": 40, "height": 30
Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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/orders/{orderId}/meta }}

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

Возвращает метаданные заказа, доступные для сборочного задания. Возможные метаданные: imei, uin, gtin, sgtin. Если ответ вернулся с пустой структурой meta, значит у сборочного задания нет метаданных и их добавление недоступно.

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

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

Responses

Response samples

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

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

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

Удаляет значение метаданных заказа для переданного ключа. Возможные метаданные: imei, uin, gtin, sgtin. Можно передать только одно значение

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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/uin }}

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

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

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

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

Максимум 1 000 запросов в минуту суммарно на один аккаунт продавца:
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием КиЗ (маркировку Честного знака)
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.

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

Максимум 1 000 запросов в минуту суммарно на один аккаунт продавца:
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием КиЗ (маркировку Честного знака)
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

Максимум 1 000 запросов в минуту суммарно на один аккаунт продавца:
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием КиЗ (маркировку Честного знака)
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/files/orders/external-stickers }}

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

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

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

  • Нельзя запросить больше 100 этикеток за раз — максимум 100 ID сборочных заданий в запросе
  • Метод возвращает этикетки только для сборочных заданий, находящихся в доставке — в статусе complete
Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 }}

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 заказа.

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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
Example
{
  • "orders": [
    ]
}

Поставки FBS

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

Порядок работы:

Пункты 3-8 обязательны к выполнению при доставке поставки на пункт выдачи заказов (ПВЗ).
  1. Создайте новую поставку. В ответ вернется ID созданной поставки в формате WB-GI-1234567.
  2. В текущую новую поставку нужно добавить сборочные задания, которые вы повезёте на склад или ПВЗ. При добавлении сборочных заданий к поставке они будут переведены в статус confirm — на сборке.
  3. В поставке создайте короб
  4. Добавьте заказы в короб
  5. Проверьте список коробов с заказами
  6. Получите стикеры коробов, распечатайте и наклейте стикеры на короба согласно распределённым в них заказам.
  7. Вы можете удалить короба из поставки, но только пока поставка находится на сборке.
  8. Вы можете удалить заказы из короба, но только пока поставка находится на сборке.
  9. После того как поставка будет укомплектована нужными сборочными заданиями, необходимо передать её в доставку. Если поставка не была передана в доставку, то при сканировании её штрихкода или приёмке первого товара на ПВЗ поставка автоматически закроется. При передаче сборочных заданий в доставку они будут автоматически собраны и переведены в статус complete — в доставке.
  10. Можно получить список всех сборочных заданий, добавленных к поставке.
  11. Можно получить информацию обо всех поставках продавца или о конкретной поставке
  12. Можно удалить поставку при условии, что она активна и за ней не закреплены сборочные задания.
  13. Если поставка была отсканирована в пункте приёмки, но при этом в ней имеются ещё неотсканированные товары, спустя определённое время необходимо доставить их повторно. Проверьте все сборочные задания, требующие повторной отгрузки на данный момент. Данные сборочные задания можно перевести в другую активную поставку. Сборочное задание также будет переведено в статус confirm — на сборке.
  14. Также можно перемещать сборочные задания между активными поставками. Нельзя перемещать сборочное задание из уже закрытой поставки, только если оно не требует повторной отгрузки.
  15. QR-код поставки можно получить в форматах SVG, ZPL или PNG. Доступно только после передачи поставки в доставку.

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

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

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

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

  • Только для сборочных заданий по схеме Везу на склад WB
  • При добавлении в поставку все передаваемые сборочные задания в статусе new — новое — будут автоматически переведены в статус confirm — на сборке
  • Если вы переведёте сборочное задание в статус cancel — отмена продавцом, прикрепленное сборочное задание автоматически удалится из поставки
  • Поставку можно собрать только из сборочных заданий (заказов) одного габаритного типа cargoType. Новая поставка не обладает габаритным признаком. При добавлении первого заказа в поставку она приобретает габаритный признак этого заказа.
Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 }}

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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.
После этого добавить можно задания только того же габаритного типа, что и у поставки.
Максимум 1 000 запросов в минуту на один аккаунт продавца
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} }}

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

Возвращает информацию о поставке

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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
}

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

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 }}

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 — в доставке. После закрытия поставки добавить новые сборочные задания к ней нельзя.

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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.

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

Размер — 580x400 px

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 }}

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

Возвращает список коробов и ID заказов, входящих в эти короба

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 }}

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

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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 }}

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

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

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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/{trbxId} }}

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

Добавляет заказы в короб для выбранной поставки.

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

trbxId
required
string
Example: WB-TRBX-1234567

ID короба

Request Body schema: application/json
orderIds
required
Array of integers

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

Responses

Request samples

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

Response samples

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

Удалить заказ из короба{{ /api/v3/supplies/{supplyId}/trbx/{trbxId}/orders/{orderId} }}

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

Удаляет заказ из короба выбранной поставки.

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

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

trbxId
required
string
Example: WB-TRBX-1234567

ID короба

orderId
required
integer <int64>
Example: 5632423

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

Responses

Response samples

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

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

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

Возвращает QR-стикеры в форматах SVG, ZPLV (вертикальный), ZPLH (горизонтальный), PNG.

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

Размер стикеров — 580x400 px

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
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": [
    ]
}

Доставка силами продавца (DBS)

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

Порядок работы:

  1. Получаем новое сборочное задание с "deliveryType": "dbs"
  2. Переводим его на сборку
  3. Переводим в доставку
  4. После перевода на сборку для заказа становится доступной информация по клиенту (имя, телефон)
  5. После доставки задания клиенту вам необходимо сообщить на наш сервер, что сборочное задание принято клиентом или, что клиент отказался от сборочного задания

Перевести на сборку{{ /api/v3/orders/{orderId}/confirm }}

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

Переводит сборочное задание в статус confirm — на сборке

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

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

Responses

Response samples

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

Перевести в доставку{{ /api/v3/orders/{orderId}/deliver }}

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

Переводит сборочное задание в статус deliver — в доставке

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

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

Responses

Response samples

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

Сообщить, что сборочное задание принято клиентом{{ /api/v3/orders/{orderId}/receive }}

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

Переводит сборочное задание в статус receive — получено клиентом

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

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

Request Body schema: application/json
required
code
string

Код клиентской доставки

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

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

Сообщить, что клиент отказался от сборочного задания{{ /api/v3/orders/{orderId}/reject }}

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

Перевести в статус reject — отказ при получении

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

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

Request Body schema: application/json
required
code
string

Код клиентской доставки

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

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

Доставка курьером WB (WBGO)

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

Порядок работы:

  1. Получаем новое сборочное задание с "deliveryType": "wbgo"
  2. Переводим его на сборку
  3. Получаем и распечатываем этикетки
  4. Переводим в доставку
  5. Ожидаем курьера
  6. Курьер забирает заказ и отвозит его клиенту
  7. Клиент принимает заказ или отказывается от него
  8. Если клиент принимает заказ, задание автоматически переводится в статус receive. Если отказывается — в reject

Перевести на сборку{{ /api/v3/orders/{orderId}/confirm }}

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

Переводит сборочное задание в статус confirm — на сборке

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

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

Responses

Response samples

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

Перевести в доставку{{ /api/v3/orders/{orderId}/assemble }}

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

Переводит сборочное задание в статус complete — в доставке

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer <int64>
Example: 5632423

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

Responses

Response samples

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

Список контактов{{ /api/v3/warehouses/{warehouseId}/contacts }}

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

Возвращает список контактов, привязанных к складу продавца

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Обновить список контактов{{ /api/v3/warehouses/{warehouseId}/contacts }}

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

Обновляет список контактов склада продавца.

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

Только для складов с типом доставки 3 — курьером WB.

К складу можно добавить максимум 5 контактов.
Чтобы удалить контакты, отправьте пустой массив contacts

Максимум 300 запросов в минуту для всех методов категории Маркетплейс на один аккаунт продавца
Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

ID склада продавца

Request Body schema: application/json
required
Array of objects <= 5 items

Responses

Request samples

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

Response samples

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