BigCommerce API endpoint
Returns product detail from a public BigCommerce storefront product page. url must be the full public product-page URL for a BigCommerce Stencil storefront.
/bigcommerce/productQuery parameters:
url (required): full public product-page URL for a BigCommerce Stencil storefront.Returns product identity, pricing, availability, brand, description, and public images. Storefronts without a public product page return an upstream error.
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| url | string | Yes | Full public BigCommerce product page URL | https://www.bulkapothecary.com/goat-milk-sfic-all-natural-glycerin-melt-and-pour-soap-base/ | |
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/bigcommerce/product?url=https%3A%2F%2Fwww.bulkapothecary.com%2Fgoat-milk-sfic-all-natural-glycerin-melt-and-pour-soap-base%2F" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"store_url": "https://store.example",
"source_url": "https://store.example/products/widget",
"product": {
"name": "Widget",
"url": "https://store.example/products/widget",
"price": 12.5,
"currency": "USD"
}
}
}Request schema
No body schema
Response schema
#/definitions/bigcommerce.productResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | bigcommerce.ProductResponse | No | ||||
| data.product | bigcommerce.Product | 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/product?url=https%3A%2F%2Fwww.bulkapothecary.com%2Fgoat-milk-sfic-all-natural-glycerin-melt-and-pour-soap-base%2F" \
-H "x-api-key: $CRAWLORA_API_KEY"