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

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

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

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

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

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

Узнать, как использовать методы в бизнес-кейсах, можно в инструкции по работе с заказами Самовывоз

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

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

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

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

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

Лимит запросов на один аккаунт продавца для всех методов сборочных заданий Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

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

Authorizations:

HeaderApiKey

Responses

Response samples

200
401
403
429

Content type

application/json

{"orders": [{"ddate": "29.10.2024",
"salePrice": 14000,
"requiredMeta": ["sgtin"
],
"article": "wb1702fyjh",
"rid": "1234567673554519872.0.0",
"createdAt": "2024-10-29T10:19:30Z",
"warehouseAddress": "Москва, район Якиманка, Софийская набережная, 4 с1",
"orderCode": "23457822-6667",
"payMode": "prepaid",
"skus": ["2041546265353"
],
"id": 1234567890,
"warehouseId": 1234567,
"nmId": 123456789,
"chrtId": 987654321,
"price": 14000,
"finalPrice": 14000,
"convertedPrice": 14000,
"convertedFinalPrice": 14000,
"currencyCode": 643,
"convertedCurrencyCode": 643,
"cargoType": 1,
"isZeroOrder": false
}
]
}

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

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

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

Лимит запросов на один аккаунт продавца для всех методов сборочных заданий Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

Один запрос с кодом ответа 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 — готово к выдаче.

Лимит запросов на один аккаунт продавца для всех методов сборочных заданий Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

Один запрос с кодом ответа 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 — готов к выдаче

Лимит запросов на один аккаунт продавца для всех методов сборочных заданий Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

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

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

orders

Array of integers

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

Responses

Request samples

Payload

Content type

application/json

{"orders": [1234567
]
}

Response samples

200
400
401
403
429

Content type

application/json

{"orders": [{"phone": "+71111111111",
"firstName": "Иван",
"orderID": 1234567,
"phoneCode": 1234567
}
]
}

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

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

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

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

Лимит запросов на один аккаунт продавца:

Период	Лимит	Интервал	Всплеск
1 минута	30 запросов	2 секунды	20 запросов

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

orderCode	string Уникальный ID заказа покупателя
passcode	string Код подтверждения

Responses

Request samples

Payload

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 — получено покупателем.

Лимит запросов на один аккаунт продавца для всех методов сборочных заданий Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

Один запрос с кодом ответа 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 — отказ при получении.

Лимит запросов на один аккаунт продавца для всех методов сборочных заданий Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

Один запрос с кодом ответа 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`	На сборке	Перевести сборочное задание на сборку
`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 минута	300 запросов	200 миллисекунд	20 запросов

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

Authorizations:

HeaderApiKey

Request Body schema: application/json
required

orders

Array of integers

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

Responses

Request samples

Payload

Content type

application/json

{"orders": [1234567
]
}

Response samples

200
400
401
403
429

Content type

application/json

{"orders": [{"supplierStatus": "confirm",
"wbStatus": "waiting",
"id": 1234567
}
]
}

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

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

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

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

Лимит запросов на один аккаунт продавца для всех методов сборочных заданий Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

Один запрос с кодом ответа 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

200
400
401
403
429

Content type

application/json

{"next": 12345566,
"orders": [{"article": "wb6scpbwvp",
"cargoType": 1,
"chrtId": 12345676,
"createdAt": "2025-03-21T09:53:31Z",
"price": 5000,
"finalPrice": 5000,
"convertedPrice": 5000,
"convertedFinalPrice": 5000,
"currencyCode": 643,
"convertedCurrencyCode": 643,
"id": 123456789,
"isZeroOrder": false,
"nmId": 1234567898765,
"orderCode": "21117866-0006",
"orderUid": "165918930_629fbc924b984618a44354475ca58675",
"payMode": "prepaid",
"rid": "5044304527347733263.0.0",
"skus": ["2043227963145"
],
"warehouseAddress": "Москва, район Якиманка, Софийская набережная, 4 с1",
"warehouseId": 1162157
}
]
}

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

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

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

Лимит запросов на один аккаунт продавца для всех методов сборочных заданий Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

Один запрос с кодом ответа 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 }}

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

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

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

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

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

Authorizations:

HeaderApiKey

path Parameters

orderId

required

integer

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

Responses

Response samples

200
401
403
404
429

Content type

application/json

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

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

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

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

Лимит запросов на один аккаунт продавца для всех методов получения и удаления метаданных Самовывоз:

Период	Лимит	Интервал	Всплеск
1 минута	300 запросов	200 миллисекунд	20 запросов

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

Authorizations:

HeaderApiKey

path Parameters

orderId

required

integer

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

query Parameters

key

required

string

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

Responses

Response samples

401
403
404
429

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 минута	1000 запросов	60 миллисекунд	20 запросов

Один запрос с кодом ответа 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

Payload

Content type

application/json

{"sgtins": ["1234567890123456"
]
}

Response samples

Content type

application/json

Example

IncorrectRequestBody

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

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

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

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

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

Период	Лимит	Интервал	Всплеск
1 минута	1000 запросов	60 миллисекунд	20 запросов

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

Authorizations:

HeaderApiKey

path Parameters

orderId

required

integer

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

Request Body schema: application/json
required

uin	string УИН

Responses

Request samples

Payload

Content type

application/json

{"uin": ["1234567890123456"
]
}

Response samples

Content type

application/json

Example

IncorrectRequestBody

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

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

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

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

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

Период	Лимит	Интервал	Всплеск
1 минута	1000 запросов	60 миллисекунд	20 запросов

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

Authorizations:

HeaderApiKey

path Parameters

orderId

required

integer

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

Request Body schema: application/json
required

imei	string IMEI

Responses

Request samples

Payload

Content type

application/json

{"imei": ["123456789012345"
]
}

Response samples

Content type

application/json

Example

IncorrectRequestBody

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

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

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

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

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

Период	Лимит	Интервал	Всплеск
1 минута	1000 запросов	60 миллисекунд	20 запросов

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

Authorizations:

HeaderApiKey

path Parameters

orderId

required

integer

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

Request Body schema: application/json
required

gtin	string GTIN

Responses

Request samples

Payload

Content type

application/json

{"gtin": ["1234567890123456"
]
}

Response samples

Content type

application/json

Example

IncorrectRequestBody

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

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