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

Метод доступен для моделей: FBS, Экспресс и DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Запускает генерацию PDF-файла с ярлыками для переданных заказов. Подробно о том, зачем они нужны и как выглядят, рассказано в Справке Маркета для продавцов.

Чтобы на ярлыке отображался внешний идентификатор заказа, передайте его в методе POST v2/campaigns/{campaignId}/orders/{orderId}/external-id.

Узнать статус генерации и получить ссылку на готовый файл можно с помощью запроса GET v2/reports/info/{reportId}.

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

Request

POST

https://api.partner.market.yandex.ru/v2/reports/documents/labels/generate

Query parameters

Name

Description

format

Type: PageFormatType

Настройка размещения ярлыков на странице. Если параметра нет, возвращается PDF с ярлыками формата A7.

Размещение ярлыков на странице PDF-файла:

  • A9_HORIZONTALLY — ярлык размером 58 × 40 мм без полей, близок к формату A9.

    Пример ярлыка для продавцов Маркета

    Изображение горизонтального ярлыка формата A9 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение горизонтального ярлыка формата A9 для продавцов Market Yandex Go

  • A9 — ярлык размером 40 × 58 мм без полей, близок к формату A9.

    Пример ярлыка для продавцов Маркета

    Изображение вертикального ярлыка формата A9 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение вертикального ярлыка формата A9 для продавцов Market Yandex Go

  • A7 — ярлык размером 75 × 120 мм (80,4 × 125,6 мм с учетом полей), близок к формату A7.

    Пример ярлыка для продавцов Маркета

    Изображение ярлыка формата A7 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение ярлыка формата A7 для продавцов Market Yandex Go

  • A4 — на листе A4 располагается ярлык того формата, который выбран в кабинете продавца на Маркете — перейдите на страницу Заказы → Заказы и отгрузки → на вкладке нужной модели работы нажмите кнопку Формат ярлыков.

Enum: A9_HORIZONTALLY, A9, A7, A4

PageFormatType

Размещение ярлыков на странице PDF-файла:

  • A9_HORIZONTALLY — ярлык размером 58 × 40 мм без полей, близок к формату A9.

    Пример ярлыка для продавцов Маркета

    Изображение горизонтального ярлыка формата A9 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение горизонтального ярлыка формата A9 для продавцов Market Yandex Go

  • A9 — ярлык размером 40 × 58 мм без полей, близок к формату A9.

    Пример ярлыка для продавцов Маркета

    Изображение вертикального ярлыка формата A9 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение вертикального ярлыка формата A9 для продавцов Market Yandex Go

  • A7 — ярлык размером 75 × 120 мм (80,4 × 125,6 мм с учетом полей), близок к формату A7.

    Пример ярлыка для продавцов Маркета

    Изображение ярлыка формата A7 для продавцов Маркета

    Пример ярлыка для продавцов Market Yandex Go

    Изображение ярлыка формата A7 для продавцов Market Yandex Go

  • A4 — на листе A4 располагается ярлык того формата, который выбран в кабинете продавца на Маркете — перейдите на страницу Заказы → Заказы и отгрузки → на вкладке нужной модели работы нажмите кнопку Формат ярлыков.

Type: string

Enum: A9_HORIZONTALLY, A9, A7, A4

Body

application/json
{
  "businessId": 1,
  "orderIds": [
    0
  ],
  "sortingType": "SORT_BY_GIVEN_ORDER"
}

Name

Description

businessId

Type: BusinessId

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

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

Min value: 1

Example: 1

orderIds

Type: integer[]

Список идентификаторов заказов.

Min items: 1

Max items: 1000

Unique items: true

Example
[
  0
]

sortingType

Type: LabelsSortingType

Тип сортировки ярлыков в файле.

Тип сортировки ярлыков:

  • SORT_BY_GIVEN_ORDER — ярлыки заказов будут расположены в том же порядке, в каком были переданы идентификаторы заказов в запросе.
  • SORT_BY_ORDER_CREATED_AT — ярлыки будут расположены в соответствии с датой создания заказа с группировкой по магазинам.

Если параметр не указан, ярлыки сортируются по дате создания.

Enum: SORT_BY_GIVEN_ORDER, SORT_BY_ORDER_CREATED_AT

BusinessId

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

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

Type: integer

Min value: 1

LabelsSortingType

Тип сортировки ярлыков:

  • SORT_BY_GIVEN_ORDER — ярлыки заказов будут расположены в том же порядке, в каком были переданы идентификаторы заказов в запросе.
  • SORT_BY_ORDER_CREATED_AT — ярлыки будут расположены в соответствии с датой создания заказа с группировкой по магазинам.

Если параметр не указан, ярлыки сортируются по дате создания.

Type: string

Enum: SORT_BY_GIVEN_ORDER, SORT_BY_ORDER_CREATED_AT

Responses

200 OK

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

Если при генерации не удалось найти часть заказов, в ответе на запрос получения готового файла вернется подстатус RESOURCE_NOT_FOUND.

Body

application/json
{
  "status": "OK",
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: GenerateReportDTO

    Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

    Example
    {
  "reportId": "example",
  "estimatedGenerationTime": 0
}
    Example
    {
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Example
{
  "status": "OK"
}

GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

Name

Description

estimatedGenerationTime

Type: integer

Ожидаемая продолжительность генерации в миллисекундах.

reportId

Type: string

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

Example: example
Example
{
  "reportId": "example",
  "estimatedGenerationTime": 0
}

400 Bad Request

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

403 Forbidden

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

420 Method Failure

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

No longer supported, please use an alternative and newer version.

Предыдущая
Готовые ярлыки для одного заказа
Следующая
Данные для изготовления ярлыков