Summary
Get a Catalog Summary
GET https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/summaryRequest
Returns a lightweight inventory summary from the BigCommerce Catalog.
The inventory summary includes:
- "inventory_count"
- "variant_count"
- "inventory_value"
- "highest_variant_price"
- "average_variant_price"
- "lowest_variant_price"
- "oldest_variant_date"
- "newest_variant_date"
- "primary_category_id"
- "primary_category_name"
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
example
curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/catalog/summary' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
Response
Body
object | application/json
dataobject
Catalog Summary object describes a lightweight summary of the catalog.
example
{
"data": {
"inventory_count": 2000,
"inventory_value": 267000,
"primary_category_id": 23,
"primary_category_name": "Shop All",
"variant_count": 46,
"highest_variant_price": 249,
"average_variant_price": 83.07978261,
"lowest_variant_price": "7",
"oldest_variant_date": "2018-08-15T00:00:00+00:00",
"newest_variant_date": "2018-08-16T00:00:00+00:00"
},
"meta": {}
}
Did you find what you were looking for?