Vendor Transaction Status API v1 reference

AmazonSPAPI

# Overview

The Selling Partner API for Retail Procurement Transaction Status provides programmatic access to status information on specific asynchronous POST transactions for vendors.

# Version information

Version : v1

# Operations

getTransaction

# Paths

# getTransaction

GET /vendor/transactions/v1/transactions/{transactionId}

# Description

Returns the status of the transaction that you specify.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

# Parameters

Type Name Description Schema
Path transactionId
required
The GUID provided by Amazon in the 'transactionId' field in response to the post request of a specific transaction. string

# Responses

HTTP Code Description Schema
200 Success.
Headers :
x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string) : Unique request reference identifier.
GetTransactionResponse

For error status codes, descriptions and schemas, see Error responses and schemas.

# Error Responses and Schemas

This table contains HTTP status codes and associated information for error responses.

HTTP Code Description Schema
400 Request has missing or invalid parameters and cannot be parsed.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse
401 The request's Authorization header is not formatted correctly or does not contain a valid token.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse
403 Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse
404 The resource specified does not exist.
Headers:
x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse
415 The request payload is in an unsupported format.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse
429 The frequency of requests was greater than allowed.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse
500 An unexpected condition occurred that prevented the server from fulfilling the request.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse
503 Temporary overloading or maintenance of the server.
Headers:
x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.
Note: For this status code, the rate limit header is deprecated and no longer returned.
x-amzn-RequestId (string):Unique request reference identifier.
GetTransactionResponse

# Definitions

# GetTransactionResponse

The response schema for the getTransaction operation.

Name Description Schema
payload
optional
The response payload for the getTransaction operation. TransactionStatus
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# TransactionStatus

Name Description Schema
transactionStatus
optional
The transaction status. Transaction

# Transaction

The transaction status.

Name Description Schema
transactionId
required
The unique identifier returned in the 'transactionId' field in response to the post request of a specific transaction. string
status
required
Current processing status of the transaction. enum (Status)
errors
optional
A list of error responses returned when a request is unsuccessful. ErrorList

# ErrorList

A list of error responses returned when a request is unsuccessful.

Type : < Error > array

# Error

Error response returned when the request is unsuccessful.

Name Description Schema
code
required
An error code that identifies the type of error that occurred. string
message
required
A message that describes the error condition. string
details
optional
Additional details that can help the caller understand or fix the issue. string

# Status

Current processing status of the transaction.

Type : enum

Value Description
Failure Transaction has failed.
Processing Transaction is in process.
Success Transaction has completed successfully.
Last Updated: 10/11/2022, 9:45:34 PM