供应商直接配送交易状态 API v1 用例指南
Help vendors in the direct fulfillment (DF) program use the Transaction Status API to manage their direct fulfillment operations.
API 版本:v1
什么是直接配送交易状态 API?
供应商可以使用此 API 来检查其 POST 交易的交易状态。
包括以下操作:
操作 | HTTP 方法 | Path | 描述 |
---|---|---|---|
getTransactionStatus | GET | /vendor/directFulfillment/transactions/v1/transactions/{transactionId} | 返回指定的 transactionId 所指示的交易状态。 |
getTransactionStatus
供应商可以使用 getTransactionStatus
操作来检查 POST 交易的状态。当使用供应商 API 中的某些 POST 操作向亚马逊发送请求时,例如 submitAcknowledgement
或 submitShipmentConfirmations
,例如,成功的响应包含唯一标识该交易的交易编号。亚马逊将异步处理交易,最终响应将通过 getTransactionStatus
操作提供。
Refer to the corresponding integration workflow diagram in the other sections of this guide to understand when to call the getTransactionStatus
operation to get the transaction status.
亚马逊通过此 API 为 POST 交易提供最终处理状态,例如 submitAcknowledgement
和 submitShipmentConfirmations
。我们强烈建议供应商使用此 API 检查状态,以确保交易已成功处理。如果发生错误,您将收到错误详情,以便您可以更正交易并重新提交。
交易状态 | 定义 |
---|---|
Processing | 亚马逊收到的 API 交易正在处理中。处理尚未完成。检查每个 API 操作的服务级别协议,了解完成处理的预计时间。 |
Success | 亚马逊成功处理了 API 交易。 |
Failure | API 交易在处理过程中失败。错误详情将在 getTransactionStatus 响应正文中提供。 |
以下直接配送 API 支持交易状态:
描述 | API 部分 | 操作 |
---|---|---|
确认订单 | 直接配送订单 | submitAcknowledgement |
提交货件确认 | 直接配送发货 | submitShipmentConfirmations |
货件标签请求 | 直接配送发货 | submitShippingLabelRequest |
配送状态更新 | 直接配送发货 | submitShipmentStatusUpdates |
库存更新 | 直接配送库存 | submitInventoryUpdate |
发票 | 直接配送付款 | submitInvoice |
交易状态暂时仅支持 Processing
和 Failure
状态码。如果交易状态为 Processing
并且 30 分钟后尚未更新为 Failure
,这表示交易已在我们的系统中成功处理。今后将支持 Success
状态。
getTransactionStatus 请求
若要返回交易状态,请调用 getTransactionStatus
操作并传递以下参数:
路径参数:
名称 | 描述 | 必填项 |
---|---|---|
transactionId |
之前已在响应特定交易的 POST 请求时返回。 类型:字符串 |
有帮助 |
请求示例:
GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/transactions/v1/transactions/20190904190535-eef8cad8-418e-4ed3-ac72-789e2ee6214a
getTransactionStatus 响应
成功的响应包括以下内容:
响应示例:
{
"transactionId": "20190918190535-eef8cad8-418e-456f-ac72-789e2ee6813c",
"status": "Failure",
"errors": [
{
"code": "INVALID_ORDER_ID",
"message": "Invalid order ID."
}
]
}
Updated 5 months ago