概述

商家履约的销售伙伴API可以帮助你建立应用程序，让卖家使用亚马逊的购买运输服务为非-Prime和Prime订单购买运输.

Version information

版本 : v0

Operations

getEligibleShipmentServicesOld
getEligibleShipmentServices
getShipment
cancelShipment
cancelShipmentOld
createShipment
getAdditionalSellerInputsOld
getAdditionalSellerInputs

路径

getEligibleShipmentServicesOld

POST /mfn/v0/eligibleServices

Description

返回一个满足指定货件请求细节的货件服务报价列表.

使用计划：

Rate (requests per second)	Burst
1	1

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

Parameters

Type	Name	Description	Schema
Body	body required	Request schema.	GetEligibleShipmentServicesRequest

Responses

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

getEligibleShipmentServices

POST /mfn/v0/eligibleShippingServices

Description

返回一个满足指定货件请求细节的货件服务报价列表.

使用计划：

Rate (requests per second)	Burst
5	10

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

Parameters

Type	Name	Description	Schema
Body	body required	Request schema.	GetEligibleShipmentServicesRequest

Responses

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

getShipment

GET /mfn/v0/shipments/{shipmentId}

Description

返回一个现有货件的货件信息.

使用计划：

Rate (requests per second)	Burst
1	1

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

Parameters

Type	Name	Description	Schema
Path	shipmentId required	the Amazon-defined shipment identifier for the shipment.	string

Responses

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

cancelShipment

DELETE /mfn/v0/shipments/{shipmentId}

Description

取消由指定货件标识符指示的货件.

使用计划：

Rate (requests per second)	Burst
1	1

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

Parameters

Type	Name	Description	Schema
Path	shipmentId required	the Amazon-defined shipment identifier for the shipment to cancel.	string

Responses

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

cancelShipmentOld

PUT /mfn/v0/shipments/{shipmentId}/cancel

Description

取消由指定货件标识符指示的货件.

使用计划：

速率(每秒的请求)	突发
1	1

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

Parameters

Type	Name	Description	Schema
Path	shipmentId required	the Amazon-defined shipment identifier for the shipment to cancel.	string

Responses

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

createShipment

**POST /mfn/v0/shipments **

Description

使用所提供的信息创建一个货件.

使用计划：

速率(每秒的请求)	突发
1	1

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

Parameters

Type	Name	Description	Schema
Body	body required	Request schema.	CreateShipmentRequest

Responses

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

getAdditionalSellerInputsOld

**POST /mfn/v0/sellerInputs **

Description

获取一个发货方式所需的额外卖方输入的列表.这通常用于国际运输.

使用计划：

速率(每秒的请求)	突发
1	1

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

Parameters

Type	Name	Description	Schema
Body	body required	Request schema.	GetAdditionalSellerInputsRequest

Responses

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

getAdditionalSellerInputs

POST /mfn/v0/additionalSellerInputs

Description

获取一个发货方式所需的额外卖方输入的列表.这一般用于国际运输.

使用计划：

Rate (requests per second)	Burst
1	1

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

Parameters

Type	Name	Description	Schema
Body	body required	Request schema.	GetAdditionalSellerInputsRequest

Responses

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

Definitions

Error

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

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

ErrorList

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

类型 < Error > 数组

LabelFormatOptionRequest

是否包括包装单.

Name	Description	Schema
IncludePackingSlipWithLabel optional	为真时，包括一个带标签的包装单.	boolean

LabelFormatOption

标签格式细节和是否包括包装单.

Name	Description	Schema
IncludePackingSlipWithLabel optional	为真时，包括一个带有标签的包装单.	boolean
LabelFormat optional	The label format.	LabelFormat

AvailableCarrierWillPickUpOption

表示承运人是否会取走包裹，以及收取什么费用，如果有的话.

Name	Description	Schema
CarrierWillPickUpOption required	Carrier will pick up option.	CarrierWillPickUpOption
Charge required	The fee charged.	CurrencyAmount

AvailableCarrierWillPickUpOptionsList

