Webhooks
Models
Catalog
Products
Product Metafields
Product Bulk Pricing Rules
Product Custom Fields
Product Images
Product Variant Options
Product Variant Option Values
Product Variants
Product Variants Metafields
Product Modifiers
Product Modifier Values
Product Modifier Images
Product Complex Rules
Product Reviews
Product Videos
Brands
Brand Metafields
Brand Images
Category
Category Metafields
Category Images
Variants
Models
get

/catalog/summary

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”

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

2 Headers

Responses

1 Example
Schema
object
data
object

Catalog Summary object describes a lightweight summary of the catalog.

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
store_hash
$$.env
2 variables not set
X-Auth-Client
X-Auth-Token