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

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

const cart = await client.carts.items.create('cart_abc123', {
  variant_id: 'variant_abc123',
  quantity: 2,
}, {
  token: '<token>',
})
{
  "id": "cart_UkLWZg9DAJ",
  "market_id": null,
  "number": "R218798477",
  "token": "FDVh29CghDceRzZhTTRHQcH6RzwtaYu7ZoM",
  "email": "toccara_bode@greenholtsenger.info",
  "customer_note": null,
  "currency": "USD",
  "locale": "en",
  "total_quantity": 2,
  "item_total": "29.99",
  "display_item_total": "$29.99",
  "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": "29.99",
  "display_total": "$29.99",
  "gift_card_total": "0.0",
  "display_gift_card_total": "$0.00",
  "amount_due": "29.99",
  "display_amount_due": "$29.99",
  "delivery_total": "0.0",
  "display_delivery_total": "$0.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": "address",
      "field": "ship_address",
      "message": "Shipping address is required"
    },
    {
      "step": "delivery",
      "field": "shipping_method",
      "message": "Select a shipping method for all shipments"
    },
    {
      "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 994255",
      "slug": "product-994255",
      "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": []
    },
    {
      "id": "li_gbHJdmfrXB",
      "variant_id": "variant_gbHJdmfrXB",
      "quantity": 1,
      "currency": "USD",
      "name": "Product 1004709",
      "slug": "product-1004709",
      "options_text": "",
      "price": "19.99",
      "display_price": "$19.99",
      "total": "19.99",
      "display_total": "$19.99",
      "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": "19.99",
      "display_pre_tax_amount": "$19.99",
      "discounted_amount": "19.99",
      "display_discounted_amount": "$19.99",
      "display_compare_at_amount": "$0.00",
      "compare_at_amount": null,
      "thumbnail_url": null,
      "option_values": [],
      "digital_links": []
    }
  ],
  "fulfillments": [],
  "payments": [],
  "billing_address": {
    "id": "addr_EfhxLZ9ck8",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "address1": "238 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": null,
  "payment_methods": [],
  "gift_card": null,
  "market": 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

Bearer token for authenticated customers

​
x-spree-token
string

Order token for guest access

​
Idempotency-Key
string

Unique key for request idempotency.

Path Parameters

​
cart_id
string
required

Cart prefixed ID (e.g., cart_abc123)

Body

application/json
​
variant_id
string
required

Variant ID to add

Example:

"variant_abc123"

​
quantity
integer

Quantity to add (default: 1)

Example:

2

​
metadata
object

Arbitrary key-value metadata

Example:
{ "gift_message": "Happy Birthday!" }

Response

item added with metadata

​
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