Vendor Direct Fulfillment Shipping API v2021-12-28 reference

亚马逊SPAPI

# 概述

用于直接履行运输的销售伙伴API提供对直接履行供应商的运输数据的程序化访问.

# Version information

版本 : 2021-12-28

# Operations

getShippingLabels
submitShippingLabelRequest
getShippingLabel
<a name="paths">

# 路径

<a name="gethippinglabels">

# getShippingLabels

GET /vendor/directFulfillment/shipping/2021-12-28/shippingLabels

# Description

返回在您指定的时间范围内创建的发货标签列表.您使用createdAfter和createdBefore参数定义该时间范围.您必须使用这两个参数.搜索的日期范围不得超过7天.

使用计划:

|速率(每秒的请求) |突发|_ | ---- | ---- | | 10 | 10 |

响应头 "x-amzn-RateLimit-Limit "返回应用于请求操作的使用计划速率限制(如果有的话). 上表显示了该操作的默认速率和突发值. 业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值. 更多信息,请参阅使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema Default
*Query *shipFromPartyId
optional
用于履行订单的供应商仓库ID.如果没有指定,结果将包含所有仓库的订单. string -
Query limit
optional
返回记录数的限制.
Minimum : 1
最大 : 100
integer -
*Query *createdAfter
required
在此日期和时间之后可用的运输标签将包括在结果中.必须是ISO-8601日期/时间格式. string (date-time) -
*Query *createdBefore
required
在此日期和时间之前可用的运输标签将被包括在结果中.必须是ISO-8601日期/时间格式. string (date-time)
Query sortOrder
optional
Sort ASC or DESC by order creation date. enum (SortOrder "ASC"
Query nextToken
optional
用于分页,当有更多的船舶标签超过指定的结果大小限制时.token值在前一个API调用中返回. string -

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
ShippingLabelList

错误状态代码、描述和模式,见错误响应和模式. <a name="submitshippinglabelrequest">

# submitShippingLabelRequest

POST /vendor/directFulfillment/shipping/2021-12-28/shippingLabels

# Description

为一个采购订单创建一个运输标签,并返回一个transactionId供参考.

使用计划:

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

响应头 "x-amzn-RateLimit-Limit "返回应用于请求操作的使用计划速率限制(如果有的话). 上表显示了该操作的默认速率和突发值. 业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值. 更多信息,请参阅使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Schema
Body body
required
SubmitShippingLabelsRequest

# Responses

HTTP Code Description Schema
202 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求)
x-amzn-RequestId (string) : Unique request reference identifier.
TransactionReference

错误状态代码、描述和模式,见错误响应和模式. <a name="gethippinglabel">

# getShippingLabel

GET /vendor/directFulfillment/shipping/2021-12-28/shippingLabels/{purchaseOrderNumber}

# Description

返回您指定的采购订单号的运输标签.

使用计划:

Rate (requests per second) Burst
10 10

响应头 "x-amzn-RateLimit-Limit "返回应用于请求操作的使用计划速率限制(如果有的话). 上表显示了该操作的默认速率和突发值. 业务需求需要更高的吞吐量的销售伙伴可能会看到比这里显示的更高的速率和突发值. 更多信息,请参阅使用计划和速率限制在销售伙伴API (opens new window).

# Parameters

Type Name Description Schema
Path purchaseOrderNumber
required
您想退回运输标签的采购订单号.它应该是与订单中收到的采购订单号相同. string

# Responses

HTTP Code Description Schema
200 Success.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
ShippingLabel

错误状态代码、描述和模式,见错误响应和模式.

<a name="error-responses-and-schemas">

# 错误响应和模式

该表包含HTTP状态代码和错误响应的相关信息.

HTTP Code Description Schema
400 Request有缺失或无效的参数,无法解析.
Headers
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
401 请求的授权头格式不正确或不包含有效的令牌.

