Spree Commerce

Spree Commerce Promotions API

The Promotions API from Spree Commerce — 11 operation(s) for promotions.

GitHub OpenAPI
Business capability
Discount & Promotion Management BC-440.30

Operations 20

GET /api/v3/admin/promotions/{promotion_id}/coupon_codes List coupon codes for a promotion #
GET /api/v3/admin/promotions/{promotion_id}/promotion_actions List actions for a promotion #
POST /api/v3/admin/promotions/{promotion_id}/promotion_actions Create an action on a promotion #
DELETE /api/v3/admin/promotions/{promotion_id}/promotion_actions/{id} Delete an action from a promotion #
GET /api/v3/admin/promotions/{promotion_id}/promotion_rules List rules for a promotion #
POST /api/v3/admin/promotions/{promotion_id}/promotion_rules Create a rule on a promotion #
PATCH /api/v3/admin/promotions/{promotion_id}/promotion_rules/{id} Update a rule's preferences #
DELETE /api/v3/admin/promotions/{promotion_id}/promotion_rules/{id} Delete a rule from a promotion #
GET /api/v3/admin/promotions List promotions #
POST /api/v3/admin/promotions Create a promotion #
GET /api/v3/admin/promotions/{id} Show a promotion #
PATCH /api/v3/admin/promotions/{id} Update a promotion #
DELETE /api/v3/admin/promotions/{id} Delete a promotion #
GET /api/v3/admin/promotion_actions/types List available promotion action types #
GET /api/v3/admin/promotion_rules/types List available promotion rule types #
GET /api/v2/platform/promotions Return a list of Promotions #
POST /api/v2/platform/promotions Create a Promotion #
GET /api/v2/platform/promotions/{id} Return a Promotion #
PATCH /api/v2/platform/promotions/{id} Update a Promotion #
DELETE /api/v2/platform/promotions/{id} Delete a Promotion #

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://artifacts.apis.io/spree-commerce/openapi/spree-commerce-promotions-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:spree-commerce-promotions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-promotions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Spree Commerce Promotions API
  version: '1.0'
  description: 'Operations tagged Promotions across 2 of this provider''s published API definitions: spree-commerce-admin-api-openapi.yml, spree-commerce-platform-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 (71 KB total) ---
# Full source: https://artifacts.apis.io/spree-commerce/openapi/spree-commerce-promotions-api-openapi.yml