Shopify API endpoint
Returns one static page from any public Shopify storefront, by path `handle` and the required `url` of the store. The response has the page's title, URL, times and its `content` as plain text. Unknown handles return 404. Localhost, private-network and credentialed URLs are rejected.
/shopify/pages/{handle}Returns static page detail from a public Shopify store.
handle: required. Page handle.url: required. Full Shopify storefront URL, using http or https. Localhost, private network, link-local, and credentialed URLs are rejected.body_html; raw HTML is not returned.404 when Shopify returns not found.transport_mode: "ssr_embedded"; content is plain text rendered from the page's rich-text blocks (marks/formatting are dropped, non-rich-text blocks such as banners are skipped), and id is omitted because it is not a Shopify numeric id. transport_mode is omitted entirely for other stores.transport_mode allowed values: ssr_embedded (only ever present, never any other value; omitted for the classic transport).
| Field | In the sample | Value in the sample |
|---|---|---|
| store_url | Has a value | allbirds.com |
| page.id | Has a value | |
| page.handle | Has a value | |
| page.title | Has a value | |
| page.url | Has a value | |
| page.content | Has a value | |
| page.published_at | Has a value | |
| page.created_at | Has a value | |
| page.updated_at | Has a value |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| handle (path) | string | Yes | Page handle | accessibility | |
| url | string | Yes | Shopify storefront URL | https://www.allbirds.com | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/shopify/pages/accessibility?url=https%3A%2F%2Fwww.allbirds.com" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"store_url": "https://www.allbirds.com",
"source_url": "https://www.allbirds.com",
"page": {
"id": "54831906896",
"handle": "accessibility",
"title": "Accessibility",
"url": "https://www.allbirds.com/pages/accessibility",
"content": "Our Commitment to Accessibility"
}
}
}Request schema
No body schema
Response schema
#/definitions/shopify.pageResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | shopify.PageResponse | No | ||||
| data.page | object | No | The static page that was requested. | |||
| data.page.content | string | No | Body of the page as plain text. | |||
| data.page.created_at | string | No | Time the record was created, as Shopify returns it. | |||
| data.page.handle | string | No | accessibility | URL slug of the page, for example `accessibility`. | ||
| data.page.id | string | No | 54831906896 | Shopify page id. | ||
| data.page.published_at | string | No | Time the record was published, as Shopify returns it. | |||
| data.page.title | string | No | Accessibility | Page title as shown on the storefront. | ||
| data.page.updated_at | string | No | Time the record was last updated, as Shopify returns it. | |||
| data.page.url | string | No | https://www.allbirds.com/pages/accessibility | Storefront URL of the page. | ||
| data.source_url | string | No | https://www.allbirds.com | URL the data was read from. | ||
| data.store_url | string | No | https://www.allbirds.com | Base URL of the Shopify storefront that was queried. | ||
| data.transport_mode | string | No | ssr_embedded | ssr_embedded | Set only for headless storefronts that do not expose Shopify's standard catalogue; the value is `ssr_embedded`. Omitted otherwise. | |
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/definitions/app.Response |
| 429 | Too Many Requests | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/shopify/pages/accessibility?url=https%3A%2F%2Fwww.allbirds.com" \
-H "x-api-key: $CRAWLORA_API_KEY"