BigCommerce API endpoint
Returns one product-search page from a public BigCommerce storefront. url must be the public storefront origin; an optional caller path or query is ignored. q is required search text. page is 1-indexed and defaults to 1.
/bigcommerce/searchQuery parameters:
url (required): public BigCommerce Stencil storefront URL. Only its origin is used.q (required): search text.page (optional): 1-indexed results page, from 1 to 1000; defaults to 1.Returns public product-search cards. A page with no cards is successful only when the storefront explicitly reports no matches.
| Field | Filled in, of 20 checked | Values in the sample |
|---|---|---|
| name | 20 | “Lavender Flowers” and 19 other values |
| url | 20 | bulkapothecary.com |
| image | 20 | cdn11.bigcommerce.com |
| images | 20 | median 1 entry |
| price | 4 | 7.95 to 8.95, median 8.95 |
| price_text | 4 | $8.95 (3), $7.95 (1) |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| url | string | Yes | Public BigCommerce storefront origin | https://www.bulkapothecary.com | |
| q | string | Yes | Search text | lavender | |
| page | integer | No | 1 | 1-indexed search page, defaults to 1 Minimum: 1. | 1 |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/bigcommerce/search?url=https%3A%2F%2Fwww.bulkapothecary.com&q=lavender&page=1" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"store_url": "https://store.example",
"source_url": "https://store.example/search.php?page=1&search_query=widget§ion=product",
"query": "widget",
"page": 1,
"products": [
{
"name": "Widget",
"url": "https://store.example/products/widget",
"price": 12.5
}
]
}
}Request schema
No body schema
Response schema
#/definitions/bigcommerce.searchResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | bigcommerce.SearchResponse | No | ||||
| data.page | integer | No | ||||
| data.products | array | No | ||||
| data.products[].availability | string | No | ||||
| data.products[].brand | string | No | ||||
| data.products[].currency | string | No | ||||
| data.products[].description | string | No | ||||
| data.products[].id | string | No | ||||
| data.products[].image | string | No | ||||
| data.products[].images | array | No | ||||
| data.products[].name | string | No | ||||
| data.products[].price | number | No | ||||
| data.products[].price_text | string | No | ||||
| data.products[].sku | string | No | ||||
| data.products[].url | string | No | ||||
| data.query | string | No | ||||
| data.source_url | string | No | ||||
| data.store_url | string | No | ||||
| 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/bigcommerce/search?url=https%3A%2F%2Fwww.bulkapothecary.com&q=lavender&page=1" \
-H "x-api-key: $CRAWLORA_API_KEY"