Update Cart Settings

PUT 
https://useast.api.elasticpath.com/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.
• Enable or disable deferred inventory checks by setting defer_inventory_check to true. When set, stock levels are not verified for products in a cart until checkout.

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
typestringrequired
Describes the type of request payload you’re sending. Set this value to settings.
Example: settings
cart_expiry_daysinteger
Indicates the number of days before a cart expires.
Example: 25
discounts object
custom_discounts_enabledboolean
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.
Example: false
use_rule_promotionsboolean
When set to true, this parameter allows the cart to use rule promotions.
Example: false
inventories object
defer_inventory_checkboolean
When true, inventory checks are not performed when adding products to a cart but still occur on checkout as normal. Default is false. This setting only affects the new empty carts while the existing active carts will not be affected.
Example: false

Responses

200

OK

application/json

Schema

Schema

data object
typestringrequired
Describes the type of request payload you’re sending. Set this value to settings.
Example: settings
cart_expiry_daysinteger
Indicates the number of days before a cart expires.
Example: 25
discounts object
custom_discounts_enabledboolean
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.
Example: false
use_rule_promotionsboolean
When set to true, this parameter allows the cart to use rule promotions.
Example: false
inventories object
defer_inventory_checkboolean
When true, inventory checks are not performed when adding products to a cart but still occur on checkout as normal. Default is false. This setting only affects the new empty carts while the existing active carts will not be affected.
Example: false

Example (auto)

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

400

Bad Request

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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 [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "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"
    }
  ]
}

Authorization: http

name: BearerTokentype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://useast.api.elasticpath.com/v2/settings/cart");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"data\": {\n    \"type\": \"settings\",\n    \"cart_expiry_days\": 25,\n    \"discounts\": {\n      \"custom_discounts_enabled\": false,\n      \"use_rule_promotions\": false\n    },\n    \"inventories\": {\n      \"defer_inventory_check\": false\n    }\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Body

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

ResponseClear

Click the Send API Request button above and see the response here!