Vendor Direct Fulfillment Transactions API v1 Reference
Access a Direct Fulfillment vendor's transaction status.
Overview
The Selling Partner API for Direct Fulfillment Transaction Status provides programmatic access to a direct fulfillment vendor's transaction status.
Version information
Version : v1
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
Paths
GET /vendor/directFulfillment/transactions/v1/transactions/{transactionId}
Operation: getTransactionStatus
Description
Returns the status of the transaction indicated by the specified transactionId.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that are applied to the operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the SP-API.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | transactionId required | Previously returned in the 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-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-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | GetTransactionResponse |
| 415 | The request payload is in an unsupported format. Headers: x-amzn-RequestId (string):Unique request reference identifier. | GetTransactionResponse |
| 429 | The frequency of requests was greater than allowed. Headers: 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-RequestId (string):Unique request reference identifier. | GetTransactionResponse |
| 503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RequestId (string):Unique request reference identifier. | GetTransactionResponse |
Definitions
GetTransactionResponse
The response schema for the getTransactionStatus operation.
| Name | Description | Schema |
|---|---|---|
| payload optional | The payload for the getTransactionStatus operation. | TransactionStatus |
| errors optional | A list of error responses returned when a request is unsuccessful. | ErrorList |
TransactionStatus
The payload for the getTransactionStatus operation.
| Name | Description | Schema |
|---|---|---|
| transactionStatus optional | The transaction status details. | Transaction |
Transaction
The transaction status details.
| Name | Description | Schema |
|---|---|---|
| transactionId required | The unique identifier sent 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 | Error code and message for the failed transaction. Only available when transaction status is 'Failure'. | 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. |
Updated 4 months ago