Skip to main content
GET
/
api
/
v3
/
store
/
carts
/
{id}
Spree SDK
import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const cart = await client.carts.get('cart_abc123', {
  token: '<token>',
})
{
  "id": "cart_UkLWZg9DAJ",
  "market_id": null,
  "number": "R929020865",
  "token": "XrTGYYzWrW8pPm2d5SNuJgjFeHQ8MNN6Ufr",
  "email": "hattie_daniel@pfannerstillherzog.us",
  "customer_note": null,
  "currency": "USD",
  "locale": "en",
  "total_quantity": 0,
  "item_total": "0.0",
  "display_item_total": "$0.00",
  "adjustment_total": "0.0",
  "display_adjustment_total": "$0.00",
  "discount_total": "0.0",
  "display_discount_total": "$0.00",
  "tax_total": "0.0",
  "display_tax_total": "$0.00",
  "included_tax_total": "0.0",
  "display_included_tax_total": "$0.00",
  "additional_tax_total": "0.0",
  "display_additional_tax_total": "$0.00",
  "total": "0.0",
  "display_total": "$0.00",
  "gift_card_total": "0.0",
  "display_gift_card_total": "$0.00",
  "amount_due": "0.0",
  "display_amount_due": "$0.00",
  "delivery_total": "0.0",
  "display_delivery_total": "$0.00",
  "warnings": [
    {
      "code": "line_item_removed",
      "message": "Product 874599 was removed because it was sold out",
      "line_item_id": "li_UkLWZg9DAJ",
      "variant_id": "variant_UkLWZg9DAJ"
    }
  ],
  "store_credit_total": "0.0",
  "display_store_credit_total": "$0.00",
  "covered_by_store_credit": false,
  "current_step": "address",
  "completed_steps": [],
  "requirements": [
    {
      "step": "cart",
      "field": "line_items",
      "message": "Add at least one item to your cart"
    },
    {
      "step": "delivery",
      "field": "shipping_method",
      "message": "Select a shipping method for all shipments"
    }
  ],
  "shipping_eq_billing_address": false,
  "discounts": [],
  "items": [],
  "fulfillments": [],
  "payments": [],
  "billing_address": {
    "id": "addr_UkLWZg9DAJ",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "address1": "109 Lovely Street",
    "address2": "Northwest",
    "postal_code": "10118",
    "city": "New York",
    "phone": "555-555-0199",
    "company": "Company",
    "country_name": "United States of America",
    "country_iso": "US",
    "state_text": "NY",
    "state_abbr": "NY",
    "quick_checkout": false,
    "is_default_billing": false,
    "is_default_shipping": false,
    "state_name": "New York"
  },
  "shipping_address": {
    "id": "addr_gbHJdmfrXB",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "address1": "110 Lovely Street",
    "address2": "Northwest",
    "postal_code": "10118",
    "city": "New York",
    "phone": "555-555-0199",
    "company": "Company",
    "country_name": "United States of America",
    "country_iso": "US",
    "state_text": "NY",
    "state_abbr": "NY",
    "quick_checkout": false,
    "is_default_billing": false,
    "is_default_shipping": false,
    "state_name": "New York"
  },
  "payment_methods": [],
  "gift_card": null,
  "market": null
}

Authorizations

​
x-spree-api-key
string
header
required

Publishable API key for store access

​
Authorization
string
header
required

JWT token for authenticated customers

Headers

​
x-spree-api-key
string
required
​
Authorization
string
​
x-spree-token
string

Path Parameters

​
id
string
required

Cart prefixed ID (e.g., cart_abc123)

Query Parameters

​
expand
string

Comma-separated associations to expand (items, fulfillments, payments, discounts, billing_address, shipping_address, gift_card, payment_methods). Use "none" to skip associations.

​
fields
string

Comma-separated list of fields to include (e.g., total,amount_due,item_count). id is always included.

Response

cart with out-of-stock item removed (warnings returned)

​
id
string
required
​
market_id
string | null
required
​
number
string
required
​
token
string
required
​
email
string | null
required
​
customer_note
string | null
required
​
currency
string
required
​
locale
string | null
required
​
total_quantity
number
required
​
item_total
string
required
​
display_item_total
string
required
​
adjustment_total
string
required
​
display_adjustment_total
string
required
​
discount_total
string
required
​
display_discount_total
string
required
​
tax_total
string
required
​
display_tax_total
string
required
​
included_tax_total
string
required
​
display_included_tax_total
string
required
​
additional_tax_total
string
required
​
display_additional_tax_total
string
required
​
total
string
required
​
display_total
string
required
​
gift_card_total
string
required
​
display_gift_card_total
string
required
​
amount_due
string
required
​
display_amount_due
string
required
​
delivery_total
string
required
​
display_delivery_total
string
required
​
warnings
object[]
required
​
store_credit_total
string
required
​
display_store_credit_total
string
required
​
covered_by_store_credit
boolean
required
​
current_step
string
required
​
completed_steps
string[]
required
​
requirements
object[]
required
​
shipping_eq_billing_address
boolean
required
​
discounts
object[]
required
​
items
object[]
required
​
fulfillments
object[]
required
​
payments
object[]
required
​
billing_address
object
required
​
shipping_address
object
required
​
payment_methods
object[]
required
​
gift_card
object
required
​
market
object
required