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 Orders API

Order management — orders, items, payments, fulfillments, refunds, gift cards, store credits

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 47 operations across 34 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

47 operations 34 paths 32 schemas 5 DELETE12 GET22 PATCH8 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Spree Commerce Orders 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 — Secret API key for admin access
  • bearer_auth — JWT token for admin user authentication

Paths & Operations 47

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

Orders 47

Order management — orders, items, payments, fulfillments, refunds, gift cards, store credits

GET
/api/v3/admin/orders/{order_id}/fulfillments
List fulfillments
5 params → 200
GET
/api/v3/admin/orders/{order_id}/fulfillments/{id}
Show a shipment
6 params → 200
PATCH
/api/v3/admin/orders/{order_id}/fulfillments/{id}
Update a shipment
4 params body → 200
PATCH
/api/v3/admin/orders/{order_id}/fulfillments/{id}/fulfill
Fulfill a fulfillment
4 params → 200
PATCH
/api/v3/admin/orders/{order_id}/fulfillments/{id}/cancel
Cancel a fulfillment
4 params → 200
PATCH
/api/v3/admin/orders/{order_id}/fulfillments/{id}/resume
Resume a fulfillment
4 params → 200
PATCH
/api/v3/admin/orders/{order_id}/fulfillments/{id}/split
Split a fulfillment
4 params body → 200
POST
/api/v3/admin/orders/{order_id}/gift_cards
Apply a gift card to an order
3 params body → 201
DELETE
/api/v3/admin/orders/{order_id}/gift_cards/{id}
Remove a gift card from an order
4 params → 204
GET
/api/v3/admin/orders/{order_id}/items
List order items
5 params → 200
POST
/api/v3/admin/orders/{order_id}/items
Add an item
3 params body → 201
GET
/api/v3/admin/orders/{order_id}/items/{id}
Show an item
6 params → 200
PATCH
/api/v3/admin/orders/{order_id}/items/{id}
Update an item
4 params body → 200
DELETE
/api/v3/admin/orders/{order_id}/items/{id}
Remove an item
4 params → 204
GET
/api/v3/admin/orders/{order_id}/payments
List payments
5 params → 200
POST
/api/v3/admin/orders/{order_id}/payments
Create a payment
3 params body → 201
GET
/api/v3/admin/orders/{order_id}/payments/{id}
Show a payment
6 params → 200
PATCH
/api/v3/admin/orders/{order_id}/payments/{id}/capture
Capture a payment
4 params → 200422
PATCH
/api/v3/admin/orders/{order_id}/payments/{id}/void
Void a payment
4 params → 200
GET
/api/v3/admin/orders/{order_id}/refunds
List refunds
5 params → 200
POST
/api/v3/admin/orders/{order_id}/refunds
Create a refund
3 params body → 201
POST
/api/v3/admin/orders/{order_id}/store_credits
Apply customer's store credit to an order
3 params body → 201
DELETE
/api/v3/admin/orders/{order_id}/store_credits
Remove store credit from an order
3 params → 204
GET
/api/v3/admin/orders
List orders
11 params → 200401
POST
/api/v3/admin/orders
Create a draft order
2 params body → 201
GET
/api/v3/admin/orders/{id}
Show an order
5 params → 200404
PATCH
/api/v3/admin/orders/{id}
Update an order
3 params body → 200
DELETE
/api/v3/admin/orders/{id}
Delete a draft order
3 params → 204
PATCH
/api/v3/admin/orders/{id}/complete
Complete an order
3 params body → 200422
PATCH
/api/v3/admin/orders/{id}/cancel
Cancel an order
3 params → 200
PATCH
/api/v3/admin/orders/{id}/approve
Approve an order
3 params → 200
PATCH
/api/v3/admin/orders/{id}/resume
Resume a canceled order
3 params → 200
POST
/api/v3/admin/orders/{id}/resend_confirmation
Resend confirmation email
3 params → 200
GET
/api/v2/platform/orders
Return a list of Orders
orders-list 4 params → 200401
POST
/api/v2/platform/orders
Creates an Order
create-order 1 param body → 201
GET
/api/v2/platform/orders/{id}
Return an Order
show-order 2 params → 200404401
PATCH
/api/v2/platform/orders/{id}
Update an Order
update-order 2 params body → 200422404401
DELETE
/api/v2/platform/orders/{id}
Delete an Order
delete-order 1 param → 204404401
PATCH
/api/v2/platform/orders/{id}/advance
Advances an Order
advance-order 2 params → 200404401
PATCH
/api/v2/platform/orders/{id}/next
Next an Order
next-order 2 params → 200404401
PATCH
/api/v2/platform/orders/{id}/complete
Completes an Order
complete-order 2 params → 200404401
PATCH
/api/v2/platform/orders/{id}/empty
Empties an Order
empty-order 2 params → 200404401
PATCH
/api/v2/platform/orders/{id}/approve
Approves an Order
approve-order 2 params → 200404401
PATCH
/api/v2/platform/orders/{id}/cancel
Cancels an Order
cancel-order 2 params → 200422404401
PATCH
/api/v2/platform/orders/{id}/use_store_credit
Use Store Credit for an Order
use-store-credit-order 2 params body → 200422404401
PATCH
/api/v2/platform/orders/{id}/apply_coupon_code
Apply Coupon Code for an Order
apply-coupon-code-order 2 params body → 200422404401
GET
/api/v3/store/orders/{id}
Get an order
6 params → 200404

Schemas 32

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

ErrorResponse
object
1 property 1 required
coupon_code_param
object
1 property
resource_properties
object
4 properties 3 required
update_order_params
object
1 property 1 required
update_address_params
object
1 property 1 required
resources_list
object
3 properties 3 required
validation_errors
object
2 properties 2 required
amount_param
object
1 property
error
object
1 property 1 required
create_order_params
object
1 property 1 required
resource
object
1 property 1 required
update_line_item_params
object
1 property 1 required
PaymentSource
object
2 properties 2 required
Payment
object
11 properties 11 required
Order
object
43 properties 43 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
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
StoreCredit
object
8 properties 8 required
State
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spree-commerce-orders-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
#Order
← Back to S APIs
API Details
ID
spree-commerce:spree-commerce-orders-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-orders-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/spree-commerce-orders-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 Orders 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.