Abandoned Carts
Update Global Abandoned Cart Settings
PUT /stores/{store_hash}/v3/abandoned-carts/settings
Request
Updates the global abandoned cart settings of a store.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - string - required
The MIME type of the request body.
Body
enable_notificationboolean
Indicates whether or not abandoned cart notification is on
email_customer_until_cart_is_recoveredboolean
Indicates whether or not a customer should continue to receive abandoned cart emails until their cart is recovered
marketing_emails_require_customer_consentboolean
Indicates whether or not a customer should receive abandoned cart emails based on their consent. By default customers will not receive emails.
email_merchant_when_cart_is_convertedboolean
Indicates whether or not a merchant should receive a notification email when a cart is converted into an order
email_merchant_when_cart_is_abandonedboolean
Indicates whether or not a merchant should receive a notification email when a cart is abandoned
merchant_email_addressstring
The email address for receiving merchant notifications
merchant_abandoned_cart_email_frequency_typestring
Indicates whether to send an email for every abandoned cart, or to send a digest email after X number of abandoned carts
Allowed: digest | individual
merchant_abandoned_cart_digest_email_frequencyinteger
The number of abandoned carts to accumulate before a digest email is sent to a merchant
example
Response
OK
Body
The response object of abandoned cart settings at the global level
dataobject
Represents all settings related to the abandoned cart functionality of a store
metaobject
Response metadata.
example
Get Channel Abandoned Cart Settings
GET /stores/{store_hash}/v3/abandoned-carts/settings/channels/{channel_id}
Request
Returns the per-channel overrides for the abandoned cart settings of a store.
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string - required
The MIME type of the response body.
- channel_id in path - integer - required
The channel ID of the settings overrides
example
Response
OK
Body
The response object of abandoned cart settings overrides for a channel
dataobject
Represents all settings overrides related to the abandoned cart functionality of a store for a channel
metaobject
Response metadata.
example
Update Channel Abandoned Cart Settings
PUT /stores/{store_hash}/v3/abandoned-carts/settings/channels/{channel_id}
Request
Updates the per-channel overrides for the abandoned cart settings of a store.
OAuth Scopes
UI Name | Permission | Parameter |
---|---|---|
Information & Settings | modify | store_v2_information |
Authentication
- X-Auth-Token in header - required
Parameters
- store_hash in path - string
- channel_id in path - integer - required
The channel ID of the settings overrides
- Content-Type in header with default of application/json - string - required
The MIME type of the request body.
Body
enable_notificationboolean or null
Indicates whether or not abandoned cart notification is on. If it is null, it means there is no override for the specified channel.
email_customer_until_cart_is_recoveredboolean or null
Indicates whether or not a customer should continue to receive abandoned cart emails until their cart is recovered. If it is null, it means there is no override for the specified channel.
marketing_emails_require_customer_consentboolean or null
Indicates whether or not a customer should receive abandoned cart emails based on their consent. If it is null, it means there is no override for the specified channel. By default customers will not receive emails.
email_merchant_when_cart_is_convertedboolean or null
Indicates whether or not a merchant should receive a notification email when a cart is converted into an order. If it is null, it means there is no override for the specified channel.
email_merchant_when_cart_is_abandonedboolean or null
Indicates whether or not a merchant should receive a notification email when a cart is abandoned. If it is null, it means there is no override for the specified channel.
merchant_email_addressstring or null
The email address for receiving merchant notifications. If it is null, it means there is no override for the specified channel.
merchant_abandoned_cart_email_frequency_typestring or null
Indicates whether to send an email for every abandoned cart or to send a digest email after X number of abandoned carts. If it is null, it means there is no override for the specified channel.
Allowed: digest | individual
merchant_abandoned_cart_digest_email_frequencyinteger or null
The number of abandoned carts to accumulate before a digest email is sent to a merchant. If it is null, it means there is no override for the specified channel.
example
Response
OK
Body
The response object of abandoned cart settings overrides for a channel
dataobject
Represents all settings overrides related to the abandoned cart functionality of a store for a channel
metaobject
Response metadata.