Abandoned carts settings
Update global abandoned cart settings
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/abandoned-carts/settingsRequest
Update the global abandoned cart settings of a store.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
Body
object | application/json
Represents all settings related to the abandoned cart functionality of a store
enable_notificationboolean
Indicates whether or not abandoned cart notification is onemail_customer_until_cart_is_recoveredboolean
requiredIndicates whether or not a customer should continue to receive abandoned cart emails until their cart is recoveredemail_merchant_when_cart_is_convertedboolean
requiredIndicates whether or not a merchant should receive a notification email when a cart is converted into an orderemail_merchant_when_cart_is_abandonedboolean
requiredIndicates whether or not a merchant should receive a notification email when a cart is abandonedmerchant_email_addressstring
requiredThe email address for receiving merchant notificationsmerchant_abandoned_cart_email_frequency_typestring
requiredIndicates whether to send an email for every abandoned cart, or to send a digest email after X number of abandoned cartsAllowed: digest | individual
merchant_abandoned_cart_digest_email_frequencyinteger
requiredThe number of abandoned carts to accumulate before a digest email is sent to a merchantMin: 2Max: 1000
example
{
"enable_notification": true,
"email_customer_until_cart_is_recovered": true,
"marketing_emails_require_customer_consent": true,
"email_merchant_when_cart_is_converted": true,
"email_merchant_when_cart_is_abandoned": true,
"merchant_email_address": "user@example.com",
"merchant_abandoned_cart_email_frequency_type": "digest",
"merchant_abandoned_cart_digest_email_frequency": 2
}
Response
OK
Body
object | application/json
The response object of abandoned cart settings at the global level
dataobject
Represents all settings related to the abandoned cart functionality of a store
example
{
"data": {
"enable_notification": true,
"email_customer_until_cart_is_recovered": true,
"marketing_emails_require_customer_consent": true,
"email_merchant_when_cart_is_converted": true,
"email_merchant_when_cart_is_abandoned": true,
"merchant_email_address": "user@example.com",
"merchant_abandoned_cart_email_frequency_type": "digest",
"merchant_abandoned_cart_digest_email_frequency": 2
},
"meta": {}
}
Get channel abandoned cart settings
GET https://api.bigcommerce.com/stores/{store_hash}/v3/abandoned-carts/settings/channels/{channel_id}Request
Return the per-channel overrides for the abandoned cart settings of a store.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- channel_id in path - integerrequiredThe channel ID of the settings overrides
example
curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/abandoned-carts/settings/channels/[channel_id]' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'
Response
OK
Body
object | application/json
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
example
{
"data": {
"enable_notification": true,
"email_customer_until_cart_is_recovered": true,
"marketing_emails_require_customer_consent": true,
"email_merchant_when_cart_is_converted": true,
"email_merchant_when_cart_is_abandoned": true,
"merchant_email_address": "user@example.com",
"merchant_abandoned_cart_email_frequency_type": "digest",
"merchant_abandoned_cart_digest_email_frequency": 2
},
"meta": {}
}
Update channel abandoned cart settings
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/abandoned-carts/settings/channels/{channel_id}Request
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- channel_id in path - integerrequiredThe channel ID of the settings overrides
Body
object | application/json
Represents all settings overrides related to the abandoned cart functionality of a store for a channel
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.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.>= 0 characters<= 500 charactersmerchant_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.Min: 2Max: 1000
example
{
"enable_notification": true,
"email_customer_until_cart_is_recovered": true,
"marketing_emails_require_customer_consent": true,
"email_merchant_when_cart_is_converted": true,
"email_merchant_when_cart_is_abandoned": true,
"merchant_email_address": "user@example.com",
"merchant_abandoned_cart_email_frequency_type": "digest",
"merchant_abandoned_cart_digest_email_frequency": 2
}
Response
OK
Body
object | application/json
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
example
{
"data": {
"enable_notification": true,
"email_customer_until_cart_is_recovered": true,
"marketing_emails_require_customer_consent": true,
"email_merchant_when_cart_is_converted": true,
"email_merchant_when_cart_is_abandoned": true,
"merchant_email_address": "user@example.com",
"merchant_abandoned_cart_email_frequency_type": "digest",
"merchant_abandoned_cart_digest_email_frequency": 2
},
"meta": {}
}
Did you find what you were looking for?