getShipments

返回一个根据您指定的标准的入境货物列表。

使用计划：

速率（每秒请求）	突发
2	30

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

请求参数

Query 参数

ShipmentStatusList

array[string]

可选

一份运输状态值的列表。用于选择当前状态与您指定的状态值匹配的运输。

枚举值:

WORKINGREADY_TO_SHIPSHIPPEDRECEIVINGCANCELLEDDELETEDCLOSEDERRORIN_TRANSITDELIVEREDCHECKED_IN

ShipmentIdList

array[string]

可选

用于选择您想要的货物的货运ID列表。如果同时指定了ShipmentStatusList和ShipmentIdList，则仅返回同时匹配这两个参数的货物。

<= 999 items

LastUpdatedAfter

string <date-time>

可选

用于选择在指定时间后（或在此时间时）最后更新的入境货物的日期。选择包括亚马逊和卖家所做的更新。

LastUpdatedBefore

string <date-time>

可选

用于选择在指定时间之前（或在该时间）最后更新的入境货物的日期。选择包括亚马逊和卖家所做的更新。

QueryType

enum<string>

必需

指示是否通过运输信息（提供ShipmentStatusList或ShipmentIdList参数）、使用日期范围（提供LastUpdatedAfter和LastUpdatedBefore参数）或使用NextToken继续返回在先前请求中指定的项目来退回货物。

枚举值:

SHIPMENTDATE_RANGENEXT_TOKEN

NextToken

string

可选

在响应您之前请求时返回的字符串令牌。

MarketplaceId

string

必需

市场标识符。指定产品将存储的市场。

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

可选

唯一请求参考标识符。

Body

getShipments 操作的响应架构。

payload

object (GetShipmentsResult)

获取货物操作的结果

可选

ShipmentData

array[object (InboundShipmentInfo) {10}]

可选

一份入境货物信息清单。

NextToken

string

可选

在存在且不为空时，请在下一个请求中传递此字符串标记，以返回下一个响应页面。

errors

array[object (Error) {3}]

可选

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

code

string

必需

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

message

string

必需

一种以人类可读的形式描述错误状态的消息。

details

string

可选

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

示例

{
  "payload": {
    "ShipmentData": [
      {
        "ShipmentId": "string",
        "ShipmentName": "string",
        "ShipFromAddress": {
          "Name": "string",
          "AddressLine1": "string",
          "AddressLine2": "string",
          "DistrictOrCounty": "string",
          "City": "string",
          "StateOrProvinceCode": "string",
          "CountryCode": "string",
          "PostalCode": "string"
        },
        "DestinationFulfillmentCenterId": "string",
        "ShipmentStatus": "WORKING",
        "LabelPrepType": "NO_LABEL",
        "AreCasesRequired": true,
        "ConfirmedNeedByDate": "2019-08-24",
        "BoxContentsSource": "NONE",
        "EstimatedBoxContentsFee": {
          "TotalUnits": 0,
          "FeePerUnit": {
            "CurrencyCode": "USD",
            "Value": 0
          },
          "TotalFee": {
            "CurrencyCode": "USD",
            "Value": 0
          }
        }
      }
    ],
    "NextToken": "string"
  },
  "errors": [
    {
      "code": "string",
      "message": "string",
      "details": "string"
    }
  ]
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠429429

🔴500服务器错误

🔴503服务器故障

请求参数

示例代码

返回响应