可用的承运人提货选项列表.

类型 : < AvailableCarrierWillPickUpOption >数组

AvailableDeliveryExperienceOption

可用的交货确认选项，以及收取的费用，如果有的话.

Name	Description	Schema
DeliveryExperienceOption required	The delivery confirmation level.	DeliveryExperienceOption
Charge required	Currency type and amount.	CurrencyAmount

AvailableDeliveryExperienceOptionsList

可用的交付经验选项列表.

类型< AvailableDeliveryExperienceOption > 数组

AvailableShippingServiceOptions

可用的运输服务选项.

Name	Description	Schema
AvailableCarrierWillPickUpOptions required	List of available carrier pickup options.	AvailableCarrierWillPickUpOptionsList
AvailableDeliveryExperienceOptions required	List of available delivery experience options.	AvailableDeliveryExperienceOptionsList

AvailableFormatOptionsForLabelList

可用的标签格式.

类型< LabelFormatOption >数组

Constraint

一个验证性的约束.

Name	Description	Schema
ValidationRegEx optional	A regular expression.	string
ValidationString required	A validation string.	string

Constraints

限制条件列表.

类型 < Constraint > 数组

AdditionalInputs

将额外的卖方输入映射到定义中.映射的关键是字段名.

Name	Description	Schema
AdditionalInputFieldName optional	The field name.	string
SellerInputDefinition optional	指定适用于卖方输入的特征.	SellerInputDefinition

SellerInputDefinition

指定适用于卖方输入的特征.

Name	Description	Schema
IsRequired required	为真时，额外的输入字段是必须的.	boolean
DataType required	额外输入字段的数据类型.	string
Constraints required	List of constraints.	Constraints
InputDisplayText required	额外输入字段的显示文本.	string
InputTarget optional	卖方的输入是适用于物品还是货物.	InputTargetType
StoredValue required	购买运输所需的额外信息.	AdditionalSellerInput
RestrictedSetValues optional	额外卖方输入中的固定值集.	RestrictedSetValues

InputTargetType

表示额外的卖家输入是在物品或装运层面.

类型 : 枚举

Value	Description
SHIPMENT_LEVEL	额外的卖方投入是在装运水平.
ITEM_LEVEL	额外的卖家输入是在物品层面.

AdditionalInputsList

额外输入的列表.

类型 < AdditionalInputs > 数组

AdditionalSellerInput

购买运费所需的额外信息.

Name	Description	Schema
DataType optional	附加信息的数据类型.	string
ValueAsString optional	数据类型为字符串时的值.	string
ValueAsBoolean optional	当数据类型为boolean.	boolean
ValueAsInteger optional	数据类型为integer时的值.	integer
ValueAsTimestamp optional	当数据类型是一个日期-时间格式的字符串时的值.	Timestamp
ValueAsAddress optional	The postal address information.	Address
ValueAsWeight optional	The weight.	Weight
ValueAsDimension optional	The length.	Length
ValueAsCurrency optional	Currency type and amount.	CurrencyAmount

AdditionalSellerInputs

购买运费所需的一组额外的卖方输入.

Name	Description	Schema
AdditionalInputFieldName required	额外输入字段的名称.	string
AdditionalSellerInput required	Additional information required to purchase shipping.	AdditionalSellerInput

AdditionalSellerInputsList

购买运费所需的额外卖方输入对的列表.

类型< AdditionalSellerInputs >数组

Address

邮政地址信息.

Name	Description	Schema
姓名 必须的	收件人的姓名，或企业名称.	AddressName
AddressLine1 required	The street address information.	AddressLine1
AddressLine2 optional	Additional street address information.	AddressLine2
AddressLine3 optional	Additional street address information.	AddressLine3
DistrictOrCounty optional	The district or county.	DistrictOrCounty
Email required	The email address.	EmailAddress
City required	The city.	City
州或省代码 可选的	州或省代码. **注意.**在加拿大、美国和英国市场需要.对于来自中国的货物也需要.	州或省代码
PostalCode required	邮政编码或邮政代码.	PostalCode
CountryCode required	国家代码.一个两个-字符的国家代码，ISO 3166-1 alpha-2格式.	CountryCode
Phone required	The phone number.	PhoneNumber

