Docs
Management API
Settings
Catalog

Catalog

Get Catalog Settings

GET /settings/catalog

Request

Returns catalog 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/catalog' \
--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": {
"auto_approve_reviews": true,
"enable_product_comparisons": true
},
"meta": {}
}

Update Catalog Settings

PUT /settings/catalog

Request

Updates catalog 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.
null set for a particular field removes override on a channel level and means inheritance from a global level

Body

object | application/json

  • auto_approve_reviews    boolean

  • enable_product_comparisons    boolean

example

{
"auto_approve_reviews": true,
"enable_product_comparisons": true
}

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": {
"auto_approve_reviews": true,
"enable_product_comparisons": true
},
"meta": {}
}
Did you find what you were looking for?
Update a Web Analytics ProviderGet Catalog Settings