x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
**头信息
x-amzn-RequestId (string):Unique request reference identifier.
ErrorList
404 指定的资源不存在.
头信息
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)为这个操作.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
413 请求的大小超过了可接受的最大大小.
**头信息
x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
415 请求的有效载荷是不支持的格式.
头信息
x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
429 请求的频率超过了允许的范围.
标题
x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
500 发生了一个意外情况,使服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string):您的速率限制(每秒的请求)对于这个操作.
_注意 _对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList
503 服务器的临时超载或维护.
头信息
x-amzn-RateLimit-Limit (string):你的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string):唯一的请求参考标识符.
ErrorList

<a name="definitions">:唯一的请求参考标识符

# Definitions

<a name="submitshippinglabelsrequest">

# SubmitShippingLabelsRequest

Name Schema
shippingLabelRequests
optional
< ShippingLabelRequest > array

<a name="shiplabelrequest">

# ShippingLabelRequest

Name Description Schema
采购订单号
必须的
采购订单号,为其创建一个运输标签.
模式 : "^[a-zA-Z0-9]+$"
string
sellingParty
required
销售方或供应商的ID. PartyIdentification
shipFromParty
required
Warehouse code of vendor. PartyIdentification
集装箱
可选
这批货物中的包裹列表. < Container > 数组

<a name="packeditem">

# PackedItem

Name Description Schema
itemSequenceNumber
required
Item Sequence Number for the item. This must be same value as sent in the order for a given item. integer
buyerProductIdentifier
optional
Buyer's Standard Identification Number (ASIN) 一个物品的标准识别码. buyerProductIdentifier 或 vendorProductIdentifier 是必需的. string
vendorProductIdentifier
optional
供应商选择的物品的产品标识.应与采购订单中发送的相同,如SKU号码. string
packedQuantity
required
包装在容器中的物品总数量. ItemQuantity

<a name="partyidentification">

# PartyIdentification

Name Description Schema
partyId
required
为当事人分配的标识. string
地址
可选的
按地址确定的当事人身份. 地址
税务登记细节
可选
实体的税务登记细节. < TaxRegistrationDetails >数组

<a name="taxregistrationdetails">

# TaxRegistrationDetails

实体的税务登记详情.

Name Description Schema
*税务登记类型
可选
实体的税务登记类型. enum (税务登记类型)
taxRegistrationNumber
required
当事人的税务登记号码.例如,VAT ID. string
税务登记地址
可选的
与税务登记号码相关的地址. 地址
xRegistrationMessages
optional
税务登记信息,可用于额外的税务相关细节. string

<a name="地址">

# Address

当事人的地址.

Name Description Schema
name
required
该地址的个人、企业或机构的名称. string
addressLine1
required
地址的第一行. string
addressLine2
optional
额外的街道地址信息,如果需要的话. string
addressLine3
optional
Additional street address information, if required. string
城市
可选择
个人、企业或机构所在的城市. string

可选择
个人、企业或机构所在的县. string

可选择
个人、企业或机构所在的区. string
州或地区
可选择
个人、企业或机构所在的州或地区. string
postalCode
optional
该地址的邮政编码.它包含一系列的字母或数字或两者,有时包括空格或标点符号. string
countryCode
required
ISO 3166-1 alpha-2格式的两个数字的国家代码. string
电话
可选
位于该地址的个人、企业或机构的电话号码. string

<a name="dimensions">

# Dimensions

容器的物理尺寸测量.|字符串