AddressLine1

街道地址信息.

类型 ：字符串

最大长度 180

AddressLine2

额外的街道地址信息.

类型 ：字符串

最大长度 60

AddressLine3

额外的街道地址信息.

类型 ：字符串

最大长度 60

AddressName

收件人的名字，或企业名称.

类型 ：字符串

最大长度 30

AmazonOrderId

一个亚马逊-定义的订单标识符，以3-7-7格式.

类型：字符串

CancelShipmentResponse

响应模式.

Name	Description	Schema
payload optional	取消发货操作的有效载荷.	Shipment
errors optional	在取消货件操作中发生了一个或多个意外的错误.	ErrorList

City

该城市.

类型 ：字符串

最大长度 30

CountryCode

国家代码. 一个两字的国家代码，ISO 3166-1 alpha-2格式.

类型：字符串

CreateShipmentRequest

请求模式.

Name	Description	Schema

|ShippingServiceId
required|An Amazon-defined shipping service identifier.|ShippingServiceIdentifier| |ShippingServiceOfferId
optional|识别由承运人发出的运输服务订单.|string| |HazmatType
optional|包装的危险材料选项.关于危险材料的更多信息，请查阅每个承运人的条款和条件.|HazmatType| |LabelFormatOption
optional|是否包括包装单.|LabelFormatOptionRequest|

CreateShipmentResponse

响应模式.

Name	Description	Schema
payload optional	Shipment information.	Shipment
errors optional	在createShipment操作过程中，发生了一个或多个意外的错误.	ErrorList

ItemLevelFields

Name	Description	Schema
Asin required	亚马逊标准识别码(ASIN)的商品.	string
AdditionalInputs required	A list of additional inputs.	AdditionalInputsList

ItemLevelFieldsList

项目级字段的列表.

类型 < ItemLevelFields > 数组

GetAdditionalSellerInputsRequest

请求模式.

Name	Description	Schema
ShippingServiceId required	An Amazon-defined shipping service identifier.	ShippingServiceIdentifier
ShipFromAddress required	发货的地址.	Address
OrderId required	一个亚马逊定义的订单标识	AmazonOrderId

GetAdditionalSellerInputsResult

getAdditionalSellerInputs操作的有效载荷.

Name	Description	Schema
ShipmentLevelFields optional	A list of additional inputs.	AdditionalInputsList
ItemLevelFieldsList optional	A list of item level fields.	ItemLevelFieldsList

GetAdditionalSellerInputsResponse

响应模式.

Name	Description	Schema
payload optional	The payload for the getAdditionalSellerInputs operation.	GetAdditionalSellerInputsResult
errors optional	A list of error responses returned when a request is unsuccessful.	ErrorList

CurrencyAmount

货币类型和金额.

Name	Description	Schema
CurrencyCode required	Three-digit currency code in ISO 4217 format. maxLength : 3	string
金额 要求	货币金额.	数字(双数)

CustomTextForLabel

要打印在标签上的自定义文本.

注意：自定义文本只包括在ZPL格式的标签上(ZPL203).联邦快递不支持CustomTextForLabel.

类型 ：字符串

最大长度 : 14

DeliveryExperienceType

送货确认级别.

类型 : 枚举

Value	Description
有成人签名的交货确认书	有成人签名的交货确认书.
有签名的交货确认书	有签名的交货确认书.需要DPD (UK).
*无签名的交货确认	无签名的交货确认.
NoTracking	No delivery confirmation.

DistrictOrCounty

区或县.

类型：字符串

EmailAddress

电子邮件地址.

类型 : 字符串

FileContents

文件数据和校验和.

Name	Description	Schema
内容 required	用于打印标签的数据，以Base64-encoded, GZip-compressed string.	string
文件类型 必填	标签的文件类型.	文件类型
校验 required	一个用于验证PDF文档数据的MD5哈希值，以Base64-编码的字符串的形式.	string

