BigCommerce
Catalog API
Summary

Catalog - Products

Get a Catalog Summary

GET /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 header - required

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string - required

    The MIME type of the response body.

example

Response

Body

object | application/json
  • data
    object

    Catalog Summary object describes a lightweight summary of the catalog.

  • meta
    object

    Response metadata.

example

Did you find what you were looking for?