Docs
Management API
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
    required

Parameters

  • store_hash in path - string

Body

application/json

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

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

Body

application/json

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?