FileType

标签的文件类型.

类型 : 枚举

Value	Description
应用/pdf	A 便携式文件格式(pdf)文件.
应用/zpl	A 斑马编程语言 (zpl) 文件.
image/png	A Portable Network Graphics (png) file.

GetEligibleShipmentServicesRequest

请求模式.

Name	Description	Schema

|ShippingOfferingFilter
optional|Filter用于请求合格的航运服务时.|ShippingOfferingFilter|

GetEligibleShipmentServicesResponse

响应模式.

Name	Description	Schema
payload optional	The payload for the getEligibleShipmentServices operation.	GetEligibleShipmentServicesResult
errors optional	此操作中发生了一个或多个意外的错误.	ErrorList

GetEligibleShipmentServicesResult

getEligibleShipmentServices操作的有效载荷.

Name	Description	Schema
ShippingServiceList required	A list of shipping services offers.	ShippingServiceList
RejectedShippingServiceList optional	此请求因某种原因无法使用的服务清单	RejectedShippingServiceList
TemporarilyUnavailableCarrierList optional	A list of temporarily unavailable carriers.	TemporarilyUnavailableCarrierList
TermsAndConditionsNotAcceptedCarrierList optional	条款和条件未被卖方接受的承运人名单.	TermsAndConditionsNotAcceptedCarrierList

GetShipmentResponse

响应模式.

Name	Description	Schema
payload optional	getShipment操作的有效载荷.	Shipment
errors optional	在这个操作中发生了一个或多个意外的错误.	ErrorList

HazmatType

包裹的危险品选项.关于危险品的更多信息，请查阅每个承运人的条款和条件.

类型 : 枚举

Value	Description
无	该包装不含危险物质.
LQHazmat	包装内含有有限数量的危险物质.

Item

一个亚马逊订单的物品标识符和一个数量.

Name	Description	Schema
OrderItemId required	一个亚马逊-定义的订单中单个项目的标识符.	OrderItemId
Quantity required	The number of items.	ItemQuantity
ItemWeight optional	The weight.	Weight
物品描述 选项	物品的描述.	物品描述
TransparencyCodeList optional	A list of transparency codes.	TransparencyCodeList
ItemLevelSellerInputsList optional	A list of additional seller inputs required to ship this item using the selected shipping service.	AdditionalSellerInputsList

ItemList

拟列入货物中的物品清单.

类型 < Item > 数组

ItemQuantity

项目的数量.

类型 : 整数 (int32)

ItemDescription

项目的描述.

类型：字符串

Label

用于创建运输标签的数据和打印标签的尺寸.

Name	Description	Schema
CustomTextForLabel optional	Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.	CustomTextForLabel
Dimensions required	Dimensions for printing a shipping label.	LabelDimensions
文件内容 必填	文件数据和校验.	文件内容
LabelFormat optional	The label format.	LabelFormat
StandardIdForLabel optional	要打印在标签上的标准标识符类型.	StandardIdForLabel

LabelCustomization

运输标签的自定义文本.

Name	Description	Schema
CustomTextForLabel optional	Custom text to print on the label. Note: Custom text is only included on labels that are in ZPL format (ZPL203). FedEx does not support CustomTextForLabel.	CustomTextForLabel
StandardIdForLabel optional	要打印在标签上的标准标识符类型.	StandardIdForLabel

LabelDimension

一个标签尺寸.

类型 : 数字

LabelDimensions

打印一个运输标签的尺寸.

Name	Description	Schema
Length required	The length dimension.	LabelDimension
Width required	The width dimension.	LabelDimension
Unit required	The unit of measurement.	UnitOfLength

LabelFormat

标签格式.

类型 : 枚举

Value	Description
PDF	便携文档格式(pdf).
PNG	便携式网络图形(png)格式.
ZPL203	斑马编程语言(zpl)格式，每英寸203点的分辨率.
ZPL300	斑马编程语言(zpl)格式，每英寸300点的分辨率.
ShippingServiceDefault	运输服务提供的默认值.

