Описание API Marketplace

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

Публичный API Marketplace создано для синхронизации данных между серверами Wildberries и серверами продавцов.
Вы загружаете данные на свои носители, работаете с ними на своих мощностях и синхронизируетесь с нашими серверами по мере необходимости.

Ограничения по запросам:
Метод PATCH api/v3/supplies/{supplyId}/orders/{orderId} "Добавить сборочное задание к поставке" - 1 000 запросов в минуту.
Методы
PUT /api/v3/orders/{orderId}/meta/uin "Закрепить за сборочным заданием УИН"
PUT /api/v3/orders/{orderId}/meta/imei "Закрепить за сборочным заданием IMEI"
PUT /api/v3/orders/{orderId}/meta/gtin "Закрепить за сборочным заданием GTIN"
PUT /api/v3/orders/{orderId}/meta/sgtin "Закрепить за сборочным заданием КиЗ (маркировку Честного знака)"
- суммарно 1 000 запросов в минуту.
Остальные методы - 300 запросов в минуту, в целом.
Не допускается использование API Marketplace в качестве внешней базы данных.

Словарь сокращений:
ПВЗ - пункт выдачи заказов
КИЗ - контрольный идентификационный знак
ИС "МДЛП" - информационная система мониторинга движения лекарственных препаратов
СЦ - сортировочный центр

Описание основных ошибок в Marketplace:

Код Описание
StatusNotAcceptable Обновление остатков заблокировано в связи с баном поставщика
UinIsNotFilled Перевод в статус 'в доставке' невозможен. Введите УИНы для всех сборочных заданий, где это необходимо.
InternalServerError Внутренняя ошибка сервера
Unauthorized Пользователь не авторизован
AccessDenied Доступ запрещён
IncorrectRequestBody Некорректное тело запроса
IncorrectRequest Переданы некорректные данные
NotFound Не найдено
UploadDataLimit Превышен лимит загружаемых данных
SubjectDBSRestriction Категория товара недоступна для продажи по схеме 'Везу на склад Wildberries'
SubjectFBSRestriction Категория товара недоступна для продажи по схеме 'Везу самостоятельно до покупателя'
CargoWarehouseRestriction Выбранный склад не предназначен для крупногабаритных товаров. Добавьте их на соответствующий склад
IncorrectParameter Передан некорректный параметр
SupplyHasOrders Не удалось обработать поставку. Убедитесь, что за ней не осталось закреплённых сборочных заданий
SupplyHasZeroOrders Не удалось обработать поставку. Убедитесь, что за ней закреплено хотя бы одно сборочное задание
SupplyHasEmptyTrbx В поставке есть пустые короба. Удалите их или вернитесь к распределению товаров
FailedToAddSupplyOrder Не удалось закрепить сборочное задание за поставкой. Убедитесь, что сборочное задание и поставка удовлетворяют всем необходимым требованиям
StatusChangeNotAllowed Задание перейдёт в завершенные после сканирования на ПВЗ
StatusMismatch Несоответствие статусов, проверьте их правильность
SupplyNotClosed Поставка не передана в доставку
PassValidationError *причина*
SupplierBanned Пользователь заблокирован: *причина*

Получить список новых сборочных заданий

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

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array of objects (OrderNew)

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

Response samples

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

Получить информацию по сборочным заданиям

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

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 Schema: application/json
next
integer <int64> (Next)

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

Array of objects (Order)

Response samples

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

Получить статусы сборочных заданий

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

supplierStatus - статус сборочного задания, триггером изменения которого является сам продавец.
Возможны следующие значения данного поля:

Статус Описание Как перевести сборочное задание в данный статус
new Новое сборочное задание
confirm На сборке При добавлении сборочного задания к поставке PATCH /api/v3/supplies/{supplyId}/orders/{orderId}
complete В доставке При переводе в доставку соответствующей поставки PATCH /api/v3/supplies/{supplyId}/deliver
cancel Отменено продавцом PATCH /api/v3/orders/{orderId}/cancel
cancel_missed_call Отмена заказа по причине недозвона.

Для схемы "Доставка силами продавца (DBS)"
Статус меняется автоматически

