Docs
Management API
Settings
Storefront Status

Storefront Status

Get Storefront Status

GET /settings/storefront/status

Request

Returns storefront status-related 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-1

Update Storefront Status

PUT /settings/storefront/status

Request

Updates storefront status-related 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

Body

object | application/json

  • down_for_maintenance_message    string

  • prelaunch_message    string

  • prelaunch_password    string

    A read-only value representing the auto-generated storefront password.

example-1

Response

OK

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example-1

Did you find what you were looking for?
Update Storefront SEO SettingsGet Storefront Status