LabelFormatList

标签格式列表.

类型 < LabelFormat > 数组

Length

长度.

Name	Description	Schema
value optional	单位的价值.	number
unit optional	The unit of length.	UnitOfLength

OrderItemId

一个亚马逊-定义的订单中单个物品的标识符.

类型：字符串

PackageDimension

类型 : 数字 (double)

PackageDimensions

货物中所包含的包裹尺寸.

Name	Description	Schema
Length optional	长度尺寸.如果你不指定PredefinedPackageDimensions，你必须指定Length.	PackageDimension
Width optional	宽度尺寸.如果你没有指定PredefinedPackageDimensions，你必须指定Width.	PackageDimension
Height optional	高度尺寸. 如果你没有指定PredefinedPackageDimensions，你必须指定Height.	PackageDimension
Unit optional	测量单位.如果你没有指定PredefinedPackageDimensions，你必须指定Unit.	UnitOfLength
PredefinedPackageDimensions optional	一个预定义包裹令牌的枚举.如果你指定一个PredefinedPackageDimensions令牌，你没有义务使用一个承运人的品牌包裹.例如如果您指定了FedEx_Box_10kg代币，您不一定要使用FedEx的那个特定包裹. 您只有义务使用符合代币指定尺寸的箱子. 注请注意，承运人对某些运输方式所允许的包裹类型可能有限制.请查看承运人网站了解所有细节.示例当材料用USPS-生产的统一费率信封或盒子邮寄时，可享受统一费率定价.	预定义包装尺寸

PhoneNumber

电话号码.

类型 ：字符串

最大长度 30

PostalCode

邮递区号或邮政编码.

类型 : 字符串

最大长度 30

PredefinedPackageDimensions

预定义包裹尺寸的枚举.如果你指定一个PredefinedPackageDimensions标记，你没有义务使用一个承运人的品牌包裹.例如，如果你指定FedEx_Box_10kg标记，你没有义务使用FedEx的那个特定包裹.你只有义务使用一个符合该标记所指定尺寸的箱子.

注意：请注意，承运人可能对某些运输方式所允许的包装类型有限制.请查看承运人网站了解所有细节.示例当材料用USPS-生产的统一费率信封或盒子由USPS发送时，可使用统一费率定价.

类型 : 枚举

