供应商直接配送发货 API v1 用例指南
如何帮助参与直接配送 (DF) 计划的供应商使用配送 API 来管理其直接配送操作。
API 版本:v1
什么是直接配送发货 API?
供应商可以使用直接配送发货 API与亚马逊交换货件相关文件。供应商可以请求货件标签、接收货件标签、发送货件确认、获取装箱单和检索客户发票。
请注意,客户发票是针对印度地区的。
以下操作可用:
操作 | HTTP 方法 | Path | 描述 |
---|---|---|---|
submitShippingLabelRequest
|
POST | /vendor/directFulfillment/shipping/v1/shippingLabels |
提交单个或多个货件标签申请。 |
getShippingLabels
|
GET | /vendor/directFulfillment/shipping/v1/shippingLabels |
根据筛选条件获取货件标签列表。 Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide. |
getShippingLabel
|
GET |
|
按采购订单编号获取货件标签。 注意:货件标签将在通过提交货件标签请求创建 90 天后过期,因此不应请求超过 90 天的货件标签。 |
submitShipmentConfirmations
|
POST | /vendor/directFulfillment/shipping/v1/shipmentConfirmations |
向亚马逊提交单次或多次货件确认。 |
submitShipmentStatusUpdates
|
POST | /vendor/directFulfillment/shipping/v1/shipmentStatusUpdates |
提交货件状态更新。仅限供应商自有承运人供应商。 |
getPackingSlips
|
GET | /vendor/directFulfillment/shipping/v1/packingSlips |
根据创建日期范围获取装箱单列表。 Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide. |
getPackingSlip
|
GET | /vendor/directFulfillment/shipping/v1/packingSlips/{purchaseOrderNumber} |
按采购订单编号获取特定订单的装箱单。 注意:数据检索只能追溯到六个月前,这意味着 createdBefore 仅限六个月前。 |
getCustomerInvoices
|
GET | /vendor/directFulfillment/shipping/v1/customerInvoices |
根据筛选条件获取客户发票列表。 Note: This is a restricted operation and therefore requires a Restricted Data Token (RDT) for authorization. For more information, refer to the Tokens API Use Case Guide. |
getCustomerInvoice
|
GET | /vendor/directFulfillment/shipping/v1/customerInvoices/{purchaseOrderNumber} |
按采购订单编号获取客户发票。 注意:数据检索只能追溯到六个月前,这意味着 createdBefore 仅限六个月前。 |
submitShippingLabelRequest
submitShippingLabelRequest
操作允许供应商向亚马逊索取每个采购订单的货件标签信息。只要遵守架构,您就可以在一个 API 调用中批量发送多个货件标签请求。当亚马逊创建货件标签时,可以使用 getShippingLabel
操作进行下载。
验证已成功提交的货件标签申请
Vendors can verify the status of their shipping label requests using the Direct Fulfillment Transaction Status API. Allow the system up to 15 min to show the status after submission. If the transaction status is not updated after 30 minutes, open a Contact Us case in Vendor Central.
货件标签申请 API 集成工作流程
下图显示了提交货件标签申请的工作流程。
业务需求
在使用订单确认 API 确认供应商接受采购订单后,亚马逊必须收到货件标签申请。
如果使用亚马逊自有货件标签,则可选择在申请中发送商品信息或包裹信息。
特定国家/地区的业务要求
不存在特定于国家/地区的要求。
submitShippingLabelRequest 请求
若要申请货件标签,请调用 submitShippingLabelRequest
操作并传递以下参数:
主体参数:
名称 |
描述 |
必填项 |
---|---|---|
shippingLabelRequests |
申请一个或多个货件标签。 类型:< |
有帮助 |
请求示例:
POST "https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels"
{
"shippingLabelRequests": [
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"containers": [
{
"containerType": "carton",
"containerIdentifier": "123",
"trackingNumber": "XXXX",
"dimensions": {
"length": "12",
"width": "12",
"height": "12",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "B07DFVDRAB",
"packedQuantity": {
"amount": 1,
"unitOfMeasure": "Each"
}
}
]
}
]
}
]
}
submitShippingLabelRequest 响应
成功的响应包括以下内容:
名称 |
描述 |
必填项 |
---|---|---|
transactionId
|
GUID 以识别此交易。此值可以与交易状态 API 一起使用,以返回此交易的状态。 类型:字符串 |
没有帮助 |
响应示例:
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
getShippingLabels
The getShippingLabels
operation returns shipping labels for all orders which meet the filter criteria specified in the request. You must have already requested shipping labels using the submitShippingLabelRequest
operation before you use this API to get shipping labels available to you for fulfillment. Amazon recommends that vendors check for shipping labels at least once per hour during business hours. Depending on your business volume, you can choose to check more frequently. You can get up to 100 shipping labels in one API call. If there are more than 100 shipping labels you can use the nextToken value to get the next set of shipping labels.
用于授权的受限数据令牌
这是一项受限操作,因此需要使用受限数据令牌 (RDT) 进行授权。有关更多信息,请参阅令牌 API 用例指南。
下图显示了检索货件标签时的集成工作流程:
getShippingLabels 请求
若要检索货件标签列表,请调用 getShippingLabels
操作并传递以下参数:
查询参数:
名称 | 描述 | 必填项 |
---|---|---|
shipFromPartyId |
将配送订单的供应商的库房编号。如果未指定,则结果将包含所有库房的订单。 类型:字符串 |
没有帮助 |
limit |
对返回的记录数的限制。 最小值:1 最大值:100 类型:整数 |
没有帮助 |
createdAfter |
在此日期和时间之后可用的货件标签将包含在结果中。必须采用 ISO-8601 日期/时间的格式。 类型:字符串(日期时间) |
有帮助 |
createdBefore |
在此日期和时间之前可用的货件标签将包含在结果中。必须采用 ISO-8601 日期/时间的格式。 类型:字符串(日期时间) |
有帮助 |
sortOrder |
按订单创建日期进行升序 (ASC ) 或降序 (DESC ) 排序。 类型:enum ( |
没有帮助 |
nextToken |
当货件标签数量超过指定结果大小限制时,用于分页。令牌值会在之前的 API 调用中返回。 类型:字符串 |
没有帮助 |
请求示例:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC
getShippingLabels 响应
成功的响应包括以下内容:
名称 | 描述 | 必填项 |
---|---|---|
pagination |
如果返回的货件标签超过 100 个,则 nextToken 在分页响应中返回。 类型:字符串 |
没有帮助 |
shippingLabels |
货件标签列表。 类型:< |
没有帮助 |
响应示例:
{
"pagination": {
"nextToken": "MDAwMDAwMDAwMQ=="
},
"shippingLabels": [
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG001",
"trackingNumber": "1Z6A34Y60369738804",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here "
}
]
},
{
"purchaseOrderNumber": "2JK3S9VD",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG002",
"trackingNumber": "1Z6A34Y60369738805",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here "
}
]
}
]
}
获取货件标签
getShippingLabel
操作会返回有关您使用采购订单编号指定的货件标签的信息。响应包括采购订单的完整货件标签信息,包括标签类型、采购订单详情和配送方式。
You can also use this API to get details for any shipping label (in the time range of seven days from a rolling window of the last six months, after the vendor went live on API).
下图显示了检索特定货件标签的集成工作流程:
何时申请货件标签?
ZPL 和 PNG 标签只能在订单发货当天申请。
特定国家/地区的业务要求
对于货件标签响应,没有特定国家/地区的要求。
getShippingLabel 请求
若要申请货件标签,请调用 getShippingLabel
操作并传递以下参数:
路径参数:
名称 | 描述 | 必填项 |
---|---|---|
purchaseOrderNumber
|
您要退回货件标签的采购订单编号。其应与订单中收到的 purchaseOrderNumber 相同。 类型:字符串 |
有帮助 |
请求示例:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels/2JK3S9VC
getShippingLabel 响应
成功的响应包括以下内容:
名称 | 描述 | 必填项 |
---|---|---|
purchaseOrderNumber
|
此字段将包含此订单的采购订单编号。 类型:字符串 |
有帮助 |
sellingParty
|
销售伙伴或供应商的编号。 | 有帮助 |
shipFromParty
|
供应商的库房代码。 | 有帮助 |
labelFormat
|
标签的格式。 enum (LabelFormat) |
有帮助 |
labelData
|
提供此货件中包裹的详细信息。 类型:< |
有帮助 |
响应示例:
{
"purchaseOrderNumber": "2JK3S9VC",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"labelFormat": "PNG",
"labelData": [
{
"packageIdentifier": "PKG001",
"trackingNumber": "1Z6A34Y60369738804",
"shipMethod": "UPS_GR_RES",
"shipMethodName": "UPS Ground Residential",
"content": "Base 64 encoded string goes here"
}
]
}
submitShipmentConfirmations
submitShipmentConfirmations
操作允许供应商向亚马逊提交货件确认。您的货件确认使我们能够有效地追踪您的货件并向我们的客户发送通知。它包含有关正在配送的商品的信息,包括采购订单编号、发货日期、预计送达日期和追踪编码。
货件确认使我们能够更有效地与承运人合作,追踪您的货件。
缺少有效的货件确认可能导致:
-
对货件的了解不足。
-
将实物货件与采购订单进行核对时出现错误。
-
手动跟进以解决差异。
对于成功提交的货件确认的验证
Vendors can verify the status of their shipment confirmations via Vendor Central > Orders > Direct Fulfillment Orders or using the Direct Fulfillment Transaction Status API. Allow the system up to 10 min to determine the status after submission. If Vendor Central is not showing the correct values for the shipment confirmation, open a Contact Us case in Vendor Central. Refer to the Business Requirements section for information about creating shipment confirmations.
下图显示了提交货件确认的集成工作流程:
业务需求
您应在订单从库房发货后 4 小时内使用此 API 确认订单发货。
对于底线拒绝的货件,请将 shipmentStatus
字段值设置为 FLOOR_DENIAL
。
所有采购订单行项目都应出现在货件确认中。不允许配送部分订单。如果有任何行项目无法配送,供应商应将该订单作为底线拒绝订单。
商品的 itemSequenceNumber
应与订单消息中收到的相同。
buyerProductIdentifier
或 vendorProductIdentifier
必须在货件确认中发送。您需要发送与采购订单中收到的相同的值。
对于供应商自己的承运人,必须发送 scacCode
。
如果货件标签由亚马逊提供,则集装箱部分为可选项,因为亚马逊可以访问包裹信息。商品部分必须提交。
货件确认中的集装箱必须有指定的 shipMethod
。
特定国家/地区的业务要求
无
submitShipmentConfirmations 请求
要提交货件确认,请调用 submitShipmentConfirmations
操作并传递以下参数:
主体参数:
名称 | 描述 | 必填项 |
---|---|---|
shipmentConfirmations |
已确认货件列表 类型:< |
有帮助 |
请求示例:
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shipmentConfirmations
{
"shipmentConfirmations": [
{
"purchaseOrderNumber": "PO00050003",
"shipmentDetails": {
"shippedDate": "2019-08-07T19:56:45.632Z",
"shipmentStatus": "SHIPPED",
"isPriorityShipment": true,
"estimatedDeliveryDate": "2019-08-07T19:56:45.632Z"
},
"sellingParty": {
"partyId": "VENDORCODE"
},
"shipFromParty": {
"partyId": "VENDORWAREHOUSECODE"
},
"items": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "ASIN001",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 2,
"buyerProductIdentifier": "ASIN002",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 3,
"buyerProductIdentifier": "ASIN003",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
},
{
"itemSequenceNumber": 4,
"buyerProductIdentifier": "ASIN004",
"vendorProductIdentifier": "9782700001659",
"shippedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
],
"containers": [
{
"containerType": "carton",
"containerIdentifier": "123",
"trackingNumber": "TRACK001",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 1,
"buyerProductIdentifier": "ASIN001",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "234",
"trackingNumber": "TRACK002",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 2,
"buyerProductIdentifier": "ASIN002",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "ABCD",
"trackingNumber": "TRACK003",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 3,
"buyerProductIdentifier": "ASIN003",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
},
{
"containerType": "carton",
"containerIdentifier": "id12",
"trackingNumber": "TRACK004",
"scacCode": "SCAC001",
"carrier": "ABCD001",
"shipMethod": "UPS",
"dimensions": {
"length": "10",
"width": "10",
"height": "10",
"unitOfMeasure": "IN"
},
"weight": {
"unitOfMeasure": "KG",
"value": "10"
},
"packedItems": [
{
"itemSequenceNumber": 4,
"buyerProductIdentifier": "ASIN004",
"packedQuantity": {
"amount": 100,
"unitOfMeasure": "Each"
}
}
]
}
]
}
]
}
submitShipmentConfirmations 响应
成功的响应包括以下内容:
名称 | 描述 | 必填项 |
---|---|---|
transactionId |
GUID 以识别此交易。此值可以与交易状态 API 一起使用,以返回此交易的状态。 类型:字符串 |
有帮助 |
响应示例:
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
submitShipmentStatusUpdates
重要说明
货件状态更新仅供 VOC(供应商自有承运人)供应商使用。这意味着供应商使用自己的承运人进行货件配送,并且不使用亚马逊承运人将货件运送给客户。供应商最终将承担运输费用和向客户交付货物的责任。
submitShipmentStatusUpdates
操作允许供应商更新正在运往最终客户的货件的运输状态事件。VOC 供应商需要在运输阶段更新货件状态(通常称为扫描)。
然后,这些信息将在“您的订单”页面上转发给亚马逊买家,从而提高订单追踪和配送流程的可见性。
未能进行货件状态更新会导致不良的运营 KPI,例如扫描率低,最终导致库房停工。
对成功提交的货件状态更新的验证
Vendors can verify the status of their shipment status updates via Vendor Central > Orders > Direct Fulfillment Orders or by using the Direct Fulfillment Transaction Status API. Allow the system up to 10 min to determine the status after submission. If Vendor Central is not showing the correct values for the shipment confirmation, open a Contact Us case in Vendor Central. Refer to the Business Requirements section for information about creating shipment confirmations.
下图显示了提交货件状态更新的集成工作流程:
业务需求
只有当您是 VOC(供应商自有承运人)供应商时,才应使用此 API,这意味着您使用自己的承运人将货件运送给客户。
仅在通过货件确认 API 或 Vendor Central 货件确认进行确认后,您才应使用此 API 更新货件状态。
货件状态 API 中的 trackingNumber
应与在货件确认中提供的 trackingNumber
100% 匹配,否则货件状态更新将失败。
一次货件状态更新 API 调用应与一个实体包裹相对应。您可以在一个 API 调用中更新多个包裹的货件状态,方法是将这些包裹作为“货件状态更新”数组进行批处理。
直接配送订单会导致向买家配送多个实体包裹。因此,需要更新几次货件状态以反映完整订单的完整货件状态。
供应商应尽可能按照“亚马逊货件状态”指南发送货件状态。
对于计划配送订单,供应商应发送 shipmentSchedule
数组,用于指定预计的交付时间和交付窗口。
特定国家/地区的业务要求
无
其他字段说明
statusCode
and reasonCode
这些字段是 EDI 标准(例如 ISA X12 和 EDIFACT)中使用的标准代码,用于提供特定的状态事件和状态事件的原因。我们希望有 statusCode
和 reasonCode
的特定组合,用于确定至最终客户的货件运输阶段的事件。
以下是我们支持的状态和原因代码,以及它们与当前 Vendor Central 的等效性:
EDIFACT 状态码 | EDIFACT 原因代码 | 操作描述 | Vendor Central 用户界面等效性 |
---|---|---|---|
404 | 117 | 由于发生大规模事故,货件延迟 | DELAYED |
301 | 000 | 货件已送达买家 | DELIVERED |
101 | 000 | 货件已离开运营中心 | DEPARTED\_FROM\_FC |
201 | 000 | 货件已抵达承运设施 | IN\_TRANSIT |
409 | 000 | 承运人丢失了货件 | LOST |
302 | 000 | 货件正在配送中 | OUT\_FOR\_DELIVERY |
407 | 000 | 收件人拒绝接受货件 | REJECTED |
416 | 000 | 货件无法配送,并将被销毁 | UNDELIVERABLE |
X12 状态码 | X12 原因代码 | 操作描述 | Vendor Central 用户界面等效性 |
---|---|---|---|
德国 | AF | 由于发生大规模事故,货件延迟 | DELAYED |
D1 | NS | 货件已送达买家 | DELIVERED |
XB | NS | 货件已离开运营中心 | DEPARTED\_FROM\_FC |
O1 | NS | 货件已抵达承运设施 | IN\_TRANSIT |
CA | 波兰 | 承运人丢失了货件 | LOST |
OD | NS | 货件正在配送中 | OUT\_FOR\_DELIVERY |
A7 | AM | 收件人拒绝接受货件 | REJECTED |
AP | BG | 货件无法配送,并将被销毁 | UNDELIVERABLE |
submitShipmentStatusUpdates 请求
若要提交货件状态更新,请调用 submitShipmentStatusUpdates
操作并传递以下参数:
主体参数:
名称 | 描述 | 必填项 |
---|---|---|
shipmentStatusUpdates |
已确认的货件列表。 类型:< |
有帮助 |
请求示例:
POST https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shipmentStatusUpdates
{
"shipmentStatusUpdates": [
{
"purchaseOrderNumber": "DX00050015",
"sellingParty": {
"partyId": "999US"
},
"shipFromParty": {
"partyId": "ABCD"
},
"statusUpdateDetails": {
"trackingNumber": "TRACK005",
"statusCode": "D1",
"reasonCode": "NS",
"statusDateTime": "2020-08-07T19:56:45Z",
"statusLocationAddress": {
"city": "Any Town",
"postalCode": "98101",
"stateOrRegion": "Washington",
"countryCode": "US"
}
}
}
]
}
submitShipmentStatusUpdates 响应
成功的响应包括以下内容:
名称 | 描述 | 必填项 |
---|---|---|
transactionId |
GUID 以识别此交易。此值可以与交易状态 API 一起使用,以返回此交易的状态。 类型:字符串 |
有帮助 |
响应示例:
{
"transactionId": "20190905010908-8a3b6901-ef20-412f-9270-21c021796605"
}
getPackingSlips
getPackingSlips
操作会返回符合指定标准的订单的装箱单列表。如果您需要获取特定订单的装箱单,请改为使用 getPackingSlip
操作。
用于授权的受限数据令牌
这是一项受限操作,因此需要使用受限数据令牌 (RDT) 进行授权。有关更多信息,请参阅令牌 API 用例指南。
您应该使用此 API 来获取可供您配送的采购订单的装箱单。亚马逊建议供应商在办公时间内,至少每小时检查一次订单。根据您的业务量,您可以选择更频繁地进行检查。在一次 API 调用中,您最多可以获得 100 个装箱单。如果装箱单超过 100 个,则可以在下一个请求中使用 nextToken 值作为参数来获取下一组装箱单。
下图显示了检索装箱单时的集成工作流程:
getPackingSlips 请求
若要检索装箱单,请调用 getPackingSlips
操作并传递以下参数:
查询参数:
名称 | 描述 | 必填项 |
---|---|---|
shipFromPartyId |
用于订单配送的供应商 warehouseId 。如果未指定,则结果将包含所有库房的订单。 类型:字符串 |
没有帮助 |
limit |
对返回的记录数的限制。 最小值:1 最大值:100 类型:整数 |
没有帮助 |
createdAfter |
在此日期和时间之后可用的装箱单将包含在结果中。必须采用 ISO-8601 日期/时间的格式。 类型:字符串(日期时间) |
有帮助 |
createdBefore |
在此日期和时间之前可用的装箱单将包含在结果中。必须采用 ISO-8601 日期/时间的格式。 类型:字符串(日期时间) |
有帮助 |
sortOrder |
按装箱单创建日期进行 ASC 或 DESC 排序。 类型:enum ( |
没有帮助 |
nextToken |
当装箱单超过指定结果大小限制时用于分页。令牌值会在之前的 API 调用中返回。 类型:字符串 |
没有帮助 |
请求示例:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/packingSlips?createdBefore=2020-06-12T12:00:00-08:00&createdAfter=2020-06-12T00:00:00-08:00&limit=2&sortOrder=DESC
getPackingSlips 响应
成功的响应包括以下内容:
名称 | 描述 | 必填项 |
---|---|---|
pagination |
如果退回的订单超过 100 个,nextToken 会在分页响应中返回。 类型:字符串 |
没有帮助 |
packingSlips |
包含装箱单的详细信息。 类型:< |
没有帮助 |
响应示例:
{
"payload": {
"pagination": {
"nextToken": "NEBxNEBxNEBxNR=="
},
"packingSlips": [
{
"purchaseOrderNumber": "UvgABdBjQ",
"content": "base64 encoded string",
"contentType": "application/pdf"
}, {
"purchaseOrderNumber": "VvgCDdBjR",
"content": "base64 encoded string",
"contentType": "application/pdf"
}
]
}
}
getPackingSlip
getPackingSlip
操作会返回有关您使用采购订单编号指定的特定装箱单的信息。响应包括装箱单的 base64 编码字符串。内容类型将始终为“application/pdf”。
下图显示了检索装箱单时的集成工作流程:
getPackingSlip 请求
若要返回装箱单,请调用 getPackingSlip
操作并传递以下参数:
路径参数:
名称 | 描述 | 必填项 |
---|---|---|
purchaseOrderNumber |
您想要的装箱单的 purchaseOrderNumber 。 类型:字符串 |
有帮助 |
请求示例:
GET https://sellingpartnerapi-na.amazon.com /vendor/directFulfillment/shipping/v1/packingSlips/UkP3YkKDr
getPackingSlip 响应
成功的响应包括以下内容:
名称 | 描述 | 必填项 |
---|---|---|
purchaseOrderNumber |
装箱单所针对的货件的采购订单编号。 类型:字符串 |
没有帮助 |
packingSlip |
装箱单信息。 类型: |
没有帮助 |
响应示例:
{
"payload": {
"purchaseOrderNumber": "UvgABdBjQ",
"content": "base64 encoded string",
"contentType": "application/pdf"
}
}
getCustomerInvoices
The getCustomerInvoices
operation returns customer invoices for all purchase orders which meet the filter criteria you specify. The use of this API is mandatory only in the India region and not required in any other region. Amazon recommends that vendors check for customer invoices at least once per hour during business hours. Depending on your business volume, you can choose to check more frequently. You can get up to 100 customer invoices in one API call. If there are more than 100 customer invoices you can use the nextToken
value as a parameter in the next request to get the next set of customer invoices.
用于授权的受限数据令牌
这是一项受限操作,因此需要使用受限数据令牌 (RDT) 进行授权。有关更多信息,请参阅令牌 API 用例指南。
下图显示了检索客户发票时的集成工作流程:
getCustomerInvoices 请求
若要返回客户发票,请调用 getCustomerInvoices
操作并传递以下参数:
查询参数:
名称 | 描述 | 必填项 |
---|---|---|
shipFromPartyId |
用于订单配送的供应商 warehouseId 。如果未指定,则结果将包含所有库房的订单。 类型:字符串 |
没有帮助 |
limit |
对返回的记录数的限制。 最小值:1 最大值:10 类型:整数 |
没有帮助 |
createdAfter |
在此日期和时间之后可用的订单将包含在结果中。必须采用 ISO-8601 日期/时间的格式。 类型:字符串(日期时间) |
有帮助 |
createdBefore |
在此日期和时间之前可用的订单将包含在结果中。必须采用 ISO-8601 日期/时间的格式。 类型:字符串(日期时间) |
有帮助 |
sortOrder |
按订单创建日期对 ASC 或 DESC 进行排序。 类型:enum ( |
没有帮助 |
nextToken |
当订单数量超过指定结果大小限制时用于分页。令牌值会在之前的 API 调用中返回。 类型:字符串 |
没有帮助 |
请求示例:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/customerInvoices?limit=2&createdAfter=2020-02-15T14:00:00-08:00&createdBefore=2020-02-20T00:00:00-08:00&sortOrder=DESC
getCustomerInvoices 响应
成功的响应包括以下内容:
名称 | 描述 | 必填项 |
---|---|---|
pagination |
如果返回的客户发票超过 100 张,则 nextToken 会在分页响应中返回。 类型:字符串 |
没有帮助 |
customerInvoices |
客户发票类别。 类型:< |
没有帮助 |
响应示例:
{
"pagination": {
"nextToken": "MDAwMDAwMDAwMQ=="
},
"customerInvoices": [
{
"purchaseOrderNumber": "PO98676856",
"content": "base 64 content goes here"
}
]
}
getCustomerInvoice
getCustomerInvoice
操作会返回有关您使用采购订单编号指定的客户发票的信息。响应包括该采购订单的完整客户发票信息。
您还可以使用此 API 获取任何客户发票的详细信息(在供应商上线 API 后,从过去 6 个月的滚动窗口起的 7 天时间范围内)。
下图显示了返回客户发票的集成工作流程:
特定国家/地区的业务要求
只有印度地区需要使用客户发票 API。
getCustomerInvoice 请求
若要返回客户发票,请调用 getCustomerInvoice
操作并传递以下参数:
路径参数:
名称 | 描述 | 必填项 |
---|---|---|
purchaseOrderNumber |
要退回发票的货件的采购订单号。 类型:字符串 |
有帮助 |
请求示例:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/shipping/v1/shippingLabels/2JK3S9VC
getCustomerInvoice 响应
成功的响应包括以下内容:
名称 | 描述 | 必填项 |
---|---|---|
purchaseOrderNumber |
此订单的采购订单编号。 类型:字符串 |
有帮助 |
content |
Base64 编码的客户发票。 类型:字符串 |
有帮助 |
响应示例:
{
"payload": {
"purchaseOrderNumber": "PO98676856",
"content": "base 64 encoded string"
}
}
Updated 23 days ago