Vendor Direct Fulfillment Shipping API v1 reference

亚马逊SPAPI

# 概述

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

# Version information

版本 : v1

# Operations

getShippingLabels
submitShippingLabelRequest
getShippingLabel
submitShipmentConfirmations
submitShipmentStatusUpdates
getCustomerInvoices
getCustomerInvoice
getPackingSlips
getPackingSlip
<a name="paths">

# 路径

<a name="getshippinglabels">

# getShippingLabels

GET /vendor/directFulfillment/shipping/v1/shippingLabels

# Description

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

使用计划:

计划类型 速率(每秒请求数) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

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

<a name="submitshippinglabelrequest">

# submitShippingLabelRequest

POST /vendor/directFulfillment/shipping/v1/shippingLabels

# Description

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

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

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

<a name="gethippinglabel">

# getShippingLabel

GET /vendor/directFulfillment/shipping/v1/shippingLabels/{purchaseOrderNumber}

# Description

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

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

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

<a name="submitshipmentconfirmations">

# submitShipmentConfirmations

POST /vendor/directFulfillment/shipping/v1/shipmentConfirmations

# Description

为供应商订单提交一份或多份发货确认书.

使用计划:

计划类型 速率(每秒的请求) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Schema
Body body
required
SubmitShipmentConfirmationsRequest

# Responses

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

<a name="submitshipmentstatusupdates">

# submitShipmentStatusUpdates

POST /vendor/directFulfillment/shipping/v1/shipmentStatusUpdates

# Description

此API调用仅由Vendor-Own-Carrier (VOC)供应商使用.调用此API将提交供应商已发货的包裹的发货状态更新.当包裹在亚马逊网络可见性之外时,它将向亚马逊客户提供其订单的可见性.

使用计划:

计划类型 速率(每秒请求数) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Schema
Body body
required
SubmitShipmentStatusUpdatesRequest

# Responses

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

<a name="getcustomerinvoices">

# getCustomerInvoices

GET /vendor/directFulfillment/shipping/v1/customerInvoices

# Description

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

使用计划:

计划类型 速率(每秒请求数) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

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

<a name="getcustomerinvoice">

# getCustomerInvoice

GET /vendor/directFulfillment/shipping/v1/customerInvoices/{purchaseOrderNumber}

# Description

根据您指定的采购订单号,返回客户发票.

使用计划:

计划类型 速率(每秒请求数) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
Path purchaseOrderNumber
required
PurchaseOrder number of the shipment for which to return the invoice. string

# Responses

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

<a name="getpackingslips">

# getPackingSlips

GET /vendor/directFulfillment/shipping/v1/packingSlips

# Description

返回符合指定标准的采购订单的包装单列表.搜索的日期范围不得超过7天.

使用计划:

计划类型 速率(每秒请求数) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema Default
*Query *shipFromPartyId
optional
The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses. 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 packing slip 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.
GetPackingSlipListResponse
400 Request有缺失或无效的参数,无法解析.
Headers:
x-amzn-RateLimit-Limit (string) : 你对这个操作的速率限制(每秒的请求)_.
x-amzn-RequestId (string) : Unique request reference identifier.
GetPackingSlipListResponse
401 请求的授权头格式不正确或不包含有效的令牌.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求).
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetPackingSlipListResponse
403 表示禁止访问该资源.可能的原因包括拒绝访问、未经授权、过期令牌或无效签名.
:
x-amzn-RequestId (string) : Unique request reference identifier.
GetPackingSlipListResponse
404 指定的资源不存在.
:
x-amzn-RateLimit-Limit (string) : 您对该操作的速率限制(每秒的请求) .
x-amzn-RequestId (string) Unique request reference identifier.
GetPackingSlipListResponse
415 请求的有效载荷是不支持的格式.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetPackingSlipListResponse
429 请求的频率超过了允许的范围.
:
x-amzn-RateLimit-Limit (string) : 你的速率限制(每秒的请求)对于这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetPackingSlipListResponse
500 遇到了一个意外情况,导致服务器无法完成请求.
头信息
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _ 对于这个状态代码,速率限制头已被废弃,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识符.
GetPackingSlipListResponse
503 服务器的临时超载或维护.
:
x-amzn-RateLimit-Limit (string) : 您的速率限制(每秒的请求)为这个操作.
_注意 _对于这个状态代码,速率限制头已经过时,不再返回.
x-amzn-RequestId (string) : 唯一的请求参考标识.
GetPackingSlipListResponse

<a name="getpackingslip">

# getPackingSlip

GET /vendor/directFulfillment/shipping/v1/packingSlips/{purchaseOrderNumber}

# Description

返回基于您指定的采购订单号的包装单.

