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

Spree Commerce Checkout / Store Credit API

The Checkout / Store Credit API from Spree Commerce — 2 operation(s) for checkout / store credit.

Spree Commerce Checkout / Store Credit 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 Checkout / Store Credit. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 2 operations across 2 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against 2 base URLs: https://demo.spreecommerce.org, http://localhost:3000.

2 operations 2 paths 13 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Spree Commerce Checkout / Store Credit API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-Spree-Order-Token (orderToken).

  • bearerAuth — User token to authorize Cart and Checkout requests. It is required to associate Cart with the User.
  • orderToken — Order token to authorize Cart and Checkout requests. [How to obtain X-Spree-Order-Token](../authenticationfor-guest-users)

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Checkout / Store Credit 2
POST
/api/v2/storefront/checkout/add_store_credit
Add Store Credit
add-store-credit 3 params → 200404422
POST
/api/v2/storefront/checkout/remove_store_credit
Remove Store Credit
remove-store-credit 2 params → 200404422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Product (4 properties), LineItem (4 properties), Shipment (4 properties), DigitalLink (4 properties). Each schema is shown below with its type and property counts.

CartIncludes
Variant
object
Variant records track the individual variants of a Product. Variants are of two types: master variants and normal variants.
4 properties 4 required
LineItem
object
4 properties 4 required
Error
object
1 property
Timestamp
string
Cart
object
The Cart provides a central place to collect information about an order, including line items, adjustments, payments, addresses, and shipments. [Read more in S…
4 properties 4 required
Relation
objectnull
2 properties 2 required
User
object
4 properties 4 required
Payment
object
4 properties 4 required
Promotion
object
3 properties 3 required
DigitalLink
object
Digital links are accessible in the order includes lineitems.digitallinks
4 properties
Shipment
object
4 properties 4 required
Product
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spree-commerce-checkout-store-credit-api-openapi.yml Raw ↑

Other APIs Spree Commerce publishes across the network.

Spree Webhooks
@spree/sdk (TypeScript Store API SDK)
@spree/admin-sdk (TypeScript Admin API SDK)
@spree/cli
create-spree-app
Spree Next.js Storefront
Spree Rails Storefront
spree-starter (Application Template)
spree-multi-store
Spree Stripe Integration
Spree Adyen Integration
Spree PayPal Checkout Integration
Where this information came from

This is an independent, third-party profile of Spree Commerce Checkout / Store Credit 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.