Docs menu

Shopify API endpoint

Shopify Search Suggest API

Use Crawlora's Shopify Search Suggest 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.

GETapiKey2 credits/requestShopifyshopify.searchSuggestResponseDoc/shopify/search/suggest

Endpoint facts

Method: GET
API path: /shopify/search/suggest
Auth: apiKey
Credits: 2 credits/request
Platform: Shopify
Response schema: #/definitions/shopify.searchSuggestResponseDoc

Overview

Returns products, collections, and query suggestions from Shopify's credential-free predictive search Ajax endpoint. 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.

Shopify platform page Try Shopify Search Suggest API in Playground Crawlora API pricing Shopify API documentation

Request parameters

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	https://www.allbirds.com
q	string	Yes		Search query	wool
types	string	No		Comma-separated suggestion types. Allowed values: product, collection, query	product,collection,query
limit	integer	No	10 and supports up to 20	Maximum results per type, defaults to 10 and supports up to 20	10
x-api-key (header)	string	Yes		API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/shopify/search/suggest?url=https%3A%2F%2Fwww.allbirds.com&q=wool&types=product%2Ccollection%2Cquery&limit=10" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Authentication

Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.

Billing

Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.

Credit cost: 2 credits/request
Charged response: Successful 2xx responses

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

Infrastructure behavior

This endpoint is executed through Crawlora's managed scraping infrastructure.

Proxy strategy: managed automatically where needed
Browser rendering: enabled for supported targets that require rendered HTML or JavaScript execution
Browser cluster: supported dynamic workloads can be routed through distributed browser instances
Retry behavior: automatic retry/fallback may be used depending on endpoint type
Challenge handling: challenged pages or unusable upstream HTML are detected and surfaced clearly when they cannot be used
Billing: credits are charged only for successful 2xx responses
Observability: responses include request context where available

Response behavior

- Products and collections are normalized to the same shapes used by the Shopify product and collection endpoints. - Query suggestions include text and a storefront search URL when Shopify provides one. - Valid empty suggestion arrays return `200` with empty arrays. - Blocked pages, malformed JSON, and missing Shopify roots return upstream errors.

