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

createShipment

北美(North America）

https://sellingpartnerapi-na.amazon.com

POST

/shipping/v1/shipments

Shipping

创建新货物运输。

使用计划：

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

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

请求参数

Body 参数application/json

创建运输操作的请求 схемa.

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)

地址。

必需

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)

重量。

必需

示例

{
    "clientReferenceId": "string",
    "shipTo": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "st",
        "postalCode": "string",
        "email": "string",
        "copyEmails": [
            "string"
        ],
        "phoneNumber": "string"
    },
    "shipFrom": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "st",
        "postalCode": "string",
        "email": "string",
        "copyEmails": [
            "string"
        ],
        "phoneNumber": "string"
    },
    "containers": [
        {
            "containerType": "PACKAGE",
            "containerReferenceId": "string",
            "value": {
                "value": 0,
                "unit": "str"
            },
            "dimensions": {
                "length": 0,
                "width": 0,
                "height": 0,
                "unit": "IN"
            },
            "items": [
                {
                    "quantity": 0,
                    "unitPrice": {
                        "value": 0,
                        "unit": "str"
                    },
                    "unitWeight": {
                        "unit": "g",
                        "value": 0
                    },
                    "title": "string"
                }
            ],
            "weight": {
                "unit": "g",
                "value": 0
            }
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sellingpartnerapi-na.amazon.com/shipping/v1/shipments' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientReferenceId": "string",
    "shipTo": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "st",
        "postalCode": "string",
        "email": "string",
        "copyEmails": [
            "string"
        ],
        "phoneNumber": "string"
    },
    "shipFrom": {
        "name": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "addressLine3": "string",
        "stateOrRegion": "string",
        "city": "string",
        "countryCode": "st",
        "postalCode": "string",
        "email": "string",
        "copyEmails": [
            "string"
        ],
        "phoneNumber": "string"
    },
    "containers": [
        {
            "containerType": "PACKAGE",
            "containerReferenceId": "string",
            "value": {
                "value": 0,
                "unit": "str"
            },
            "dimensions": {
                "length": 0,
                "width": 0,
                "height": 0,
                "unit": "IN"
            },
            "items": [
                {
                    "quantity": 0,
                    "unitPrice": {
                        "value": 0,
                        "unit": "str"
                    },
                    "unitWeight": {
                        "unit": "g",
                        "value": 0
                    },
                    "title": "string"
                }
            ],
            "weight": {
                "unit": "g",
                "value": 0
            }
        }
    ]
}'

返回响应

🟢200成功

application/json

成功。

Headers

x-amzn-RateLimit-Limit

string

可选

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

x-amzn-RequestId

string

独特请求参考ID。

可选

Body

创建货件操作的响应模式。

payload

object (CreateShipmentResult)

可选

创建运输操作的有效载荷模式。

shipmentId

string

唯一的货物识别码。

必需

eligibleRates

array[object (Rate) {6}]

必需

可用于发送货物的所有可用运费列表。

errors

array[object (Error) {3}]

可选

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

code

string

必需

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

message

string

必需

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

details

string

可选

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

示例

{
    "shipmentId": "89108749065090",
    "eligibleRates": [
        {
            "billedWeight": {
                "value": 4,
                "unit": "kg"
            },
            "totalCharge": {
                "value": 3.25,
                "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"
                }
            },
            "rateId": "RI123456",
            "expirationTime": "2018-08-22T09:22:30.737Z"
        }
    ]
}

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🟠404记录不存在

🟠429429

🔴500服务器错误

🔴503服务器故障

getInvoiceStatus

getShipment