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

购买运输标签。

使用计划：

速率（每秒请求数）	突发
5	15

有关更多信息，请参阅销售合作伙伴 API 文档中的“使用计划和速率限制”。

请求参数

Body 参数application/json

购买运输操作的有效负载模式。

clientReferenceId

string

客户参考编号。

必需

<= 40 字符

shipTo

object (Address)

地址。

必需

name

string

必需

该地址的个人、商业或机构名称。

>= 1 字符<= 50 字符

addressLine1

string

该地址的第一行。

必需

>= 1 字符<= 60 字符

addressLine2

string

可选

如有需要，附加地址信息。

>= 1 字符<= 60 字符

addressLine3

string

可选

如有需要，附加地址信息。

>= 1 字符<= 60 字符

stateOrRegion

string

必需

该人、企业或机构所在的州或地区。

city

string

必需

该人、商业或机构所在的城市。

>= 1 字符<= 50 字符

countryCode

string

必需

两位数字的国家代码。采用 ISO 3166-1 alpha-2 格式。

>= 2 字符<= 2 字符

postalCode

string

必需

该地址的邮政编码。它包含一系列字母或数字或两者，有时包括空格或标点符号。

>= 1 字符<= 20 字符

string

可选

与该地址相关的联系人的电子邮件地址。

<= 64 字符

copyEmails

array[string]

可选

与该地址相关联的联系人的电子邮件抄送地址。

<= 2 items

phoneNumber

string

可选

该地址上个人、企业或机构的电话号码。

>= 1 字符<= 20 字符

shipFrom

object (Address)

地址。

必需

shipDate

string <date-time>

可选

开始日期和时间。默认为当前日期和时间。

serviceType

enum<string>

必需

将用于服务提供的运输服务类型。

枚举值:

Amazon Shipping GroundAmazon Shipping StandardAmazon Shipping Premium

containers

array[object (Container) {6}]

容器列表。

必需

containerType

enum<string>

可选

所使用的物理容器类型。（始终为 'PACKAGE'）

枚举值:

PACKAGE

containerReferenceId

string

必需

容器的标识符。它必须在同一货物运输中的所有容器中是唯一的。

<= 40 字符

value

object (Currency)

必需

集装箱内所有物品的总价值。

dimensions

object (Dimensions)

必需

一组三维物体的测量。

items

array[object (ContainerItem) {4}]

容器内物品清单。

必需

weight

object (Weight)

重量。

必需

labelSpecification

object (LabelSpecification)

标签规格信息。

必需

labelFormat

enum<string>

必需

标签的格式。目前仅支持PNG的枚举。

枚举值:

PNG

labelStockSize

enum<string>

必需

标签库存尺寸规格，包括长度和高度。目前仅支持4x6的枚举。

枚举值:

4x6

示例

示例代码

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

独特请求参考ID。

可选

Body

购买发货操作的响应模式。

payload

object (PurchaseShipmentResult)

可选

购买运输操作的有效负载模式。

shipmentId

string

唯一的货物识别码。

必需

serviceRate

object (ServiceRate)

必需

运输服务的具体费率，如果没有可用服务，则为零。

labelResults

array[object (LabelResult) {3}]

标签结果列表

必需

errors

array[object (Error) {3}]

可选

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

code

string

必需

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

message

string

必需

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

details

string

可选

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

示例

{
  "shipmentId": "89108749065090",
  "serviceRate": {
    "billableWeight": {
      "value": 4,
      "unit": "kg"
    },
    "totalCharge": {
      "value": 3.5,
      "unit": "GBP"
    },
    "serviceType": "Amazon Shipping Standard",
    "promise": {
      "deliveryWindow": {
        "start": "2018-08-25T20:22:30.737Z",
        "end": "2018-08-26T20:22:30.737Z"
      },
      "receiveWindow": {
        "start": "2018-08-23T09:22:30.737Z",
        "end": "2018-08-23T11:22:30.737Z"
      }
    }
  },
  "labelResults": [
    {
      "containerReferenceId": "CRI123456789",
      "trackingId": "1512748795322",
      "label": {
        "labelStream": "iVBORw0KGgo...AAAARK5CYII=(Truncated)",
        "labelSpecification": {
          "labelFormat": "PNG",
          "labelStockSize": "4x6"
        }
      }
    }
  ]
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠429429

🔴500服务器错误

🔴503服务器故障