Update Cart Settings

PUT 
/v2/settings/cart

You can modify the cart expiry settings to set it to any number of days up to 365. Any existing carts default to the expiry of 7 days. To update cart settings in Commerce Manager, see Updating Cart setting.

With update cart settings endpoint, you can:

• Enable or disable custom discounts by setting the custom_discounts_enabled field to true. This allows you to activate your custom discounts from external services. By default, this setting is determined by the cart settings configured for the store.
• Enable or disable the use of rule promotions within the cart. You can apply this setting either at the store level using the update cart setting endpoint or individually to a specific cart using the update a cart endpoint.

note

You cannot use both custom discounts and rule promotions at the same time.

Errors

The following error is received if you enable a cart to use both custom discounts and rule promotions:

{
    "status": 422,
    "title": "Cannot use both discounts together",
    "detail": "Only one discount setting can be set to true at a time."
}

Request

application/json

Body

data object

type stringrequired

Describes the type of request payload you’re sending. Set this value to settings.

cart_expiry_days integer

Indicates the number of days before a cart expires.

discounts object

custom_discounts_enabled boolean

When true, custom discounts are enabled. Default is false. This setting only affects the new empty carts while the existing active carts will not be affected.

use_rule_promotions boolean

When set to true, this parameter allows the cart to use rule promotions.

Responses

200

OK

application/json

Schema

Schema

data object

type stringrequired

Describes the type of request payload you’re sending. Set this value to settings.

cart_expiry_days integer

Indicates the number of days before a cart expires.

discounts object

custom_discounts_enabled boolean

When true, custom discounts are enabled. Default is false. This setting only affects the new empty carts while the existing active carts will not be affected.

use_rule_promotions boolean

When set to true, this parameter allows the cart to use rule promotions.

Example (from schema)

{
  "data": {
    "type": "settings",
    "cart_expiry_days": 25,
    "discounts": {
      "custom_discounts_enabled": false,
      "use_rule_promotions": false
    }
  }
}

400

Bad Request

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

bad-request-error

{
  "errors": [
    {
      "title": "enum",
      "source": "data.type",
      "detail": "data.type must be one of the following: \"settings\""
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Loading...