Получение информации о ярлыках
Возвращает информацию о возможности печати ярлыков-наклеек для заказов в отгрузке.
⚙️ Лимит: 100 запросов в час |
---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/orders/info
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
shipmentId* |
Type: integer<int64> Идентификатор отгрузки. |
Responses
200 OK
Информация по годным/негодным для печати ярлыков заказам в отгрузке.
Body
{
"status": "OK",
"result": {
"orderIdsWithLabels": [
0
],
"orderIdsWithoutLabels": [
0
]
}
}
Name |
Description |
status |
Type: ApiResponseStatusType Тип ответа.
|
result |
Type: OrdersShipmentInfoDTO Годные/негодные ярлыки по заказам в отгрузке. |
OrdersShipmentInfoDTO
Годные/негодные ярлыки по заказам в отгрузке.
Name |
Description |
orderIdsWithLabels* |
Type: integer<int64>[] Идентификаторы заказов в отгрузке, для которых можно распечатать ярлыки.
|
orderIdsWithoutLabels* |
Type: integer<int64>[] Идентификаторы заказов в отгрузке, для которых нельзя распечатать ярлыки.
|
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
status |
Type: ApiResponseStatusType Тип ответа.
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
Name |
Description |
code* |
Type: string Код ошибки. |
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
status |
Type: ApiResponseStatusType Тип ответа.
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
status |
Type: ApiResponseStatusType Тип ответа.
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
status |
Type: ApiResponseStatusType Тип ответа.
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
status |
Type: ApiResponseStatusType Тип ответа.
|
errors |
Type: ApiErrorDTO[] Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
status |
Type: ApiResponseStatusType Тип ответа.
|
errors |
Type: ApiErrorDTO[] Список ошибок. |