Error behavior

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.

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "store_url": "https://www.allbirds.com",
    "source_url": "https://www.allbirds.com",
    "query": "wool",
    "types": [
      "product",
      "collection",
      "query"
    ],
    "limit": 10,
    "products": [
      {
        "handle": "mens-wool-runners",
        "title": "Men's Wool Runners"
      }
    ],
    "collections": [
      {
        "handle": "mens",
        "title": "Men"
      }
    ],
    "queries": [
      {
        "text": "wool",
        "url": "https://www.allbirds.com/search?q=wool"
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/shopify.searchSuggestResponseDoc

Field	Type	Required	Example
code	integer	No	200
data	shopify.SearchSuggestResponse	No
data.collections	array	No
data.collections[].created_at	string	No
data.collections[].description	string	No
data.collections[].handle	string	No	mens
data.collections[].id	string	No	278435758160
data.collections[].products_count	integer	No	24
data.collections[].published_at	string	No
data.collections[].title	string	No	Men
data.collections[].updated_at	string	No
data.collections[].url	string	No	https://www.allbirds.com/collections/mens
data.limit	integer	No	10
data.products	array	No
data.products[].available	boolean	No
data.products[].compare_at_price	number	No	120
data.products[].created_at	string	No
data.products[].description	string	No
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[].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[].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[].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.queries	array	No
data.queries[].text	string	No	wool
data.queries[].url	string	No	https://www.allbirds.com/search?q=wool
data.query	string	No	wool
data.source_url	string	No	https://www.allbirds.com
data.store_url	string	No	https://www.allbirds.com
data.types	array	No	product,collection,query
msg	string	No	OK

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/shopify/search/suggest?url=https%3A%2F%2Fwww.allbirds.com&q=wool&types=product%2Ccollection%2Cquery&limit=10" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Responsible public web data workflows

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

More Shopify endpoint docs Shopify scraper API platform page Crawlora API pricing Try Shopify Search Suggest API in Playground Shopify Collections API documentation Shopify Collection Products API documentation Shopify Pages API documentation Shopify Page API documentation Shopify Products API documentation Shopify Product API documentation

Open in Playground Back to group

Docs menu

Shopify API endpoint

Shopify Search Suggest API

GETapiKey2 credits/requestShopifyshopify.searchSuggestResponseDoc/shopify/search/suggest

Endpoint facts

Method: GET
API path: /shopify/search/suggest
Auth: apiKey
Credits: 2 credits/request
Platform: Shopify
Response schema: #/definitions/shopify.searchSuggestResponseDoc

Overview

Shopify platform page Try Shopify Search Suggest API in Playground Crawlora API pricing Shopify API documentation

Request parameters

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	https://www.allbirds.com
q	string	Yes		Search query	wool
types	string	No		Comma-separated suggestion types. Allowed values: product, collection, query	product,collection,query
limit	integer	No	10 and supports up to 20	Maximum results per type, defaults to 10 and supports up to 20	10
x-api-key (header)	string	Yes		API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/shopify/search/suggest?url=https%3A%2F%2Fwww.allbirds.com&q=wool&types=product%2Ccollection%2Cquery&limit=10" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Authentication

Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.

Billing

Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.

Credit cost: 2 credits/request
Charged response: Successful 2xx responses

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

Infrastructure behavior

This endpoint is executed through Crawlora's managed scraping infrastructure.

Proxy strategy: managed automatically where needed
Browser rendering: enabled for supported targets that require rendered HTML or JavaScript execution
Browser cluster: supported dynamic workloads can be routed through distributed browser instances
Retry behavior: automatic retry/fallback may be used depending on endpoint type
Challenge handling: challenged pages or unusable upstream HTML are detected and surfaced clearly when they cannot be used
Billing: credits are charged only for successful 2xx responses
Observability: responses include request context where available

Response behavior

Error behavior

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.

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "store_url": "https://www.allbirds.com",
    "source_url": "https://www.allbirds.com",
    "query": "wool",
    "types": [
      "product",
      "collection",
      "query"
    ],
    "limit": 10,
    "products": [
      {
        "handle": "mens-wool-runners",
        "title": "Men's Wool Runners"
      }
    ],
    "collections": [
      {
        "handle": "mens",
        "title": "Men"
      }
    ],
    "queries": [
      {
        "text": "wool",
        "url": "https://www.allbirds.com/search?q=wool"
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/shopify.searchSuggestResponseDoc

Field	Type	Required	Example
code	integer	No	200
data	shopify.SearchSuggestResponse	No
data.collections	array	No
data.collections[].created_at	string	No
data.collections[].description	string	No
data.collections[].handle	string	No	mens
data.collections[].id	string	No	278435758160
data.collections[].products_count	integer	No	24
data.collections[].published_at	string	No
data.collections[].title	string	No	Men
data.collections[].updated_at	string	No
data.collections[].url	string	No	https://www.allbirds.com/collections/mens
data.limit	integer	No	10
data.products	array	No
data.products[].available	boolean	No
data.products[].compare_at_price	number	No	120
data.products[].created_at	string	No
data.products[].description	string	No
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[].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[].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[].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.queries	array	No
data.queries[].text	string	No	wool
data.queries[].url	string	No	https://www.allbirds.com/search?q=wool
data.query	string	No	wool
data.source_url	string	No	https://www.allbirds.com
data.store_url	string	No	https://www.allbirds.com
data.types	array	No	product,collection,query
msg	string	No	OK

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/shopify/search/suggest?url=https%3A%2F%2Fwww.allbirds.com&q=wool&types=product%2Ccollection%2Cquery&limit=10" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Responsible public web data workflows

Read Crawlora terms

Open in Playground Back to group

Shopify Search Suggest API

Endpoint facts

Overview

Request parameters

cURL example

Authentication

Billing

Infrastructure behavior

Response behavior

Error behavior

Failure responses

Example JSON response

Code examples

Responsible public web data workflows

Related

Shopify Search Suggest API

Endpoint facts

Overview

Request parameters

cURL example

Authentication

Billing

Infrastructure behavior

Response behavior

Error behavior

Failure responses

Example JSON response

Code examples

Responsible public web data workflows

Related