> ## 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. # Get a cart > Returns a shopping cart by prefixed ID. Authorize via x-spree-token header (guest) or JWT Bearer token (authenticated user). ## OpenAPI ````yaml /api-reference/store.yaml get /api/v3/store/carts/{id} openapi: 3.0.3 info: title: Store API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Store API v3 - Customer-facing storefront API for building headless commerce experiences. ## Authentication The Store API uses two authentication methods: ### API Key (Required) All requests must include a publishable API key in the `x-spree-api-key` header. ### JWT Bearer Token (For authenticated customers) After login, include the JWT token in the `Authorization: Bearer ` header. ### Order Token (For guest checkout) When creating an order, a `token` is returned. Include this in the `x-spree-token` header for guest access to that specific order. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "record_not_found", "message": "Product not found" } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Customer authentication (login, logout, token refresh) - name: Product Catalog description: Products and categories - name: Carts description: Shopping cart management - name: Orders description: Order lookup - name: Customers description: Customer account, addresses, saved payment methods, and order history - name: Markets description: Markets, countries, currencies, and locales - name: Wishlists description: Customer wishlists - name: Newsletter Subscribers description: Guest and customer newsletter subscriptions (double opt-in) - name: Policies description: Store policies (return policy, privacy policy, terms of service) - name: Digitals description: Digital product downloads paths: /api/v3/store/carts/{id}: get: tags: - Carts summary: Get a cart description: > Returns a shopping cart by prefixed ID. Authorize via x-spree-token header (guest) or JWT Bearer token (authenticated user). parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: false schema: type: string - name: x-spree-token in: header required: false schema: type: string - name: id in: path required: true description: Cart prefixed ID (e.g., cart_abc123) schema: type: string - name: expand in: query required: false description: >- Comma-separated associations to expand (items, fulfillments, payments, discounts, billing_address, shipping_address, gift_card, payment_methods). Use "none" to skip associations. schema: type: string - name: fields in: query required: false description: >- Comma-separated list of fields to include (e.g., total,amount_due,item_count). id is always included. schema: type: string responses: '200': description: cart with out-of-stock item removed (warnings returned) content: application/json: example: id: cart_UkLWZg9DAJ market_id: mkt_UkLWZg9DAJ channel_id: ch_UkLWZg9DAJ preferred_stock_location_id: null company_id: null company_name: null po_number_required: false po_document_filename: null po_document_byte_size: null number: cart_UkLWZg9DAJ token: HnnryvFFwjfx9P6ykByF4Gg2 email: null customer_note: null po_number: null currency: USD locale: en total_quantity: 0 warnings: - code: line_item_removed message: Product 230307 was removed because it was sold out line_item_id: li_UkLWZg9DAJ variant_id: variant_UkLWZg9DAJ coupon_code: null item_total: '0.0' display_item_total: $0.00 adjustment_total: '17.0' display_adjustment_total: $17.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: '17.0' display_total: $17.00 gift_card_total: '0.0' display_gift_card_total: $0.00 amount_due: '17.0' display_amount_due: $17.00 delivery_total: '0.0' display_delivery_total: $0.00 fee_total: '17.0' display_fee_total: $17.00 store_credit_total: '0.0' display_store_credit_total: $0.00 covered_by_store_credit: false current_step: address completed_steps: [] requirements: - code: line_items_required step: cart field: line_items message: Add at least one item to your cart - code: email_required step: address field: email message: Email address is required - code: payment_required step: payment field: payment message: Add a payment method order_minimum: null order_minimum_shortfall: null below_order_minimum: false freight_summary: null shipping_eq_billing_address: true discounts: [] fees: - id: fee_UkLWZg9DAJ label: Gift wrapping kind: gift_wrap line_item_id: null fulfillment_id: null amount: '5.0' display_amount: $5.00 - id: fee_gbHJdmfrXB label: Import duty kind: duty line_item_id: null fulfillment_id: null amount: '12.0' display_amount: $12.00 items: [] fulfillments: [] payments: [] billing_address: null shipping_address: null payment_methods: [] gift_card: null market: id: mkt_UkLWZg9DAJ name: United States currency: USD default_locale: en tax_inclusive: false default: true country_codes: - US country_isos: - US supported_locales: - en schema: $ref: '#/components/schemas/Cart' '404': description: cart not found content: application/json: example: error: code: record_not_found message: Cart not found schema: $ref: '#/components/schemas/ErrorResponse' security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree SDK source: |- import { createClient } from '@spree/sdk' const client = createClient({ baseUrl: 'https://your-store.com', publishableKey: '', }) const cart = await client.carts.get('cart_abc123', { token: '', }) components: schemas: Cart: type: object properties: id: type: string market_id: type: string nullable: true channel_id: type: string nullable: true preferred_stock_location_id: type: string nullable: true company_id: type: string nullable: true company_name: type: string nullable: true po_number_required: type: boolean po_document_filename: type: string nullable: true po_document_byte_size: type: number nullable: true number: type: string token: type: string email: type: string nullable: true customer_note: type: string nullable: true po_number: type: string nullable: true currency: type: string locale: type: string nullable: true total_quantity: type: number warnings: type: array items: $ref: '#/components/schemas/CartWarning' coupon_code: type: string nullable: true item_total: type: string nullable: true display_item_total: type: string nullable: true adjustment_total: type: string nullable: true display_adjustment_total: type: string nullable: true discount_total: type: string nullable: true display_discount_total: type: string nullable: true tax_total: type: string nullable: true display_tax_total: type: string nullable: true included_tax_total: type: string nullable: true display_included_tax_total: type: string nullable: true additional_tax_total: type: string nullable: true display_additional_tax_total: type: string nullable: true total: type: string nullable: true display_total: type: string nullable: true gift_card_total: type: string nullable: true display_gift_card_total: type: string nullable: true amount_due: type: string nullable: true display_amount_due: type: string nullable: true delivery_total: type: string nullable: true display_delivery_total: type: string nullable: true fee_total: type: string nullable: true display_fee_total: type: string nullable: true store_credit_total: type: string nullable: true display_store_credit_total: type: string nullable: true covered_by_store_credit: type: boolean current_step: type: string completed_steps: type: array items: type: string requirements: type: array items: $ref: '#/components/schemas/CheckoutRequirement' order_minimum: type: number nullable: true order_minimum_shortfall: type: number nullable: true below_order_minimum: type: boolean nullable: true freight_summary: allOf: - $ref: '#/components/schemas/FreightSummary' nullable: true shipping_eq_billing_address: type: boolean discounts: type: array items: $ref: '#/components/schemas/AppliedPromotion' fees: type: array items: $ref: '#/components/schemas/Fee' items: type: array items: $ref: '#/components/schemas/LineItem' fulfillments: type: array items: $ref: '#/components/schemas/Fulfillment' payments: type: array items: $ref: '#/components/schemas/Payment' billing_address: allOf: - $ref: '#/components/schemas/Address' nullable: true shipping_address: allOf: - $ref: '#/components/schemas/Address' nullable: true payment_methods: type: array items: $ref: '#/components/schemas/PaymentMethod' gift_card: allOf: - $ref: '#/components/schemas/GiftCard' nullable: true market: allOf: - $ref: '#/components/schemas/Market' nullable: true required: - id - market_id - channel_id - preferred_stock_location_id - company_id - company_name - po_number_required - po_document_filename - po_document_byte_size - number - token - email - customer_note - po_number - currency - locale - total_quantity - warnings - coupon_code - item_total - display_item_total - adjustment_total - display_adjustment_total - discount_total - display_discount_total - tax_total - display_tax_total - included_tax_total - display_included_tax_total - additional_tax_total - display_additional_tax_total - total - display_total - gift_card_total - display_gift_card_total - amount_due - display_amount_due - delivery_total - display_delivery_total - fee_total - display_fee_total - store_credit_total - display_store_credit_total - covered_by_store_credit - current_step - completed_steps - requirements - order_minimum - order_minimum_shortfall - below_order_minimum - freight_summary - shipping_eq_billing_address - discounts - fees - items - fulfillments - payments - billing_address - shipping_address - payment_methods - gift_card - market x-typelizer: true ErrorResponse: type: object properties: error: type: object properties: code: type: string example: record_not_found message: type: string example: Record not found details: type: object description: Field-specific validation errors nullable: true example: name: - is too short - is required email: - is invalid required: - code - message required: - error example: error: code: validation_error message: Validation failed details: name: - is too short email: - is invalid CartWarning: type: object description: A warning about a cart issue (e.g., item removed due to stock change) properties: code: type: string description: Machine-readable warning code example: line_item_removed message: type: string description: Human-readable warning message example: Blue T-Shirt was removed because it was sold out line_item_id: type: string nullable: true description: Prefixed line item ID (when applicable) example: li_abc123 variant_id: type: string nullable: true description: Prefixed variant ID (when applicable) example: variant_abc123 item_index: type: integer nullable: true description: >- Position in the submitted items array, for warnings raised while applying a batch of item changes example: 1 required: - code - message CheckoutRequirement: type: object properties: step: type: string description: Checkout step this requirement belongs to example: payment field: type: string description: Field that needs to be satisfied example: payment message: type: string description: Human-readable requirement message example: Add a payment method required: - step - field - message FreightSummary: type: object properties: total_units: type: number total_cartons: type: number total_pallets: type: number nullable: true total_volume: type: string total_weight: type: string complete: type: boolean required: - total_units - total_cartons - total_pallets - total_volume - total_weight - complete x-typelizer: true AppliedPromotion: type: object properties: id: type: string promotion_id: type: string name: type: string description: type: string nullable: true code: type: string nullable: true amount: type: string nullable: true display_amount: type: string nullable: true required: - id - promotion_id - name - description - code - amount - display_amount x-typelizer: true Fee: type: object properties: id: type: string label: type: string kind: anyOf: - type: string enum: - surcharge - handling - gift_wrap - cod - payment - duty - exchange - type: string description: >- What sort of charge this is. `duty` is a customs duty on a cross-border order and is not taxed; the other kinds are. Extensions may register further kinds. line_item_id: type: string nullable: true fulfillment_id: type: string nullable: true amount: type: string nullable: true display_amount: type: string nullable: true required: - id - label - kind - line_item_id - fulfillment_id - amount - display_amount x-typelizer: true LineItem: type: object properties: id: type: string variant_id: type: string seller_id: type: string nullable: true preorder: type: boolean preorder_ships_at: type: string nullable: true quantity: type: number currency: type: string name: type: string slug: type: string options_text: type: string price: type: string nullable: true display_price: type: string nullable: true total: type: string nullable: true display_total: type: string nullable: true adjustment_total: type: string nullable: true display_adjustment_total: type: string nullable: true additional_tax_total: type: string nullable: true display_additional_tax_total: type: string nullable: true included_tax_total: type: string nullable: true display_included_tax_total: type: string nullable: true discount_total: type: string nullable: true display_discount_total: type: string nullable: true pre_tax_amount: type: string nullable: true display_pre_tax_amount: type: string nullable: true discounted_amount: type: string nullable: true display_discounted_amount: type: string nullable: true display_compare_at_amount: type: string nullable: true compare_at_amount: type: string nullable: true thumbnail_url: type: string nullable: true seller: $ref: '#/components/schemas/Seller' option_values: type: array items: $ref: '#/components/schemas/OptionValue' digital_links: type: array items: $ref: '#/components/schemas/DigitalLink' tax_lines: type: array items: $ref: '#/components/schemas/TaxLine' required: - id - variant_id - seller_id - preorder - preorder_ships_at - quantity - currency - name - slug - options_text - price - display_price - total - display_total - adjustment_total - display_adjustment_total - additional_tax_total - display_additional_tax_total - included_tax_total - display_included_tax_total - discount_total - display_discount_total - pre_tax_amount - display_pre_tax_amount - discounted_amount - display_discounted_amount - display_compare_at_amount - compare_at_amount - thumbnail_url - option_values x-typelizer: true Fulfillment: type: object properties: id: type: string number: type: string tracking: type: string nullable: true tracking_url: type: string nullable: true pickup_point_data: type: object nullable: true selected_delivery_rate_id: type: string nullable: true unpriced: type: boolean cost: type: string nullable: true display_cost: type: string nullable: true total: type: string nullable: true display_total: type: string nullable: true discount_total: type: string nullable: true display_discount_total: type: string nullable: true additional_tax_total: type: string nullable: true display_additional_tax_total: type: string nullable: true included_tax_total: type: string nullable: true display_included_tax_total: type: string nullable: true tax_total: type: string nullable: true display_tax_total: type: string nullable: true status: anyOf: - type: string enum: - unfulfilled - fulfilled - delivered - canceled - type: string description: The values listed are the built-in ones; extensions may add more. fulfillment_type: type: string enum: - shipping - digital - pickup - pickup_point fulfilled_at: type: string nullable: true delivered_at: type: string nullable: true items: type: array items: $ref: '#/components/schemas/FulfillmentManifestItem' deliveries: type: array items: $ref: '#/components/schemas/Delivery' delivery_method: $ref: '#/components/schemas/DeliveryMethod' stock_location: $ref: '#/components/schemas/StockLocation' delivery_rates: type: array items: $ref: '#/components/schemas/DeliveryRate' tax_lines: type: array items: $ref: '#/components/schemas/TaxLine' required: - id - number - tracking - tracking_url - pickup_point_data - selected_delivery_rate_id - unpriced - cost - display_cost - total - display_total - discount_total - display_discount_total - additional_tax_total - display_additional_tax_total - included_tax_total - display_included_tax_total - tax_total - display_tax_total - status - fulfillment_type - fulfilled_at - delivered_at - items - deliveries - delivery_method - stock_location - delivery_rates x-typelizer: true Payment: type: object properties: id: type: string payment_method_id: type: string response_code: type: string nullable: true number: type: string status: anyOf: - type: string enum: - checkout - processing - pending - completed - failed - void - invalid - type: string description: The values listed are the built-in ones; extensions may add more. amount: type: string nullable: true display_amount: type: string nullable: true source_type: type: string nullable: true enum: - credit_card - store_credit - payment_source source_id: type: string nullable: true source: anyOf: - $ref: '#/components/schemas/CreditCard' - $ref: '#/components/schemas/StoreCredit' - $ref: '#/components/schemas/PaymentSource' nullable: true payment_method: $ref: '#/components/schemas/PaymentMethod' required: - id - payment_method_id - response_code - number - status - amount - display_amount - source_type - source_id - source - payment_method x-typelizer: true Address: type: object properties: id: type: string label: type: string nullable: true first_name: type: string nullable: true last_name: type: string nullable: true full_name: type: string address1: type: string nullable: true address2: type: string nullable: true postal_code: type: string nullable: true city: type: string nullable: true phone: type: string nullable: true company: type: string nullable: true country_name: type: string country_code: type: string state_text: type: string nullable: true state_code: type: string nullable: true quick_checkout: type: boolean is_default_billing: type: boolean is_default_shipping: type: boolean state_abbr: type: string nullable: true country_iso: type: string state_name: type: string nullable: true required: - id - label - first_name - last_name - full_name - address1 - address2 - postal_code - city - phone - company - country_name - country_code - state_text - state_code - quick_checkout - is_default_billing - is_default_shipping - state_abbr - country_iso - state_name x-typelizer: true PaymentMethod: type: object properties: id: type: string name: type: string description: type: string nullable: true type: type: string description: >- Payment method type. Built-in: check, store_credit, custom_payment_source_method, bogus (test only); payment provider gems register their own, for example stripe. session_required: type: boolean source_required: type: boolean required: - id - name - description - type - session_required - source_required x-typelizer: true GiftCard: type: object properties: id: type: string code: type: string status: anyOf: - type: string enum: - active - partially_redeemed - redeemed - canceled - expired - type: string description: The values listed are the built-in ones; extensions may add more. currency: type: string amount: type: string nullable: true amount_used: type: string nullable: true amount_authorized: type: string nullable: true amount_remaining: type: string nullable: true display_amount: type: string nullable: true display_amount_used: type: string nullable: true display_amount_remaining: type: string nullable: true expires_at: type: string nullable: true redeemed_at: type: string nullable: true expired: type: boolean active: type: boolean required: - id - code - status - currency - amount - amount_used - amount_authorized - amount_remaining - display_amount - display_amount_used - display_amount_remaining - expires_at - redeemed_at - expired - active x-typelizer: true Market: type: object properties: id: type: string name: type: string currency: type: string default_locale: type: string tax_inclusive: type: boolean default: type: boolean country_codes: type: array items: type: string country_isos: type: array items: type: string supported_locales: type: array items: type: string countries: type: array items: $ref: '#/components/schemas/Country' required: - id - name - currency - default_locale - tax_inclusive - default - country_codes - country_isos - supported_locales x-typelizer: true Seller: type: object properties: id: type: string name: type: string slug: type: string about: type: string about_html: type: string logo_url: type: string nullable: true square_logo_url: type: string nullable: true cover_photo_url: type: string nullable: true policies: type: array items: $ref: '#/components/schemas/Policy' required: - id - name - slug - about - about_html - logo_url - square_logo_url - cover_photo_url x-typelizer: true OptionValue: type: object properties: id: type: string option_type_id: type: string name: type: string label: type: string position: type: number color_code: type: string nullable: true option_type_name: type: string option_type_label: type: string image_url: type: string nullable: true required: - id - option_type_id - name - label - position - color_code - option_type_name - option_type_label - image_url x-typelizer: true DigitalLink: type: object properties: id: type: string access_counter: type: number filename: type: string content_type: type: string download_url: type: string expires_at: type: string nullable: true authorizable: type: boolean expired: type: boolean access_limit_exceeded: type: boolean required: - id - access_counter - filename - content_type - download_url - expires_at - authorizable - expired - access_limit_exceeded x-typelizer: true TaxLine: type: object properties: id: type: string label: type: string included: type: boolean credit: type: boolean rate: type: string tax_rate_id: type: string nullable: true line_item_id: type: string nullable: true fulfillment_id: type: string nullable: true fee_id: type: string nullable: true return_line_item_id: type: string nullable: true claim_line_item_id: type: string nullable: true exchange_line_item_id: type: string nullable: true amount: type: string nullable: true display_amount: type: string nullable: true required: - id - label - included - credit - rate - tax_rate_id - line_item_id - fulfillment_id - fee_id - return_line_item_id - claim_line_item_id - exchange_line_item_id - amount - display_amount x-typelizer: true FulfillmentManifestItem: type: object description: >- An item within a fulfillment — which line item and how many units are in this fulfillment properties: item_id: type: string description: Line item ID example: li_abc123 variant_id: type: string description: Variant ID example: variant_abc123 quantity: type: integer description: Quantity in this fulfillment example: 2 required: - item_id - variant_id - quantity Delivery: type: object properties: id: type: string tracking_number: type: string carrier: type: string nullable: true carrier_name: type: string nullable: true service: type: string nullable: true status: type: string enum: - pending - pre_transit - in_transit - out_for_delivery - available_for_pickup - delivered - return_to_sender - failure - unknown tracking_url: type: string nullable: true estimated_delivery_at: type: string nullable: true delivered_at: type: string nullable: true required: - id - tracking_number - carrier - carrier_name - service - status - tracking_url - estimated_delivery_at - delivered_at x-typelizer: true DeliveryMethod: type: object properties: id: type: string name: type: string code: type: string nullable: true estimated_transit_business_days_min: type: number nullable: true estimated_transit_business_days_max: type: number nullable: true digital: type: boolean pickup: type: boolean pickup_point: type: boolean required: - id - name - code - estimated_transit_business_days_min - estimated_transit_business_days_max - digital - pickup - pickup_point x-typelizer: true StockLocation: type: object properties: id: type: string name: type: string address1: type: string nullable: true city: type: string nullable: true zipcode: type: string nullable: true country_code: type: string nullable: true country_name: type: string nullable: true state_code: type: string nullable: true state_text: type: string nullable: true pickup_ready_in_minutes: type: number nullable: true pickup_instructions: type: string nullable: true required: - id - name - address1 - city - zipcode - country_code - country_name - state_code - state_text - pickup_ready_in_minutes - pickup_instructions x-typelizer: true DeliveryRate: type: object properties: id: type: string delivery_method_id: type: string name: type: string selected: type: boolean cost: type: string total: type: string additional_tax_total: type: string included_tax_total: type: string tax_total: type: string carrier: type: string nullable: true service_level: type: string nullable: true estimated_delivery_date: type: string nullable: true unpriced: type: boolean freight_summary: allOf: - $ref: '#/components/schemas/FreightSummary' nullable: true display_cost: type: string display_total: type: string display_additional_tax_total: type: string display_included_tax_total: type: string display_tax_total: type: string delivery_method: $ref: '#/components/schemas/DeliveryMethod' required: - id - delivery_method_id - name - selected - cost - total - additional_tax_total - included_tax_total - tax_total - carrier - service_level - estimated_delivery_date - unpriced - freight_summary - display_cost - display_total - display_additional_tax_total - display_included_tax_total - display_tax_total - delivery_method x-typelizer: true CreditCard: type: object properties: id: type: string brand: type: string last4: type: string month: type: number year: type: number name: type: string nullable: true default: type: boolean gateway_payment_profile_id: type: string nullable: true required: - id - brand - last4 - month - year - name - default - gateway_payment_profile_id x-typelizer: true StoreCredit: type: object properties: id: type: string amount: type: string amount_used: type: string amount_remaining: type: string display_amount: type: string display_amount_used: type: string display_amount_remaining: type: string currency: type: string required: - id - amount - amount_used - amount_remaining - display_amount - display_amount_used - display_amount_remaining - currency x-typelizer: true PaymentSource: type: object properties: id: type: string gateway_payment_profile_id: type: string nullable: true required: - id - gateway_payment_profile_id x-typelizer: true Country: type: object properties: iso: type: string iso3: type: string name: type: string states_required: type: boolean zipcode_required: type: boolean states: type: array items: $ref: '#/components/schemas/State' market: allOf: - $ref: '#/components/schemas/Market' nullable: true required: - iso - iso3 - name - states_required - zipcode_required x-typelizer: true Policy: type: object properties: id: type: string name: type: string slug: type: string body: type: string nullable: true body_html: type: string nullable: true updated_at: type: string required: - id - name - slug - body - body_html - updated_at x-typelizer: true State: type: object properties: abbr: type: string name: type: string required: - abbr - name x-typelizer: true securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Publishable API key for store access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for authenticated customers ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.