wbStatus - статус сборочного задания в системе Wildberries.
Возможны следующие значения данного поля:

  • waiting - сборочное задание в работе
  • sorted - сборочное задание отсортировано
  • sold - сборочное задание получено покупателем
  • canceled - отмена сборочного задания
  • canceled_by_client - покупатель отменил заказ при получении
  • declined_by_client - покупатель отменил заказ в первый чаc
    Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборку
  • defect - отмена сборочного задания по причине брака
  • ready_for_pickup - сборочное задание прибыло на ПВЗ
  • canceled_by_missed_call - отмена заказа по причине недозвона. Для схемы "Доставка силами продавца (DBS)"
Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
required
Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

Список идентификаторов сборочных заданий

Responses

Response Schema: application/json
Array of objects

Request samples

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

Response samples

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

Получить все сборочные задания на повторную отгрузку

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

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array of objects

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

Response samples

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

Отменить сборочное задание

Переводит сборочное задание в статус cancel ("Отменено продавцом").

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

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

Responses

Response samples

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

Закрепить за сборочным заданием КиЗ (маркировку Честного знака)

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

Получить загруженные КиЗ можно методом Получить метаданные сборочного задания
С правилами работы с КиЗ можно ознакомиться тут: https://честныйзнак.рф

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": "Некорректное тело запроса"
}

Получить этикетки для сборочных заданий

Возвращает список этикеток по переданному массиву сборочных заданий. Можно запросить этикетку в формате svg, zplv (вертикальный), zplh (горизонтальный), png.

Ограничения при работе с методом:

  • Нельзя запросить больше 100 этикеток за раз (не более 100 идентификаторов сборочных заданий в запросе).
  • Метод возвращает этикетки только для сборочных заданий, находящихся на сборке (в статусе confirm).
  • Доступные размеры:
    580x400 пикселей, при параметрах width = 58, height = 40
    400x300 пикселей, при параметрах width = 40, height = 30
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 > ]

Массив идентификаторов сборочных заданий

Responses

Response Schema: application/json
Array of objects

Request samples

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

Response samples

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

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

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

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

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

Responses

Response Schema: application/json
object (Meta)

Метаданные заказа

Response samples

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

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

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

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": "Переданы некорректные данные"
}

Закрепить за сборочным заданием УИН (уникальный идентификационный номер)

Обновляет УИН сборочного задания. У одного сборочного задания может быть только один УИН. Добавлять маркировку можно только для заказов в статусе confirm и доставка которых осуществляется силами Wildberries.

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

Обновляет IMEI сборочного задания. У одного сборочного задания может быть только один IMEI. Добавлять маркировку можно только для заказов в статусе confirm и доставка которых осуществляется силами Wildberries.

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

Обновляет GTIN (уникальный идентификатор товара в Беларуси) сборочного задания. У одного сборочного задания может быть только один GTIN. Добавлять маркировку можно только для заказов в статусе confirm и доставка которых осуществляется силами Wildberries.

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": "Некорректное тело запроса"
}

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

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

Ограничения при работе с методом:

  • Нельзя запросить больше 100 этикеток за раз (не более 100 идентификаторов сборочных заданий в запросе).
  • Метод возвращает этикетки только для сборочных заданий, находящихся в доставке (в статусе complete).
Authorizations:
HeaderApiKey
Request Body schema: application/json
orders
Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ]

Массив идентификаторов сборочных заданий

Responses

Response Schema: application/json
Array of objects

Request samples

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

Response samples

Content type
application/json
{}

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

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

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

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

Responses

Response Schema: application/json
Array of objects

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

Request samples

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

Response samples

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

Информация по клиенту

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

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

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

Responses

Response Schema: application/json
One of
Array of objects (DbsClientInfo)

Информация по клиенту для dbs-заказа (доставка силами продавца)

Request samples

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

Response samples

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

Поставки

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


