Поиск
API docs by Redocly

Заказы Самовывоз (instorepickup)

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

Заказы Самовывоз

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

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

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

Порядок работы по схеме:

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

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

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

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey

Responses

Response samples

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

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

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

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Responses

Response samples

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

Сообщить, что сборочное задание готово к выдаче{{ /api/v3/click-collect/orders/{orderId}/prepare }}

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

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Responses

Response samples

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

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

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

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

  • Информацию можно получить только для сборочных заданий, находящихся на сборке — статус confirm и готовых к получению — статус prepare.
Максимум 300 запросов в минуту для всех методов схемы Самовывоз на один аккаунт продавца.

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

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

Responses

Request samples

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

Response samples

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

Проверить, что сборочное задание принадлежит покупателю{{ /api/v3/click-collect/orders/client/identity }}

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

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

Максимум 3 запроса в минуту на один аккаунт продавца.

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orderCode
string

Уникальный ID заказа покупателя

passcode
string

Код подтверждения

Responses

Request samples

Content type
application/json
{
  • "orderCode": "170046918-0011",
  • "passcode": "4567"
}

Response samples

Content type
application/json
{
  • "ok": true
}

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

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

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Responses

Response samples

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

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

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

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Responses

Response samples

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

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

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

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

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

Возможные значения 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 — статус сборочного задания в системе WB.

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
orders
Array of integers

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

Responses

Request samples

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

Response samples

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

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

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

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

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
query Parameters
limit
required
integer [ 1 .. 1000 ]

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

next
required
integer

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

dateFrom
required
integer

Дата начала периода в формате Unix timestamp

dateTo
required
integer

Дата конца периода в формате Unix timestamp

Responses

Response samples

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

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

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

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Responses

Response samples

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

Метаданные Самовывоз

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

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

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

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

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

Возможные метаданные: imei, uin, gtin, sgtin

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Responses

Response samples

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

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

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

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

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

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

query Parameters
key
required
string

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

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/click-collect/orders/{orderId}/meta/sgtin }}

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

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

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

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

Максимум 1 000 запросов в минуту суммарно на один аккаунт продавца для методов:
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием код маркировки

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Request Body schema: application/json
required
sgtins
Array of strings

Массив кодов маркировки. Допускается от 16 до 135 символов для кода одной маркировки

Responses

Request samples

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

Response samples

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

Закрепить за сборочным заданием УИН (уникальный идентификационный номер){{ /api/v3/click-collect/orders/{orderId}/meta/uin }}

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

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

Максимум 1 000 запросов в минуту суммарно на один аккаунт продавца для методов:
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием код маркировки

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Request Body schema: application/json
required
uin
string

УИН

Responses

Request samples

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

Response samples

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

Закрепить за сборочным заданием IMEI{{ /api/v3/click-collect/orders/{orderId}/meta/imei }}

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

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

Максимум 1 000 запросов в минуту суммарно на один аккаунт продавца для методов:
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием код маркировки

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Request Body schema: application/json
required
imei
string

IMEI

Responses

Request samples

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

Response samples

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

Закрепить за сборочным заданием GTIN{{ /api/v3/click-collect/orders/{orderId}/meta/gtin }}

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

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

Максимум 1 000 запросов в минуту суммарно на один аккаунт продавца для методов:
1. Закрепить за сборочным заданием УИН
2. Закрепить за сборочным заданием IMEI
3. Закрепить за сборочным заданием GTIN
4. Закрепить за сборочным заданием код маркировки

Один запрос с кодом ответа 409 учитывается как 5 запросов
Authorizations:
HeaderApiKey
path Parameters
orderId
required
integer

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

Request Body schema: application/json
required
gtin
string

GTIN

Responses

Request samples

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

Response samples

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