Заказы DBS (order)

Управление сборочными заданиями и метаданными заказов DBS (Delivery by Seller).

Заказы DBS

Управление сборочными заданиями и метаданными заказов DBS (Delivery by Seller).

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

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

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

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

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

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

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

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

Authorizations:

HeaderApiKey

Responses

Response samples

200
401
403
429

Content type

application/json

{"orders": [{"address": {"fullAddress": "Челябинская область, г. Челябинск, 51-я улица Арабкира, д. 10А, кв. 42",
"longitude": 44.519068,
"latitude": 40.20192
},
"ddate": "17.05.2024",
"salePrice": 504658,
"dTimeFrom": "15:00",
"dTimeTo": "16:00",
"requiredMeta": ["uin"
],
"deliveryType": "dbs",
"comment": "Упакуйте в плёнку, пожалуйста",
"orderUid": "165918930_629fbc924b984618a44354475ca58675",
"article": "one-ring-7548",
"colorCode": "RAL 3017",
"rid": "f884001e44e511edb8780242ac120002",
"createdAt": "2022-05-04T07:56:29Z",
"skus": ["6665956397512"
],
"id": 13833711,
"warehouseId": 658434,
"nmId": 123456789,
"chrtId": 987654321,
"price": 1014,
"convertedPrice": 28322,
"currencyCode": 933,
"convertedCurrencyCode": 643,
"cargoType": 1,
"isZeroOrder": false
}
]
}

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

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

Метод предоставляет информацию о завершённых сборочных заданиях после продажи или отмены заказа.

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

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

Authorizations:

HeaderApiKey

query Parameters

limit required	integer [ 1 .. 1000 ] Параметр пагинации. Устанавливает предельное количество возвращаемых данных.
next required	integer <int64> Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноимённого поля в ответе.
dateFrom required	integer Дата начала периода в формате Unix timestamp
dateTo required	integer Дата конца периода в формате Unix timestamp

Responses

Response samples

200
400
401
403
429

Content type

application/json

{"next": 13833711,
"orders": [{"address": {"fullAddress": "Челябинская область, г. Челябинск, 51-я улица Арабкира, д. 10А, кв. 42",
"longitude": 44.519068,
"latitude": 40.20192
},
"deliveryType": "string",
"orderUid": "165918930_629fbc924b984618a44354475ca58675",
"article": "one-ring-7548",
"colorCode": "RAL 3017",
"rid": "f884001e44e511edb8780242ac120002",
"createdAt": "2022-05-04T07:56:29Z",
"skus": ["6665956397512"
],
"id": 13833711,
"warehouseId": 658434,
"nmId": 12345678,
"chrtId": 987654321,
"price": 1014,
"convertedPrice": 28322,
"currencyCode": 933,
"convertedCurrencyCode": 643,
"cargoType": 1,
"comment": "Упакуйте в плёнку, пожалуйста",
"isZeroOrder": false
}
]
}

Информация о покупателе{{ /api/v3/dbs/orders/client }}

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

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

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

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

orders

Array of integers

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

Responses

Request samples

Payload

Content type

application/json

{"orders": [987654321,
123456789
]
}

Response samples

Content type

application/json

{"orders": [{"firstName": "string",
"fullName": "Иван Иван Иванович",
"orderID": 134567,
"phone": 79871234567,
"phoneCode": 1234567,
"additionalPhoneCodes": [12345,
65498
]
}
]
}

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

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

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

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

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

Статус	Описание	Как перевести сборочное задание в данный статус
new	Новое сборочное задание
confirm	На сборке	Перевести сборочное задание на сборку
deliver	В доставке	Перевести сборочное задание в доставку
receive	Получено покупателем	Сообщить, что сборочное задание принято покупателем
reject	Отказ покупателя при получении	Сообщить, что покупатель отказался от сборочного задания
cancel	Отменено продавцом	Отменить сборочное задание
cancel_missed_call	Отмена заказа по причине недозвона.	Статус меняется автоматически

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

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

waiting - сборочное задание в работе
sorted - сборочное задание отсортировано
sold - сборочное задание получено покупателем
canceled - отмена сборочного задания
canceled_by_client - покупатель отменил заказ при получении
declined_by_client - покупатель отменил заказ в первый чаc
Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборку
defect - отмена сборочного задания по причине брака
ready_for_pickup - сборочное задание прибыло на ПВЗ
canceled_by_missed_call - отмена заказа по причине недозвона

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

