BigCommerce Docs

Returns order settings for a specific channel.

X-Auth-Tokenstring

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`

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

channel_idstringRequired

Channel ID

store_hashstringRequired

Permanent ID of the BigCommerce store.

notificationsobject

Channel notification settings.

metaobject

Response metadata.

400

Bad Request Error

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`

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

$	curl https://api.bigcommerce.com/stores/store_hash/v3/orders/settings/channels/channel_id \
>	-H "Accept: application/json" \
>	-H "X-Auth-Token: <apiKey>" \
>	-H "Content-Type: application/json"

1	{
2	"notifications": {
3	"order_placed": {
4	"email_addresses": [
5	"orders-notify@storeexample.com",
6	"support@storeexample.com"
7	]
8	},
9	"forward_invoice": {
10	"email_addresses": [
11	"invoices@storeexample.com"
12	]
13	}
14	},
15	"meta": {}
16	}

$	curl https://api.bigcommerce.com/stores/store_hash/v3/orders/settings/channels/channel_id \
>	-H "Accept: application/json" \
>	-H "X-Auth-Token: <apiKey>" \
>	-H "Content-Type: application/json"

1	{
2	"notifications": {
3	"order_placed": {
4	"email_addresses": [
5	"orders-notify@storeexample.com",
6	"support@storeexample.com"
7	]
8	},
9	"forward_invoice": {
10	"email_addresses": [
11	"invoices@storeexample.com"
12	]
13	}
14	},
15	"meta": {}
16	}

Get Channel Order Settings