Публичное АПИ по работе со схемой доставки "Самовывоз".
Для начала работы свяжитесь с менеджером Wildberries и попросите создать для вас склад.
| Код ошибки | Описание |
|---|---|
| InternalServerError | Внутренняя ошибка сервиса |
| Unauthorized | Не авторизован |
| AccessDenied | Доступ запрещён |
| IncorrectRequestBody | Передано некорректное тело запроса |
| NotFound | Запрашиваемые данные не найдены |
| IncorrectParameter | Передан некорректный параметр |
| IncorrectRequest | Переданы некорректные данные в теле запроса |
| StatusMismatch | Несоответствие статусов, проверьте их правильность |
| FailedToUpdateMeta | Не удалось обновить метаданные сборочного задания |
| InvalidPasscode | Введён неправильный проверочный код |
Возвращает список всех новых сборочных заданий у продавца на данный момент.
Array of objects (api.NewOrder) Список сборочных заданий |
{- "orders": [
- {
- "ddate": "29.10.2024",
- "salePrice": 14000,
- "requiredMeta": [
- "sgtin"
], - "article": "wb1702fyjh",
- "rid": "1234567673554519872.0.0",
- "createdAt": "2024-10-29T10:19:30Z",
- "warehouseAddress": "",
- "orderCode": "",
- "skus": [
- "2041546265353"
], - "id": 1234567890,
- "warehouseId": 1234567,
- "nmId": 123456789,
- "chrtId": 987654321,
- "price": 14000,
- "currencyCode": 643,
- "cargoType": 1,
- "isZeroOrder": false
}
]
}Переводит сборочное задание в статус prepare ("Готово к выдаче").
| orderId required | integer ID сборочного задания |
{- "code": "string",
- "data": { },
- "message": "string"
}Метод позволяет получать информацию о клиенте по ID заказа. Доступно только для заказов в статусе "На сборке" и "Готово к получению".
Список заказов
| orders | Array of integers Список заказов |
Array of objects (api.OrderClientInfo) |
{- "orders": [
- {
- "firstName": "string",
- "orderID": 0,
- "phone": "string",
- "phoneCode": 0
}
]
}Сообщает, принадлежит ли проверяемый заказ клиенту или нет по переданному коду.
Код проверки клиента
| orderCode | string Уникальный номер заказа клиента |
| passcode | string Код для проверки клиента |
| ok | boolean Флаг, сообщающий, принадлежит заказ клиенту или нет |
{- "ok": true
}Возвращает информацию по сборочным заданиям без их актуального статуса. Только по завершённым (архив). Можно выгрузить данные за конкретный период, максимум 30 календарных дней
| limit required | integer Параметр пагинации. Устанавливает предельное количество возвращаемых данных. |
| next required | integer Параметр пагинации. Устанавливает значение, с которого надо получить следующий пакет данных. Для получения полного списка данных должен быть равен 0 в первом запросе. Для следующих запросов необходимо брать значения из одноимённого поля в ответе. |
| dateFrom required | integer Дата начала периода в формате Unix timestamp. |
| dateTo required | integer Дата конца периода в формате Unix timestamp |
| next | integer Параметр пагинации. Содержит значение, которое необходимо указать в запросе для получения следующего пакета данных |
Array of objects (api.Order) Список сборочных заданий |
{- "next": 0,
- "orders": [
- {
- "article": "string",
- "cargoType": 0,
- "chrtId": 0,
- "createdAt": "string",
- "currencyCode": 0,
- "id": 0,
- "isZeroOrder": true,
- "nmId": 0,
- "orderCode": "string",
- "orderUid": "string",
- "price": 0,
- "rid": "string",
- "skus": [
- "string"
], - "warehouseAddress": "string",
- "warehouseId": 0
}
]
}Переводит сборочное задание в статус receive ("Получено клиентом").
| orderId required | integer ID сборочного задания |
{- "code": "string",
- "data": { },
- "message": "string"
}Возвращает статусы сборочных заданий по переданному списку идентификаторов сборочных заданий. supplierStatus - статус сборочного задания, триггером изменения которого является сам продавец. Возможны следующие значения данного поля:
| Статус | Описание | Как перевести сборочное задание в данный статус |
|---|---|---|
| new | Новое сборочное задание | |
| confirm | На сборке | PATCH /api/v3/click-collect/orders/{orderId}/confirm |
| prepare | Готов к выдаче | PATCH /api/v3/click-collect/orders/{orderId}/prepare |
| receive | Получено клиентом | PATCH /api/v3/click-collect/orders/{orderId}/receive |
| reject | Отказ покупателя | PATCH /api/v3/click-collect/orders/{orderId}/reject |
| cancel | Отменено продавцом | PATCH /api/v3/click-collect/orders/{orderId}/cancel |
| cancel_shelf_life | Отмена по истечению срока хранения | Переводится автоматически по возникновению события |
wbStatus - статус сборочного задания в системе Wildberries. Возможны следующие значения данного поля:
Список заказов
| orders | Array of integers Список заказов |
Array of objects (api.OrderStatus) Список статусов сборочных заданий |
{- "orders": [
- {
- "id": 0,
- "supplierStatus": "string",
- "wbStatus": "string"
}
]
}Возвращает метаданные заказа. Возможные метаданные: imei, uin, gtin, sgtin В ответе метода возвращаются метаданные, доступные для сборочного задания. Если ответ вернулся с пустой структурой meta, значит у сборочного задания нет метаданных, и добавление их не доступно.
| orderId required | integer ID сборочного задания |
object Метаданные сборочного задания |
{- "meta": {
- "gtin": "string",
- "imei": "string",
- "sgtin": [
- "string"
], - "uin": "string"
}
}Удаляет значение метаданных заказа для переданного ключа. Возможные метаданные: imei, uin, gtin, sgtin Передается только одно значение.
| orderId required | integer ID сборочного задания |
| key required | string Название метаданных для удаления (imei, uin, gtin, sgtin). Передается только одно значение. |
{- "code": "string",
- "data": { },
- "message": "string"
}Обновляет GTIN (уникальный идентификатор товара в Беларуси) сборочного задания. У одного сборочного задания может быть только один GTIN. Добавлять маркировку можно только для заказов в статусе confirm и доставка которых осуществляется силами Wildberries.
| orderId required | integer ID сборочного задания |
GTIN
| gtin | string GTIN |
{- "code": "string",
- "data": { },
- "message": "string"
}Обновляет IMEI сборочного задания. У одного сборочного задания может быть только один IMEI. Добавлять маркировку можно только для заказов в статусе confirm и доставка которых осуществляется силами Wildberries.
| orderId required | integer ID сборочного задания |
IMEI
| imei | string IMEI |
{- "code": "string",
- "data": { },
- "message": "string"
}Метод позволяет закрепить за сборочным заданием КиЗ (маркировку Честного знака). Закрепление КиЗ за сборочным заданием возможно только в случае, если это поле возвращается в ответе метода Получить метаданные сборочного задания, а сборочное задание находится в статусе confirm. Получить загруженные КиЗ можно методом Получить метаданные сборочного задания С правилами работы с КиЗ можно ознакомиться тут: https://честныйзнак.рф
| orderId required | integer ID сборочного задания |
Массив КиЗов. Допускается от 16 до 135 символов для кода одной маркировки.
| sgtins | Array of strings Массив КиЗов. Допускается от 16 до 135 символов для кода одной маркировки. |
{- "code": "string",
- "data": { },
- "message": "string"
}Обновляет УИН сборочного задания. У одного сборочного задания может быть только один УИН. Добавлять маркировку можно только для заказов в статусе confirm и доставка которых осуществляется силами Wildberries.
| orderId required | integer ID сборочного задания |
УИН
| uin | string УИН |
{- "code": "string",
- "data": { },
- "message": "string"
}