Authorizations:

HeaderApiKey

Request Body schema: application/json

orders

required

Array of integers <int64> [ 1 .. 1000 ] items [ items <int64 > ]

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

Responses

Request samples

Payload

Content type

application/json

{"orders": [5632423
]
}

Response samples

200
400
401
403
429

Content type

application/json

{"orders": [{"id": 5632423,
"supplierStatus": "new",
"wbStatus": "string"
}
]
}

Отменить сборочное задание{{ /api/v3/dbs/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/dbs/orders/{order}/confirm }}

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

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

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

Authorizations:

HeaderApiKey

path Parameters

order

required

integer <int64>

Example: 5632423

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

Responses

Response samples

Content type

application/json

{"code": "IncorrectParameter",
"message": "Передан некорректный параметр"
}

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

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

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

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

Authorizations:

HeaderApiKey

path Parameters

order

required

integer <int64>

Example: 5632423

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

Responses

Response samples

Content type

application/json

{"code": "IncorrectParameter",
"message": "Передан некорректный параметр"
}

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

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

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

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

Authorizations:

HeaderApiKey

path Parameters

order

required

integer <int64>

Example: 5632423

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

Request Body schema: application/json
required

code	string Код подтверждения. Отображается у покупателя на сайте и в приложении Wildberries

Responses

Request samples

Payload

Content type

application/json

{"code": "123456"
}

Response samples

Content type

application/json

{"code": "IncorrectParameter",
"message": "Передан некорректный параметр"
}

Сообщить, что покупатель отказался от заказа{{ /api/v3/dbs/orders/{order}/reject }}

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

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

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

Authorizations:

HeaderApiKey

path Parameters

order

required

integer <int64>

Example: 5632423

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

Request Body schema: application/json
required

code	string Код подтверждения. Отображается у покупателя на сайте и в приложении Wildberries

Responses

Request samples

Payload

Content type

application/json

{"code": "123456"
}

Response samples

Content type

application/json

{"code": "IncorrectParameter",
"message": "Передан некорректный параметр"
}

Метаданные DBS

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

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

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

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

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

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

imei — IMEI
uin — УИН
gtin — GTIN
sgtin — код маркировки

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

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

Authorizations:

HeaderApiKey

path Parameters

orderId

required

integer <int64>

Example: 5632423

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

Responses

Response samples

200
401
403
404
429

Content type

application/json

{"meta": {"imei": {"value": 123456789012345
},
"uin": {"value": 123456789012345
},
"gtin": {"value": 123456789012345
},
"sgtin": {"value": [123456789012345
]
}
}
}

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

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

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

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

imei — IMEI
uin — УИН
gtin — GTIN
sgtin — код маркировки

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

Authorizations:

HeaderApiKey

path Parameters

orderId

required

integer <int64>

Example: 5632423

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

query Parameters

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

Responses

Response samples

400
401
403
409
429

Content type

application/json

Example

IncorrectRequest

{"code": "IncorrectRequest",
"message": "Переданы некорректные данные"
}

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

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

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

Закрепить код маркировки можно только если в метаданных сборочного задания есть поле 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

Payload

Content type

application/json

{"sgtins": ["1234567890123456"
]
}

Response samples

Content type

application/json

Example

IncorrectRequestBody

{"code": "IncorrectRequestBody",
"message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием УИН (уникальный идентификационный номер){{ /api/v3/dbs/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

Payload

Content type

application/json

{"uin": "1234567890123456"
}

Response samples

400
401
403
409
429

Content type

application/json

Example

IncorrectRequestBody

{"code": "IncorrectRequestBody",
"message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием IMEI{{ /api/v3/dbs/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

Payload

Content type

application/json

{"imei": "123456789012345"
}

Response samples

400
401
403
409
429

Content type

application/json

Example

IncorrectRequestBody

{"code": "IncorrectRequestBody",
"message": "Некорректное тело запроса"
}

Закрепить за сборочным заданием GTIN{{ /api/v3/dbs/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

Payload

Content type

application/json

{"gtin": "1234567890123"
}

Response samples

400
401
403
409
429

Content type

application/json

Example

IncorrectRequestBody

{"code": "IncorrectRequestBody",
"message": "Некорректное тело запроса"
}

Заказы DBS (order)