Поиск

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

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

Вы можете протестировать методы Самовывоза в песочнице. Также в песочнице доступны специальные методы для эмуляции действий пользователя

Самовывоз

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

Вы можете протестировать методы Самовывоза в песочнице. Также в песочнице доступны специальные методы для эмуляции действий пользователя

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

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

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

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

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

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

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

Лимит запросов на один профиль продавца для методов сборочных заданий Самовывоз:
Период Лимит Интервал Всплеск
1 мин 300 запросов 200 мс 20 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey

Responses

Response samples

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

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

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

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

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

Лимит запросов на один профиль продавца для методов сборочных заданий Самовывоз:
Период Лимит Интервал Всплеск
1 мин 300 запросов 200 мс 20 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

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

Количество элементов в ответе

next
required
integer

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

dateFrom
required
integer

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

dateTo
required
integer

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

Responses

Response samples

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

Получить цены продавца и суммы к оплате{{ /api/marketplace/v3/click-collect/orders/final-price }}

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

Метод возвращает:

  • цены продавца без учёта скидок
  • суммы к оплате покупателем с учетом всех скидок и кэшбека
Лимит запросов на один профиль продавца для всех методов получения и удаления идентификаторов маркировки Самовывоз:
Период Лимит Интервал Всплеск
1 мин 150 запросов 400 мс 20 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

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

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "f1787bd2d1fdc35d6f537316514y4a05",
  • "results": [
    ]
}

Перевести сборочные задания на сборку{{ /api/marketplace/v3/click-collect/orders/status/confirm }}

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

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

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 сек 1 запрос 1 сек 10 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
required
Array of integers <= 1000 items

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

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

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

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

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 сек 1 запрос 1 сек 10 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
required
Array of integers <= 1000 items

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

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

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

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

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

  • confirm — на сборке
  • prepare — готов к выдаче
Лимит запросов на один профиль продавца для методов сборочных заданий Самовывоз:
Период Лимит Интервал Всплеск
1 мин 300 запросов 200 мс 20 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

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 }}

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

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

Доступно, если хотя бы одно сборочное задание из заказа находится в статусе prepare - готов к выдаче.

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 мин 30 запросов 2 сек 20 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

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/marketplace/v3/click-collect/orders/status/receive }}

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

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

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 сек 1 запрос 1 сек 10 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
required
Array of integers <= 1000 items

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Сообщить об отказе от заказов{{ /api/marketplace/v3/click-collect/orders/status/reject }}

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

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

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 сек 1 запрос 1 сек 10 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
required
Array of integers <= 1000 items

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

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

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

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

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

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

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



wbStatus — статус системы Wildberries.

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

  • waiting - сборочное задание в работе
  • sold - заказ получен покупателем
  • canceled - отмена сборочного задания
  • canceled_by_client - покупатель отменил заказ при получении
  • declined_by_client - покупатель отменил заказ в первый чаc
    Отмена доступна покупателю в первый час с момента заказа, если заказ не переведён на сборку
  • defect - отмена заказа по причине брака
  • ready_for_pickup - заказ готов к выдаче
Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 сек 1 запрос 1 сек 10 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
ordersIds
required
Array of integers <= 1000 items

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

Responses

Request samples

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

Response samples

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

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

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

Переводит сборочные задания из статусов new, confirm, prepare в статус cancel — отменено продавцом.

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 сек 1 запрос 1 сек 10 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
ordersIds
required
Array of integers <= 1000 items

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Идентификаторы маркировки Самовывоз

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

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

Заполнять идентификаторы маркировки сборочных заданий в песочнице необязательно

Получить идентификаторы маркировки сборочных заданий{{ /api/marketplace/v3/click-collect/orders/meta/details }}

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

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

Перечень идентификаторов маркировки, доступных для сборочного задания, можно получить в списке новых сборочных заданий, поле requiredMeta. Если поле requiredMeta не содержит какой-либо идентификатор маркировки, значит, у сборочного задания не может быть этого идентификатора — и добавить его нельзя.
Возможные идентификаторы маркировки:

