Settings V3
Get Storefront Status
GET /stores/{store_hash}/v3/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.
-
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 headerrequired
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
dataobject
metaobject
Response metadata.
example-1
Update Storefront Status
PUT /stores/{store_hash}/v3/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.
-
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 headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
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
down_for_maintenance_messagestring
prelaunch_messagestring
prelaunch_passwordstring
A read-only value representing the auto-generated storefront password.
example-1
Response
OK
Body
dataobject
metaobject
Response metadata.