使用计划:

计划类型 速率(每秒请求数) 突发
Default 10 10
销售伙伴具体 变量 变量

x-amzn-RateLimit-Limit响应头返回应用于请求操作的使用计划费率限制.某些销售伙伴的费率限制将不同于上表所示的默认费率和爆裂量.更多信息,请参阅销售伙伴API文档中的 "使用计划和费率限制".

# Parameters

Type Name Description Schema
路径 采购订单号
必须的
您想要的包装单的采购订单号. string

# Responses

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

<a name="definitions">

# Definitions

<a name="packingslip">

# PackingSlip

包装单信息.

Name Description Schema
采购订单号
必须的
包装单所对应的货物的采购订单号.
模式 : "^[a-zA-Z0-9]+$"
string
内容
required
A 包装单的Base64编码字符串 PDF. string
内容类型
可选的
文件的格式,如PDF,JPEG等. enum (ContentType)

<a name="packingsliplist">

# PackingSlipList

一个包装单的清单.

Name Schema
pagination
optional
Pagination
packingSlips
optional
< PackingSlip > array

<a name="getpackingsliplistresponse">

# GetPackingSlipListResponse

Name Description Schema
*付货
可选
A包装单清单. 包装单清单
errors
optional
当请求不成功时返回的错误响应列表. ErrorList

<a name="getpackingslipresponse">

# GetPackingSlipResponse

Name Description Schema
payload
optional
Packing slip information. PackingSlip
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<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="项">

# Item

被运送的物品的详细信息.

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

<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="shipmentdetails">

# ShipmentDetails

关于一个货物的细节.

Name Description Schema
shippedDate
required
该字段表示货物离开供应商所在地的日期.请供应商在离开其仓库/配送中心后30分钟内或在亚马逊目的地仓库预约时间前至少6小时内发送ASN.发货确认中提到的发货日期不应该是在未来. string (date-time)
shipmentStatus
required
Indicate the shipment status. enum (ShipmentStatus)
isPriorityShipment
optional
提供货件的优先权. boolean
vendorOrderNumber
optional
供应商订单号是由供应商生成的唯一标识,供其参考. string
estimatedDeliveryDate
optional
预计货物到达买方仓库的日期.需要根据发货地-和目的地之间的平均运输时间来估算.准确的预约时间将由买方提供,在创建货物确认时可能不知道. string (date-time)

<a name="statusupdatedetails">

# StatusUpdateDetails

供应商为特定包裹提供的货件状态更新的细节.

Name Description Schema
追踪号码
required
这是每个包裹都需要提供的,并且应该与为货物确认发送的追踪号码一致. string
statusCode
required
表示包裹的运输状态代码,为亚马逊跟踪系统提供运输信息,并最终为最终客户提供运输信息. string
reasonCode
required
提供包裹状态的原因代码,将提供关于运输状态的额外信息. string
statusDateTime
required
货件状态被更新的日期和时间.这个字段应该是ISO-8601日期/时间格式,带有UTC时区或UTC偏移.例如,2020-07-16T23 00:00Z或者2020-07-16T23:00:00+01:00. string (date-time)
statusLocationAddress
required
Address of the party. Address
shipmentSchedule
optional
- shipmentSchedule

<a name="statusupdatedetails-shipmentschedule"> 运货计划

Name Description Schema
estimatedDeliveryDateTime
optional
预计货物到达客户交货地点的日期.该字段应采用ISO-8601日期/时间格式,带有UTC时区或UTC偏移.例如,2020-07-16T23 00:00Z或者2020-07-16T23:00:00+01:00. string (date-time)
apptWindowStartDateTime
optional
此字段表示预定交付货件的预约窗口开始时的日期和时间.此字段应采用ISO-8601日期/时间格式,并带有UTC时区或UTC偏移.例如,2020-07-16T23 00:00Z或者2020-07-16T23:00:00+01:00. string (date-time)
apptWindowEndDateTime
optional
该字段表示预定交付货件的预约窗口结束时的日期和时间.该字段应采用ISO-8601日期/时间格式,并带有UTC时区或UTC偏移.例如,2020-07-16T23 00:00Z 或 2020-07-16T23:00:00+01:00. string (date-time)

<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
city
optional
个人、企业或机构所在的城市. 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="submitshipmentconfirmationsresponse">

# SubmitShipmentConfirmationsResponse

提交货件确认操作的响应模式.

Name Description Schema
payload
optional
submitShipmentConfirmations操作的响应有效载荷. TransactionReference
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="submitshipmentstatusupdatesresponse">

# SubmitShipmentStatusUpdatesResponse

提交船运状态更新操作的响应模式.

