Settings V3
Get Store Profile Settings
GET /stores/{store_hash}/v3/settings/store/profile
Request
Returns store profile 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 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
The basic profile settings for a store, used to give the shopper information about the business from which they are purchasing.
metaobject
Response metadata.
example
Update Store Profile Settings
PUT /stores/{store_hash}/v3/settings/store/profile
Request
Updates store profile 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 withnull
value 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
The basic profile settings for a store, used to give the shopper information about the business from which they are purchasing.
store_addressstring
store_address_typestring
Only supports manipulation on a global level.
Allowed: Home Office | Commercial Office | Retail | Warehouse
Default: Home Office
store_emailstring
store_namestring
store_phonestring
example
Response
Body
dataobject
The basic profile settings for a store, used to give the shopper information about the business from which they are purchasing.
metaobject
Response metadata.