Storefront Category
Get Storefront Category Settings
GET https://api.bigcommerce.com/stores/{store_hash}/v3/settings/storefront/categoryRequest
Returns category settings.
-
Channel ID can be used as a query parameter for getting channel-specific settings. If omitted, you will interact with the global settings only.
-
null
indicates that a particular field has not been overridden on a channel level when channel level settings are requested and values are inherited from global level.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
OK. null
indicates that a particular field has not been overridden on a channel level when channel level settings are requested
Body
dataobject
example
Update Storefront Category Settings
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/settings/storefront/categoryRequest
Updates category settings.
-
Channel ID can be used as a query parameter for updating channel-specific settings. If omitted, you will interact with the global settings only.
-
null
should be supplied to delete overrides per given channel and to inherit values from global level. Partial updates are not supported and all settings should be supplied withnull
value in order to delete overrides per channel.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
category_tree_depthinteger
Min: 1Max: 8default_product_sortstring
The available sorts for PLP pages.
Allowed: featured | bestselling | newest | alphaasc | alphadesc | pricedesc | priceasc | avgcustomerreview | relevance
Default: bestselling
listing_modestring
Allowed: current_category_only | child_categories | child_categories_if_category_empty
example
Response
OK
Body
dataobject