category
object

{{category}} available to templates/pages/category.html and other category page templates and components

config
array[object]
count
integer
description
string

Merchant-defined description of the category.

detail_messages
array[object]

Message displayed when a product is out of stock, and inventory settings are configured to redirect to a category: “Sorry, the product you tried to view is currently out of stock, here are some similar products we have available.” (This phrasing is set by the BigCommerce App.)

faceted_search_enabled
boolean

Boolean that defines whether product-filtering search is enabled for the store.

facets
array[object]

Available search facets.

id
integer

Unique ID for the category.

image
object

{{*.image}} object used by various objects such as {{category.image}}, {{product.images[*]}}

meta
array[object]
name
string

Merchant-defined category name.

products
array[object]
selected
array[object]

Selected search facets.

shop_by_price
array[object]

Exposes price- and currency-related properties in both raw numeric, and formatted string, formats.

show_compare
integer

Boolean that defines whether to show controls for product comparison

state
array[object]
subcategories
array[object]

List of any child categories.

total_products
integer

Count of the number of products in the category.

url
string