Получение файла со штрихкодами

Info

Console

Метод доступен для модели FBY.

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

inventory-and-order-processing — Обработка заказов и учёт товаров
all-methods — Полное управление кабинетом

Запускает генерацию PDF-файла со штрихкодами переданных товаров или товаров в указанной заявке на поставку.

Файл не получится сгенерировать, если в нем будет более 1 500 штрихкодов.

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

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

Request

POST

https://api.partner.market.yandex.ru/v1/reports/documents/barcodes/generate

Body

application/json

{
    "campaignId": 0,
    "barcodeFormat": "F_30_20",
    "barcodeOfferInfos": [
        {
            "offerId": "string",
            "barcodeCount": 0
        }
    ],
    "supplyRequestId": 0
}

Name	Description
barcodeFormat*	Type: BarcodeFormatType Формат страницы и размер штрихкодов: `F_30_20` — А4, штрихкоды размера 30 × 20 мм. `F_43_25` — А4, штрихкоды размера 43 × 25 мм. `F_58_40` — А4, штрихкоды размера 58 × 40 мм. `F_43_25_SINGLE` — для печати этикеток. Enum: `F_30_20`, `F_43_25`, `F_58_40`, `F_43_25_SINGLE`
campaignId*	Type: integer<int64> Идентификатор кампании. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули: блок Идентификатор кампании; вкладка Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.
barcodeOfferInfos	Type: BarcodeOfferInfoDTO[] Список товаров. Передайте этот параметр и уникальные `offerId`, чтобы вернуть файл со штрихкодами конкретных товаров. В запросе обязательно должен быть либо `barcodeOfferInfos`, либо `supplyRequestId`, но не оба сразу. Если передается информация о товаре, у которого несколько штрихкодов, все штрихкоды будут добавлены в файл, их количество будет задано параметром `barcodeCount`. Информация о штрихкодах. Min items: `1` Max items: `100`
supplyRequestId	Type: integer<int64> Идентификатор заявки на поставку. Передайте этот параметр, чтобы вернуть файл со штрихкодами товаров в указанной заявке на поставку. Вернутся штрихкоды каждого товара в заявке. В запросе обязательно должен быть либо `barcodeOfferInfos`, либо `supplyRequestId`, но не оба сразу. Min value: `1`

BarcodeFormatType

Формат страницы и размер штрихкодов:

F_30_20 — А4, штрихкоды размера 30 × 20 мм.
F_43_25 — А4, штрихкоды размера 43 × 25 мм.
F_58_40 — А4, штрихкоды размера 58 × 40 мм.
F_43_25_SINGLE — для печати этикеток.

Type	Description
BarcodeFormatType	Enum: `F_30_20`, `F_43_25`, `F_58_40`, `F_43_25_SINGLE`

BarcodeOfferInfoDTO

Информация о штрихкодах.

Name

Description

barcodeCount*

Type: integer<int64>

Количество штрихкодов для печати.

Min value: 1

Max value: 100

offerId*

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

У каждого товара SKU должен быть свой.
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

Responses

200 OK

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

Body

application/json

{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: GenerateReportDTO

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

ApiResponseStatusType

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

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

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

GenerateReportDTO

Name

Description

estimatedGenerationTime*

Type: integer<int64>

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

reportId*

Type: string

400 Bad Request

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

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[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

403 Forbidden

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

420 Method Failure

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

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

Генерация штрихкодов

Информация о заполненности карточек