How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Spree Commerce

Spree Commerce Carts API

Shopping cart management

Documentation Provider Profile APIs.io OpenAPI GitHub

Spree Commerce Carts API is one of 183 APIs that Spree Commerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cart. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 22 operations across 16 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against a single base URL, http://{defaultHost}.

22 operations 16 paths 25 schemas 5 DELETE3 GET6 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://demo.spreecommerce.org
Authentication
API Key, HTTP Bearer
Contact
Spree Commerce
Resource Areas
1

Authentication & Security 2

Spree Commerce Carts API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-spree-api-key (api_key). It accepts HTTP bearer tokens (JWT) (bearer_auth).

  • api_key — Publishable API key for store access
  • bearer_auth — JWT token for authenticated customers

Paths & Operations 22

Across 16 paths, the API surfaces 22 operations — 5 DELETE, 3 GET, 6 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Carts 22

Shopping cart management

GET
/api/v3/store/carts
List active carts
9 params → 200401
POST
/api/v3/store/carts
Create a new cart
3 params body → 201
GET
/api/v3/store/carts/{id}
Get a cart
6 params → 200404
PATCH
/api/v3/store/carts/{id}
Update a cart
5 params body → 200
DELETE
/api/v3/store/carts/{id}
Delete a cart
4 params → 204
PATCH
/api/v3/store/carts/{id}/associate
Associate guest cart with authenticated user
3 params → 200401
POST
/api/v3/store/carts/{id}/complete
Complete cart
4 params → 200422
POST
/api/v3/store/carts/{cart_id}/discount_codes
Apply discount code
5 params body → 201422
DELETE
/api/v3/store/carts/{cart_id}/discount_codes/{id}
Remove discount code
5 params → 200422
PATCH
/api/v3/store/carts/{cart_id}/fulfillments/{id}
Select delivery rate for fulfillment
5 params body → 200404
POST
/api/v3/store/carts/{cart_id}/gift_cards
Apply gift card
5 params body → 201404422
DELETE
/api/v3/store/carts/{cart_id}/gift_cards/{id}
Remove gift card
5 params → 200
POST
/api/v3/store/carts/{cart_id}/items
Add item to cart
5 params body → 201404
PATCH
/api/v3/store/carts/{cart_id}/items/{id}
Update line item quantity
5 params body → 200
DELETE
/api/v3/store/carts/{cart_id}/items/{id}
Remove line item from cart
5 params → 200404
POST
/api/v3/store/carts/{cart_id}/payment_sessions
Create payment session
5 params body → 201
GET
/api/v3/store/carts/{cart_id}/payment_sessions/{id}
Get payment session
5 params → 200404
PATCH
/api/v3/store/carts/{cart_id}/payment_sessions/{id}
Update payment session
5 params body → 200
PATCH
/api/v3/store/carts/{cart_id}/payment_sessions/{id}/complete
Complete payment session
6 params body → 200404
POST
/api/v3/store/carts/{cart_id}/payments
Create payment
4 params body → 201422
POST
/api/v3/store/carts/{cart_id}/store_credits
Apply store credit
5 params body → 200422
DELETE
/api/v3/store/carts/{cart_id}/store_credits
Remove store credit
4 params → 200

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Cart (46 properties), Order (43 properties), LineItem (28 properties), Fulfillment (23 properties). Each schema is shown below with its type and property counts.

PaymentSource
object
2 properties 2 required
Payment
object
11 properties 11 required
Order
object
43 properties 43 required
CartWarning
object
A warning about a cart issue (e.g., item removed due to stock change)
4 properties 2 required
Discount
object
7 properties 7 required
Fulfillment
object
23 properties 23 required
GiftCard
object
15 properties 15 required
Address
object
18 properties 18 required
PaymentSession
object
12 properties 11 required
Country
object
7 properties 5 required
PaymentMethod
object
6 properties 6 required
DigitalLink
object
8 properties 8 required
CreditCard
object
8 properties 8 required
FulfillmentManifestItem
object
An item within a fulfillment — which line item and how many units are in this fulfillment
3 properties 3 required
StockLocation
object
9 properties 9 required
DeliveryRate
object
15 properties 15 required
LineItem
object
28 properties 28 required
DeliveryMethod
object
3 properties 3 required
Market
object
8 properties 7 required
OptionValue
object
9 properties 9 required
Cart
object
46 properties 46 required
StoreCredit
object
8 properties 8 required
CheckoutRequirement
object
3 properties 3 required
ErrorResponse
object
1 property 1 required
State
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spree-commerce-carts-api-openapi.yml Raw ↑

Other APIs Spree Commerce publishes across the network.

Spree Webhooks
AE Profile APIs.io
@spree/sdk (TypeScript Store API SDK)
AE Profile APIs.io
@spree/admin-sdk (TypeScript Admin API SDK)
AE Profile APIs.io
@spree/cli
AE Profile APIs.io
create-spree-app
AE Profile APIs.io
Spree Next.js Storefront
AE Profile APIs.io
Spree Rails Storefront
AE Profile APIs.io
spree-starter (Application Template)
AE Profile APIs.io
spree-multi-store
AE Profile APIs.io
Spree Stripe Integration
AE Profile APIs.io
Spree Adyen Integration
AE Profile APIs.io
Spree PayPal Checkout Integration
AE Profile APIs.io
#Cart
← Back to S APIs
API Details
ID
spree-commerce:spree-commerce-carts-api
Base URL
https://demo.spreecommerce.org
Docs
https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
Provider
Spree Commerce
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=spree-commerce-carts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/spree-commerce-carts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Spree Commerce Carts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.