航运API v1参考

亚马逊SPAPI

# 概述

提供对亚马逊发货API的程序化访问.

# Version information

版本 : v1

# Operations

createShipment
getShipment
cancelShipment
purchaseLabels
retrieveShippingLabel
purchaseShipment
getRates
getAccount
getTrackingInformation
<a name="paths">

# 路径

<a name="createseshipment">

# createShipment

POST /shipping/v1/shipments

# Description

创建一个新的货件.

使用计划:

速率(每秒的请求) 突发
5 15

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Body body
required
the request schema for the createShipment operation. CreateShipmentRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference id.
CreateShipmentResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
CreateShipmentResponse
401 请求的授权头格式不正确或不包含有效的标记.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
CreateShipmentResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
头信息
x-amzn-RequestId (string) : 唯一的请求参考ID.
CreateShipmentResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
CreateShipmentResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
CreateShipmentResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
CreateShipmentResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
CreateShipmentResponse

<a name="getshipment">

# getShipment

GET /shipping/v1/shipments/{shipmentId}

# Description

返回shipmentId.的整个货件对象

使用计划:

Rate (requests per second) Burst
5 15

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Schema
Path shipmentId
required
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference id.
GetShipmentResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
GetShipmentResponse
401 请求的授权头格式不正确或不包含有效的标记.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetShipmentResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源等.
**头信息
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetShipmentResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_ .
x-amzn-RequestId (string) : Unique request reference id.
GetShipmentResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetShipmentResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetShipmentResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetShipmentResponse

<a name="cancelshipment">

# cancelShipment

POST /shipping/v1/shipments/{shipmentId}/cancel

# Description

根据给定的货件ID取消货件.

使用计划:

Rate (requests per second) Burst
5 15

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Schema
Path shipmentId
required
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : Unique request reference id.
CancelShipmentResponse
400 Request有缺失或无效的参数,不能被解析.
头信息:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
CancelShipmentResponse
401 请求的授权头格式不正确或不包含有效的标记.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
CancelShipmentResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
**头信息
x-amzn-RequestId (string) : 唯一的请求参考ID.
CancelShipmentResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
CancelShipmentResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
CancelShipmentResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
CancelShipmentResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
CancelShipmentResponse

<a name="purchaselabels">

# purchaseLabels

POST /shipping/v1/shipments/{shipmentId}/purchaseLabels

# Description

根据给定的费率购买运输标签.

使用计划:

速率(每秒的请求) 突发
5 15

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path shipmentId
required
- string
Body body
required
the request schema for the purchaseLabels operation. PurchaseLabelsRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference id.
PurchaseLabelsResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseLabelsResponse
401 请求的授权头格式不正确或不包含有效的令牌.

x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseLabelsResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
头信息
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseLabelsResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
PurchaseLabelsResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseLabelsResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseLabelsResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseLabelsResponse

<a name="retrieveshippinglabel">

# retrieveShippingLabel

**POST /shipping/v1/shipments/{shipmentId}/containers/{trackingId}/label **

# Description

根据货件ID和跟踪ID检索运输标签.

使用计划:

速率(每秒的请求) 突发
5 15

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path shipmentId
required
- string
Path trackingId
required
- string
Body body
required
retrieveShippingLabel操作的请求模式. RetrieveShippingLabelRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference id.
RetrieveShippingLabelResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
RetrieveShippingLabelResponse
401 请求的授权头格式不正确或不包含有效的标记.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
RetrieveShippingLabelResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.

x-amzn-RequestId (string) : 唯一的请求参考ID.
RetrieveShippingLabelResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
RetrieveShippingLabelResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
RetrieveShippingLabelResponse
500 遇到了一个意外的情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
RetrieveShippingLabelResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
RetrieveShippingLabelResponse

<a name="purchaseshipment">

# purchaseShipment

POST /shipping/v1/purchaseShipment

# Description

购买运输标签.

使用计划:

