BigCommerce
Management API
Abandoned Carts Settings

Abandoned Carts

Update Global Abandoned Cart Settings

PUT /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

application/json
  • enable_notification
    boolean

    Indicates whether or not abandoned cart notification is on

  • email_customer_until_cart_is_recovered
    boolean

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

  • marketing_emails_require_customer_consent
    boolean

    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_converted
    boolean

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

  • email_merchant_when_cart_is_abandoned
    boolean

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

  • merchant_email_address
    string

    The email address for receiving merchant notifications

  • merchant_abandoned_cart_email_frequency_type
    string

    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

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

      example

      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

      Get Channel Abandoned Cart Settings

      GET /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

      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

      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 - 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

      application/json
      • enable_notification
        boolean

        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_recovered
        boolean

        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_consent
        boolean

        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_converted
        boolean

        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_abandoned
        boolean

        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_address
        string

        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_type
        string

        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

        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

          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

          Did you find what you were looking for?