自标签生产数据

方法适用于模式:FBS, ExpressDBS.

目前不适用于卖家Market Yandex Go.

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

返回订单中粘在盒子上的标签信息。

⚙️ 限制: 每小时100,000次请求

Request

GET

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

Path parameters

Name

Description

campaignId

Type: integer

广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:

  • 运动ID;
  • 标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要把它与:

  • 商店的标识符,显示在商家的个人帐户中。
  • 广告活动。

Min value: 1

orderId

Type: integer

的订单ID。

Responses

200 OK

用于打印标签的信息。

Body

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

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    响应的类型。 可能的值:

    • OK — 没有错误。
    • ERROR — 处理请求时出错。

    Enum: OK, ERROR

    服务器响应的标准包装器。

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

    result

    Type: object

    orderId

    Type: integer

    的订单ID。

    parcelBoxLabels

    Type: object[]

    boxId

    Type: integer

    箱的ID。

    deliveryServiceId

    Type: string

    送服务ID。 有关派递服务的资料,可透过要求 GET delivery/services.

    Example: example

    deliveryServiceName

    Type: string

    送货服务的法定名称。

    Example: example

    fulfilmentId

    Type: string

    商店信息系统中盒子的ID。

    以格式返回: 市场上的订单号是箱号。. 例如, 7206821‑1, 7206821‑2 等等。

    Example: example

    orderId

    Type: integer

    市场系统中的订单ID。

    orderNum

    Type: string

    商店信息系统中的订单ID。

    orderId 如果市场不知道商店系统中的订单号。

    Example: example

    place

    Type: string

    顺序中的箱号。 以格式返回: 座位数/座位总数.

    Example: example

    recipientName

    Type: string

    订单收件人的姓氏和首字母。

    Example: example

    supplierName

    Type: string

    商店的法定名称。

    Example: example

    url

    Type: string

    Min length: 1

    Max length: 2000

    Example: example

    weight

    Type: string

    订单中所有物品的总重量。

    以格式返回 重量kg.

    Example: example

    deliveryAddress

    Type: string

    收件人的地址。

    Example: example

    shipmentDate

    Type: string

    装运日期的格式 dd.MM.yyyy.

    Example: example

    标签上的信息。

    Example
    [
      {
        "url": "example",
        "supplierName": "example",
        "deliveryServiceName": "example",
        "orderId": 0,
        "orderNum": "example",
        "recipientName": "example",
        "boxId": 0,
        "fulfilmentId": "example",
        "place": "example",
        "weight": "example",
        "deliveryServiceId": "example",
        "deliveryAddress": "example",
        "shipmentDate": "example"
      }
    ]
    

    placesNumber

    Type: integer

    顺序的框数。

    url

    Type: string

    Min length: 1

    Max length: 2000

    Example: example

    用于打印标签的数据。

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

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

    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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

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

404 Not Found

找不到请求的资源。 有关错误的更多信息

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

    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: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

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

500 Internal Server Error

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

Body

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

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

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

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

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

    服务器错误的标准包装器。

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

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