getOrderMetrics

get https://sellingpartnerapi-na.amazon.com/sales/v1/orderMetrics

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.

Query Params

marketplaceIds

array of strings

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.

marketplaceIds*

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.

granularityTimeZone

string

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

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.

buyerType

string

Defaults to All

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.

fulfillmentNetwork

string

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

string

Defaults to Monday

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.

asin

string

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

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.

Responses

Response body

object

payload

array of objects

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

payload

object

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

required

The currency type and the amount.

totalSales

object

required

The currency type and the amount.

errors

array of objects

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

errors

object

code

string

required

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

message

string

required

A message that describes the error condition in a human-readable form.

details

string

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sellingpartnerapi-na.amazon.com/sales/v1/orderMetrics?granularity=Hour&buyerType=All&firstDayOfWeek=Monday' \
3
     --header 'accept: application/json'


xxxxxxxxxx
25
 
1
{
2
  "payload": [
3
    {
4
      "interval": "string",
5
      "unitCount": 0,
6
      "orderItemCount": 0,
7
      "orderCount": 0,
8
      "averageUnitPrice": {
9
        "currencyCode": "string",
10
        "amount": "string"
11
      },
12
      "totalSales": {
13
        "currencyCode": "string",
14
        "amount": "string"
15
      }
16
    }
17
  ],
18
  "errors": [
19
    {
20
      "code": "string",
21
      "message": "string",
22
      "details": "string"
23
    }
24
  ]
25
}

200OrderMetric action taken on the resource OrderMetrics.

400Request has missing or invalid parameters and cannot be parsed.

403403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The entity of the request is in a format not supported by the requested resource.

429The frequency of requests was greater than allowed.

500Encountered an unexpected condition which prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.