Заказы FBS (order)
В разделе заказов FBS (Fulfillment by Seller) вам доступны методы:
- Управления сборочными заданиями: информация о сборочных заданиях, метаданные, стикеры и так далее.
- Управления поставками заказов продавца на склады WB.
- Заказа пропусков на склады WB.
- Доставки заказов курьером WB (DBW).
В разделе заказов FBS (Fulfillment by Seller) вам доступны методы:
- Управления сборочными заданиями: информация о сборочных заданиях, метаданные, стикеры и так далее.
- Управления поставками заказов продавца на склады WB.
- Заказа пропусков на склады WB.
- Доставки заказов курьером WB (DBW).
Получить список новых сборочных заданий{{ /api/v3/orders/new }}
Метод предоставляет список всех новых сборочных заданий, которые есть у продавца на момент запроса.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
Responses
Response samples
- 200
- 401
- 403
- 429
{- "orders": [
- {
- "address": {
- "fullAddress": "Челябинская область, г. Челябинск, 51-я улица Арабкира, д. 10А, кв. 42",
- "longitude": 44.519068,
- "latitude": 40.20192
}, - "ddate": "17.05.2024",
- "salePrice": 504600,
- "requiredMeta": [
- "uin"
], - "deliveryType": "fbs",
- "comment": "Упакуйте в плёнку, пожалуйста",
- "scanPrice": null,
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "offices": [
- "Калуга"
], - "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "nmId": 123456789,
- "chrtId": 987654321,
- "price": 1014,
- "convertedPrice": 28322,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "isZeroOrder": false,
- "options": {
- "isB2b": true
}
}
]
}
Получить информацию о сборочных заданиях{{ /api/v3/orders }}
Метод предоставляет информацию о сборочных заданиях без их актуального статуса.
Можно получить данные за заданный период, максимум 30 календарных дней.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
query Parameters
limit required | integer [ 1 .. 1000 ] Параметр пагинации. Устанавливает предельное количество возвращаемых данных. |
next required | integer <int64> Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноимённого поля в ответе. |
dateFrom | integer Дата начала периода в формате Unix timestamp. По умолчанию — дата за 30 дней до запроса |
dateTo | integer Дата конца периода в формате Unix timestamp |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
{- "next": 13833711,
- "orders": [
- {
- "address": {
- "fullAddress": "Челябинская область, г. Челябинск, 51-я улица Арабкира, д. 10А, кв. 42",
- "longitude": 44.519068,
- "latitude": 40.20192
}, - "scanPrice": 1500,
- "deliveryType": "fbs",
- "supplyId": "WB-GI-92937123",
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "offices": [
- "Калуга"
], - "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "nmId": 12345678,
- "chrtId": 987654321,
- "price": 1014,
- "convertedPrice": 28322,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "comment": "Упакуйте в плёнку, пожалуйста",
- "isZeroOrder": false,
- "options": {
- "isB2b": true
}
}
]
}
Получить статусы сборочных заданий{{ /api/v3/orders/status }}
Метод предоставляет статусы сборочных заданий по их ID.
supplierStatus
— статус сборочного задания. Триггер его изменения — сам продавец.
Возможные значения supplierStatus
:
Статус | Описание | Как перевести сборочное задание в данный статус |
---|---|---|
new | Новое сборочное задание | |
confirm | На сборке Для доставки силами Wildberries fbs |
Добавить сборочное задание к поставке |
complete | В доставке Для доставки силами Wildberries fbs и курьером WB wbgo |
Для fbs — передать поставку в доставку Для wbgo — перевести сборочное задание в доставку |
cancel | Отменено продавцом | Отменить сборочное задание |
receive | Получено клиентом Для доставки курьером WB wbgo |
Статус меняется автоматически |
reject | Отказ клиента при получении Для доставки курьером WB wbgo |
Статус меняется автоматически |
wbStatus
— статус сборочного задания в системе WB.
Возможные значения wbStatus
:
waiting
— сборочное задание в работеsorted
— сборочное задание отсортированоsold
— сборочное задание получено покупателемcanceled
— отмена сборочного заданияcanceled_by_client
— покупатель отменил заказ при полученииdeclined_by_client
— покупатель отменил заказ. Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборкуdefect
— отмена сборочного задания по причине бракаready_for_pickup
— сборочное задание прибыло на пункт выдачи заказов (ПВЗ)postponed_delivery
— курьерская доставка отложена
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
Request Body schema: application/json
orders required | Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ] Список ID сборочных заданий |
Responses
Request samples
- Payload
{- "orders": [
- 5632423
]
}
Response samples
- 200
- 400
- 401
- 403
- 429
{- "orders": [
- {
- "id": 5632423,
- "supplierStatus": "new",
- "wbStatus": "waiting"
}
]
}
Получить все сборочные задания для повторной отгрузки{{ /api/v3/supplies/orders/reshipment }}
Метод предоставляет все сборочные задания, требующие повторной отгрузки.
Повторная отгрузка требуется, если поставка была отсканирована в пункте приёмки, но при этом в ней всё ещё есть неотсканированные товары. Спустя определённое время необходимо доставить эти товары заново. Данные сборочные задания можно перевести в другую активную поставку.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
{- "orders": [
- {
- "supplyID": "WB-GI-1234567",
- "orderID": 5632423
}
]
}
Отменить сборочное задание{{ /api/v3/orders/{orderId}/cancel }}
Метод отменяет сборочное задание и переводит в статус cancel
— отменено продавцом.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "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
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
query Parameters
type required | string Enum: "svg" "zplv" "zplh" "png" Тип стикера |
width required | integer Enum: 58 40 Ширина стикера |
height required | integer Enum: 40 30 Высота стикера |
Request Body schema: application/json
orders | Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ] Массив ID сборочных заданий |
Responses
Request samples
- Payload
{- "orders": [
- 5346346
]
}
Response samples
- 200
- 400
- 401
- 403
- 429
{- "stickers": [
- {
- "orderId": 5346346,
- "partA": 231648,
- "partB": 9753,
- "barcode": "!uKEtQZVx",
- "file": "PD94bWwgdmVyc2lvbj0iMS4wIj8+CjwhLS0gR2VuZXJhdGVkIGJ5IFNWR28gLS0+Cjxzdmcgd2lkdGg9IjQwMCIgaGVpZ2h0PSIzMDAiCiAgICAgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIgogICAgIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIj4KPHJlY3QgeD0iMCIgeT0iMCIgd2lkdGg9IjQwMCIgaGVpZQiIGhlaWdodD0iMTcwIiBzdHlsZT0iZmlsbDpibGFjayIgLz4KPHJlY3QgeD0iMzE4IiB5PSIyMCIgd2lkdGg9IjYiIGhlaWdodD0iMTcwIiBzdHlsZT0iZmlsbDpibGFjayIgLz4KPHJlY3QgeD0iMzI2IiB5PSIyMCIgd2lkdGg9IjIiIGhlaWdodD0iMTcwIiBzdHlsZT0iZmlsbDpibGFjayIgLz4KPHJlY3QgeD0iMzMwIiB5PSIyMCIgd2lkdGg9IjQiIGhlaWdodD0iMTcwIiBzdHlsZT0iZmlsbDpibGFjayIgLz4KPHJlY3QgeD0iMjAiIHk9IjIwMCIgd2lkdGg9IjM1MCIgaGVpZ2h0PSI5MCIgc3R5bGU9ImZpbGw6YmxhY2siIC8+Cjx0ZXh0IHg9IjMwIiB5PSIyNDAiIHN0eWxlPSJmaWxsOndoaXRlO2ZvbnQtc2l6ZTozMHB0O3RleHQtYW5jaG9yOnN0YXJ0IiA+MjMxNjQ4PC90ZXh0Pgo8dGV4dCB4PSIzNTAiIHk9IjI3MCIgc3R5bGU9ImZpbGw6d2hpdGU7Zm9udC1zaXplOjUwcHQ7dGV4dC1hbmNob3I6ZW5kIiA+OTc1MzwvdGV4dD4KPC9zdmc+Cg=="
}
]
}
Получить список ссылок на стикеры сборочных заданий, которые требуются при кроссбордере{{ /api/v3/files/orders/external-stickers }}
Метод предоставляет список ссылок на стикеры сборочных заданий, которые требуются при кроссбордере.
Ограничения:
- За один запрос можно получить максимум 100 стикеров.
- Можно получить стикеры только для сборочных заданий, находящихся в доставке — статус
complete
.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
Request Body schema: application/json
orders | Array of integers <int64> [ 1 .. 100 ] items [ items <int64 > ] Массив ID сборочных заданий |
Responses
Request samples
- Payload
{- "orders": [
- 5346346
]
}
Response samples
- 200
- 400
- 401
- 403
- 429
{
}
История статусов для сборочных заданий кроссбордера{{ /api/v3/orders/status/history }}
Метод предоставляет историю статусов для сборочных заданий кроссбордера.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
Responses
Response samples
- 200
- 401
- 403
- 404
- 429
{- "orders": [
- {
- "deliveryDate": "string",
- "statuses": [
- {
- "date": null,
- "code": "SORTED"
}
], - "orderID": 123456789
}
]
}
Заказы с информацией по клиенту{{ /api/v3/orders/client }}
Метод позволяет получать информацию о покупателе по ID сборочного задания.
Только для кроссбордера из Турции.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
Request Body schema: application/jsonrequired
orders | Array of integers Список заказов |
Responses
Request samples
- Payload
{- "orders": [
- 987654321,
- 123456789
]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "orders": [
- {
- "firstName": "Иван",
- "fullName": "Андреев Иван Васильевич",
- "lastName": "Андреев",
- "middleName": "Васильевич",
- "orderID": 134567,
- "phone": 79871234567,
- "phoneCode": 0
}
]
}
Получить метаданные сборочного задания{{ /api/v3/orders/{orderId}/meta }}
Метод предоставляет метаданные заказа, доступные для сборочного задания.
Возможные метаданные:
imei
— IMEIuin
— УИНgtin
— GTINsgtin
— код маркировки
Если ответ вернулся с пустой структурой meta
, значит у сборочного задания нет метаданных и добавить их нельзя.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Responses
Response samples
- 200
- 401
- 403
- 404
- 429
{- "meta": {
- "imei": 123456789012345,
- "uin": 1234567890123456,
- "gtin": 1234567890123,
- "sgtin": 1234567890123456
}
}
Удалить метаданные сборочного задания{{ /api/v3/orders/{orderId}/meta }}
Метод удаляет значение метаданных сборочного задания для переданного ключа.
Возможные метаданные:
imei
— IMEIuin
— УИНgtin
— GTINsgtin
— код маркировки
Можно передать только один ключ.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 ID сборочного задания |
query Parameters
key | string Название метаданных для удаления ( |
Responses
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectRequest",
- "message": "Переданы некорректные данные"
}
Закрепить за сборочным заданием код маркировки товара{{ /api/v3/orders/{orderId}/meta/sgtin }}
Метод позволяет закрепить за сборочным заданием код маркировки Честный знак.
Закрепить код маркировки можно только если в метаданных сборочного задания есть поле sgtin
, а сборочное задание находится в статусе confirm
.
Получить загруженные маркировки можно в метаданных сборочного задания.
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием код маркировки
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
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
- Payload
{- "sgtins": [
- "1234567890123456"
]
}
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}
Закрепить за сборочным заданием УИН{{ /api/v3/orders/{orderId}/meta/uin }}
Метод обновляет УИН в метаданных сборочного задания — уникальный идентификационный номер.
У одного сборочного задания может быть только один УИН.
Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm
.
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием код маркировки
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Request Body schema: application/json
uin required | string = 16 characters УИН |
Responses
Request samples
- Payload
{- "uin": "1234567890123456"
}
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}
Закрепить за сборочным заданием IMEI{{ /api/v3/orders/{orderId}/meta/imei }}
Метод обновляет IMEI в метаданных сборочного задания.
У одного сборочного задания может быть только один IMEI.
Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm
.
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием код маркировки
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Request Body schema: application/json
imei required | string = 15 characters IMEI |
Responses
Request samples
- Payload
{- "imei": "123456789012345"
}
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}
Закрепить за сборочным заданием GTIN{{ /api/v3/orders/{orderId}/meta/gtin }}
Метод обновляет GTIN в метаданных сборочного задания — уникальный ID товара в Беларуси.
У одного сборочного задания может быть только один GTIN.
Добавлять маркировку можно только для заказов, которые доставляются WB и находятся в статусе confirm
.
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием код маркировки
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Request Body schema: application/json
gtin required | string = 13 characters GTIN |
Responses
Request samples
- Payload
{- "gtin": "1234567890123"
}
Response samples
- 400
- 401
- 403
- 409
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}
Создать новую поставку{{ /api/v3/supplies }}
Метод создаёт новую поставку.
Ограничения:
- Только для сборочных заданий по схеме FBS.
- При добавлении в поставку все передаваемые сборочные задания в статусе
new
будут автоматически переведены в статусconfirm
— на сборке. - Если вы переведёте сборочное задание в статус
cancel
— отмена продавцом, прикрепленное сборочное задание автоматически удалится из поставки. - Поставку можно собрать только из сборочных заданий (заказов) одного габаритного типа
cargoType
. Новая поставка не обладает габаритным признаком, она приобретает габаритный признак первого заказа, добавленного в поставку.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
Request Body schema: application/jsonrequired
name | string [ 1 .. 128 ] characters Наименование поставки |
Responses
Request samples
- Payload
{- "name": "Тестовая поставка"
}
Response samples
- 201
- 400
- 401
- 403
- 429
{- "id": "WB-GI-1234567"
}
Получить список поставок{{ /api/v3/supplies }}
Метод предоставляет список поставок.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
query Parameters
limit required | integer [ 1 .. 1000 ] Параметр пагинации. Устанавливает предельное количество возвращаемых данных. |
next required | integer <int64> Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноимённого поля в ответе. |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
{- "next": 13833711,
- "supplies": [
- {
- "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}/orders/{orderId} }}
Метод добавляет сборочное задание к поставке и переводит его в статус confirm
— на сборке.
Может перемещать сборочное задание:
- между активными поставками.
- из закрытой поставки в активную, если сборочное задание требует повторной отгрузки.
cargoType
.После этого в поставку можно добавить сборочные задания только того же габаритного типа, что и у поставки.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 ID поставки |
orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}
Получить информацию о поставке{{ /api/v3/supplies/{supplyId} }}
Метод предоставляет подробную информацию о поставке.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 ID поставки |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "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} }}
Метод удаляет поставку, если она активна и за ней не закреплено ни одно сборочное задание.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 ID поставки |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}
Получить сборочные задания в поставке{{ /api/v3/supplies/{supplyId}/orders }}
Метод предоставляет сборочные задания, закреплённые за поставкой.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 ID поставки |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "orders": [
- {
- "scanPrice": null,
- "orderUid": "165918930_629fbc924b984618a44354475ca58675",
- "article": "one-ring-7548",
- "colorCode": "RAL 3017",
- "rid": "f884001e44e511edb8780242ac120002",
- "createdAt": "2022-05-04T07:56:29Z",
- "offices": [
- "Калуга"
], - "skus": [
- "6665956397512"
], - "id": 13833711,
- "warehouseId": 658434,
- "nmId": 123456789,
- "chrtId": 987654321,
- "price": 1014,
- "convertedPrice": 28322,
- "currencyCode": 933,
- "convertedCurrencyCode": 643,
- "cargoType": 1,
- "isZeroOrder": false
}
]
}
Передать поставку в доставку{{ /api/v3/supplies/{supplyId}/deliver }}
Метод закрывает поставку и переводит все сборочные задания в ней в статус complete
— в доставке. После закрытия поставки добавить новые сборочные задания к ней нельзя.
Если поставка не была передана в доставку, то при сканировании её штрихкода или приёмке первого товара поставка автоматически закроется.
Передать поставку в доставку можно только если в ней:
- есть хотя бы одно сборочное задания
- отсутствуют пустые короба
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 ID поставки |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}
Получить QR-код поставки{{ /api/v3/supplies/{supplyId}/barcode }}
Метод предоставляет QR-код поставки в форматах:
- SVG
- ZPLV (вертикальный)
- ZPLH (горизонтальный)
- PNG
QR-код поставки можно получить только если поставка передана в доставку.
Размер — 580x400 px.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 ID поставки |
query Parameters
type required | string Enum: "svg" "zplv" "zplh" "png" Тип стикера |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 409
- 429
{- "barcode": "WB-GI-12345678",
- "file": "U3dhZ2dlciByb2Nrcw=="
}
Получить список коробов поставки{{ /api/v3/supplies/{supplyId}/trbx }}
Метод предоставляет список коробов и ID заказов, входящих в эти короба.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 ID поставки |
Responses
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "trbxes": [
- {
- "id": "WB-TRBX-1234567",
- "orders": [
- 1234567
]
}
]
}
Добавить короба к поставке{{ /api/v3/supplies/{supplyId}/trbx }}
Метод добавляет требуемое количество коробов в поставку.
Можно добавить только пока поставка на сборке.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 ID поставки |
Request Body schema: application/json
amount required | integer [ 1 .. 1000 ] Количество коробов, которые необходимо добавить к поставке. |
Responses
Request samples
- Payload
{- "amount": 4
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 429
{- "trbxIds": [
- "WB-TRBX-1234567"
]
}
Удалить короба из поставки{{ /api/v3/supplies/{supplyId}/trbx }}
Метод убирает заказы из перечисленных коробов поставки и удаляет короба.
Можно удалить только пока поставка на сборке.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
supplyId required | string Example: WB-GI-1234567 ID поставки |
Request Body schema: application/json
trbxIds required | Array of strings Список ID коробов, которые необходимо удалить. |
Responses
Request samples
- Payload
{- "trbxIds": [
- "WB-TRBX-1234567"
]
}
Response samples
- 400
- 401
- 403
- 404
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}
Добавить заказы в короб{{ /api/v3/supplies/{supplyId}/trbx/{trbxId} }}
Метод добавляет заказы в короб для выбранной поставки.
Можно добавить только пока поставка на сборке.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
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
- Payload
{- "orderIds": [
- 1234567
]
}
Response samples
- 400
- 401
- 403
- 404
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}
Удалить заказ из короба{{ /api/v3/supplies/{supplyId}/trbx/{trbxId}/orders/{orderId} }}
Метод удаляет заказ из короба выбранной поставки.
Можно удалить только пока поставка на сборке.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
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
- 400
- 401
- 403
- 404
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}
Получить стикеры коробов поставки{{ /api/v3/supplies/{supplyId}/trbx/stickers }}
Метод предоставляет QR-стикеры в форматах:
- SVG
- ZPLV (вертикальный)
- ZPLH (горизонтальный)
- PNG
Можно получить только если в коробе есть заказы.
Размер стикеров — 580x400 px.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
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
- Payload
{- "trbxIds": [
- "WB-TRBX-1234567"
]
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 429
{- "stickers": [
- {
- "barcode": "$WBMP:1:123:1234567",
- "file": "U3dhZ2dlciByb2Nrcw=="
}
]
}
Получить список складов, для которых требуется пропуск{{ /api/v3/passes/offices }}
Метод предоставляет список складов для привязки к пропуску продавца.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
Responses
Response samples
- 200
- 401
- 403
- 429
[- {
- "name": "Коледино",
- "address": "г. Подольск, д. Коледино, ул. Троицкая",
- "id": 1
}
]
Получить список пропусков{{ /api/v3/passes }}
Метод предоставляет список всех созданных пропусков продавца.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
Responses
Response samples
- 200
- 401
- 403
- 429
[- {
- "firstName": "Александр",
- "dateEnd": "2022-07-31 17:53:13+00:00",
- "lastName": "Петров",
- "carModel": "Lamborghini",
- "carNumber": "A456BC123",
- "officeName": "Коледино",
- "officeAddress": "г. Подольск, д. Коледино, ул. Троицкая",
- "officeId": 15,
- "id": 1
}
]
Создать пропуск{{ /api/v3/passes }}
Метод создаёт пропуск продавца с привязкой к складу WB.
Пропуск действует 48 часов со времени создания.
Authorizations:
Request Body schema: application/jsonrequired
Общая длина ФИО ограничена от 6 до 100 символов. В номере машины могут быть только буквы и цифры.
firstName required | string non-empty Имя водителя |
lastName required | string non-empty Фамилия водителя |
carModel required | string [ 1 .. 100 ] characters Марка машины |
carNumber required | string [ 6 .. 9 ] characters Номер машины |
officeId required | integer <int64> >= 1 ID склада |
Responses
Request samples
- Payload
{- "firstName": "Александр",
- "lastName": "Петров",
- "carModel": "Lamborghini",
- "carNumber": "A456BC123",
- "officeId": 15
}
Response samples
- 201
- 400
- 401
- 403
- 404
- 429
{- "id": 2
}
Обновить пропуск{{ /api/v3/passes/{passId} }}
Метод обновляет данные пропуска продавца. В том числе, можно обновить данные привязанного склада WB.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
passId required | integer <int64> Example: 45 ID пропуска |
Request Body schema: application/jsonrequired
Общая длина ФИО ограничена от 6 до 100 символов. В номере машины могут быть только буквы и цифры.
firstName required | string non-empty Имя водителя |
lastName required | string >= 6 characters Фамилия водителя |
carModel required | string [ 1 .. 100 ] characters Марка машины |
carNumber required | string [ 6 .. 9 ] characters Номер машины |
officeId required | integer <int64> >= 1 ID склада |
Responses
Request samples
- Payload
{- "firstName": "Александр",
- "lastName": "Петров",
- "carModel": "Lamborghini",
- "carNumber": "A456BC123",
- "officeId": 15
}
Response samples
- 400
- 401
- 403
- 404
- 429
{- "code": "IncorrectRequestBody",
- "message": "Некорректное тело запроса"
}
Удалить пропуск{{ /api/v3/passes/{passId} }}
Метод удаляет пропуск продавца из списка.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
passId required | integer <int64> Example: 45 ID пропуска |
Responses
Response samples
- 401
- 403
- 404
- 429
{- "title": "unauthorized",
- "detail": "token problem; token is malformed: could not base64 decode signature: illegal base64 data at input byte 84",
- "code": "07e4668e--a53a3d31f8b0-[UK-oWaVDUqNrKG]; 03bce=277; 84bd353bf-75",
- "requestId": "7b80742415072fe8b6b7f7761f1d1211",
- "origin": "s2s-api-auth-catalog",
- "status": 401,
- "statusText": "Unauthorized",
- "timestamp": "2024-09-30T06:52:38Z"
}
Перевести на сборку{{ /api/v3/orders/{orderId}/confirm }}
Метод переводит сборочное задание в статус confirm
— на сборке.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}
Перевести в доставку{{ /api/v3/orders/{orderId}/assemble }}
Метод переводит сборочное задание в статус complete
— в доставке.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
orderId required | integer <int64> Example: 5632423 ID сборочного задания |
Responses
Response samples
- 400
- 401
- 403
- 404
- 409
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}
Список контактов{{ /api/v3/warehouses/{warehouseId}/contacts }}
Метод предоставляет список контактов, привязанных к складу продавца.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
warehouseId required | integer <int64> Example: 1 ID склада продавца |
Responses
Response samples
- 200
- 400
- 401
- 403
- 429
[- {
- "contacts": [
- {
- "comment": "Иванов Иван Иванович. Звонить с 10 до 21 часа.",
- "phone": "+79998887766"
}
]
}
]
Обновить список контактов{{ /api/v3/warehouses/{warehouseId}/contacts }}
Метод обновляет список контактов склада продавца.
Только для складов с типом доставки 3
— курьером WB.
К складу можно добавить максимум 5 контактов. Чтобы удалить контакты, отправьте пустой массив contacts
.
Один запрос с кодом ответа
409
учитывается как 5 запросов
Authorizations:
path Parameters
warehouseId required | integer <int64> Example: 1 ID склада продавца |
Request Body schema: application/jsonrequired
Array of objects <= 5 items |
Responses
Request samples
- Payload
{- "contacts": [
- {
- "comment": "Иванов Иван Иванович. Звонить с 10 до 21 часа.",
- "phone": "+79998887766"
}
]
}
Response samples
- 400
- 401
- 403
- 429
{- "code": "IncorrectParameter",
- "message": "Передан некорректный параметр"
}