Get Cart Settings

GET 
https://useast.api.elasticpath.com/v2/settings/cart

Retrieves cart settings

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

401

Unauthorized

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

unauthorized-error

{
  "errors": [
    {
      "title": "Unauthorized",
      "status": "401"
    }
  ]
}

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.Get, "https://useast.api.elasticpath.com/v2/settings/cart");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
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

ResponseClear

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