Vendor Direct Fulfillment Transaction Status API v2021-12-28 Use Case Guide

API Version: 2021-12-28

What is the Direct Fulfillment Transaction Status API?

Use this API to check the transaction status of your POST transactions.

The following operation is included:

getTransactionStatus

Use the getTransactionStatus operation to check the status of a POST transaction. The response to certain Vendor API POST operations, such as submitAcknowledgement or submitShipmentConfirmations, contain a transaction ID that uniquely identifies the transaction. Amazon processes the transaction asynchronously, and you can query the transaction ID with the getTransactionStatus operation to retrieve the final processed status.

You can use the getTransactionStatus operation to check if transactions are successful. If unsuccessful, the response returns an error with details for correcting the transaction.

The transaction status is supported for the following Direct Fulfillment APIs:

If the transaction status is Processing for more than 15 minutes, then the transaction did not complete. If the transaction is successful, a Success status is returned. If unsuccessful, a Failure status is returned.

Invoice messages are not supported with getTransactionStatus. If you include them in your request, the status remains as Processing. If you have a payment-related query that pertains to a status that has not changed in more than 24 hours, go to Vendor Central, select Contact Us, and select the relevant queue. Before opening a case, ensure that you have correctly formatted the data for submission.

If a shipping label request for a transaction fails with Internal server error, you can go to Vendor Central and select Contact Us to initiate an investigation into the cause of the failure. This generally happens due to operational constraints. For data related failures, correct the data and resubmit the payload to get the order fulfilled.

Request

To return the transaction status, call the getTransactionStatus operation and pass the following parameter:

Path parameter

Request example

GET https://sellingpartnerapi-na.amazon.com/vendor/directFulfillment/transactions/2021-12-28/transactions/20190904190535-eef8cad8-418e-4ed3-ac72-789e2ee6214a

Response

A successful response includes the following:

Response example

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

List of errors

The following table contains a list of error codes for each message type. Use these error codes in your system to design a failure handling mechanism. Each error code has a message that explains the error and how to resolve it.