Docs
Management API
Abandoned carts
Abandoned Carts Settings

Abandoned carts settings

Update global abandoned cart settings

PUT /abandoned-carts/settings

Request

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 - string
    required
    The MIME type of the request body.
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

Body

object | application/json
Represents all settings related to the abandoned cart functionality of a store

  • enable_notification    boolean

    Indicates whether or not abandoned cart notification is on

  • marketing_emails_require_customer_consent    boolean
    required

    Indicates whether or not a customer should receive abandoned cart emails based on their consent. By default customers will not receive emails

  • merchant_email_address    string
    required

    The email address for receiving merchant notifications

  • merchant_abandoned_cart_email_frequency_type    string
    required

    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_frequency    integer
    required

    The number of abandoned carts to accumulate before a digest email is sent to a merchant
    Min: 2
    Max: 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

  • data    object

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

  • meta    object

    Response metadata

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 /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 - integer
    required
    The 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

  • data    object

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

  • meta    object

    Response metadata

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 /abandoned-carts/settings/channels/{channel_id}

Request

Updates the per-channel overrides for the abandoned cart settings of a store.

OAuth Scopes

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.
  • 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

Body

object | application/json
Represents all settings overrides related to the abandoned cart functionality of a store for a channel

  • enable_notification    boolean 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.

  • marketing_emails_require_customer_consent    boolean 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.

  • merchant_email_address    string 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 characters

  • merchant_abandoned_cart_email_frequency_type    string 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_frequency    integer 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: 2
    Max: 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

  • data    object

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

  • meta    object

    Response metadata

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?
Get global abandoned cart settingsUpdate global abandoned cart settings