Данные для самостоятельного изготовления ярлыков

Info

Console

Возвращает информацию на ярлыках, которые клеятся на коробки в заказе.

⚙️ Лимит: 100 000 запросов в час

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}/orders/{orderId}/delivery/labels/data

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

orderId*

Type: integer<int64>

Идентификатор заказа.

Responses

200 OK

Информация для печати ярлыков.

Body

application/json

{
    "status": "OK",
    "result": {
        "orderId": 0,
        "placesNumber": 0,
        "url": "string",
        "parcelBoxLabels": [
            {
                "url": "string",
                "supplierName": "string",
                "deliveryServiceName": "string",
                "orderId": 0,
                "orderNum": "string",
                "recipientName": "string",
                "boxId": 0,
                "fulfilmentId": "string",
                "place": "string",
                "weight": "string",
                "deliveryServiceId": "string",
                "deliveryAddress": "string",
                "shipmentDate": "string"
            }
        ]
    }
}

Name

Description

result

Type: OrderLabelDTO

Данные для печати ярлыка.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

OrderLabelDTO

Данные для печати ярлыка.

Name	Description
orderId*	Type: integer<int64> Идентификатор заказа.
parcelBoxLabels*	Type: ParcelBoxLabelDTO[] Информация на ярлыке. Информация о ярлыке для коробки.
placesNumber*	Type: integer<int32> Количество коробок в заказе.
url*	Type: string URL файла с ярлыками‑наклейками на все коробки в заказе. Соответствует URL, по которому выполняется запрос GET campaigns/{campaignId}/orders/{orderId}/delivery/labels.

ApiResponseStatusType

Тип ответа.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

ParcelBoxLabelDTO

Информация о ярлыке для коробки.

Name	Description
boxId*	Type: integer<int64> Идентификатор коробки.
deliveryServiceId*	Type: string Идентификатор службы доставки. Информацию о службе доставки можно получить с помощью запроса GET delivery/services.
deliveryServiceName*	Type: string Юридическое название службы доставки.
fulfilmentId*	Type: string Идентификатор коробки в информационной системе магазина. Возвращается в формате: `номер заказа на Маркете-номер коробки`. Например, `7206821‑1`, `7206821‑2` и т. д.
orderId*	Type: integer<int64> Идентификатор заказа в системе Маркета.
orderNum*	Type: string Идентификатор заказа в информационной системе магазина. Совпадает с `orderId`, если Маркету неизвестен номер заказа в системе магазина.
place*	Type: string Номер коробки в заказе. Возвращается в формате: `номер места/общее количество мест`.
recipientName*	Type: string Фамилия и инициалы получателя заказа.
supplierName*	Type: string Юридическое название магазина.
url*	Type: string Соответствует URL, по которому выполняется запрос GET campaigns/{campaignId}/orders/{orderId}/delivery/shipments/{shipmentId}/boxes/{boxId}/label.
weight*	Type: string Этот параметр устарел. Не используйте его. Общая масса всех товаров в заказе. Возвращается в формате: `weight кг`.
deliveryAddress	Type: string Адрес получателя.
shipmentDate	Type: string Дата отгрузки в формате `dd.MM.yyyy`.

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

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: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

Была ли статья полезна?

Готовые ярлыки для нескольких заказов

Ярлыки для доверительной приемки (FBS)