Docs
Management API
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
    required

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
  • 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
    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 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

Response

OK

Did you find what you were looking for?