Get Storefront Product Settings
GET /stores/{store_hash}/v3/settings/storefront/product
Request
Returns product settings.
-
Channel ID can be used as a query parameter for getting channel-specific setting. If omitted, you will interact with the global setting only.
-
nullindicates 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
- channel_id in query - integer
Channel ID to use for channel-specific setting. If omitted, you will interact with the global setting only.
example
curl --request GET \ --url 'https://api.bigcommerce.com/stores/[store_hash]/v3/settings/storefront/product' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'
Response
OK. null indicates that a particular field has not been overridden on a channel level when channel level settings are requested
Body
dataobject
metaobject
Response metadata.
Update Storefront Product Settings
PUT /stores/{store_hash}/v3/settings/storefront/product
Request
Updates product settings.
-
Channel ID can be used as a query parameter for updating channel-specific setting. If omitted, you will interact with the global setting only.
-
nullshould 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 withnullvalue in order to delete overrides per channel.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- 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 setting. If omitted, you will interact with the global setting only.
Body
show_product_priceboolean
Determines the visibility of the product price.
Example: true
show_product_skuboolean
Determines the visibility of the product SKU.
Example: true
show_product_weightboolean
Determines the visibility of the product's weight.
Example: false
show_product_brandboolean
Determines the visibility of the product's brand.
Example: true
show_product_shippingboolean
Determines the visibility of the product's shipping option.
Example: false
show_product_ratingboolean
Determines the visibility of the product's rating.
Example: true
show_add_to_cart_linkboolean
Determines the visibility of the Add to Cart link.
Example: true
default_preorder_messagestring
The product's pre-order message. If undefined, the message defaults to the storewide setting.
Example: Preorder message
show_breadcrumbs_product_pagesstring
Allowed: show_one | show_none
Example: show_one
show_add_to_cart_qty_boxboolean
Determines the visibility of the Add to Cart quantity setting.
Example: true
show_add_to_wishlistboolean
Determines the visibilty of the Add to Wishlist setting.
Example: true
hide_price_from_guestsboolean
Determines the visibility of the price.
Example: false
example
{ "show_product_price": true, "show_product_sku": true, "show_product_weight": false, "show_product_brand": true, "show_product_shipping": false, "show_product_rating": true, "show_add_to_cart_link": true, "default_preorder_message": "Preorder message", "show_breadcrumbs_product_pages": "show_one", "show_add_to_cart_qty_box": true, "show_add_to_wishlist": true, "hide_price_from_guests": false }
Response
OK. null indicates that a particular field has not been overridden on a channel level when channel level settings are requested
Body
dataobject
metaobject
Response metadata.