Catalog - Products
Get a Catalog Summary
GET /stores/{store_hash}/v3/catalog/summary
Request
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 headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
Body
object | application/json
dataobject
Catalog Summary object describes a lightweight summary of the catalog.
metaobject
Response metadata.
example
Did you find what you were looking for?