Overview

Amazon is adding an optional amazonProgram parameter to the Selling Partner API (SP‑API) Sales endpoint getOrderMetrics. The new enum lets developers request metrics for a specific Amazon marketplace program, beginning with AmazonHaul. The change is optional at the API level, but any client library regenerated from the updated OpenAPI spec will include the new argument, so sellers and developers must adjust their code to keep calls working.

Key Points

• New enum parameter — amazonProgram appears as an optional string enum in the getOrderMetrics operation.
• First value is AmazonHaul — The enum currently supports the value AmazonHaul, which isolates metrics for Amazon’s discount‑shopping program.
• Null retains current behavior — Passing null or omitting the parameter returns the same aggregated metrics that sellers have been using today.
• Client regeneration required — Auto‑generated SDKs built from the revised specification will expose a new method signature; every call must be updated or will fail to compile.
• Custom integrations stay functional — Hand‑written API calls are not forced to include the parameter, but adding support is recommended for future‑proofing.

How the New Parameter Works

1. Add the enum argument — When the SDK is regenerated, the getOrderMetrics method signature expands to include amazonProgram.

   • Example: client.getOrderMetrics(startDate, endDate, amazonProgram) where amazonProgram can be "AmazonHaul" or null.

2. Select a program or use null — If a seller wants metrics only for Amazon Haul, they pass the string "AmazonHaul"; if they want the historic all‑program view, they pass .