速率(每秒的请求) 突发
5 15

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Body body
required
the payload schema for the purchaseShipment operation. PurchaseShipmentRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : Unique request reference id.
PurchaseShipmentResponse
400 Request有缺失或无效的参数,不能被解析.
头信息:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
PurchaseShipmentResponse
401 请求的授权头格式不正确或不包含有效的标记.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseShipmentResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
**头信息
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseShipmentResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
PurchaseShipmentResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseShipmentResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseShipmentResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
PurchaseShipmentResponse

<a name="getrates">

# getRates

POST /shipping/v1/rates

# Description

获取服务费率.

使用计划:

速率(每秒的请求) 突发
5 15

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Body body
required
the payload schema for getRates operation. GetRatesRequest

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference id.
GetRatesResponse
400 Request缺少或有无效参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) : Unique request reference id.
GetRatesResponse
401 请求的授权头格式不正确或不包含有效的令牌.

x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetRatesResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
头信息
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetRatesResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
GetRatesResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetRatesResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetRatesResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetRatesResponse

<a name="getaccount">

# getAccount

GET /shipping/v1/account

# Description

验证当前账户是否有效.

使用计划:

速率(每秒的请求) 爆发
5 15

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Responses

HTTP Code Description Schema
200 账户有效.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference id.
GetAccountResponse
400 Request有缺失或无效的参数,无法解析.
Headers :
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
GetAccountResponse
401 请求的授权头格式不正确或不包含有效的令牌.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetAccountResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
**头信息
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetAccountResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string) Unique request reference id.
GetAccountResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetAccountResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetAccountResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetAccountResponse

<a name="gettrackinginformation">

# getTrackingInformation

GET /shipping/v1/tracking/{trackingId}

# Description

返回一个货件的跟踪信息.

使用计划:

Rate (requests per second) Burst
1 1

更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Schema
Path trackingId
required
string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse
401 请求的授权头格式不正确或不包含有效的令牌.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetTrackingInformationResponse
403 403的原因可能是拒绝访问、未经授权、过期令牌、无效签名或未找到资源.
头信息
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference id.
GetTrackingInformationResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetTrackingInformationResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetTrackingInformationResponse
503 服务器临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考ID.
GetTrackingInformationResponse

<a name="definitions">

# Definitions

<a name="错误">

# Error

当请求不成功时返回的错误响应.

Name Description Schema
code
required
一个错误代码,用于识别发生的错误类型. string
message
required
一个以人类可读的形式描述错误情况的信息. string
details
optional
可以帮助呼叫者理解或解决这个问题的额外细节. string

<a name="errorlist">

# ErrorList

当一个请求不成功时返回的错误响应列表.

类型 < Error > 数组

<a name="accountid">

# AccountId

这是在亚马逊航运入职过程中产生的亚马逊航运账户ID.

类型 :字符串

最大长度 10

<a name="shipmentid">

# ShipmentId

唯一的货件识别码.

类型 : 字符串

<a name="cliententreferenceid">

# ClientReferenceId

客户参考编号.

类型 : 字符串

最大长度 40

<a name="containerreferenceid">

# ContainerReferenceId

容器的标识符.这在同一批货物中的所有容器中必须是唯一的.

类型:字符串

最大长度 : 40

<a name="eventcode">

# EventCode

货件的事件代码,如离开、收到和准备接收.

类型 :字符串

minLength : 1
最大长度 : 60

<a name="stateorregion">

# StateOrRegion

个人、企业或机构所在的州或地区.

类型 :字符串

<a name="city">

# City

这个人、企业或机构所在的城市.

类型 : 字符串

minLength : 1
最大长度 : 50

<a name="countrycode">

# CountryCode

两位数的国家代码.以ISO 3166-1 alpha-2格式.

类型:字符串

最小长度 2
最大长度 : 2

<a name="postalcode">

# PostalCode

该地址的邮政编码.它包含一连串的字母或数字或两者,有时包括空格或标点符号.

类型:字符串

最小长度 1
最大长度 : 20

<a name="location">

# Location

该人、企业或机构所在的位置.

