listTransactions - Amazon SP API

Returns transactions for the given parameters. Orders from the last 48 hours might not be included in financial events.

Usage Plan:

Rate (requests per second)	Burst
0.5	10

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the `listTransactions` operation.

nextToken

string

optional

The response includes nextToken when the number of results exceeds the specified pageSize value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

transactions

array[object (Transaction) {12}]

optional

A list of transactions within the specified time period.

sellingPartnerMetadata

object (SellingPartnerMetadata)

optional

Metadata that describes the seller.

relatedIdentifiers

array[object (RelatedIdentifier) {2}]

optional

Related business identifiers of the transaction.

transactionType

string

optional

The type of transaction.

Possible value: Shipment

transactionId

string

optional

The unique identifier of the transaction.

transactionStatus

string

optional

The status of the transaction.

Possible values:

Deferred

Released

description

string

optional

Describes the reasons for the transaction.

Example: 'Order Payment', 'Refund Order'

postedDate

string <date-time>

optional

A date in ISO 8601 date-time format.

totalAmount

object (Currency)

optional

The type and amount of currency.

marketplaceDetails

object (MarketplaceDetails)

optional

Information about the marketplace where the transaction occurred.

Example:

{"marketplaceId":"ATVPDKIKX0DER","marketplaceName":"Amazon.com"}

items

array[object (Item) {7}]

optional

A list of items contained in the package.

<= 500 items

contexts

array[object (Context) {17}]

optional

A list of additional information about the item.

breakdowns

array[object (Breakdown) {3}]

optional

A list of breakdowns that provide details on how the total amount is calculated for the transaction.

Example

{
    "nextToken": "string",
    "transactions": [
        {
            "sellingPartnerMetadata": {
                "sellingPartnerId": "XXXXXXXXXXXXXX",
                "accountType": "PAYABLE",
                "marketplaceId": "ATVPDKIKX0DER"
            },
            "relatedIdentifiers": [
                {
                    "relatedIdentifierName": "ORDER_ID",
                    "relatedIdentifierValue": "8129762527551"
                }
            ],
            "transactionType": "Shipment",
            "transactionId": "b1qD0oAliFkLiqRyGbmeT0DoS2Z2kHzi7TZ92z-vARI",
            "transactionStatus": "Released",
            "description": "Order Payment",
            "postedDate": "2020-07-14T03:35:13.214Z",
            "totalAmount": {
                "currencyAmount": 10,
                "currencyCode": "USD"
            },
            "marketplaceDetails": {
                "marketplaceId": "ATVPDKIKX0DER",
                "marketplaceName": "Amazon.com"
            },
            "items": [
                {
                    "description": "Item title",
                    "totalAmount": {
                        "currencyAmount": 10,
                        "currencyCode": "USD"
                    },
                    "relatedIdentifiers": [
                        {
                            "itemRelatedIdentifierName": "ORDER_ADJUSTMENT_ITEM_ID",
                            "itemRelatedIdentifierValue": "81297625-121-27551"
                        }
                    ],
                    "breakdowns": [
                        {
                            "breakdownType": "Product Charges",
                            "breakdownAmount": {
                                "currencyAmount": 10,
                                "currencyCode": "USD"
                            },
                            "breakdowns": [
                                {
                                    "breakdownType": "Principle",
                                    "breakdownAmount": {
                                        "currencyAmount": 10,
                                        "currencyCode": "USD"
                                    },
                                    "breakdowns": []
                                }
                            ]
                        }
                    ],
                    "contexts": [
                        {
                            "contextType": "ProductContext",
                            "asin": "B07FGXZQZ1",
                            "sku": "sku-12",
                            "quantityShipped": 1,
                            "fulfillmentNetwork": "MFN"
                        }
                    ]
                }
            ],
            "breakdowns": {
                "breakdowns": [
                    {
                        "breakdownType": "Sales",
                        "breakdownAmount": {
                            "currencyAmount": 10,
                            "currencyCode": "USD"
                        },
                        "breakdowns": [
                            {
                                "breakdownType": "Product Charges",
                                "breakdownAmount": {
                                    "currencyAmount": 10,
                                    "currencyCode": "USD"
                                },
                                "breakdowns": []
                            }
                        ]
                    }
                ]
            },
            "contexts": [
                {
                    "contextType": "AmazonPayContext",
                    "storeName": "Store 1",
                    "orderType": "Order Type",
                    "channel": "MFN"
                }
            ]
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable