Order Notification Settings

  • Version: 3.0.0
  • Host: api.bigcommerce.com/stores/store_hash/v3
  • Protocols: https
  • Accepts: application/json
  • Responds With: application/json

Order notification settings determine whether a store owner will receive an email when a customer places a new order, and where these notifications are sent. The Order Notifications resource lets you manage the email addresses where a store will send order notifications and forward order invoices. You can also manage these settings for specific sales Channels with this resource.

On This Page


Authentication

You can authenticate requests by sending a client_id and access_token via X-Auth-Client and X-Auth-Token HTTP headers:

GET /stores/store_hash/v3/orders/settings
host: api.bigcommerce.com
Accept: application/json
X-Auth-Client: {client_id}
X-Auth-Token: {access_token}

You can obtain the client_id and access_token using either of the following methods:


OAuth Scopes

Scope limits ability to read or modify data. To interact with the Order Notification Settings resource, set the scope to the minimum level needed to accomplish your specific task.

UI Name Permission Parameter
Information & Settings modify store_v2_information
Information & Settings read-only store_v2_information_read_only

For more information on OAuth Scopes, see the REST API Authentication page.


Additional Information

Related API Resources

Knowledge Base