Name Description Schema
州或地区
可选
个人、企业或机构所在的州或地区. 州或地区
city
optional
个人、企业或机构所在的城市. City
countryCode
optional
两位数的国家代码.以ISO 3166-1 alpha-2格式. CountryCode
postalCode
optional
该地址的邮政编码.它包含一系列的字母或数字或两者,有时包括空格或标点. PostalCode

<a name="event">

# Event

一件货物的事件

Name Description Schema
eventCode
required
货物的事件代码,如Departed, Received, and ReadyForReceive. EventCode
eventTime
required
货件事件的日期和时间. string (date-time)
location
optional
个人、企业或机构所在的位置. Location

<a name="eventlist">

# EventList

一批货物的事件列表.

类型 < Event > 数组

<a name="trackingid">

# TrackingId

为每件货物生成的追踪ID.它包含一系列的字母或数字,或两者兼有.

类型:字符串

minLength : 1
最大长度 : 60

<a name="trackingsummary">

# TrackingSummary

追踪摘要.

Name Description Schema
status
optional
基于eventHistory.
minLength中的事件的衍生状态1
*最大长度 : 60
string

<a name="promisededdeliverydate">

# PromisedDeliveryDate

货物的承诺交付日期和时间.

类型:字符串(日期-时间)

<a name="address">

# Address

该地址.

Name Description Schema
name
required
该地址的个人、企业或机构的名称.
minLength : 1
*最大长度 : 50
字符串
addressLine1
required
该地址的第一行.
minLength : 1
最大长度 : 60
string
addressLine2
optional
额外的地址信息,如果需要的话.
minLength : 1
*最大长度 : 60
字符串
addressLine3
optional
额外的地址信息,如果需要的话.
minLength : 1
*最大长度 : 60
字符串
stateOrRegion
required
个人、企业或机构所在的州或地区. StateOrRegion
city
required
个人、企业或机构所在的城市. City
countryCode
required
两位数的国家代码.以ISO 3166-1 alpha-2格式. CountryCode
postalCode
required
该地址的邮政编码.它包含一系列的字母或数字或两者,有时包括空格或标点符号. PostalCode
email
optional
与该地址相关的联系人的电子邮件地址.
maxLength : 64
string
copyEmails
optional
与地址相关的联系人的电子邮件抄送地址. < string > array
phoneNumber
optional
位于该地址的个人、企业或机构的电话号码.
minLength : 1
*最大长度 : 20
string

<a name="timerange">

# TimeRange

时间范围.

Name Description Schema
start
optional
开始的日期和时间.这默认为当前日期和时间. string (date-time)
end
optional
结束日期和时间.这必须在start.的值之后_这默认为从start.开始的下一个工作日. string (date-time)

<a name="shippromiseset">

# ShippingPromiseSet

承诺的交货时间和提货时间.

Name Description Schema
deliveryWindow
optional
货物交付的时间窗口. TimeRange
receiveWindow
optional
亚马逊航运将取走货物的时间窗口. TimeRange

<a name="servicetype">

# ServiceType

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

类型 : 枚举

Value Description
亚马逊地面运输 亚马逊地面运输.
亚马逊航运标准 亚马逊航运标准.
*亚马逊航运高级 亚马逊航运高级.

<a name="servicetypelist">

# ServiceTypeList

可用于发送货件的服务类型列表.

类型< ServiceType > 数组

<a name="rate">

# Rate

可用于发送货件的可用费率

Name Description Schema
rateId
optional
费率的标识符. string
totalCharge
optional
费率的总费用. Currency
billedWeight
optional
用于计算总费用的重量. Weight
expirationTime
optional
发售过期的时间. string (date-time)
serviceType
optional
将用于服务提供的运输服务的类型. ServiceType
承诺
可选
承诺的交货时间和提货时间. ShippingPromiseSet

<a name="ratelist">

# RateList

所有可用于发送货件的费率列表.

类型< Rate > 数组

<a name="rateid">

# RateId

评级的一个标识符.

类型:字符串

<a name="acceptrate">

# AcceptedRate

为这批货物购买的具体费率,如果没有购买,则为空.

