getShippingLabels - Amazon Selling Partner API (SP-API)-中文

返回您指定时间范围内创建的运输标签列表。您可以使用 createdAfter 和 createdBefore 参数来定义该时间范围。必须同时使用这两个参数。搜索的日期范围不得超过 7 天。

使用计划：

速率（每秒请求次数）	突发
10	10

x-amzn-RateLimit-Limit 响应头返回适用于请求操作的使用计划速率限制（如果可用）。上表显示了此操作的默认速率和突发值。业务需求需要更高吞吐量的销售合作伙伴可能会看到高于这里显示的速率和突发值。有关更多信息，请参阅销售伙伴 API 中的使用计划和速率限制。

请求参数

Query 参数

shipFromPartyId

string

可选

订单履行的供应商 warehouseId。如果未指定，结果将包含所有仓库的订单。

limit

integer

可选

返回记录的数量限制。

>= 1<= 100

createdAfter

string <date-time>

必需

在此日期和时间之后生成的运输标签将包含在结果中。必须使用ISO 8601日期/时间格式。

createdBefore

string <date-time>

必需

在此日期和时间之前可用的运输标签将包含在结果中。必须采用ISO 8601日期/时间格式。

sortOrder

enum<string>

可选

按订单创建日期升序或降序排序。

枚举值:

ASCDESC

默认值:

ASC

nextToken

string

可选

用于分页，当船舶标签数量超过指定的结果大小限制时。令牌值在之前的API调用中返回。

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

您对此操作的速率限制（每秒请求数量）。

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

`getShippingLabels` 操作的响应模式。

payload

object (ShippingLabelList)

可选

响应有效载荷包含运送标签列表

pagination

object (Pagination)

可选

检索剩余数据所需的分页元素。

shippingLabels

array[object (ShippingLabel) {5}]

可选

一个包含生成的运输标签详细信息的数组。

errors

array[object (Error) {3}]

可选

请求失败时返回的错误响应列表。

code

string

必需

一个标识发生错误类型的错误代码。

message

string

必需

描述错误状态的消息。

details

string

可选

可以帮助拨打者理解或解决问题的附加细节。

示例

{
  "payload": {
    "pagination": {
      "nextToken": "string"
    },
    "shippingLabels": [
      {
        "purchaseOrderNumber": "string",
        "sellingParty": {
          "partyId": "string",
          "address": {
            "name": "string",
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "city": "string",
            "county": "string",
            "district": "string",
            "stateOrRegion": "string",
            "postalCode": "string",
            "countryCode": "string",
            "phone": "string"
          },
          "taxRegistrationDetails": [
            {
              "taxRegistrationType": "VAT",
              "taxRegistrationNumber": "string",
              "taxRegistrationAddress": {
                "name": "string",
                "addressLine1": "string",
                "addressLine2": "string",
                "addressLine3": "string",
                "city": "string",
                "county": "string",
                "district": "string",
                "stateOrRegion": "string",
                "postalCode": "string",
                "countryCode": "string",
                "phone": "string"
              },
              "taxRegistrationMessages": "string"
            }
          ]
        },
        "shipFromParty": {
          "partyId": "string",
          "address": {
            "name": "string",
            "addressLine1": "string",
            "addressLine2": "string",
            "addressLine3": "string",
            "city": "string",
            "county": "string",
            "district": "string",
            "stateOrRegion": "string",
            "postalCode": "string",
            "countryCode": "string",
            "phone": "string"
          },
          "taxRegistrationDetails": [
            {
              "taxRegistrationType": "VAT",
              "taxRegistrationNumber": "string",
              "taxRegistrationAddress": {
                "name": "string",
                "addressLine1": "string",
                "addressLine2": "string",
                "addressLine3": "string",
                "city": "string",
                "county": "string",
                "district": "string",
                "stateOrRegion": "string",
                "postalCode": "string",
                "countryCode": "string",
                "phone": "string"
              },
              "taxRegistrationMessages": "string"
            }
          ]
        },
        "labelFormat": "PNG",
        "labelData": [
          {
            "packageIdentifier": "string",
            "trackingNumber": "string",
            "shipMethod": "string",
            "shipMethodName": "string",
            "content": "string"
          }
        ]
      }
    ]
  },
  "errors": [
    {
      "code": "string",
      "message": "string",
      "details": "string"
    }
  ]
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠415415

🟠429429

🔴500服务器错误

🔴503服务器故障