Name Description Schema
payload
optional
submitShipmentStatusUpdates操作的响应有效载荷. TransactionReference
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="getshippinglabellistresponse">

# GetShippingLabelListResponse

getShippingLabels操作的响应模式.

Name Description Schema
payload
optional
List of ship labels. ShippingLabelList
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="getshippinglabelresponse">

# GetShippingLabelResponse

getShippingLabel操作的响应模式.

Name Description Schema
payload
optional
getShippingLabel操作的有效载荷. ShippingLabel
errors
optional
A list of error responses return when a request is unsuccessful. ErrorList

<a name="shiplabellist">

# 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="submitshippinglabelsresponse">

# SubmitShippingLabelsResponse

submitShippingLabelRequest操作的响应模式.

Name Description Schema
payload
optional
submitShippingLabelRequest操作的响应有效载荷. TransactionReference
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="submitshipmentconfirmationsrequest">

# SubmitShipmentConfirmationsRequest

Name Schema
shipmentConfirmations
optional
< ShipmentConfirmation > array

<a name="shipmentconfirmation">

# ShipmentConfirmation

Name Description Schema
采购订单号
必填
采购订单号对应的货物.
模式 : "^[a-zA-Z0-9]+$"
string
shipmentDetails
required
Shipment information. ShipmentDetails
sellingParty
required
销售方或供应商的ID. PartyIdentification
shipFromParty
required
Warehouse code of vendor. PartyIdentification
items
required
提供这批货物中物品的详细信息.如果任何物品的详细信息字段在包装或托盘级别上是通用的,那么在相应的包装上提供它们. < Item> array
集装箱
可选
提供这批货物中的物品细节.如果任何一个物品细节字段在包裹或托盘层面是通用的,那么就在相应的包裹. < Container > 数组

<a name="submitshipmentstatusupdatesrequest">

# SubmitShipmentStatusUpdatesRequest

Name Schema
shipmentStatusUpdates
optional
< ShipmentStatusUpdate > array

<a name="shipmentstatusupdate">

# ShipmentStatusUpdate

Name Description Schema
采购订单号
必须的
采购订单号,用于更新货件状态.
模式 : "^[a-zA-Z0-9]+$"
string
sellingParty
required
销售方或供应商的ID. PartyIdentification
shipFromParty
required
Warehouse code of vendor. PartyIdentification
statusUpdateDetails
required
提供关于该时间点货物状态的详细信息. StatusUpdateDetails

<a name="getcustomerinvoicesresponse">

# GetCustomerInvoicesResponse

getCustomerInvoices操作的响应模式.

Name Description Schema
payload
optional
List of customer invoices. CustomerInvoiceList
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="getcustomerinvoiceresponse">

# GetCustomerInvoiceResponse

getCustomerInvoice操作的响应模式.

Name Description Schema
payload
optional
getCustomerInvoice操作的有效载荷. CustomerInvoice
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

<a name="customerinvoicelist">

# CustomerInvoiceList

Name Schema
pagination
optional
Pagination
客户发票
可选
< 客户发票 > 数组

<a name="分页">

# Pagination

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

<a name="customerinvoice">

# CustomerInvoice

Name Description Schema
采购订单号
必填
此订单的采购订单号.
模式 : "^[a-zA-Z0-9]+$"
string
内容
required
The Base64encoded customer invoice. string

<a name="transactionreference">

# TransactionReference

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

<a name="errorlist">

# ErrorList

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

类型 < Error > 数组

<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="contenttype">

# ContentType

文件的格式,如PDF、JPEG等.

类型 : 枚举

Value Description
应用/pdf Portable Document Format (pdf).

<a name="shipmentstatus">

# ShipmentStatus

表明货件状态.

类型 : 枚举

Value Description
SHIPPED 已经离开仓库的订单的发货状态是.
FLOOR_DENIAL 由于地面上产品的质量问题,或者实物和虚拟库存不匹配而被拒绝的订单状态.

<a name="taxregistrationtype">

# TaxRegistrationType

该实体的税务登记类型.

类型 : 枚举

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

<a name="containertype">

# ContainerType

容器的类型.

类型 : 枚举

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

<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

<a name="sortorder">

# SortOrder

类型 : 枚举

<a id="sortorder-subgroup-1">用于操作(s)getPackingSlips 按包装单创建日期进行ASC或DESC排序.

Value Description
*ASC 按包装单创建日期升序排序.
DESC 按包装单创建日期降序排序.

<a id="sortorder-subgroup-2">用于操作(s)getShippingLabels, getCustomerInvoices 按订单创建日期进行ASC或DESC排序.

Value Description
ASC 按订单创建日期升序排序.
DESC 按订单创建日期降序排序.
Last Updated: 2022/10/17 下午9:17:02