Amazon Overhauls SP-API Documentation With Complete Response Examples and Multi-Language Code Samples
On Jan 30 2025 Amazon released a redesigned SP‑API reference that adds full JSON response examples and live request snippets for 20 programming languages. Legacy pages will be retired on Jun 28 2025, giving developers a five‑month window to switch.
Overview
On January 30 2025 Amazon launched a comprehensive redesign of its Selling Partner API (SP‑API) reference documentation. The update adds full response payload examples and interactive request snippets for 20 programming languages, aiming to cut development time for sellers and third‑party developers. All legacy reference pages will be retired on June 28 2025, giving integration teams a five‑month window to transition.
Key Points
- Full Response Payloads — Every endpoint now displays a complete JSON example, including every field, nested object, and data type, so developers can see exactly what Amazon returns without trial calls.
- Interactive Request Samples — Code snippets are live and adapt to user input, illustrating how to build valid requests for each operation.
- Twenty Language Coverage — Sample code is provided for Python, Java, Go, Rust, Ruby, PHP, TypeScript and 13 additional languages, expanding beyond the previous handful of examples.
- Redesigned Layout — The reference site follows modern documentation standards, with clearer navigation, searchable sections, and consistent formatting across all APIs.
- Hard Cutover Date — All older documentation will disappear on June 28 2025, forcing developers to adopt the new reference by that deadline.
How the New Documentation Works
- Select an Endpoint — Users choose an API operation (e.g., GET /orders/v0/orders) from the left‑hand navigation tree. The page instantly shows a collapsible “Response Example” panel containing a fully populated JSON object, such as an order with fields like
orderId,purchaseDate,orderStatus, and nestedshippingAddress. - View Language‑Specific Code — Below the response panel, a tab strip lists the 20 supported languages. Clicking the “Go” tab reveals a ready‑to‑run snippet that constructs the request, sets required headers, and parses the example response into Go structs. The same request can be viewed in Rust, Ruby, or PHP with a single click, eliminating manual translation.
Analysis & Recommendations
Why This Matters
The complete response payloads eliminate blind test calls, letting sellers instantly see fields like orderSource and buyerInfo. Interactive, language‑specific samples reduce prototype time, especially with the new Go, Rust, and Ruby snippets. Missing the Jun 28 cut‑off could break existing tooling that still points to retired docs.
Key Takeaways
- Full JSON response examples now cover every field for each endpoint, e.g., orderId, purchaseDate, shippingAddress.
- Interactive code samples are available in 20 languages, including Python, Java, Go, Rust, Ruby, PHP, and TypeScript.
- All legacy SP‑API documentation will disappear on June 28 2025, enforcing migration within five months.
Recommended Actions
- →Update internal wikis and bookmarks to the new developer-docs.amazon.com SP‑API URLs before Jun 28 2025.
- →Contact your integration vendors to confirm they will refresh their connectors using the new 20‑language samples.
- →Test the live request snippets in Seller Central > Developer Tools to validate placeholders like {{sellerId}} before production rollout.
Comments
Join the discussion
Log in or create an account to share your thoughts on this update.
No comments yet. Be the first to share your thoughts!