Overview

Amazon has upgraded the Selling Partner API (SP‑API) Sales endpoint to let developers pull metrics that belong only to the Amazon Haul program. The new optional filter, added to the getOrderMetrics call, isolates Haul orders from regular marketplace data, giving sellers a clean view of performance in the budget‑focused channel. Sellers who rely on data‑driven decisions can now track revenue, order count and other KPIs for Haul without rewriting existing integrations.

Key Points

• Haul‑only filter — Adding the haul=true query parameter to getOrderMetrics returns metrics that exclude every non‑Haul transaction, e.g., a seller with 1,200 total orders sees only the 300 Haul orders in the response.
• Zero‑impact upgrade — Because the parameter is optional, APIs that omit it continue to deliver the full data set exactly as before, so legacy dashboards remain functional.
• Four market support — The filter works for the United States, United Kingdom, Germany and Japan, allowing a single request to compare Haul performance across all active regions.
• Full compatibility with existing filters — Sellers can combine the Haul flag with date ranges, granularity (daily, weekly, monthly) and ASIN‑level breakdowns, e.g., a request for daily Haul metrics for ASIN B07XYZ on March 1‑7, 2024.
• Immediate analytics — No new authentication scopes or token changes are required; the same SP‑API credentials used for standard sales data grant access to the Haul‑specific view.

How the Sales Endpoint Works

1. Add the Haul flag — In the API request URL, append haul=true.

   • Example: GET https://sellingpartnerapi-na.amazon.com/sales/v1/orderMetrics?marketplaceIds=ATVPDKIKX0DER&haul=true&granularity=DAY&startDate=2024-03-01&endDate=2024-03-07.
   • The response now contains only orders that originated from the Haul shopping experience.

2. — Keep any previously used parameters such as , , or .