1. Создайте новую поставку с помощью метода POST /api/v3/supplies. В ответ вернется идентификатор созданной поставки в формате "WB-GI-1234567".
2. В текущую новую поставку нужно добавить сборочные задания, которые вы повезёте на склад или ПВЗ, методом PATCH /api/v3/supplies/{supplyId}/orders/{orderId}. Обратите внимание, что при добавлении сборочных заданий к поставке они будут переведены в статус confirm ("На сборке").
Примечание: пункты 3 - 8 обязательны к выполнению при доставке поставки на ПВЗ.
3. В поставке создайте короб методом POST /api/v3/supplies/{supplyId}/trbx.
4. Добавьте заказы в короб методом PATCH /api/v3/supplies/{supplyId}/trbx/{trbxId}.
5. Список коробов с заказами можно получить методом GET /api/v3/supplies/{supplyId}/trbx.
6. Получите стикеры коробов методом POST /api/v3/supplies/{supplyId}/trbx/stickers, распечатайте и наклейте стикеры на короба согласно распределённым в них заказам.
7. Вы можете удалить короба из поставки методом DELETE /api/v3/supplies/{supplyId}/trbx. Обратите внимание, что удалить короба из поставки можно, только пока поставка находится на сборке.
8. Вы можете удалить заказы из короба методом DELETE /api/v3/supplies/{supplyId}/trbx/{trbxId}/orders/{orderId}. Обратите внимание, что удалить заказы из короба можно, только пока поставка находится на сборке.
9. После того как поставка будет укомплектована нужными сборочными заданиями, необходимо ее передать в доставку с помощью метода PATCH /api/v3/supplies/{supplyId}/deliver. Если поставка не была передана в доставку, то при сканировании её штрихкода или приёмке первого товара поставка автоматически закроется. Обратите внимание, что при передаче сборочных заданий в доставку они будут автоматически собраны, т.е. переведены в статус complete ("В доставке").
10. Список сборочных заданий, добавленных к поставке, можно получить методом GET /api/v3/supplies/{supplyId}/orders.
11. Все поставки, имеющиеся у продавца, можно получить методом GET /api/v3/supplies.
12. Детализацию конкретной поставки можно получить методом GET /api/v3/supplies/{supplyId}.
13. С помощью метода DELETE /api/v3/supplies/{supplyId} можно удалить поставку при условии, что она активна и за ней не закреплено ни одно сборочное задание.
14. Если поставка была отсканирована в пункте приёмки, но при этом в ней имеются ещё неотсканированные товары, то спустя определенное время необходимо доставить их повторно. Все сборочные задания, требующие повторной отгрузки на данный момент, можно получить с помощью метода GET /api/v3/supplies/orders/reshipment. При помощи метода PATCH /api/v3/supplies/{id поставки}/orders/{id сборочного задания} данные сборочные задания можно перевести в другую активную поставку (сборочное задание также будет переведено в статус confirm ("На сборке")).
15. Метод PATCH /api/v3/supplies/{supplyId}/orders/{orderId} также позволяет перемещать сборочные задания между активными поставками. Обратите внимание, что нельзя перемещать сборочное задание из уже закрытой поставки, только если оно не требует повторной отгрузки.
16. QR-код поставки можно получить методом GET /api/v3/supplies/{supplyId}/barcode в формате svg, zpl или png. Доступно только после передачи поставки в доставку.

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

Ограничения работы с поставками:

  • Только для сборочных заданий по схеме "Везу на склад WB"
  • При добавлении в поставку все передаваемые сборочные задания в статусе new ("Новое") будут автоматически переведены в статус confirm ("На сборке").
  • Обратите внимание, что если вы переведёте сборочное задание в статус cancel ("Отмена продавцом"), то сборочное задание автоматически удалится из поставки, если было прикреплено к ней.
  • Поставку можно собрать только из сборочных заданий (заказов) одного габаритного типа (cargoType). Новая поставка не обладает габаритным признаком. При добавлении первого заказа в поставку она приобретает габаритный признак этого заказа.
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
name
string [ 1 .. 128 ] characters

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

Responses

Response Schema: application/json
id
string

Идентификатор поставки

Request samples

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

Response samples

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

Получить список поставок

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

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

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

next
required
integer <int64>

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

Responses

Response Schema: application/json
next
integer <int64> (Next)

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