Value	Description
FedEx_Box_10kg	15.81 x 12.94 x 10.19 in.
FedEx_Box_25kg	54.80 x 42.10 x 33.50 in.
FedEx_Box_Extra_Large_1	11.88 x 11.00 x 10.75 in.
FedEx_Box_Extra_Large_2	15.75 x 14.13 x 6.00 in.
FedEx_Box_Large_1	17.50 x 12.38 x 3.00 in.
FedEx_Box_Large_2	11.25 x 8.75 x 7.75 in.
FedEx_Box_Medium_1	13.25 x 11.50 x 2.38 in.
FedEx_Box_Medium_2	11.25 x 8.75 x 4.38 in.
FedEx_Box_Small_1	12.38 x 10.88 x 1.50 in.
FedEx_Box_Small_2	8.75 x 2.63 x 11.25 in.
FedEx_Envelope	12.50 x 9.50 x 0.80 in.
FedEx_Padded_Pak	11.75 x 14.75 x 2.00 in.
FedEx_Pak_1	15.50 x 12.00 x 0.80 in.
FedEx_Pak_2	12.75 x 10.25 x 0.80 in.
FedEx_Tube	38.00 x 6.00 x 6.00 in.
FedEx_XL_Pak	17.50 x 20.75 x 2.00 in.
UPS_Box_10kg	41.00 x 33.50 x 26.50 cm.
UPS_Box_25kg	48.40 x 43.30 x 35.00 cm.
UPS_Express_Box	46.00 x 31.50 x 9.50 cm.
UPS_Express_Box_Large	18.00 x 13.00 x 3.00 in.
UPS_Express_Box_Medium	15.00 x 11.00 x 3.00 in.
UPS_Express_Box_Small	13.00 x 11.00 x 2.00 in.
UPS_Express_Envelope	12.50 x 9.50 x 2.00 in.
UPS_Express_Hard_Pak	14.75 x 11.50 x 2.00 in.
UPS_Express_Legal_Envelope	15.00 x 9.50 x 2.00 in.
UPS_Express_Pak	16.00 x 12.75 x 2.00 in.
UPS_Express_Tube	97.00 x 19.00 x 16.50 cm.
UPS_Laboratory_Pak	17.25 x 12.75 x 2.00 in.
UPS_Pad_Pak	14.75 x 11.00 x 2.00 in.
UPS_Pallet	120.00 x 80.00 x 200.00 cm.
USPS_Card	6.00 x 4.25 x 0.01 in.
USPS_Flat	15.00 x 12.00 x 0.75 in.
USPS_FlatRateCardboardEnvelope	12.50 x 9.50 x 4.00 in.
USPS_平板纸信封	12.50 x 9.50 x 4.00 in.
USPS_FlatRateGiftCardEnvelope	10.00 x 7.00 x 4.00 in
USPS_FlatRateLegalEnvelope	15.00 x 9.50 x 4.00 in.
USPS_FlatRatePaddedEnvelope	12.50 x 9.50 x 4.00 in.
USPS_FlatRateWindowEnvelope	10.00 x 5.00 x 4.00 in.
USPS_LargeFlatRateBoardGameBox	24.06 x 11.88 x 3.13 in.
USPS_LargeFlatRateBox	12.25 x 12.25 x 6.00 in.
USPS_Letter	11.50 x 6.13 x 0.25 in.
USPS_MediumFlatRateBox1	11.25 x 8.75 x 6.00 in.
USPS_MediumFlatRateBox2	14.00 x 12.00 x 3.50 in.
USPS_RegionalRateBoxA1	10.13 x 7.13 x 5.00 in.
USPS_RegionalRateBoxA2	13.06 x 11.06 x 2.50 in.
USPS_RegionalRateBoxB1	16.25 x 14.50 x 3.00 in.
USPS_RegionalRateBoxB2	12.25 x 10.50 x 5.50 in.
USPS_RegionalRateBoxC	15.00 x 12.00 x 12.00 in.
USPS_SmallFlatRateBox	8.69 x 5.44 x 1.75 in.
USPS_SmallFlatRateEnvelope	10.00 x 6.00 x 4.00 in.

RestrictedSetValues

在一个额外的卖方输入.中的固定值集

类型 < string > 数组

SellerOrderId

一个卖方-定义的订单标识符.

类型 ：字符串

最大长度 64

Shipment

货件的详细信息，包括货件的状态.

Name	Description	Schema
ShipmentId required	An Amazon-defined shipment identifier.	ShipmentId
AmazonOrderId required	An Amazon-defined order identifier, in 3-7-7 format.	AmazonOrderId
SellerOrderId optional	A seller-defined order identifier.	SellerOrderId
ItemList required	货物中包含的物品清单.	ItemList
ShipFromAddress required	发件人的地址.	Address
ShipToAddress required	货物的目的地地址.	Address
包装尺寸 required	快件中包含的包装尺寸.	包装尺寸
Weight required	The package weight.	Weight
Insurance required	如果在之前调用createShipment操作时指定了DeclaredValue，那么Insurance表示承运人将用来为货件投保的金额.如果在之前调用createShipment操作时没有指定DeclaredValue那么这批货物将按照承运人的最低保险金额进行投保，或者按照这批货物中所列物品的综合销售价格进行投保，以较低者为准.	CurrencyAmount
ShippingService required	A shipping service offer made by a carrier.	ShippingService
Label required	用于创建运输标签的数据和打印标签的尺寸.如果货物被取消，将返回一个空标签.	Label
Status required	The shipment status.	ShipmentStatus
TrackingId optional	由承运人提供的货件跟踪标识符.	TrackingId
CreatedDate required	货件创建的日期和时间.	Timestamp
LastUpdatedDate optional	最后更新的日期和时间.	Timestamp

