Docs
Management API
Settings
Inventory Notifications

Inventory Notifications

Get Inventory Notifications Settings

GET /settings/inventory/notifications

Request

Returns inventory notification settings.

  • channel_id can 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 header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • channel_id in query - integer
    Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/settings/inventory/notifications' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

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.

Update Inventory Notifications Settings

PUT /settings/inventory/notifications

Request

Updates inventory notification settings.

  • channel_id can be used as a query parameter to get inventory notification settings per channel. If omitted, you will interact with the global settings only.
  • Supplying null settings 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, null should be supplied for all the settings within the given endpoint.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • 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 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_address    array[string]

  • out_of_stock_notification_address    array[string]

example

{
"low_stock_notification_address": [
"test.user@example.com"
],
"out_of_stock_notification_address": [
"test.user@example.com"
]
}

Response

OK
Did you find what you were looking for?
Update Inventory SettingsGet Inventory Notifications Settings