Welcome to the new SP-API Documentation site
Amazon launched a redesigned SP‑API documentation hub in early June 2024 (sellingpartnerapi.amazon.com/docs) with a searchable index, embedded "Try it out" Explorer, and version‑specific changelogs. Notable updates include the May 2023 addition of a buyerInfo object to the Order schema and the Oct 12 2023 mandate of a contentMD5 header for CreateFeedDocument.
Overview
Amazon has launched a redesigned documentation hub for the Selling Partner API (SP‑API) in English, consolidating guides, reference data, and developer tools onto a single, easily bookmarked homepage. The new portal went live in early June 2024 and introduces a searchable index, interactive testing, and version‑specific changelogs. Sellers and developers who automate orders, inventory, pricing, or advertising should explore the site immediately to keep their integrations aligned with the latest specifications.
Key Points
- Unified Home Page — The landing dashboard presents tiles for API reference, tutorials, and service status, enabling a developer to open the Orders service index with a single click.
- Service‑Based Organization — All endpoint definitions, request‑response examples, and error‑code tables are grouped by functional area such as Orders, Listings, Payments, and Advertising, so a seller can locate the “GetOrder” operation without navigating unrelated sections.
- Embedded API Explorer — An in‑browser “Try it out” console lets users submit live calls, for example running a
GET /orders/v0/ordersrequest with their own access token to view a real JSON payload instantly. - Versioning and Changelog — Each API release is tagged with a dated changelog; the May 2023 version added a
buyerInfoobject to the Order schema, while the October 12 2023 update toCreateFeedDocumentintroduced a mandatorycontentMD5header. - Search‑Optimized Index — Keyword‑rich search returns precise sections within seconds, allowing a developer typing “pagination token” to land directly on the pagination guide for the Listings API.
- Feedback Widget — A floating “Submit Feedback” button captures comments on documentation clarity, enabling Amazon to prioritize fixes such as clarifying the required
MarketplaceIdfield for the Fulfillment Inbound API.
How the New Documentation Site Works
- Open the Dashboard — Visit the portal’s main URL; the home screen displays large tiles labeled “API Reference,” “Guides & Tutorials,” and “Status & Announcements,” and clicking the “API Reference” tile instantly loads the index for the Orders service.
Analysis & Recommendations
Why This Matters
Developers must align their code with the new schema changes and required headers to avoid API errors. The integrated Explorer lets sellers validate live calls, reducing support tickets, and the new automation guide claims up to 30% fewer throttling incidents. Upcoming deprecation of legacyOrderId in Q3 2024 also requires attention.
Key Takeaways
- The new portal went live in early June 2024 and consolidates all SP‑API resources under a single URL (sellingpartnerapi.amazon.com/docs).
- An in‑browser API Explorer enables live GET /orders/v0/orders calls with a personal access token.
- Changelog entries: May 2023 added a buyerInfo object to Order; Oct 12 2023 made contentMD5 header mandatory for CreateFeedDocument.
- The automation tutorial reports batch‑processing can cut throttling incidents by up to 30% for early adopters.
Recommended Actions
- →Replace any hard‑coded legacy doc URLs (e.g., developer.amazon.com/sp-api/docs/orders) with the new home page URL in all internal documentation.
- →Open the new portal, navigate to Orders, Listings, and Feeds endpoints, and use the "Try it out" button to run a test call verifying required heade...
- →Subscribe to the Release Notes RSS feed, and set a monthly calendar reminder to review the changelog for deprecations such as the legacyOrderId rem...
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!