Docs
Management API
Settings
Storefront Seo

Storefront SEO

Get Storefront SEO Settings

GET /settings/storefront/seo

Request

Returns SEO 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/seo' \
--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-1

{
"data": {
"meta_description": "Your BigCommerce Store",
"meta_keywords": "",
"page_title": "BigCommerce Store",
"www_redirect": "no-www"
},
"meta": {}
}

Update Storefront SEO Settings

PUT /settings/storefront/seo

Request

Updates SEO settings.

  • You can use channel_id as a query parameter to update channel-specific settings. If omitted, you will only interact with the global settings.

  • You can use channel_id in the request body of a headless channel of this endpoint to control the www_redirect settings for the headless channel's unique checkout URL.

  • null should be supplied to delete overrides per given channel and to inherit values from a 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.
  • 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

  • meta_description    string

  • meta_keywords    string

  • page_title    string

  • www_redirect    string

    Allowed: www | no-www | none

example-1

{
"meta_description": "Your BigCommerce Store",
"meta_keywords": "",
"page_title": "New BigCommerce Store",
"www_redirect": "no-www"
}

Response

OK

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.
Did you find what you were looking for?
Update Storefront Security SettingsGet Storefront SEO Settings