ベンダー出品者出荷トランザクションステータス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説明
getTransactionStatusGET/vendor/directFulfillment/transactions/v1/transactions/{transactionId}指定したtransactionIdのトランザクションのステータスを返します。

getTransactionStatus

getTransactionStatusオペレーションを使用してPOSTトランザクションのステータスを確認できます。ベンダーAPIで、submitAcknowledgementsubmitShipmentConfirmationsといった特定の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を介して、submitAcknowledgementsubmitShipmentConfirmationsなどのPOSTトランザクションの最終処理ステータスを提供します。ベンダーには、このAPIを使用してステータスを確認し、トランザクションが正常に処理されたことを確認することを強くお勧めします。エラーが発生した場合、エラー情報が届くため、トランザクションを修正して再送信できます。

トランザクションステータス定義
ProcessingAPIトランザクションはAmazonによって受信され、処理中です。処理はまだ完了していません。各APIオペレーションのサービスレベルアグリーメントをチェックして、処理が完了するまでの予想時間を確認してください。
SuccessAPIトランザクションはAmazonによって正常に処理されました。
FailureAPIトランザクションは処理中に失敗しました。エラーの詳細は、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 特定のトランザクションのPOSTリクエストのレスポンスで送信されたtransactionIdフィールドの一意のID。

タイプ:文字列

はい
status トランザクションの現在の処理ステータス。

列挙(ステータス

はい
errors 失敗したトランザクションのエラーコードとメッセージ。トランザクションステータスが「Failure」の場合にのみ使用できます。

タイプ:ErrorList

いいえ

レスポンスの例:

{ "transactionId": "20190918190535-eef8cad8-418e-456f-ac72-789e2ee6813c", "status": "Failure", "errors": [ { "code": "INVALID_ORDER_ID", "message": "Invalid order ID." } ] }

このページは役に立ちましたか?