Shopify API endpoint
Resolves a public Shopify storefront and returns its metadata.
/shopify/storeQuery parameters:
url: required. Full Shopify storefront URL, using http or https. Localhost, private network, link-local, and credentialed URLs are rejected.Notable response behavior:
myshopify_domain, store name, currency, country, and published product/collection counts when /meta.json exposes them.transport_mode is ssr_embedded; it is omitted entirely for other stores. Responses for these stores may have fewer populated fields (for example myshopify_domain and the store-metadata fields are typically unavailable).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 |
|---|---|---|
| requested_url | Has a value | allbirds.com |
| domain | Has a value | “www.allbirds.com” |
| source_domain | Has a value | “www.allbirds.com” |
| myshopify_domain | Has a value | “weareallbirds.myshopify.com” |
| name | Has a value | “Allbirds” |
| currency | Has a value | “USD” |
| country | Has a value | “US” |
| city | Has a value | “Beverly Hills” |
| province | Has a value | “California” |
| description | Has a value | 175 characters |
| published_products_count | Has a value | 692 |
| published_collections_count | Has a value | 1,346 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| 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/store?url=https%3A%2F%2Fwww.allbirds.com" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"requested_url": "https://www.allbirds.com",
"source_url": "https://www.allbirds.com",
"domain": "www.allbirds.com",
"source_domain": "www.allbirds.com",
"name": "Allbirds",
"currency": "USD",
"country": "US",
"published_products_count": 638
}
}Request schema
No body schema
Response schema
#/definitions/shopify.storeResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | shopify.StoreResponse | No | ||||
| data.city | string | No | San Francisco | City of the store's business address. | ||
| data.country | string | No | US | Country code of the store, for example `US`. | ||
| data.currency | string | No | USD | Currency code the store prices in, for example `USD`. | ||
| data.description | string | No | Store description set by the merchant. | |||
| data.domain | string | No | www.gymshark.com | Domain of the storefront URL that was requested. | ||
| data.myshopify_domain | string | No | gymsharkusa.myshopify.com | The store's `myshopify.com` domain, for example `gymsharkusa.myshopify.com`. | ||
| data.name | string | No | Allbirds | Store name, for example `Allbirds`. | ||
| data.province | string | No | CA | State or province of the store's business address. | ||
| data.published_collections_count | integer | No | 42 | Number of published collections in the store. | ||
| data.published_products_count | integer | No | 638 | Number of published products in the store. | ||
| data.requested_url | string | No | https://www.gymshark.com | Storefront URL that was requested. | ||
| data.source_domain | string | No | gymsharkusa.myshopify.com | Domain the store data was read from. It differs from `domain` when the store's `myshopify.com` domain is used. | ||
| data.source_url | string | No | https://gymsharkusa.myshopify.com | URL the data was read from. | ||
| 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 |
| 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/store?url=https%3A%2F%2Fwww.allbirds.com" \
-H "x-api-key: $CRAWLORA_API_KEY"