ShipmentId

一个亚马逊-定义的货件识别码.

类型：字符串

ShipmentRequestDetails

要求提供运输服务报价或创建一个快件所需的快件信息.

Name	Description	Schema
AmazonOrderId required	An Amazon-defined order identifier in 3-7-7 format.	AmazonOrderId
SellerOrderId optional	A seller-defined order identifier.	SellerOrderId
ItemList required	货物中包含的物品清单.	ItemList
ShipFromAddress required	发件人的地址.	Address
PackageDimensions required	The package dimensions.	PackageDimensions
Weight required	The package weight.	Weight
MustArriveByDate 可选	包裹必须到达以履行对客户的承诺的日期，ISO 8601日期格式.如果指定MustArriveByDate，只返回能在该日期前交付的运输服务报价.	Timestamp
ShipDate optional	在请求中使用时，这是卖方希望运送包裹的日期和时间.在响应中使用时，这是包裹可以通过指定方法运送的日期和时间.	Timestamp
ShippingServiceOptions required	承运人提供的额外服务.	ShippingServiceOptions
LabelCustomization optional	Label customization options.	LabelCustomization

ShipmentStatus

货件状态.

类型 : 枚举

Value	Description
购买了	卖方通过调用createShipment操作购买了一个标签.
RefundPending	该卖家通过调用cancelShipment操作申请了一个标签的退款，并且该退款申请正在由承运人处理. Note: 当Status=RefundPending时，卖方可以为已取消的货物创建新的货物. 在通过调用cancelShipment操作请求标签退款后，该订单的状态仍为 "已发货".
RefundRejected	标签退款请求被承运人拒绝.退款请求被拒绝的原因如下： 取消窗口已经过期.取消政策因承运人而异.关于承运人取消政策的更多信息，请参见卖方中心帮助. 承运人已经接受货件交付.
退款申请	退款已被批准并记入卖家的账户.

DeliveryExperienceOption

送货确认级别.

类型 : 枚举

Value	Description
有成人签名的交货确认书	有成人签名的交货确认书.
有签名的交货确认书	有签名的交货确认书.需要DPD (UK).
*无签名的交货确认	无签名的交货确认.
NoTracking	No delivery confirmation.
NoPreference	No preference.

ShippingOfferingFilter

用于请求符合条件的航运服务时的过滤器.

Name	Description	Schema
IncludePackingSlipWithLabel optional	为真时，包括一个带有标签的包装单.	boolean
IncludeComplexShippingOptions optional	为真时，包括复杂的运输选项.	boolean
CarrierWillPickUp optional	Carrier will pick up option.	CarrierWillPickUpOption
DeliveryExperience optional	The delivery confirmation level.	DeliveryExperienceOption

ShippingService

由承运人提出的运输服务报价.

Name	Description	Schema
ShippingServiceName required	A plain text representation of a carrier's shipping service. For example, "UPS Ground" or "FedEx Standard Overnight" .	string
CarrierName required	运营商的名称.	string
ShippingServiceId required	An Amazon-defined shipping service identifier.	ShippingServiceIdentifier
ShippingServiceOfferId required	An Amazon-defined shipping service offer identifier.	string
ShipDate required	承运人将运送包裹的日期.	Timestamp
最早预计交付日期 可选	承运人将交付货物的最早日期.	时间戳
LatestEstimatedDeliveryDate optional	货物交付的最晚日期.	Timestamp
Rate required	承运人将对货件收取的金额.	CurrencyAmount
ShippingServiceOptions required	承运人提供的额外服务.	ShippingServiceOptions
AvailableShippingServiceOptions optional	The available shipping service options.	AvailableShippingServiceOptions
AvailableLabelFormats optional	List of label formats.	LabelFormatList
AvailableFormatOptionsForLabel optional	The available label formats.	AvailableFormatOptionsForLabelList
RequiresAdditionalSellerInputs required	为真时，需要额外的卖方输入.	boolean

