Get a Cart

GET 
https://useast.api.elasticpath.com/v2/carts/:cartID

Use this endpoint to retrieve a specific cart. If a cart ID does not exist, a new cart will be automatically created. If the cart is associated with shipping groups, calling this endpoint displays the associated shipping group IDs in the relationships section.

You can easily get a new or existing cart by providing the unique cart reference in the request. If the cart is associated with shipping groups, calling this endpoint displays the associated shipping group IDs in the relationships section.

note

• The default cart name is Cart. However, you can update the cart name as required. Ensure that the string length of the name is greater than or equal to one. Follow the safe character guidelines for name and description naming. For more information about cart ID naming requirements, see the Safe Characters section.
• Outside of the JS-SDK, we don't handle creating cart references. You need to create your own.

caution

An empty cart is returned for any carts that don't currently exist. For more information about the cart items object, see Get Cart Items.

Query parameters

Name	Required	Type	Description
include	Optional	string	Comma-delimited string of entities that can be included. The information included are items,tax_items, custom_discounts, or promotions.

Request

Path Parameters

cartID stringrequired

The unique identifier for this cart that you created.

Responses

200

OK

application/json

Schema

Schema

data object
idstring
The unique identifier for the cart. Use SDK or create it yourself.
typestring
The type of object being returned.
namestring
The name of this cart.
descriptionstring
A description of the cart.
contact object
emailemail
The email address attached to a cart.
discount_settings object
custom_discounts_enabledboolean
This parameter enables custom discounts for a cart. When set to true, Elastic Path promotions will not be applied to the new carts. Default is set from cart discount settings for the store. See Cart Settings.
use_rule_promotionsboolean
When set to true, this parameter allows the cart to use rule promotions.
inventory_settings object
defer_inventory_checksboolean
This parameter enables deferring inventory checks on the cart. This allows items to be added to or updating in the cart without checking stock levels. Inventory checks are still performed as normal on checkout
payment_intent_idstring
Stripe-assigned unique identifier for the linked Payment Intent
custom_attributesobject
Specifies custom attributes for cart or order objects. Each attribute includes a top-level key, as well as corresponding type and value entries. Attribute values must correspond to the assigned types.
Example:
"custom_attributes": { "is_member": { "type": "boolean", "value": true }, "membership_level": { "type": "string", "value": "premium" } }
links object
selfstring
A link to that specific resource.
meta object
display_price object
with_tax object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_tax object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
tax object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
discount object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
without_discount object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
shipping object
amountnumber
The raw total.
currencystring
The currency set for this amount.
formattedstring
The formatted total based on the amount and currency.
timestamps object
created_atstring
The date this was created.
updated_at
The date this was last updated.
relationships object
customers object
Array of relationships
data object[]
Individual relationships
Array [
typestring
The type of related resource.
iduuid
The ID of the related resource.
]
items object
Array of relationships
data object[]
Individual relationships
Array [
typestring
The type of related resource.
iduuid
The ID of the related resource.
]
accounts object
Array of relationships
data object[]
Individual relationships
Array [
typestring
The type of related resource.
iduuid
The ID of the related resource.
]
custom_discounts object
Array of relationships
data object[]
Individual relationships
Array [
typestring
The type of related resource.
iduuid
The ID of the related resource.
]
promotions object
Array of relationships
data object[]
Individual relationships
Array [
typestring
The type of related resource.
iduuid
The ID of the related resource.
]

Example (auto)

{
  "data": {
    "id": "string",
    "type": "string",
    "name": "string",
    "description": "string",
    "contact": {
      "email": "user@example.com"
    },
    "discount_settings": {
      "custom_discounts_enabled": true,
      "use_rule_promotions": true
    },
    "inventory_settings": {
      "defer_inventory_checks": true
    },
    "payment_intent_id": "string",
    "custom_attributes": {},
    "links": {
      "self": "string"
    },
    "meta": {
      "display_price": {
        "with_tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "without_tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "tax": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "discount": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "without_discount": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        },
        "shipping": {
          "amount": 0,
          "currency": "string",
          "formatted": "string"
        }
      },
      "timestamps": {
        "created_at": "string"
      }
    },
    "relationships": {
      "customers": {
        "data": [
          {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        ]
      },
      "items": {
        "data": [
          {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        ]
      },
      "accounts": {
        "data": [
          {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        ]
      },
      "custom_discounts": {
        "data": [
          {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        ]
      },
      "promotions": {
        "data": [
          {
            "type": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        ]
      }
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

detailstring
statusstring
titlestring

Example (auto)

[
  null
]

Example

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

Authorization: http

name: bearerAuthtype: 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/carts/:cartID");
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

Parameters

cartID — pathrequired

ResponseClear

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