Settings V3
Get Inventory Notifications Settings
GET /stores/{store_hash}/v3/settings/inventory/notifications
Request
Returns inventory notification settings.
channel_idcan be used as a query parameter to get inventory notification settings per channel. If omitted, you will interact with the global settings only.
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
object | application/json
dataobject
metaobject
Response metadata.
Update Inventory Notifications Settings
PUT /stores/{store_hash}/v3/settings/inventory/notifications
Request
Updates inventory notification settings.
channel_idcan be used as a query parameter to get inventory notification settings per channel. If omitted, you will interact with the global settings only.- Supplying
nullsettings values per channel will delete overrides per given channel and values will be inherited from global level. - Partial updates are not supported within the given endpoint. In order to delete overrides per channel,
nullshould be supplied for all the settings within the given endpoint.
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.
null set for a particular field removes override on a channel level and means inheritance from a global level
Body
object | application/json
low_stock_notification_addressarray[string]
out_of_stock_notification_addressarray[string]
example
Response
OK
Did you find what you were looking for?