Docs
Management API
Settings
Storefront Category

Storefront Category

Get Storefront Category Settings

GET /settings/storefront/category

Request

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 header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • channel_id in query - integer
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/settings/storefront/category' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK. null indicates that a particular field has not been overridden on a channel level when channel level settings are requested

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

{
"data": {
"category_tree_depth": 1,
"default_product_sort": "featured",
"listing_mode": "current_category_only"
},
"meta": {}
}

Update Storefront Category Settings

PUT /settings/storefront/category

Request

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 with null value in order to delete overrides per channel.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • channel_id in query - integer
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

Body

object | application/json

  • category_tree_depth    integer

    Min: 1
    Max: 8

  • default_product_sort    string

    The available sorts for PLP pages.

    Allowed: featured | bestselling | newest | alphaasc | alphadesc | pricedesc | priceasc | avgcustomerreview | relevance

    Default: bestselling

  • listing_mode    string

    Allowed: current_category_only | child_categories | child_categories_if_category_empty

example

{
"category_tree_depth": 1,
"default_product_sort": "featured",
"listing_mode": "current_category_only"
}

Response

OK

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example

{
"data": {
"category_tree_depth": 1,
"default_product_sort": "featured",
"listing_mode": "current_category_only"
},
"meta": {}
}
Did you find what you were looking for?
Update Store Profile SettingsGet Storefront Category Settings