ベンダー出品者出荷トランザクションステータス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で、submitAcknowledgement
、submitShipmentConfirmations
といった特定のPOSTオペレーションを使用してリクエストをAmazonにPOSTすると、そのトランザクションを一意に識別するトランザクションIDが成功レスポンスに記載されます。そのトランザクションはAmazonで非同期的に処理され、最終的なレスポンスは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.
Amazonは、このAPIを介して、submitAcknowledgement
、submitShipmentConfirmations
などのPOSTトランザクションの最終処理ステータスを提供します。ベンダーには、このAPIを使用してステータスを確認し、トランザクションが正常に処理されたことを確認することを強くお勧めします。エラーが発生した場合、エラー情報が届くため、トランザクションを修正して再送信できます。
トランザクションステータス | 定義 |
---|---|
Processing | APIトランザクションはAmazonによって受信され、処理中です。処理はまだ完了していません。各APIオペレーションのサービスレベルアグリーメントをチェックして、処理が完了するまでの予想時間を確認してください。 |
Success | APIトランザクションはAmazonによって正常に処理されました。 |
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