Перенос заказов в следующую отгрузку
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- inventory-and-order-processing — Обработка заказов и учёт товаров
- all-methods — Полное управление кабинетом
Переносит указанные заказы из указанной отгрузки в следующую отгрузку. Что такое отгрузка?
Используйте этот запрос, если не успеваете собрать и упаковать заказы вовремя.
Такие переносы снижают индекс качества магазина
Этот запрос предназначен для исключительных случаев. Если вы будете переносить заказы слишком часто, магазин столкнется с ограничениями. Что за ограничения?
Переносить заказы можно, если до формирования отгрузки осталось больше получаса.
Перенос происходит не мгновенно, а занимает несколько минут.
⚙️ Лимит: 200 запросов в час |
---|
Request
POST
https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/transfer
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
Min value: |
shipmentId* |
Type: integer<int64> Идентификатор отгрузки. Min value: |
Body
application/json
{
"orderIds": [
0
]
}
Name |
Description |
orderIds* |
Type: integer<int64>[] Список заказов, которые вы не успеваете подготовить. Max items: Min items: |
Responses
200 OK
Запрос на перенос заказов проверен и принят, и они будут перенесены спустя несколько минут.
Body
application/json
{
"status": "OK"
}
Name |
Description |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
400 Bad Request
Ошибка 400 обозначает, что в переданном вами списке заказов что-то не так — например, не все они относятся к заданной отгрузке. В сообщении об ошибке будут все подробности.
Частичное выполнение запроса невозможно
Если в списке есть хотя бы один проблемный идентификатор, не будет перенесен ни один заказ из списка.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
ApiErrorDTO
Общий формат ошибки.
Name |
Description |
code* |
Type: string Код ошибки. |
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
No longer supported, please use an alternative and newer version.