sales_getOrderMetrics

Order metrics (units, order count, revenue) as a time series per granularity — sales trends, year-over-year comparisons, revenue reporting.

readAmazon Seller (SP-API)sp.sales

Read-only. Amazon SP-API · getOrderMetrics · GET /sales/v1/orderMetrics

Call it

In an AI client (MCP)

tools/call

{
  "name": "sales_getOrderMetrics",
  "arguments": {
    "store": "myStore-US",
    "interval": "<interval>",
    "granularity": "Hour"
  }
}

From code (Tool API)

curl -X POST https://api.sellersheetai.com/api/v1/tools/sales_getOrderMetrics \
  -H "Authorization: Bearer $SELLERSHEET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"store":"myStore-US","interval":"<interval>","granularity":"Hour"}'

Early access — the Tool API is open on request, contact us.

Arguments

Name	Type	Description
`store`required	`string`	the store ref `<store>-<CC>` (name-country, e.g. 'myStore-US') — one of get_user_context's store_refs, verbatim.
`interval`required	`string`	two ISO-8601 datetimes joined by '--', BOTH with a timezone offset ('2026-01-01T00:00:00-07:00--2026-02-01T00:00:00-07:00', or 'Z' for UTC) — a single datetime is rejected before the call, and Amazon refuses an offset-less interval even with granularity_time_zone set. Hour works only for an interval within the last 30 days; every other granularity within the last 2 years.
`granularity`required	`string`	the bucket size of the series; Total returns one sum for the interval. Allowed: Hour \| Day \| Week \| Month \| Year \| Total.`HourDayWeekMonthYearTotal`
`marketplace_ids`	`object[]`	optional single-element override of the store's marketplace (['ATVPDKIKX0DER']) — Amazon allows EXACTLY ONE per call, so compare marketplaces one call each; omit to use the store's.
`granularity_time_zone`	`string`	IANA zone ('UTC', 'Asia/Dubai') that sets the day boundary for Day-or-longer granularity; Amazon requires it above Hour. Match it to the interval's offset (a 'Z' interval → 'UTC', '+04:00' → 'Asia/Dubai') or the buckets are re-cut in that zone with partial-day edges.
`buyer_type`	`string`	whose orders to count — business buyers, consumers or both. Default: All. Allowed: B2B \| B2C \| All.`B2BB2CAll`
`fulfillment_network`	`string`	AFN (FBA) \| MFN (seller-fulfilled); omit for both.
`first_day_of_week`	`string`	the day a Week bucket starts on. Default: Monday. Allowed: Monday \| Sunday.`MondaySunday`
`asin`	`string`	the ASIN (e.g. 'B0XXXXXXXX'). Mutually exclusive with sku.
`sku`	`string`	one seller SKU. Mutually exclusive with asin.
`amazon_program`	`string`	limits the metrics to one Amazon program — AmazonHaul is the low-cost storefront; omit for all programs.

Result

Every tool answers {notification, data, human_action}; data carries:

data.granularity / data.interval — as requested.
data.result — one per period — {interval, unitCount, orderItemCount, orderCount, averageUnitPrice {amount, currencyCode}, totalSales {amount, currencyCode}}.

Call itCopy Anchor Link

ArgumentsCopy Anchor Link

ResultCopy Anchor Link

On this page

Call it

Arguments

Result