Update Global Abandoned Cart Settings

PUT

https://api.bigcommerce.com/stores/:store_hash/v3/abandoned-carts/settings

PUT

/stores/:store_hash/v3/abandoned-carts/settings

curl -X PUT https://api.bigcommerce.com/stores/store_hash/v3/abandoned-carts/settings \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "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": "string",
  "merchant_abandoned_cart_email_frequency_type": "digest",
  "merchant_abandoned_cart_digest_email_frequency": 1
}'

{
  "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": "string",
    "merchant_abandoned_cart_email_frequency_type": "digest",
    "merchant_abandoned_cart_digest_email_frequency": 1
  },
  "meta": {}
}

Update the global abandoned cart settings of a store.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Information & Settings	read-only	`store_v2_information_read_only`
Information & Settings	modify	`store_v2_information`

Authentication header

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

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Request

This endpoint expects an object.

email_customer_until_cart_is_recoveredbooleanRequired

Indicates whether or not a customer should continue to receive abandoned cart emails until their cart is recovered

marketing_emails_require_customer_consentbooleanRequired

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_convertedbooleanRequired

Indicates whether or not a merchant should receive a notification email when a cart is converted into an order

email_merchant_when_cart_is_abandonedbooleanRequired

Indicates whether or not a merchant should receive a notification email when a cart is abandoned

merchant_email_addressstringRequiredformat: "email"

The email address for receiving merchant notifications

merchant_abandoned_cart_email_frequency_typeenumRequired

Indicates whether to send an email for every abandoned cart, or to send a digest email after X number of abandoned carts

Allowed values:

merchant_abandoned_cart_digest_email_frequencyintegerRequired2-1000

The number of abandoned carts to accumulate before a digest email is sent to a merchant

enable_notificationbooleanOptional

Indicates whether or not abandoned cart notification is on

Response

dataobjectOptional

Represents all settings related to the abandoned cart functionality of a store

metaobjectOptional

Response metadata

Errors

401

Unauthorized Error

422

Unprocessable Entity Error