Settings V3
Get Transactional Email Settings
GET /stores/{store_hash}/v3/settings/email-statuses
Request
Get global transactional email settings or channel specific overrides by channel_id.
Authentication
- X-Auth-Token in headerrequired
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
dataobject
metaobject
Response metadata.
Example
Update Transactional Email Settings
PUT /stores/{store_hash}/v3/settings/email-statuses
Request
Update global transactional email settings or create channel specific overrides by channel_id.
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.
- channel_id in query - integer
Channel ID to use for channel-specific settings. If omitted, you will interact with the global settings only.
Body
object | application/json
abandoned_cart_emailboolean
account_details_changed_emailboolean
combined_order_status_emailboolean
create_account_emailboolean
create_guest_account_emailboolean
gift_certificate_emailboolean
invoice_emailboolean
order_message_notification_emailboolean
product_review_emailboolean
return_confirmation_emailboolean
return_statuschange_emailboolean
Example
Response
OK
Body
object | application/json
dataobject
metaobject
Response metadata.
Example
Did you find what you were looking for?