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 Gift Cards API

The Gift Cards API from Spree Commerce — 4 operation(s) for gift cards.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 8 operations across 4 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version v3.

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

8 operations 4 paths 40 schemas 1 DELETE4 GET1 PATCH2 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 Gift Cards 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 8

Across 4 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Gift Cards 8
GET
/api/v3/admin/gift_card_batches
List gift card batches
6 params → 200
POST
/api/v3/admin/gift_card_batches
Create a gift card batch
2 params body → 201422
GET
/api/v3/admin/gift_card_batches/{id}
Get a gift card batch
3 params → 200404
GET
/api/v3/admin/gift_cards
List gift cards
8 params → 200401
POST
/api/v3/admin/gift_cards
Create a gift card
2 params body → 201422
GET
/api/v3/admin/gift_cards/{id}
Get a gift card
4 params → 200404
PATCH
/api/v3/admin/gift_cards/{id}
Update a gift card
3 params body → 200
DELETE
/api/v3/admin/gift_cards/{id}
Delete a gift card
3 params → 204422

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are Order (72 properties), Variant (38 properties), LineItem (36 properties), Customer (33 properties). Each schema is shown below with its type and property counts.

PaginationMeta
object
9 properties 7 required
CustomerGroup
object
7 properties 6 required
PaymentSource
object
5 properties 5 required
AdminUser
object
8 properties 8 required
Payment
object
21 properties 18 required
Order
object
72 properties 56 required
Discount
object
9 properties 9 required
Fulfillment
object
32 properties 27 required
Customer
object
33 properties 27 required
PriceHistory
object
10 properties 10 required
GiftCard
object
23 properties 19 required
Variant
object
38 properties 32 required
CustomField
object
10 properties 10 required
Price
object
13 properties 12 required
Address
object
23 properties 23 required
Country
object
9 properties 7 required
PaymentMethod
object
15 properties 15 required
GiftCardBatch
object
9 properties 9 required
DigitalLink
object
10 properties 10 required
CreditCard
object
13 properties 13 required
Channel
object
8 properties 8 required
Refund
object
11 properties 9 required
Media
object
22 properties 22 required
Adjustment
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
TaxCategory
object
7 properties 7 required
StockItem
object
12 properties 10 required
StockLocation
object
25 properties 25 required
DeliveryRate
object
17 properties 16 required
Reimbursement
object
9 properties 8 required
AdminUserRoleAssignment
object
A role assignment for the current store on a staff member
2 properties 2 required
LineItem
object
36 properties 33 required
DeliveryMethod
object
5 properties 5 required
Market
object
10 properties 9 required
ReturnAuthorization
object
10 properties 8 required
OptionValue
object
13 properties 12 required
StoreCredit
object
16 properties 16 required
ErrorResponse
object
1 property 1 required
OptionType
object
10 properties 9 required
State
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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