getOrderMetrics

Tested

GET

/sales/v1/orderMetrics

Last modified:2025-03-21 10:00:17

Maintainer:Sarath S

Returns aggregated order metrics for given interval, broken down by granularity, for given buyer type.

Usage Plan:

Rate (requests per second)	Burst
.5	15

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.

Request

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/sales/v1/orderMetrics?marketplaceIds={{MARKET_USA}}&interval=2025-01-01T00:00:00Z--2025-03-10T23:59:59Z&granularityTimeZone&granularity=Total&buyerType&fulfillmentNetwork&firstDayOfWeek&asin&sku'

Responses

🟢200OK

application/json

OrderMetric action taken on the resource OrderMetrics.

Headers

Body

Example

{
    "payload": [
        {
            "interval": "string",
            "unitCount": 0,
            "orderItemCount": 0,
            "orderCount": 0,
            "averageUnitPrice": {
                "currencyCode": "string",
                "amount": "string"
            },
            "totalSales": {
                "currencyCode": "string",
                "amount": "string"
            }
        }
    ],
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

Modified at 2025-03-21 10:00:17

getReportDocument

getMarketplaceParticipations