Skip to main content

List Orders Behind a Channel Health Metric

GET 
/api/channel-health/metrics/:metric/orders

The orders behind a metric for one integration instance, bad ones first, plus breakdown — every bad event (not just this page) grouped by fulfillment source and the raw carrier string sent.

Required scope: channel-health:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Sources:

  • Amazon Valid Tracking Rate and Late Shipment Rate: the shipments SKU confirmed to Amazon within the metric's window, each judged the way SKU's estimate judges it (counts_as valid / invalid / late), linked to its shipment flag (flag_id). is_estimate is true.
  • Metrics the marketplace itemises (Walmart cancellations, on-time shipment, etc.): the rows of the latest per-order report, with counts_as invalid / late / cancelled / defect, or not_counted (and counted false) for a row the marketplace lists but doesn't hold the seller accountable for — those are listed last and left out of breakdown. is_estimate is false.

counted is true when the row counts against the metric as a bad event.

  • Metrics no one itemises (e.g. Order Defect Rate claims): an empty page with is_estimate true and seller_central_url pointing to the marketplace's own report.

Paginated: per_page default 10, max 500.

Authentication: Bearer token (Personal Access Token) with the channel-health:read scope. The user needs the Integrations › View permission.

Request​

Responses​

OK

Response Headers
    Content-Type