RESTAdminCatalogProductsSummary

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"

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Products | modify | `store_v2_products` | | Products | read-only | `store_v2_products_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Response

dataobject
Catalog Summary object describes a lightweight summary of the catalog.
metaobject
Response metadata.