Thanks for being patient while we implement your feedback to improve the developer experience.

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 setting. If omitted, you will interact with the global setting 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 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/status' \
  --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

object | application/json

  • data    object

  • meta    object

    Response metadata.

example-1

{
  "data": {
    "down_for_maintenance_message": "Down for maintenance",
    "prelaunch_message": "Prelaunch",
    "prelaunch_password": "mezt1f77gd"
  },
  "meta": {}
}

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 setting. If omitted, you will interact with the global setting 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 setting. If omitted, you will interact with the global setting only.

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

{
  "down_for_maintenance_message": "Down for maintenance",
  "prelaunch_message": "Coming soon"
}

Response

OK

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

example-1

{
  "data": {
    "down_for_maintenance_message": "Down for maintenance",
    "prelaunch_message": "Coming soon",
    "prelaunch_password": "mezt1f77gd"
  },
  "meta": {}
}