Name Description Schema
length
required
容器的长度. Decimal
width
required
容器的宽度. 十进制
height
required
容器的高度. 十进制
unitOfMeasure
required
尺寸的测量单位. enum (UnitOfMeasure

<a name="weight">

# Weight

重量.

Name Description Schema
unitOfMeasure
required
The unit of measurement. enum (UnitOfMeasure)
value
required
The measurement value. Decimal

<a name="十进制">

# Decimal

一个没有精度损失的十进制数.当精度损失不可接受时很有用,比如货币.遵循RFC7159的数字表示法.
模式^-?(0|([1-9]\\d*))(\\.\\d+)?([eE][+-]?\\d+)?$.

类型:字符串

<a name="itemquantity">

# ItemQuantity

项目数量的详细信息.

Name Description Schema
amount
required
特定物品在某一装运级别的装运单位数量.如果该物品仅存在于装运中的某些包装或托盘中,请在适当的包装或托盘级别提供. integer
unitOfMeasure
required
装运数量的计量单位. string

<a name="shippinglabellist">

# ShippingLabelList

Name Schema
pagination
optional
Pagination
shippingLabels
optional
< ShippingLabel > array

<a name="labeldata">

# LabelData

货物标签的详细信息.

Name Description Schema
packageIdentifier
optional
包装的标识符.第一个包装是001,第二个是002,以此类推.这个数字被用来作为参考,以便从托盘层面参考这个包装. string
trackingNumber
optional
来自运输公司的包裹追踪标识. string
*shipMethod
optional
Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during implementation. string
*shipMethodName
optional
装运方法名称,供内部参考. string
内容
必填
此字段将包含货件标签内容的Base64编码字符串. string

<a name="shiplabel">

# ShippingLabel

Name Description Schema
采购订单号
必填
此字段将包含此订单的采购订单号.
模式 : "^[a-zA-Z0-9]+$"
string
sellingParty
required
销售方或供应商的ID. PartyIdentification
shipFromParty
required
Warehouse code of vendor. PartyIdentification
labelFormat
required
Format of the label. enum (LabelFormat
labelData
required
提供此批货物中包裹的详细信息. < LabelData >数组

<a name="分页">

# Pagination

Name Description Schema
nextToken
optional
A生成的字符串,用来传递信息给你的下一个请求.如果NextToken被返回,就把NextToken的值传递给下一个请求.如果NextToken没有返回,就没有更多的订单项目可以返回. string

<a name="transactionreference">

# TransactionReference

Name Description Schema
transactionId
optional
GUID来识别这个交易.这个值可以和交易状态API一起使用来返回这个交易的状态. string

<a name="errorlist">

# ErrorList

当请求不成功时返回的错误响应列表.|string| <a name="errorlist">### ErrorList

Name Schema
errors
required
< Error > array

<a name="error">

# Error

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

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

<a name="container">

# Container

Name Description Schema
containerType
required
容器的类型. enum (ContainerType)
containerIdentifier
required
The container identifier. string
追踪号码
可选择的
追踪号码. string
manifestId
optional
the manifest identifier. string
manifestDate
optional
舱单的日期. string
*运货方法
可选择
运货方法. string
scacCode
optional
仅NA VOC供应商需要的SCAC代码. string
carrier
optional
Carrier仅适用于欧盟VOC供应商. string
集装箱序列号
可选
一个整数,仅在多箱运输时必须提交,其中一件物品可能有不同的包装. integer
尺寸
可选
集装箱的物理尺寸测量. Dimensions
weight
optional
The weight. Weight
packedItems
required
A list of packed items. < PackedItem> array

<a name="labelformat">

# LabelFormat

标签的格式.

类型 : 枚举

Value Description
PNG 便携式网络图形(png)格式.
ZPL 斑马编程语言(zpl)格式.

<a name="taxregistrationtype">

# TaxRegistrationType

该实体的税务登记类型.

类型 : 枚举

Value Description
VAT Value-added tax.
GST 商品和服务税(GST).

<a name="containertype">

# ContainerType

容器的类型.

类型 : 枚举

Value Description
纸箱 包装容器类型.通常用于饮料或食品.
托盘 一种扁平的运输结构,在用叉车吊起货物时能稳定地支撑货物.

<a name="sortorder">

# SortOrder

按订单创建日期的ASC或DESC排序.

类型 : 枚举

Value Description
ASC 按订单创建日期升序排序.
DESC 按订单创建日期降序排序.

<a name="unitofmeasure">

# UnitOfMeasure

类型 : 枚举

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

Value Description
KG Kilogram
LB Pounds (Libra for Latin).

<a id="unitofmeasure-subgroup-2">用于定义(s)Dimensions 尺寸的测量单位.

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