ShippingServiceIdentifier

一个亚马逊-定义的运输服务标识符.

类型：字符串

ShippingServiceList

航运服务提供的列表.

类型 < ShippingService > 数组

ShippingServiceOptions

承运人提供的额外服务.

Name	Description	Schema
DeliveryExperience required	The delivery confirmation level.	DeliveryExperienceType
DeclaredValue optional	货物的申报价值.承运人使用此价值来确定用于投保货物的金额.如果DeclaredValue大于承运人的最低保险金额，卖方将被收取承运人确定的额外保险费用.关于可选保险的信息，请参见卖方中心帮助UK (opens new window) US (opens new window).	CurrencyAmount
CarrierWillPickUp required	为真时，承运人将取走包裹. 注意：预定的承运人取件只适用于Dynamex (US)、DPD (UK)和Royal Mail (UK).	boolean
CarrierWillPickUpOption optional	Carrier will pick up option.	CarrierWillPickUpOption
LabelFormat optional	卖方喜欢的标签格式.	LabelFormat

CarrierWillPickUpOption

承运人将拾取的选项.

类型 : 枚举

Value	Description
承运人将取走	承运人将取走包裹.
托运人将送达	卖方负责安排提货或将包裹交给承运人.
NoPreference	No preference.

StandardIdForLabel

要打印在标签上的标准标识符的类型.

类型 : 枚举

Value	Description
AmazonOrderId	An Amazon-defined order identifier in 3-7-7 format.

StateOrProvinceCode

州或省的代码. 注意. 在加拿大、美国和英国市场上需要. 对于来自中国的货物也需要.

类型：字符串

最大长度 : 30

RejectedShippingService

关于一个被拒绝的运输服务的信息

Name	Description	Schema
CarrierName required	被拒绝的运输载体名称. e.g. USPS	string
ShippingServiceName required	被拒绝的运输服务本地化名称. e.g. FedEx Standard Overnight	string
ShippingServiceId required	The rejected shipping service identifier. e.g. FEDEX_PTP_STANDARD_OVERNIGHT	ShippingServiceIdentifier
RejectionReasonCode required	A reason code meant to be consumed programatically. e.g. CARRIER_CANNOT_SHIP_TO_POBOX	string
RejectionReasonMessage optional	A localized human readable description of the rejected reason.	string

RejectedShippingServiceList

由于某种原因，此请求无法使用的服务列表

类型 : < RejectedShippingService > 数组

TemporarilyUnavailableCarrier

暂时无法使用的承运人，很可能是由于该承运人遇到的服务中断.

Name	Description	Schema
CarrierName required	运营商的名称.	string

TemporarilyUnavailableCarrierList

暂时不可用的承运人列表.

类型< TemporarilyUnavailableCarrier > 数组

TermsAndConditionsNotAcceptedCarrier

卖方未接受其条款和条件的承运人.

Name	Description	Schema
承运人名称 要求	承运人的名称.	字符串

TermsAndConditionsNotAcceptedCarrierList

卖方不接受其条款和条件的运营商名单.

类型: < TermsAndConditionsNotAcceptedCarrier >阵列

Timestamp

类型 ：字符串 (date-time)

TrackingId

承运人提供的货件跟踪标识符.

类型：字符串

TransparencyCode

与该物品相关的透明度代码.

类型 : 字符串

TransparencyCodeList

透明度代码的列表.

类型< TransparencyCode >数组

UnitOfLength

长度单位.

类型 : 枚举

Value	Description
英寸	长度单位是英寸.
厘米	长度单位是厘米.

UnitOfWeight

重量的单位.

类型 : 枚举

Value	Description
oz	重量单位是盎司.
g	重量单位是克.

Weight

体重.

Name	Description	Schema
Value required	The weight value.	WeightValue
Unit required	The unit of weight.	UnitOfWeight

WeightValue

重量值.

类型 : 数字(double)