Update Global Order Settings

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/orders/settings

PUT

/stores/:store_hash/v3/orders/settings

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/orders/settings \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "notifications": {
    "order_placed": {
      "email_addresses": [
        "admin@example.com",
        "another-email@example.com"
      ]
    },
    "forward_invoice": {
      "email_addresses": [
        "admin@example.com",
        "another-email@example.com"
      ]
    }
  }
}'

{
  "notifications": {
    "order_placed": {
      "email_addresses": [
        "string"
      ]
    },
    "forward_invoice": {
      "email_addresses": [
        "string"
      ]
    }
  },
  "meta": {}
}

Updates global order settings.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Order Transactions	read and modify `transactions` and `payment_methods`	`store_v2_transactions`
Order Transactions	read `transactions` and `payment_methods`	`store_v2_transactions_read_only`
Orders	read and modify `payment_methods`	`store_v2_orders`
Orders	read `payment_methods`	`store_v2_orders_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

notificationsobjectOptional

Global notification settings.

Response

notificationsobjectOptional

Global notification settings.

metaobjectOptional

Response metadata.

Errors

400

Bad Request Error

422

Unprocessable Entity Error