现成的标签-在几个订单中所有盒子的贴纸

方法适用于模式:FBS, 快递DBS.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

开始生成带有转移订单快捷方式的PDF文件。 详细说明了为什么需要它们以及它们的外观 在市场对卖家的帮助.

您可以查找生成状态,并使用请求获取到已完成文件的链接。 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.

PageFormatType

在PDF文件页面上放置标签:

  • A9_HORIZONTALLY -一个58×40毫米的标签,没有边距,接近格式 A9.

    市场卖家的标签示例

    水平格式标签的图像 A9 市场卖家须知

    市场Yandex Go卖家的捷径示例

    市场Yandex Go卖家的a9格式水平标签的图像

  • A9 -标签尺寸为40x58毫米,无边距,接近A9格式。

    市场卖家的标签示例

    垂直标签格式的图像 A9 市场卖家须知

    市场Yandex Go卖家的捷径示例

    垂直标签格式的图像 A9 对于Yandex Go市场的卖家

  • A7 -标签尺寸75×120毫米(80.4×125.6毫米,包括边距),接近格式 A7.

    市场卖家的标签示例

    市场卖家的A7格式标签的图像

    市场Yandex Go卖家的捷径示例

    格式标签的图像 A7 对于Yandex Go市场的卖家

  • A4 —在A4工作表上有一个在市场上卖方办公室选择的格式的标签-转到页面 命令订单及付运 →在所需工作模型的选项卡上,单击 标签格式.

Type

Description

PageFormatType

Enum: A9_HORIZONTALLY, A9, A7, A4

Body

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

Name

Description

businessId*

Type: integer<int64>

内阁ID。

orderIds*

Type: integer<int64>[]

订单Id列表。
的订单ID。

Min items: 1

Max items: 1000

Unique items  

sortingType

Type: LabelsSortingType

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

Enum: SORT_BY_GIVEN_ORDER, SORT_BY_ORDER_CREATED_AT

LabelsSortingType

标签排序类型:

  • SORT_BY_GIVEN_ORDER -订单标签将按照请求中发送的订单Id的顺序排列。
  • SORT_BY_ORDER_CREATED_AT -标签将根据订单创建日期排列,并按商店分组。

如果未指定参数,则按创建日期对标签进行排序。

Type

Description

LabelsSortingType

Enum: SORT_BY_GIVEN_ORDER, SORT_BY_ORDER_CREATED_AT

Responses

200 OK

作为响应,您会收到一个标识符,该标识符允许您找出生成状态并下载完成的文件。

如果在生成过程中找不到部分订单,则将返回子状态以响应接收完成文件的请求。 RESOURCE_NOT_FOUND.

Body

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

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Enum: OK, ERROR

result

Type: GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK -没有错误。
  • ERROR -处理请求时发生错误。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

Name

Description

estimatedGenerationTime*

Type: integer<int64>

以毫秒为单位的预期生成时间。

reportId*

Type: string

跟踪生成状态和接收完成的报告或文档所需的ID。

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

Yandex的内部错误。 市场。 有关错误的更多信息

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

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