Shopify API endpoint
Use Crawlora's Shopify Products API to extract supported public Shopify data as structured JSON. This page includes request parameters, cURL examples, response schema, error behavior, credit cost, and a Playground link for testing before integration.
/shopify/productsReturns normalized products from a public Shopify `/products.json` endpoint. Valid empty result pages return `200` with an empty products array. `sortBy` and dynamic facet-filter query params (e.g. `fit`, `canonicalColour`) only take effect for headless storefronts served via the embedded-SSR-JSON fallback transport (`transport_mode: "ssr_embedded"`) and return an invalid-param error if supplied against a classic-transport store, since Shopify's classic public catalog JSON has no server-side sort or filter support. Developers commonly use this endpoint for data enrichment, monitoring, research dashboards, internal automation, and agent-native workflows that need repeatable structured public web data. Authentication uses the documented Crawlora headers, and usage is metered with the credit cost shown on this page.
Request parameters are generated from the active endpoint catalog. Required values must be sent before Crawlora can call the upstream public web data source.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| url | string | Yes | Shopify storefront URL | ||
| page | integer | No | 1 | 1-based page, defaults to 1 | |
| limit | integer | No | 50 and supports up to 250 | Maximum products, defaults to 50 and supports up to 250 | |
| sortBy | string | No | SSR-fallback transport only (transport_mode ssr_embedded). Allowed values: sortLTH, sortHTL, newest. Omit for the storefront's default relevancy order. Rejected as an invalid param for classic-transport stores. Allowed values: sortLTH, sortHTL, newest | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/shopify/products?page=1&limit=10&sortBy=sortLTH" \ -H "x-api-key: $CRAWLORA_API_KEY"
Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.
Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.
| Plan | Price | Included credits | Daily cap | Rate limit | Overage |
|---|---|---|---|---|---|
| Free | $0/mo | 2,000 | 500 daily credits | 5/min | No overage |
| Starter | $9/mo | 20,000 | 5,000 daily credits | 15/min | $0.75/1,000 overage credits when enabled |
| Growth | $29/mo | 100,000 | 25,000 daily credits | 45/min | $0.45/1,000 overage credits when enabled |
| Pro | $79/mo | 400,000 | No daily cap | 120/min | $0.30/1,000 overage credits |
| Business | $199/mo | 1,200,000 | No daily cap | 300/min | $0.20/1,000 overage credits |
| Enterprise | $499/mo | 5,000,000 | No daily cap | 1,000/min | $0.12/1,000 overage credits |
This endpoint is executed through Crawlora's managed scraping infrastructure.
Some targets require real browser execution because the data is loaded through JavaScript, dynamic rendering, or interaction-like browser behavior.
For supported endpoints, Crawlora can route requests through a managed browser cluster. This allows Crawlora to execute JavaScript, load dynamic content, apply browser-level request behavior, and normalize the rendered result into JSON.
You do not need to operate your own Playwright, Puppeteer, Chrome, proxy, queue, or retry infrastructure.
- Valid empty result pages return `200` with an empty `products` array. - Product prices are normalized to decimal currency units. - Blocked pages, malformed JSON, and missing `products` roots return upstream errors. - If the classic `/products.json` endpoint and `*.myshopify.com` domain resolution are both unavailable (some headless Next.js/React storefronts on a Shopify catalog do not expose either), the service falls back to the storefront's own conventional "all products" collection page (`/collections/all`) and parses its embedded search-result payload. When this fallback was used, the response includes `transport_mode: "ssr_embedded"`, `total_items`, and `total_pages` (the storefront's own result-count/page-count metadata), and each product may include additive fields only available from this source: `colour`, `canonical_colour`, `discount_percentage`, `rating`, `rating_count`, `collection_tags`, `labels`, and per-variant `inventory_quantity`. `limit` is still honored as an upper bound on returned items, but the underlying page size is fixed by the storefront (commonly 60) and cannot be requested larger than that in fallback mode. `transport_mode`, `total_items`, and `total_pages` are omitted entirely for stores served by the classic catalog JSON. - When the `ssr_embedded` fallback was used, the response may also include `facets` and `facets_stats`, mirroring the storefront's own filter sidebar for that listing: `facets` maps a facet field name exactly as the storefront names it (for example `fit`, `activities`, `canonicalColour`, `sizeInStock`) to its value-to-count buckets, and `facets_stats` gives `min`/`max`/`avg` for numeric-range fields such as `price` and `discountPercentage`. Both are omitted when the storefront's payload did not include facet data, and always omitted for the classic transport. - **Sort and filters are SSR-fallback only.** Shopify's classic public `/products.json` catalog feed has no server-side sort or filter support at all — confirmed live: requesting the same store's classic JSON with a sort applied returns byte-identical product order to the unsorted request. Rather than silently accepting and ignoring `sortBy` or a facet filter against a classic-transport store (which would look like it worked but wouldn't), this endpoint rejects the request with a `400` invalid-param error whenever `sortBy` or any facet-filter query param is supplied and the resolved store is not `transport_mode: "ssr_embedded"`. - When a sort and/or filters were applied on the SSR-fallback transport, the response echoes back what was actually honored: `sort` (one of the enum values below) and `filters` (a map of facet field name to the array of values that were requested for it, after comma-splitting). Both are omitted when no sort/filter was supplied. - `hitsPerPage` (the storefront's own listing page size, commonly 60) is unaffected by sort/filters; `limit` continues to apply as an upper bound on the returned page. `sortBy` allowed values: `sortLTH`, `sortHTL`, `newest`. `transport_mode` allowed values: `ssr_embedded` (only ever present, never any other value; omitted for the classic transport). Example response: ```json { "code": 200, "msg": "OK", "data": { "store_url": "https://www.allbirds.com", "source_url": "https://www.allbirds.com", "page": 1, "limit": 2, "products": [ { "id": "7188363542608", "handle": "mens-tree-runner-nz-natural-white", "title": "Men's Tree Runner NZ - Natural White (Natural White Sole)", "url": "https://www.allbirds.com/products/mens-tree-runner-nz-natural-white", "price": 100, "available": true } ] } } ```
Crawlora does not silently return bad data when the upstream page cannot be used.
| Status | Common failure case |
|---|---|
| 400 | Invalid input or missing required parameter |
| 429 | Plan or endpoint rate limit exceeded |
| 500 | Internal execution error |
| 502 | Upstream platform failed, returned unusable HTML, or served a challenge page that could not be resolved |
When possible, Crawlora returns structured error context so your integration can retry, back off, or inspect the request.
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
{
"code": 200,
"msg": "OK",
"data": {
"store_url": "https://www.allbirds.com",
"source_url": "https://www.allbirds.com",
"page": 1,
"limit": 2,
"products": [
{
"id": "7188363542608",
"handle": "mens-tree-runner-nz-natural-white",
"title": "Men's Tree Runner NZ - Natural White (Natural White Sole)",
"url": "https://www.allbirds.com/products/mens-tree-runner-nz-natural-white",
"price": 100,
"available": true
}
]
}
}Request schema
No body schema
Response schema
#/definitions/shopify.productsResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | shopify.ProductsResponse | No | ||||
| data.facets | object | No | Facets and FacetsStats are populated only when TransportMode is ssr_embedded, from the storefront's own embedded search-index facet buckets (the same data driving its own filter sidebar). | |||
| data.facets_stats | object | No | ||||
| data.filters | object | No | ||||
| data.limit | integer | No | 50 | |||
| data.page | integer | No | 1 | |||
| data.products | array | No | ||||
| data.products[].available | boolean | No | ||||
| data.products[].canonical_colour | string | No | black | |||
| data.products[].collection_tags | array | No | ||||
| data.products[].colour | string | No | black | The fields below are only populated when the product was resolved via the embedded-SSR-JSON fallback transport (see ssr_fallback.go) and the source page exposed this data; they are additive and never populated for classic-store responses. | ||
| data.products[].compare_at_price | number | No | 120 | |||
| data.products[].created_at | string | No | ||||
| data.products[].description | string | No | ||||
| data.products[].discount_percentage | number | No | 20 | |||
| data.products[].featured_image | string | No | ||||
| data.products[].handle | string | No | mens-wool-runners | |||
| data.products[].id | string | No | 6616124981328 | |||
| data.products[].images | array | No | ||||
| data.products[].images[].alt | string | No | Product image | |||
| data.products[].images[].created_at | string | No | ||||
| data.products[].images[].height | integer | No | 1600 | |||
| data.products[].images[].id | string | No | 36411373027408 | |||
| data.products[].images[].position | integer | No | 1 | |||
| data.products[].images[].updated_at | string | No | ||||
| data.products[].images[].url | string | No | https://cdn.shopify.com/s/files/1/example.jpg | |||
| data.products[].images[].variant_ids | array | No | ||||
| data.products[].images[].width | integer | No | 1600 | |||
| data.products[].labels | array | No | new | |||
| data.products[].options | array | No | ||||
| data.products[].options[].name | string | No | Size | |||
| data.products[].options[].position | integer | No | 1 | |||
| data.products[].options[].values | array | No | ||||
| data.products[].price | number | No | 98 | |||
| data.products[].product_type | string | No | Shoes | |||
| data.products[].published_at | string | No | ||||
| data.products[].rating | number | No | 4.2 | |||
| data.products[].rating_count | integer | No | 1549 | |||
| data.products[].tags | array | No | ||||
| data.products[].title | string | No | Men's Wool Runners | |||
| data.products[].updated_at | string | No | ||||
| data.products[].url | string | No | https://www.allbirds.com/products/mens-wool-runners | |||
| data.products[].variants | array | No | ||||
| data.products[].variants[].available | boolean | No | ||||
| data.products[].variants[].barcode | string | No | ||||
| data.products[].variants[].compare_at_price | number | No | 120 | |||
| data.products[].variants[].created_at | string | No | ||||
| data.products[].variants[].featured_image | string | No | ||||
| data.products[].variants[].grams | integer | No | 400 | |||
| data.products[].variants[].id | string | No | 34761278160941 | |||
| data.products[].variants[].inventory_quantity | integer | No | 24 | InventoryQuantity is only populated via the embedded-SSR-JSON fallback transport (see ssr_fallback.go); classic-store responses never set it. | ||
| data.products[].variants[].option1 | string | No | ||||
| data.products[].variants[].option2 | string | No | ||||
| data.products[].variants[].option3 | string | No | ||||
| data.products[].variants[].position | integer | No | 1 | |||
| data.products[].variants[].price | number | No | 98 | |||
| data.products[].variants[].product_id | string | No | 6616124981328 | |||
| data.products[].variants[].requires_shipping | boolean | No | ||||
| data.products[].variants[].sku | string | No | A123 | |||
| data.products[].variants[].taxable | boolean | No | ||||
| data.products[].variants[].title | string | No | Natural Black / 10 | |||
| data.products[].variants[].updated_at | string | No | ||||
| data.products[].vendor | string | No | Allbirds | |||
| data.sort | string | No | sortLTH, sortHTL, newest | sortLTH | Sort and Filters echo back the effective sortBy/facet-filter query params that were applied, present only when transport_mode is ssr_embedded and the caller supplied at least one. Always omitted for the classic transport (which rejects them as invalid params instead). | |
| data.source_url | string | No | https://www.allbirds.com | |||
| data.store_url | string | No | https://www.allbirds.com | |||
| data.total_items | integer | No | 184 | TotalItems and TotalPages are populated only when TransportMode is ssr_embedded, from the storefront's own embedded search-result pagination metadata. | ||
| data.total_pages | integer | No | 4 | |||
| data.transport_mode | string | No | ssr_embedded | ssr_embedded | ||
| msg | string | No | OK |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/shopify/products?page=1&limit=10&sortBy=sortLTH" \
-H "x-api-key: $CRAWLORA_API_KEY"Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.
Read Crawlora terms