Array of objects (Supply)

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

Response samples

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

Добавить к поставке сборочное задание

Добавляет к поставке сборочное задание и переводит его в статус confirm ("На сборке").
Также может перемещать сборочное задание между активными поставками, либо из закрытой в активную при условии, что сборочное задание требует повторной отгрузки.

Важно!
В пустую поставку можно добавить сборочное задание любого габаритного типа.
После добавления первого задания поставка приобретает габаритный тип этого задания, см. значение поля cargoType в ответе метода "Получить информацию о поставке".
После этого добавить в поставку можно только те задания, габаритный тип которых соответствует таковому у поставки.

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": "Передан некорректный параметр"
}

Получить информацию о поставке

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

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

ID поставки

Responses

Response Schema: application/json
id
string

Идентификатор поставки

done
boolean

Флаг закрытия поставки

createdAt
string <date-time>

Дата создания поставки (RFC3339)

closedAt
string <date-time>

Дата закрытия поставки (RFC3339)

scanDt
string <date-time>

Дата скана поставки (RFC3339)

name
string

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

cargoType
integer
Enum: 0 1 2 3
Тип поставки:
0 - признак отсутствует
1 - обычная
2 - СГТ (Содержит сверхгабаритные товары)
3 - КГТ (Содержит крупногабаритные товары). Не используется на данный момент.

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
}

Удалить поставку

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

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

ID поставки

Responses

Response samples

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

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

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

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

ID поставки

Responses

Response Schema: application/json
Array of objects (SupplyOrder)

Response samples

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

Передать поставку в доставку

Закрывает поставку и переводит все сборочные задания в ней в статус complete ("В доставке"). После закрытия поставки новые сборочные задания к ней добавить будет невозможно.

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

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

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

ID поставки

Responses

Response samples

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

Получить QR поставки

Возвращает QR в svg, zplv (вертикальный), zplh (горизонтальный), png.
Можно получить, только если поставка передана в доставку.

Доступные размеры:
580x400 пикселей
Authorizations:
HeaderApiKey
path Parameters
supplyId
required
string
Example: WB-GI-1234567

ID поставки

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

Тип этикетки

Responses

Response Schema: application/json
barcode
string

Закодированное значение этикетки (идентификатор поставки)

file
string <byte>

Полное представление этикетки в заданном формате. (кодировка base64)

Response samples

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

Получить список коробов поставки

Возвращает список коробов и идентификаторы заказов, входящих в них.

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

ID поставки

Responses

Response Schema: application/json
Array of objects (SupplyTrbx)

Response samples

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

Добавить короба к поставке

Добавляет требуемое количество коробов в поставку. Можно добавить, только пока поставка на сборке.

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

ID поставки

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

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

Responses

Response Schema: application/json
trbxIds
Array of strings non-empty

Список ID коробов, которые были созданы.

Request samples

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

Response samples

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

Удалить короба из поставки

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

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": "Передан некорректный параметр"
}

Добавить заказы к коробу

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

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": "Передан некорректный параметр"
}

Удалить заказ из короба

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

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": "Передан некорректный параметр"
}

Получить стикеры коробов поставки

Возвращает стикеры QR в svg, zplv (вертикальный), zplh (горизонтальный), png.
Можно получить, только если в коробе есть заказы.

Размер стикеров: 580x400 пикселей
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

Response Schema: application/json
Array of objects (TrbxStickers) non-empty

Request samples

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

Response samples

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

Остатки

Допускается максимум 300 запросов в минуту на методы Marketplace в целом

Обновить остатки товаров

Обновляет остатки товаров.
Важно! Имена параметров запроса не валидируются. При отправке некорректных имен Вы получите успешный ответ(204), но остатки не обновятся.
Тщательнее проверяйте данные перед отправкой.

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

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

Request Body schema: application/json
required
Array of objects [ 1 .. 1000 ] items

Массив баркодов товаров и их остатков

Responses

Request samples

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

Response samples

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

Удалить остатки товаров

Удаляет остатки товаров. Внимание! Действие необратимо. Удаленный остаток будет необходимо загрузить повторно для возобновления продаж.

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

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

