BigCommerce API endpoint
Returns one product-listing page from a public BigCommerce storefront category page. url must be the full public category-page URL. page is 1-indexed and defaults to 1.
/bigcommerce/categoryQuery parameters:
url (required): full public category-page URL for a BigCommerce Stencil storefront.page (optional): 1-indexed category page, from 1 to 1000; defaults to 1.Returns product cards from the category. A page with no cards is successful only when the storefront explicitly reports that no products exist.
| Field | Filled in, of 20 checked | Values in the sample |
|---|---|---|
| name | 20 | “Goat Milk SFIC (all natural) Glycerin Melt and Pour Soap Ba…” and 19 other values |
| url | 20 | bulkapothecary.com |
| image | 20 | cdn11.bigcommerce.com |
| images | 20 | median 1 entry |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| url | string | Yes | Full public BigCommerce category page URL | https://www.bulkapothecary.com/melt-and-pour-soap-bases/ | |
| page | integer | No | 1 | 1-indexed category 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/category?url=https%3A%2F%2Fwww.bulkapothecary.com%2Fmelt-and-pour-soap-bases%2F&page=1" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"store_url": "https://store.example",
"source_url": "https://store.example/category?page=1",
"page": 1,
"products": [
{
"name": "Widget",
"url": "https://store.example/products/widget",
"price": 12.5
}
]
}
}Request schema
No body schema
Response schema
#/definitions/bigcommerce.categoryResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | bigcommerce.ProductsResponse | No | ||||
| data.page | integer | No | ||||
| data.products | array | No | Product record, 12 fields: availability, brand, currency, description, id, image, images, name, price, price_text, sku, url. Described under BigCommerce storefront search API. | |||
| 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/category?url=https%3A%2F%2Fwww.bulkapothecary.com%2Fmelt-and-pour-soap-bases%2F&page=1" \
-H "x-api-key: $CRAWLORA_API_KEY"