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

Parameters

  • store_hash in path - string
  • 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.

example-1

Update Storefront SEO Settings

PUT /settings/storefront/seo

Request

Updates SEO 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
  • 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

Response

OK

Body

object | application/json
  • data
    object

  • meta
    object

    Response metadata.

Did you find what you were looking for?