Docs
Management API
Carts
Settings

Settings

Get Global Cart Settings

GET /carts/settings

Request

Returns the global cart settings of a store.

OAuth scopes

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/carts/settings' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK

Body

object | application/json
The response object of cart settings at the global level.

  • data    object

    Represents all settings related to the shopping cart functionality of a store.

  • meta    object

    Response metadata.

example

{
"data": {
"allow_purchasing": true
},
"meta": {}
}

Update Global Cart Settings

PUT /carts/settings

Request

Update the global cart settings of a store. Authentication

OAuth scopes

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required

Body

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

  • allow_purchasing    boolean
    required

example

{
"allow_purchasing": true
}

Response

OK

Body

object | application/json
The response object of cart settings at the global level.

  • data    object

    Represents all settings related to the shopping cart functionality of a store.

  • meta    object

    Response metadata.

example

{
"data": {
"allow_purchasing": true
},
"meta": {}
}

Get Channel Cart Settings

GET /carts/settings/channels/{channel_id}

Request

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

OAuth scopes

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information

Authentication

  • X-Auth-Token in header

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.

    OAuth scopes

    UI NamePermissionParameter
    Information & Settingsmodifystore_v2_information
    Information & Settingsread-onlystore_v2_information

example

curl --request GET \
--url 'https://api.bigcommerce.com/stores/[store_hash]/v3/carts/settings/channels/[channel_id]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: {{token}}'

Response

OK

Body

object | application/json
The response object of cart settings overrides for a channel.

  • data    object

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

  • meta    object

    Response metadata.

example

{
"data": {
"allow_purchasing": true
},
"meta": {}
}

Update Channel Cart Settings

PUT /carts/settings/channels/{channel_id}

Request

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

OAuth scopes

UI NamePermissionParameter
Information & Settingsmodifystore_v2_information
Information & Settingsread-onlystore_v2_information

Authentication

  • X-Auth-Token in header

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.

    OAuth scopes

    UI NamePermissionParameter
    Information & Settingsmodifystore_v2_information
    Information & Settingsread-onlystore_v2_information
  • Content-Type in header with default of application/json - string
    required

Body

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

  • allow_purchasing    boolean or null

example

{
"allow_purchasing": true
}

Response

OK

Body

object | application/json
The response object of cart settings overrides for a channel.

  • data    object

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

  • meta    object

    Response metadata.

example

{
"data": {
"allow_purchasing": true
},
"meta": {}
}
Did you find what you were looking for?
Create Cart Redirect URLGet Global Cart Settings