Docs
Management API
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
    required

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

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

example

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
    required

Parameters

  • store_hash in path - string

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

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

Did you find what you were looking for?