Docs
Management API
Settings
Storefront Product

Storefront Product

Get Storefront Product Settings

GET /settings/storefront/product

Request

Returns product 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

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.

Update Storefront Product Settings

PUT /settings/storefront/product

Request

Updates product 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

  • show_product_price    boolean

    Determines the visibility of the product price.

    Example: true

  • show_product_sku    boolean

    Determines the visibility of the product SKU.

    Example: true

  • show_product_weight    boolean

    Determines the visibility of the productʼs weight.

  • show_product_brand    boolean

    Determines the visibility of the productʼs brand.

    Example: true

  • show_product_shipping    boolean

    Determines the visibility of the productʼs shipping option.

  • show_product_rating    boolean

    Determines the visibility of the productʼs rating.

    Example: true

  • show_add_to_cart_link    boolean

    Determines the visibility of the Add to Cart link.

    Example: true

  • default_preorder_message    string

    The productʼs pre-order message. If undefined, the message defaults to the storewide setting.

    Example: Preorder message

  • show_breadcrumbs_product_pages    string

    Allowed: show_one | show_none

    Example: show_one

  • show_add_to_cart_qty_box    boolean

    Determines the visibility of the Add to Cart quantity setting.

    Example: true

  • show_add_to_wishlist    boolean

    Determines the visibility of the Add to Wishlist setting.

    Example: true

  • hide_price_from_guests    boolean

    Determines the visibility of the price.

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.
Did you find what you were looking for?
Update Storefront Category SettingsGet Storefront Product Settings