Core concepts
Platforms & marketplaces
Which retailers and storefronts are live, what their item ids look like, and how to discover coverage from the API.
Platforms
A platform is a retailer. Every item endpoint takes a platform field and returns the same envelope whichever one you pick; only the ids you send and the platform-specific extras differ.
| Platform | platform | Live marketplaces | Live endpoints |
|---|---|---|---|
| Amazon | amazon | us | POST /v1/products, POST /v1/offers, POST /v1/offers/check |
| Walmart | walmart | us | POST /v1/products |
| Target | target | us | POST /v1/products |
| Best Buy | bestbuy | us | POST /v1/products |
platform defaults to amazon for compatibility with older integrations. Send it explicitly in new code.
Marketplaces
A marketplace is one regional storefront of a platform, such as us or ca. Each call reads exactly one. Prices come back in that marketplace's currency, named beside every price.
| Platform | marketplace | Name | Currency | Status |
|---|---|---|---|---|
| Amazon | us | Amazon US | USD | Live |
| Amazon | uk | Amazon UK | GBP | Coming soon |
| Amazon | de | Amazon Germany | EUR | Coming soon |
| Amazon | fr | Amazon France | EUR | Coming soon |
| Amazon | it | Amazon Italy | EUR | Coming soon |
| Amazon | es | Amazon Spain | EUR | Coming soon |
| Amazon | ca | Amazon Canada | CAD | Coming soon |
| Amazon | mx | Amazon Mexico | MXN | Coming soon |
| Amazon | jp | Amazon Japan | JPY | Coming soon |
| Amazon | au | Amazon Australia | AUD | Coming soon |
| Amazon | in | Amazon India | INR | Coming soon |
| Amazon | br | Amazon Brazil | BRL | Coming soon |
| Amazon | nl | Amazon Netherlands | EUR | Coming soon |
| Amazon | se | Amazon Sweden | SEK | Coming soon |
| Amazon | pl | Amazon Poland | PLN | Coming soon |
| Walmart | us | Walmart US | USD | Live |
| Target | us | Target US | USD | Live |
| Best Buy | us | Best Buy US | USD | Live |
| Best Buy | ca | Best Buy Canada | CAD | Coming soon |
marketplacedefaults to the platform's default (uson every live platform).- A coming-soon marketplace answers
501 NOT_IMPLEMENTEDwith"coming_soon": true. Nothing is charged. - An unknown platform or marketplace is a
400 INVALID_PARAM; the message lists the valid values.
Item ids
Send each platform's own product identifier in ids. On Amazon, asins is accepted as an alias.
| Platform | Item id | Format | Where to find it | Example |
|---|---|---|---|---|
| Amazon | ASIN | 10 letters or digits (books: the ISBN-10) | The ASIN, after /dp/ in a product URL. | B0009KNLV6 |
| Walmart | item id | 5 to 15 digits | The number at the end of walmart.com/ip/<name>/5129928603. | 5129928603 |
| Target | TCIN | 6 to 10 digits | The TCIN, after /A- in a product URL. A leading A- is stripped. | 83887639 |
| Best Buy | SKU | 5 to 10 digits | The SKU on the product page (older URLs end in /6505727.p). | 6505727 |
- Ids are trimmed (and upper-cased on Amazon). Empty strings are ignored.
- Duplicates are fetched and charged once; each unique id comes back exactly once.
- An id that does not match the format is a
400 INVALID_PARAMwithparamset toids[i], and nothing is charged.
Discover coverage
GET /v1/platforms lists every platform, its marketplaces and endpoints, each live or coming_soon, with tiers and prices. It needs no API key, so SDKs and dashboards can read coverage instead of hard-coding it.
curl "https://api.scrapelyserp.com/v1/platforms"Coming soon
- Platforms: Google, eBay and AliExpress.
- Amazon marketplaces:
uk,de,fr,it,es,ca,mx,jp,au,in,br,nl,se,pl. - Best Buy marketplaces:
ca.
Anything announced answers 501 NOT_IMPLEMENTED with "coming_soon": true until it launches, and is never charged.