Name Description Schema
totalCharge
optional
将被计费的总费用. Currency
billedWeight
optional
用于计算总费用的重量. Weight
serviceType
optional
将用于提供服务的运输服务类型. ServiceType
承诺
可选
承诺的交货时间和取货时间. ShippingPromiseSet

<a name="servicerate">

# ServiceRate

运送服务的具体费率,如果没有可用的服务,则为空.

Name Description Schema
totalCharge
required
将被计费的总费用. Currency
billableWeight
required
用于计算总费用的重量. Weight
serviceType
required
将用于提供服务的运输服务的类型. ServiceType
承诺
必填
承诺的交货时间和取货时间. ShippingPromiseSet

<a name="serviceratelist">

# ServiceRateList

一个服务费率的列表.

类型< ServiceRate >数组

<a name="party">

# Party

与货件有关的帐户.

Name Description Schema
accountId
optional
这是在亚马逊航运入职过程中产生的亚马逊航运账户ID. AccountId

<a name="currency">

# Currency

容器中所有物品的总价值.

Name Description Schema
价值
要求的
货币的数量. 数字
单位
要求的
A 3-字符的货币代码.
minLength 3
最大长度 : 3
字符串

<a name="dimensions">

# Dimensions

一组三-维物体的测量值.

Name Description Schema
length
required
容器的长度. number
*宽度
required
容器的宽度. 编号
高度
required
容器的高度. 数字
单位
要求的
这些测量的单位. enum (Unit)

<a name="weight">

# Weight

重量.

Name Description Schema
单位
要求
测量单位. enum (Unit)

必须的
测量值. 数字

<a name="containeritem">

# ContainerItem

容器中的项目.

