Orders V3
Get Global Order Settings
GET /stores/{store_hash}/v3/orders/settings
Request
Returns global order settings.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
example
Response
OK
Body
notificationsobject
Global notification settings.
metaobject
Response metadata.
Update Global Order Settings
PUT /stores/{store_hash}/v3/orders/settings
Request
Updates global order settings.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
notificationsobject
Global notification settings.
EnableMultipleOrderNotifications
DisableOrderPlacedNotificatons
Response
OK
Body
notificationsobject
Global notification settings.
metaobject
Response metadata.
example
Get Channel Order Settings
GET /stores/{store_hash}/v3/orders/settings/channels/{channel_id}
Request
Returns order settings for a specific channel.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- channel_id in path - stringrequired
Channel ID
example
Response
OK
Body
notificationsobject
Channel notification settings.
metaobject
Response metadata.
Update Channel Order Settings
PUT /stores/{store_hash}/v3/orders/settings/channels/{channel_id}
Request
Updates order settings for a specific channel.
Note: You must override both notifications email_addresses
or neither, i.e. either both notification email_addresses
are an array of valid email addresses, or both email_addresses
must be null. You may not have one set to an array of addresses and the other set to null
.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- channel_id in path - stringrequired
Channel ID
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
notificationsobject
Channel notification settings.
OverrideOrderPlacedEmailAddressesAndDisableForwardEmailAddresses
ResetChannelSettings
DisableMultipleNotificatonsForChannels
Response
OK
Body
notificationsobject
Channel notification settings.
metaobject
Response metadata.