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

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

const carts = await client.carts.list({
  token: '<token>',
})
{
  "data": [
    {
      "id": "cart_gbHJdmfrXB",
      "market_id": null,
      "number": "R139181277",
      "token": "HcVHbgtZJ4WxxcynuTKt6p79iQNAxukuSNX",
      "email": "alejandra@leuschke.com",
      "customer_note": null,
      "currency": "USD",
      "locale": "en",
      "total_quantity": 1,
      "item_total": "10.0",
      "display_item_total": "$10.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": "110.0",
      "display_total": "$110.00",
      "gift_card_total": "0.0",
      "display_gift_card_total": "$0.00",
      "amount_due": "110.0",
      "display_amount_due": "$110.00",
      "delivery_total": "100.0",
      "display_delivery_total": "$100.00",
      "warnings": [],
      "store_credit_total": "0.0",
      "display_store_credit_total": "$0.00",
      "covered_by_store_credit": false,
      "current_step": "address",
      "completed_steps": [],
      "requirements": [
        {
          "step": "payment",
          "field": "payment",
          "message": "Add a payment method"
        }
      ],
      "shipping_eq_billing_address": false,
      "discounts": [],
      "items": [
        {
          "id": "li_gbHJdmfrXB",
          "variant_id": "variant_gbHJdmfrXB",
          "quantity": 1,
          "currency": "USD",
          "name": "Product 583630",
          "slug": "product-583630",
          "options_text": "",
          "price": "10.0",
          "display_price": "$10.00",
          "total": "10.0",
          "display_total": "$10.00",
          "adjustment_total": "0.0",
          "display_adjustment_total": "$0.00",
          "additional_tax_total": "0.0",
          "display_additional_tax_total": "$0.00",
          "included_tax_total": "0.0",
          "display_included_tax_total": "$0.00",
          "discount_total": "0.0",
          "display_discount_total": "$0.00",
          "pre_tax_amount": "10.0",
          "display_pre_tax_amount": "$10.00",
          "discounted_amount": "10.0",
          "display_discounted_amount": "$10.00",
          "display_compare_at_amount": "$0.00",
          "compare_at_amount": null,
          "thumbnail_url": null,
          "option_values": [],
          "digital_links": []
        }
      ],
      "fulfillments": [
        {
          "id": "ful_gbHJdmfrXB",
          "number": "H38066716360",
          "tracking": "U10000",
          "tracking_url": null,
          "cost": "100.0",
          "display_cost": "$100.00",
          "total": "100.0",
          "display_total": "$100.00",
          "discount_total": "0.0",
          "display_discount_total": "$0.00",
          "additional_tax_total": "0.0",
          "display_additional_tax_total": "$0.00",
          "included_tax_total": "0.0",
          "display_included_tax_total": "$0.00",
          "tax_total": "0.0",
          "display_tax_total": "$0.00",
          "status": "pending",
          "fulfillment_type": "shipping",
          "fulfilled_at": null,
          "items": [
            {
              "item_id": "li_gbHJdmfrXB",
              "variant_id": "variant_gbHJdmfrXB",
              "quantity": 1
            }
          ],
          "delivery_method": {
            "id": "dm_gbHJdmfrXB",
            "name": "UPS Ground",
            "code": "UPS_GROUND"
          },
          "stock_location": {
            "id": "sloc_UkLWZg9DAJ",
            "state_abbr": "NY",
            "name": "Winfred Dietrich",
            "address1": "1600 Pennsylvania Ave NW",
            "city": "Washington",
            "zipcode": "20500",
            "country_iso": "US",
            "country_name": "United States of America",
            "state_text": "NY"
          },
          "delivery_rates": [
            {
              "id": "dr_gbHJdmfrXB",
              "delivery_method_id": "dm_gbHJdmfrXB",
              "name": "UPS Ground",
              "selected": true,
              "cost": "100.0",
              "total": "100.0",
              "additional_tax_total": "0.0",
              "included_tax_total": "0.0",
              "tax_total": "0.0",
              "display_cost": "$100.00",
              "display_total": "$100.00",
              "display_additional_tax_total": "$0.00",
              "display_included_tax_total": "$0.00",
              "display_tax_total": "$0.00",
              "delivery_method": {
                "id": "dm_gbHJdmfrXB",
                "name": "UPS Ground",
                "code": "UPS_GROUND"
              }
            }
          ]
        }
      ],
      "payments": [],
      "billing_address": {
        "id": "addr_uw2YK1rnl0",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "address1": "105 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_OIJLhNcSbf",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "address1": "106 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
    },
    {
      "id": "cart_UkLWZg9DAJ",
      "market_id": null,
      "number": "R653240222",
      "token": "Lta26Lyfq4EtwsMwD1kt4az1XZLr14fQKqn",
      "email": "alejandra@leuschke.com",
      "customer_note": null,
      "currency": "USD",
      "locale": "en",
      "total_quantity": 1,
      "item_total": "10.0",
      "display_item_total": "$10.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": "110.0",
      "display_total": "$110.00",
      "gift_card_total": "0.0",
      "display_gift_card_total": "$0.00",
      "amount_due": "110.0",
      "display_amount_due": "$110.00",
      "delivery_total": "100.0",
      "display_delivery_total": "$100.00",
      "warnings": [],
      "store_credit_total": "0",
      "display_store_credit_total": "$0.00",
      "covered_by_store_credit": false,
      "current_step": "address",
      "completed_steps": [],
      "requirements": [
        {
          "step": "payment",
          "field": "payment",
          "message": "Add a payment method"
        }
      ],
      "shipping_eq_billing_address": false,
      "discounts": [],
      "items": [
        {
          "id": "li_UkLWZg9DAJ",
          "variant_id": "variant_UkLWZg9DAJ",
          "quantity": 1,
          "currency": "USD",
          "name": "Product 574608",
          "slug": "product-574608",
          "options_text": "",
          "price": "10.0",
          "display_price": "$10.00",
          "total": "10.0",
          "display_total": "$10.00",
          "adjustment_total": "0.0",
          "display_adjustment_total": "$0.00",
          "additional_tax_total": "0.0",
          "display_additional_tax_total": "$0.00",
          "included_tax_total": "0.0",
          "display_included_tax_total": "$0.00",
          "discount_total": "0.0",
          "display_discount_total": "$0.00",
          "pre_tax_amount": "10.0",
          "display_pre_tax_amount": "$10.00",
          "discounted_amount": "10.0",
          "display_discounted_amount": "$10.00",
          "display_compare_at_amount": "$0.00",
          "compare_at_amount": null,
          "thumbnail_url": null,
          "option_values": [],
          "digital_links": []
        }
      ],
      "fulfillments": [
        {
          "id": "ful_UkLWZg9DAJ",
          "number": "H27683996067",
          "tracking": "U10000",
          "tracking_url": null,
          "cost": "100.0",
          "display_cost": "$100.00",
          "total": "100.0",
          "display_total": "$100.00",
          "discount_total": "0.0",
          "display_discount_total": "$0.00",
          "additional_tax_total": "0.0",
          "display_additional_tax_total": "$0.00",
          "included_tax_total": "0.0",
          "display_included_tax_total": "$0.00",
          "tax_total": "0.0",
          "display_tax_total": "$0.00",
          "status": "pending",
          "fulfillment_type": "shipping",
          "fulfilled_at": null,
          "items": [
            {
              "item_id": "li_UkLWZg9DAJ",
              "variant_id": "variant_UkLWZg9DAJ",
              "quantity": 1
            }
          ],
          "delivery_method": {
            "id": "dm_UkLWZg9DAJ",
            "name": "UPS Ground",
            "code": "UPS_GROUND"
          },
          "stock_location": {
            "id": "sloc_UkLWZg9DAJ",
            "state_abbr": "NY",
            "name": "Winfred Dietrich",
            "address1": "1600 Pennsylvania Ave NW",
            "city": "Washington",
            "zipcode": "20500",
            "country_iso": "US",
            "country_name": "United States of America",
            "state_text": "NY"
          },
          "delivery_rates": [
            {
              "id": "dr_UkLWZg9DAJ",
              "delivery_method_id": "dm_UkLWZg9DAJ",
              "name": "UPS Ground",
              "selected": true,
              "cost": "100.0",
              "total": "100.0",
              "additional_tax_total": "0.0",
              "included_tax_total": "0.0",
              "tax_total": "0.0",
              "display_cost": "$100.00",
              "display_total": "$100.00",
              "display_additional_tax_total": "$0.00",
              "display_included_tax_total": "$0.00",
              "display_tax_total": "$0.00",
              "delivery_method": {
                "id": "dm_UkLWZg9DAJ",
                "name": "UPS Ground",
                "code": "UPS_GROUND"
              }
            }
          ]
        }
      ],
      "payments": [],
      "billing_address": {
        "id": "addr_EfhxLZ9ck8",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "address1": "103 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_VqXmZF31wY",
        "first_name": "John",
        "last_name": "Doe",
        "full_name": "John Doe",
        "address1": "104 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
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 2,
    "pages": 1,
    "from": 1,
    "to": 2,
    "in": 2,
    "previous": null,
    "next": null
  }
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

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
required

Query Parameters

​
page
integer

Page number (default: 1)

​
limit
integer

Number of results per page (default: 25, max: 100)

​
sort
string

Sort order. Prefix with - for descending. Values: created_at, -created_at, updated_at, -updated_at

​
q[created_at_gt]
string

Filter by created after date (ISO 8601)

​
q[updated_at_gt]
string

Filter by updated after date (ISO 8601)

​
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

carts listed