Name Description Schema
数量
要求
容器中该类型物品的数量. 数字
unitPrice
required
该类型物品的单价(该物品类型在容器中的总价值为unitPrice
  • 数量).
  • 货币
    unitWeight
    required
    这种类型的物品的单位重量(这种类型的物品在容器中的总重量是unitWeight
  • quantity).
  • Weight
    title
    required
    A descriptive title of the item.
    maxLength : 30
    string

    <a name="container">

    # Container

    货物中的集装箱.

    Name Description Schema
    containerType
    optional
    正在使用的物理容器类型. (总是'PACKAGE') enum (ContainerType
    containerReferenceId
    required
    集装箱的标识符.这在同一批货物的所有集装箱中必须是唯一的. ContainerReferenceId
    value
    required
    集装箱内所有物品的总价值. Currency
    尺寸
    要求的
    容器的长、宽、高和重量. 尺寸
    items
    required
    容器中物品的列表. < ContainerItem > array
    weight
    required
    容器的重量. Weight

    <a name="containerlist">

    # ContainerList

    容器的列表.

    类型< Container >数组

    <a name="containerspecification">

    # ContainerSpecification

    用于检查服务速率的容器规格.

    Name Description Schema
    尺寸
    要求
    容器的长、宽、高. 尺寸
    重量
    必须的
    容器的重量. 重量

    <a name="containerspecificationlist">

    # ContainerSpecificationList

    容器规格的列表.

    类型< ContainerSpecification >数组

    <a name="label">

    # Label

    容器的标签细节.

    Name Description Schema
    labelStream
    optional
    包含以base-64字符串编码的二进制图像数据. LabelStream
    labelSpecification
    optional
    The label specification info. LabelSpecification

    <a name="labelresult">

    # LabelResult

    标签细节,包括标签流、格式、尺寸.

    Name Description Schema
    集装箱参考号
    可选
    集装箱的标识符.这在同一批货物的所有集装箱中必须是唯一的. ContainerReferenceId
    trackingId
    optional
    分配给集装箱的跟踪标识符. string
    label
    optional
    容器的标签细节. Label

    <a name="labelresultlist">

    # LabelResultList

    一个标签结果的列表

    类型 < LabelResult >数组

    <a name="labelstream">

    # LabelStream

    包含编码为base-64字符串的二进制图像数据.

    类型 : 字符串

    <a name="labelspecification">

    # LabelSpecification

    标签规格信息.

    Name Description Schema
    labelFormat
    required
    标签的格式. Enum of PNG only for now. enum (LabelFormat)
    labelStockSize
    required
    标签库存尺寸规格的长度和高度. Enum of 4x6 only for now. enum (LabelStockSize

    <a name="createseshipmentrequest">

    # CreateShipmentRequest

    创建货物操作的请求模式.

    Name Description Schema
    clientReferenceId
    required
    Client reference id. ClientReferenceId
    shipTo
    required
    The address. Address
    shipFrom
    required
    The address. Address
    containers
    required
    A list of container. ContainerList

    <a name="purchaselabelsrequest">

    # PurchaseLabelsRequest

    购买标签操作的请求模式.

    Name Description Schema
    rateId
    required
    一个评级的标识符. RateId
    labelSpecification
    required
    The label specification info. LabelSpecification

    <a name="retrieveshippinglabelrequest">

    # RetrieveShippingLabelRequest

    retrieveShippingLabel操作的请求模式.

    Name Description Schema
    labelSpecification
    required
    The label specification info. LabelSpecification

    <a name="getratesrequest">

    # GetRatesRequest

    getRates操作的有效载荷模式.

    Name Description Schema
    shipTo
    required
    The address. Address
    shipFrom
    required
    The address. Address
    serviceTypes
    required
    A list of service types that can be used to send the shipment. ServiceTypeList
    *shipDate
    optional
    起始日期和时间.这默认为当前日期和时间. string (date-time)
    containerSpecifications
    required
    A list of container specifications. ContainerSpecificationList

    <a name="purchaseshipmentrequest">

    # PurchaseShipmentRequest

    购买装运操作的有效载荷模式.

    Name Description Schema
    clientReferenceId
    required
    Client reference id. ClientReferenceId
    shipTo
    required
    The address. Address
    shipFrom
    required
    The address. Address
    *shipDate
    可选的
    开始日期和时间.这默认为当前日期和时间. string (date-time)
    serviceType
    required
    将用于提供服务的运输服务的类型. ServiceType
    containers
    required
    A list of container. ContainerList
    labelSpecification
    required
    The label specification info. LabelSpecification

    <a name="createseshipmentresult">

    # CreateShipmentResult

    createShipment操作的有效载荷模式.

    Name Description Schema
    shipmentId
    required
    The unique shipment identifier. ShipmentId
    eligibleRates
    required
    所有可用于发送货件的费率列表. RateList

    <a name="shipment">

    # Shipment

    与货件有关的数据.

    Name Description Schema
    shipmentId
    required
    The unique shipment identifier. ShipmentId
    clientReferenceId
    required
    Client reference id. ClientReferenceId
    shipFrom
    required
    The address. Address
    shipTo
    required
    The address. Address
    acceptedRate
    optional
    为货件购买的具体费率,如果没有购买则为空. AcceptedRate
    shipper
    optional
    与货件有关的账户. Party
    containers
    required
    A list of container. ContainerList

    <a name="purchaselabelsresult">

    # PurchaseLabelsResult

    购买标签(purchaseLabels)操作的有效载荷模式.

    Name Description Schema
    shipmentId
    required
    The unique shipment identifier. ShipmentId
    clientReferenceId
    optional
    Client reference id. ClientReferenceId
    acceptedRate
    required
    为货物购买的具体费率,如果没有购买则为空. AcceptedRate
    labelResults
    required
    A list of label results LabelResultList

    <a name="retrieveshippinglabelresult">

    # RetrieveShippingLabelResult

    retrieveShippingLabel操作的有效载荷模式.

    Name Description Schema
    labelStream
    required
    包含编码为base-64字符串的二进制图像数据. LabelStream
    labelSpecification
    required
    The label specification info. LabelSpecification

    <a name="帐户">

    # Account

    帐户的相关数据.

    Name Description Schema
    accountId
    required
    这是在亚马逊航运入职过程中产生的亚马逊航运账户ID. AccountId

    <a name="getratesresult">

    # GetRatesResult

    getRates操作的有效载荷模式.

    Name Description Schema
    serviceRates
    required
    A list of service rates. ServiceRateList

    <a name="purchaseshipmentresult">

    # PurchaseShipmentResult

    购买装运操作的有效载荷模式.

    Name Description Schema
    shipmentId
    required
    The unique shipment identifier. ShipmentId
    serviceRate
    required
    运货服务的具体费率,如果没有服务则为空. ServiceRate
    labelResults
    required
    A list of label results LabelResultList

    <a name="trackinginformation">

    # TrackingInformation

    getTrackingInformation操作的有效载荷模式.

    Name Description Schema
    trackingId
    required
    为每件货物生成的追踪ID.它包含一系列的字母或数字或两者兼有. TrackingId
    summary
    required
    The tracking summary. TrackingSummary
    承诺交货日期
    必须的
    货物的承诺交货日期和时间. 承诺交货日期
    eventHistory
    required
    A list of events of a shipment. EventList

    <a name="createshipmentresponse">

    # CreateShipmentResponse

    createShipment操作的响应模式.

    Name Description Schema
    payload
    optional
    The payload for createShipment operation CreateShipmentResult
    errors
    optional
    操作中遇到的错误. ErrorList

    <a name="getshipmentresponse">

    # GetShipmentResponse

    getShipment操作的响应模式.

    Name Description Schema
    payload
    optional
    getShipment操作的有效载荷 Shipment
    errors
    optional
    操作中遇到的错误. ErrorList

    <a name="getratesresponse">

    # GetRatesResponse

    getRates操作的响应模式.

    Name Description Schema
    payload
    optional
    getRates操作的有效载荷 GetRatesResult
    errors
    optional
    操作中遇到的错误. ErrorList

    <a name="purchaseshipmentresponse">

    # PurchaseShipmentResponse

    购买装运操作的响应模式.

    Name Description Schema
    payload
    optional
    The payload for purchaseShipment operation PurchaseShipmentResult
    errors
    optional
    该操作所发生的错误. ErrorList

    <a name="cancelshipmentresponse">

    # CancelShipmentResponse

    取消发货操作的响应模式.

    Name Description Schema
    errors
    optional
    Encountered errors for the operation. ErrorList

    <a name="purchaselabelsresponse">

    # PurchaseLabelsResponse

    购买标签操作的响应模式.

    Name Description Schema
    payload
    optional
    The payload for purchaseLabels operation PurchaseLabelsResult
    errors
    optional
    操作中遇到的错误. ErrorList

    <a name="retrieveshippinglabelresponse">

    # RetrieveShippingLabelResponse

    retrieveShippingLabel操作的响应模式.

    Name Description Schema
    payload
    optional
    The payload for retrieveShippingLabel operation RetrieveShippingLabelResult
    errors
    optional
    Encountered errors for the operation. ErrorList

    <a name="getaccountresponse">

    # GetAccountResponse

    getAccount操作的响应模式.

    Name Description Schema
    payload
    optional
    getAccount操作的有效载荷 Account
    errors
    optional
    操作中遇到的错误. ErrorList

    <a name="gettrackinginformationresponse">

    # GetTrackingInformationResponse

    getTrackingInformation操作的响应模式.

    Name Description Schema
    payload
    optional
    The payload for getTrackingInformation operation TrackingInformation
    errors
    optional
    操作中遇到的错误. ErrorList

    <a name="labelformat">

    # LabelFormat

    标签的格式.目前只有PNG的枚举.

    类型 : 枚举

    Value Description
    PNG PNG

    <a name="容器类型">

    # ContainerType

    正在使用的物理容器的类型. (总是'PACKAGE')

    类型 : 枚举

    Value Description
    PACKAGE PACKAGE

    <a name="labelstocksize">

    # LabelStockSize

    长度和高度的标签尺寸规格.目前只有4x6的枚举.

    类型 : 枚举

    Value Description
    4x6 4x6

    <a name="unit">

    # Unit

    类型 : 枚举

    <a id="unit-subgroup-1">用于定义(s)Weight 计量单位.

    Value Description
    g Grams
    kg Kilograms
    oz Ounces
    lb Pounds

    <a id="unit-subgroup-2">用于定义(s)Dimensions 这些测量的单位.

    Value Description
    IN Inches
    CM Centimeters
    Last Updated: 2022/10/17 下午9:17:02