getOrderMetrics

Tested

GET

/sales/v1/orderMetrics

sales

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

marketplaceIds

array[string]

required

A marketplace identifier. This specifies the marketplace in which the order was placed. Only one marketplace can be specified.

For example, ATVPDKIKX0DER indicates the US marketplace.

Example:

["{{MARKET_USA}}"]

interval

string

required

A time interval used for selecting order metrics. This takes the form of two dates separated by two hyphens (first date is inclusive; second date is exclusive). Dates are in ISO8601 format and must represent absolute time (either Z notation or offset notation). Example: 2018-09-01T00:00:00-07:00--2018-09-04T00:00:00-07:00 requests order metrics for Sept 1st, 2nd and 3rd in the -07:00 zone.

Example:

2025-01-01T00:00:00Z--2025-03-10T23:59:59Z

granularityTimeZone

string

optional

An IANA-compatible time zone for determining the day boundary. Required when specifying a granularity value greater than Hour. The granularityTimeZone value must align with the offset of the specified interval value. For example, if the interval value uses Z notation, then granularityTimeZone must be UTC. If the interval value uses an offset, then granularityTimeZone must be an IANA-compatible time zone that matches the offset. Example: US/Pacific to compute day boundaries, accounting for daylight time savings, for US/Pacific zone.

granularity

enum<string>

required

The granularity of the grouping of order metrics, based on a unit of time. Specifying granularity=Hour results in a successful request only if the interval specified is less than or equal to 30 days from now. For all other granularities, the interval specified must be less or equal to 2 years from now. Specifying granularity=Total results in order metrics that are aggregated over the entire interval that you specify. If the interval start and end date don’t align with the specified granularity, the head and tail end of the response interval will contain partial data. Example: Day to get a daily breakdown of the request interval, where the day boundary is defined by the granularityTimeZone.

Allowed values:

HourDayWeekMonthYearTotal

Example:

Total

buyerType

enum<string>

optional

Filters the results by the buyer type that you specify, B2B (business to business) or B2C (business to customer). Example: B2B, if you want the response to include order metrics for only B2B buyers.

Allowed values:

B2BB2CAll

Default:

All

fulfillmentNetwork

string

optional

Filters the results by the fulfillment network that you specify, MFN (merchant fulfillment network) or AFN (Amazon fulfillment network). Do not include this filter if you want the response to include order metrics for all fulfillment networks. Example: AFN, if you want the response to include order metrics for only Amazon fulfillment network.

firstDayOfWeek

enum<string>

optional

Specifies the day that the week starts on when granularity=Week, either Monday or Sunday. Default: Monday. Example: Sunday, if you want the week to start on a Sunday.

Allowed values:

MondaySunday

Default:

Monday

asin

string

optional

Filters the results by the ASIN that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all ASINs. Example: B0792R1RSN, if you want the response to include order metrics for only ASIN B0792R1RSN.

sku

string

optional

Filters the results by the SKU that you specify. Specifying both ASIN and SKU returns an error. Do not include this filter if you want the response to include order metrics for all SKUs. Example: TestSKU, if you want the response to include order metrics for only SKU TestSKU.

Request 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

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

unique request reference id.

Body

The response schema for the getOrderMetrics operation.

payload

array[object (OrderMetricsInterval) {6}]

optional

A set of order metrics, each scoped to a particular time interval.

interval

string

required

The interval of time based on requested granularity (ex. Hour, Day, etc.) If this is the first or the last interval from the list, it might contain incomplete data if the requested interval doesn't align with the requested granularity (ex. request interval 2018-09-01T02:00:00Z--2018-09-04T19:00:00Z and granularity day will result in Sept 1st UTC day and Sept 4th UTC days having partial data).

unitCount

integer

required

The number of units in orders based on the specified filters.

orderItemCount

integer

required

The number of order items based on the specified filters.

orderCount

integer

required

The number of orders based on the specified filters.

averageUnitPrice

object (Money)

required

The currency type and amount.

totalSales

object (Money)

required

The currency type and amount.

errors

array[object (Error) {3}]

optional

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

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

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

getReportDocument

getMarketplaceParticipations