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 Newsletter Subscribers API

Guest and customer newsletter subscriptions (double opt-in)

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

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

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

2 operations 2 paths 2 schemas 2 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
Resource Areas
1

Authentication & Security 2

Spree Commerce Newsletter Subscribers 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 — Publishable API key for store access
  • bearer_auth — JWT token for authenticated customers

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.

Newsletter Subscribers 2

Guest and customer newsletter subscriptions (double opt-in)

POST
/api/v3/store/newsletter_subscribers
Subscribe to the newsletter
2 params body → 201422
POST
/api/v3/store/newsletter_subscribers/verify
Verify a newsletter subscription
1 param body → 200422

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are NewsletterSubscriber (7 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

ErrorResponse
object
1 property 1 required
NewsletterSubscriber
object
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

spree-commerce-newsletter-subscribers-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 Newsletter Subscribers 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.