Get V2 Settings Cart

Get Cart Settings

GET/v2/settings/cart

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the Get V2 Settings Cart action (under Carts).
Fill in the fields below, then reference the result from later steps as {{getV2SettingsCart.response.data}}.

Fields

baseUrlstring

The API host this action calls. Choose one, or pick Custom to enter your own.

One ofhttps://useast.api.elasticpath.comhttps://euwest.api.elasticpath.com__custom__Default "https://useast.api.elasticpath.com"

baseUrlCustomstring

forwardAllHeadersboolean

If enabled, all headers from the incoming request will be forwarded. Additional headers below will override forwarded ones.

Default false

headerskeyvalue

Extra HTTP headers to include, beyond what this action already declares. These override forwarded or declared headers with the same name.

queryParamskeyvalue

Extra URL query parameters to include, beyond what this action already declares. These override declared query parameters with the same name.

Response

Returns 200 with an object. Read it in later steps with {{getV2SettingsCart.response.data.<field>}}.

dataobject

typestringrequired

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

idstring

The unique identifier for the cart settings.

cart_expiry_daysinteger

Indicates the number of days before a cart expires.

discountsobject2 fields

inventoriesobject1 fields

itemsobject1 fields

show_all_cartsboolean

When `true`, admins (users with admin scope) can retrieve all carts in the store via `GET /v2/carts`, regardless of customer or account associations. When `false`, admins can only see carts that are registered (associated with customers or accounts). For new stores, this defaults to `true`. For existing stores created before this feature was introduced, this defaults to `false` to maintain backward compatibility.

json

{
  "data": {
    "type": "settings",
    "id": "15419118-44ce-5343-8ff6-574daf52bc6b",
    "cart_expiry_days": 25,
    "discounts": {
      "custom_discounts_enabled": false,
      "use_rule_promotions": false
    },
    "inventories": {
      "defer_inventory_check": false
    },
    "items": {
      "separate_items_by_location": false
    },
    "show_all_carts": true
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.

Was this page helpful?