Request Body schema: application/json
required
skus
Array of strings [ 1 .. 1000 ] items

Массив баркодов

Responses

Request samples

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

Response samples

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

Получить остатки товаров

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

Authorizations:
HeaderApiKey
path Parameters
warehouseId
required
integer <int64>
Example: 1

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

Request Body schema: application/json
required
skus
Array of strings [ 1 .. 1000 ] items

Массив баркодов

Responses

Response Schema: application/json
Array of objects

Request samples

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

Response samples

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

Склады

Допускается максимум 300 запросов в минуту на методы Marketplace в целом

Получить список складов WB

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

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array
address
string

Адрес

name
string

Название

city
string

Город

id
integer <int64>

ID

longitude
number <float64>

Долгота

latitude
number <float64>

Широта

cargoType
integer
Enum: 1 2 3
Тип товара, который принимает склад:
1 - обычный
2 - СГТ (Сверхгабаритный товар)
3 - КГТ (Крупногабаритный товар). Не используется на данный момент.
deliveryType
integer
Enum: 1 2 3
Тип доставки, который принимает склад:
1 - доставка на склад Wildberries
2 - доставка силами продавца
3 - доставка курьером WB
selected
boolean

Признак того, что склад уже выбран продавцом

Response samples

Content type
application/json
[
  • {
    }
]

Получить список складов продавца

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

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array
name
string

Название склада продавца

officeId
integer <int64>

ID склада WB

id
integer <int64>

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

cargoType
integer
Enum: 1 2 3
Тип товара, который принимает склад:
1 - обычный
2 - СГТ (Сверхгабаритный товар)
3 - КГТ (Крупногабаритный товар). Не используется на данный момент.
deliveryType
integer
Enum: 1 2 3
Тип доставки, который принимает склад:
1 - доставка на склад Wildberries
2 - доставка силами продавца
3 - доставка курьером WB

Response samples

Content type
application/json
[
  • {
    }
]

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

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

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

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

officeId
required
integer >= 1

ID склада WB

Responses

Response Schema: application/json
id
integer

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

Request samples

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

Response samples

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

Обновить склад

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

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

Идентификатор склада WB

Responses

Request samples

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

Response samples

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

Удалить склад продавца

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

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": "s2sauth-ca",
  • "status": 401,
  • "statusText": "Unauthorized"
}

Пропуска

Допускается максимум 300 запросов в минуту на методы Marketplace в целом

Получить список складов, для которых требуется пропуск

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

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array
name
string

Название

address
string

Адрес

id
integer <int64>

ID

Response samples

Content type
application/json
[
  • {
    }
]

Получить список пропусков

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

Authorizations:
HeaderApiKey

Responses

Response Schema: application/json
Array
firstName
string

Имя водителя

dateEnd
string

Дата окончания действия пропуска

lastName
string

Фамилия водителя

carModel
string

Марка машины

carNumber
string

Номер машины

officeName
string

Название склада

officeAddress
string

Адрес склада

officeId
integer <int64>

ID склада

id
integer <int64>

ID пропуска

Response samples

Content type
application/json
[
  • {
    }
]

Создать пропуск

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

Response Schema: application/json
id
integer

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

Request samples

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

Response samples

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

Обновить пропуск

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

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": "Некорректное тело запроса"
}

Удалить пропуск

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

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": "s2sauth-ca",
  • "status": 401,
  • "statusText": "Unauthorized"
}

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



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

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

Перевести на сборку

Переводит сборочное задание в статус confirm ("На сборке").

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

Идентификатор сборочного задания

Responses

Response samples

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

Перевести в доставку

Переводит сборочное задание в статус deliver ("В доставке").

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

Идентификатор сборочного задания

Responses

Response samples

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

Сообщить, что сборочное задание принято клиентом

Переводит сборочное задание в статус receive ("Получено клиентом").

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

Идентификатор сборочного задания

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": "Передан некорректный параметр"
}

Сообщить, что клиент отказался от сборочного задания

Перевести в статус reject ("Отказ при получении").

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

Идентификатор сборочного задания

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": "Передан некорректный параметр"
}