Лимит запросов на один профиль продавца для всех методов получения и удаления идентификаторов маркировки Самовывоз:
Период Лимит Интервал Всплеск
1 мин 150 запросов 400 мс 20 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
ordersIds
required
Array of integers <= 1000 items

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "f1787bd2d1fdс35d6f537316514у4a05",
  • "orders": [
    ]
}

Удалить идентификаторы маркировки сборочных заданий{{ /api/marketplace/v3/click-collect/orders/meta/delete }}

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

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

В одном запросе можно удалить идентификаторы маркировки только одного типа. Укажите тип идентификаторов маркировки в запросе:

Лимит запросов на один профиль продавца для всех методов получения и удаления идентификаторов маркировки Самовывоз:
Период Лимит Интервал Всплеск
1 мин 150 запросов 400 мс 20 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
key
required
string
Enum: imei uin gtin sgtin customsDeclaration

Тип идентификаторов маркировки для удаления. Передаётся только одно значение

ordersIds
required
Array of integers <= 1000 items

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Закрепить коды маркировки Честного знака за сборочными заданиями{{ /api/marketplace/v3/click-collect/orders/meta/sgtin }}

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

Метод обновляет код маркировки Честного знака в идентификаторах маркировки сборочных заданий.
Закрепить код маркировки можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле sgtin.

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

Лимит запросов на один профиль продавца для всех методов закрепления идентификаторов маркировки Самовывоз:
Период Лимит Интервал Всплеск
1 мин 20 запросов 3 сек 500 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Закрепить УИН за сборочными заданиями{{ /api/marketplace/v3/click-collect/orders/meta/uin }}

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

Метод обновляет УИН, уникальные идентификационные номера, в идентификаторах маркировки сборочных заданий. У одного сборочного задания может быть только один УИН.
Закрепить УИН можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле uin.

Лимит запросов на один профиль продавца для всех методов закрепления идентификаторов маркировки Самовывоз:
Период Лимит Интервал Всплеск
1 мин 20 запросов 3 сек 500 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

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

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

Метод обновляет IMEI в идентификаторах маркировки сборочных заданий.
У одного сборочного задания может быть только один IMEI. Если у устройства два IMEI — IMEI и IMEI2 или IMEI1 и IMEI2 — укажите только IMEI или IMEI1. IMEI2 указывать не нужно.
Закрепить IMEI можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле imei.

Лимит запросов на один профиль продавца для всех методов закрепления идентификаторов маркировки Самовывоз:
Период Лимит Интервал Всплеск
1 мин 20 запросов 3 сек 500 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

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

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

Метод обновляет GTIN, уникальный ID товара в Беларуси, в идентификаторах маркировки сборочных заданий. У одного сборочного задания может быть только один GTIN.
Закрепить GTIN можно только за сборочным заданием в статусе confirm и если в идентификаторах маркировки сборочного задания есть поле gtin.

Лимит запросов на один профиль продавца для всех методов закрепления идентификаторов маркировки Самовывоз:
Период Лимит Интервал Всплеск
1 мин 20 запросов 3 сек 500 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "03615778-eb9e-4f55-b4O4-fd3ac0fad2сc",
  • "results": [
    ]
}

Закрепить номера ДТ за сборочными заданиями{{ /api/marketplace/v3/click-collect/orders/meta/customs-declaration }}

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

Метод обновляет номера ДТ — деклараций на товары — и коды стран происхождения товаров в идентификаторах маркировки сборочных заданий. У одного сборочного задания может быть только один номер ДТ.
Закрепить номер ДТ можно, только если выполняются все условия:

Лимит запросов на один профиль продавца для всех методов закрепления идентификаторов маркировки Самовывоз:
Период Лимит Интервал Всплеск
1 мин 20 запросов 3 сек 500 запросов

Один запрос с кодами ответов 4XX учитывается как 10 запросов.


В песочнице — максимум 1 запрос в секунду суммарно для всех методов Маркетплейса.

Authorizations:
HeaderApiKey
Request Body schema: application/json
required
required
Array of objects <= 1000 items

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "requestId": "7849e1c4-d30e-4937-abe3-0e54e85874bd",
  • "results": [
    ]
}