Spree Commerce

Spree Commerce Orders API

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

GitHub OpenAPI
Business capability
Order Fulfilment Management BC-520.40

Operations 47

GET /api/v3/admin/orders/{order_id}/fulfillments List fulfillments #
GET /api/v3/admin/orders/{order_id}/fulfillments/{id} Show a shipment #
PATCH /api/v3/admin/orders/{order_id}/fulfillments/{id} Update a shipment #
PATCH /api/v3/admin/orders/{order_id}/fulfillments/{id}/fulfill Fulfill a fulfillment #
PATCH /api/v3/admin/orders/{order_id}/fulfillments/{id}/cancel Cancel a fulfillment #
PATCH /api/v3/admin/orders/{order_id}/fulfillments/{id}/resume Resume a fulfillment #
PATCH /api/v3/admin/orders/{order_id}/fulfillments/{id}/split Split a fulfillment #
POST /api/v3/admin/orders/{order_id}/gift_cards Apply a gift card to an order #
DELETE /api/v3/admin/orders/{order_id}/gift_cards/{id} Remove a gift card from an order #
GET /api/v3/admin/orders/{order_id}/items List order items #
POST /api/v3/admin/orders/{order_id}/items Add an item #
GET /api/v3/admin/orders/{order_id}/items/{id} Show an item #
PATCH /api/v3/admin/orders/{order_id}/items/{id} Update an item #
DELETE /api/v3/admin/orders/{order_id}/items/{id} Remove an item #
GET /api/v3/admin/orders/{order_id}/payments List payments #
POST /api/v3/admin/orders/{order_id}/payments Create a payment #
GET /api/v3/admin/orders/{order_id}/payments/{id} Show a payment #
PATCH /api/v3/admin/orders/{order_id}/payments/{id}/capture Capture a payment #
PATCH /api/v3/admin/orders/{order_id}/payments/{id}/void Void a payment #
GET /api/v3/admin/orders/{order_id}/refunds List refunds #
POST /api/v3/admin/orders/{order_id}/refunds Create a refund #
POST /api/v3/admin/orders/{order_id}/store_credits Apply customer's store credit to an order #
DELETE /api/v3/admin/orders/{order_id}/store_credits Remove store credit from an order #
GET /api/v3/admin/orders List orders #
POST /api/v3/admin/orders Create a draft order #
GET /api/v3/admin/orders/{id} Show an order #
PATCH /api/v3/admin/orders/{id} Update an order #
DELETE /api/v3/admin/orders/{id} Delete a draft order #
PATCH /api/v3/admin/orders/{id}/complete Complete an order #
PATCH /api/v3/admin/orders/{id}/cancel Cancel an order #
PATCH /api/v3/admin/orders/{id}/approve Approve an order #
PATCH /api/v3/admin/orders/{id}/resume Resume a canceled order #
POST /api/v3/admin/orders/{id}/resend_confirmation Resend confirmation email #
GET /api/v2/platform/orders Return a list of Orders #
POST /api/v2/platform/orders Creates an Order #
GET /api/v2/platform/orders/{id} Return an Order #
PATCH /api/v2/platform/orders/{id} Update an Order #
DELETE /api/v2/platform/orders/{id} Delete an Order #
PATCH /api/v2/platform/orders/{id}/advance Advances an Order #
PATCH /api/v2/platform/orders/{id}/next Next an Order #
PATCH /api/v2/platform/orders/{id}/complete Completes an Order #
PATCH /api/v2/platform/orders/{id}/empty Empties an Order #
PATCH /api/v2/platform/orders/{id}/approve Approves an Order #
PATCH /api/v2/platform/orders/{id}/cancel Cancels an Order #
PATCH /api/v2/platform/orders/{id}/use_store_credit Use Store Credit for an Order #
PATCH /api/v2/platform/orders/{id}/apply_coupon_code Apply Coupon Code for an Order #
GET /api/v3/store/orders/{id} Get an order #

Documentation

📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/store-api/introduction
📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/admin-api/introduction
📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/platform-api/introduction
📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/storefront-api/introduction
📖
Documentation
https://dev-docs.spreecommerce.org/api-reference/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/spree-commerce/refs/heads/main/openapi/spree-commerce-orders-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/spree-commerce-orders-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

spree-commerce-orders-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Spree Commerce Orders API
  version: '1.0'
  description: 'Operations tagged Orders across 3 of this provider''s published API definitions: spree-commerce-admin-api-openapi.yml, spree-commerce-platform-api-openapi.yml, spree-commerce-store-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://{defaultHost}
  variables:
    defaultHost:
      default: localhost:3000
tags:


# --- truncated at 32 KB (214 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spree-commerce/refs/heads/main/openapi/spree-commerce-orders-api-openapi.yml