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

Customer management — profiles, addresses, store credits, credit cards

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

45 operations 29 paths 62 schemas 7 DELETE20 GET7 PATCH11 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 Customers 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 45

Across 29 paths, the API surfaces 45 operations — 7 DELETE, 20 GET, 7 PATCH, 11 POST. Each is listed below with its method, path, parameters, and response codes.

Customers 45

Customer management — profiles, addresses, store credits, credit cards

GET
/api/v3/admin/customer_groups
List customer groups
7 params → 200401
POST
/api/v3/admin/customer_groups
Create a customer group
2 params body → 201422
GET
/api/v3/admin/customer_groups/{id}
Get a customer group
5 params → 200404
PATCH
/api/v3/admin/customer_groups/{id}
Update a customer group
3 params body → 200422
DELETE
/api/v3/admin/customer_groups/{id}
Delete a customer group
3 params → 204
GET
/api/v3/admin/customers/{customer_id}/addresses
List customer addresses
5 params → 200
POST
/api/v3/admin/customers/{customer_id}/addresses
Create a customer address
3 params body → 201
PATCH
/api/v3/admin/customers/{customer_id}/addresses/{id}
Update a customer address
4 params body → 200
DELETE
/api/v3/admin/customers/{customer_id}/addresses/{id}
Delete a customer address
4 params → 204
GET
/api/v3/admin/customers/{customer_id}/credit_cards
List customer credit cards
5 params → 200
GET
/api/v3/admin/customers/{customer_id}/credit_cards/{id}
Show a customer credit card
6 params → 200
DELETE
/api/v3/admin/customers/{customer_id}/credit_cards/{id}
Delete a customer credit card
4 params → 204
GET
/api/v3/admin/customers/{customer_id}/store_credits
List customer store credits
5 params → 200
POST
/api/v3/admin/customers/{customer_id}/store_credits
Issue a store credit to a customer
3 params body → 201
PATCH
/api/v3/admin/customers/{customer_id}/store_credits/{id}
Update a store credit
4 params body → 200
DELETE
/api/v3/admin/customers/{customer_id}/store_credits/{id}
Delete a store credit
4 params → 204
GET
/api/v3/admin/customers
List customers
7 params → 200
POST
/api/v3/admin/customers
Create a customer
2 params body → 201
GET
/api/v3/admin/customers/{id}
Show a customer
5 params → 200
PATCH
/api/v3/admin/customers/{id}
Update a customer
3 params body → 200
DELETE
/api/v3/admin/customers/{id}
Delete a customer
3 params → 204
POST
/api/v3/admin/customers/bulk_add_to_groups
Bulk-add customers to groups
2 params body → 200
POST
/api/v3/admin/customers/bulk_remove_from_groups
Bulk-remove customers from groups
2 params body → 200
POST
/api/v3/admin/customers/bulk_add_tags
Bulk-add tags to customers
2 params body → 200
POST
/api/v3/admin/customers/bulk_remove_tags
Bulk-remove tags from customers
2 params body → 200
GET
/api/v3/store/customers/me/addresses
List customer addresses
5 params → 200401
POST
/api/v3/store/customers/me/addresses
Create an address
2 params body → 201422
GET
/api/v3/store/customers/me/addresses/{id}
Get an address
4 params → 200404
PATCH
/api/v3/store/customers/me/addresses/{id}
Update an address
3 params body → 200
DELETE
/api/v3/store/customers/me/addresses/{id}
Delete an address
3 params → 204404
GET
/api/v3/store/customers/me/credit_cards
List saved credit cards
5 params → 200401
GET
/api/v3/store/customers/me/credit_cards/{id}
Get a credit card
4 params → 200404
DELETE
/api/v3/store/customers/me/credit_cards/{id}
Delete a credit card
3 params → 204404
GET
/api/v3/store/customers/me/orders
List orders
14 params → 200401
GET
/api/v3/store/customers/me/orders/{id}
Get an order
5 params → 200404
POST
/api/v3/store/customers
Register a new customer
1 param body → 201422
GET
/api/v3/store/customers/me
Get current customer profile
3 params → 200401
PATCH
/api/v3/store/customers/me
Update current customer profile
2 params body → 200422
GET
/api/v3/store/customers/me/gift_cards
List gift cards
5 params → 200401
GET
/api/v3/store/customers/me/gift_cards/{id}
Get a gift card
4 params → 200404
POST
/api/v3/store/customers/me/payment_setup_sessions
Create payment setup session
2 params body → 201401404
GET
/api/v3/store/customers/me/payment_setup_sessions/{id}
Get payment setup session
3 params → 200404
PATCH
/api/v3/store/customers/me/payment_setup_sessions/{id}/complete
Complete payment setup session
3 params body → 200404
GET
/api/v3/store/customers/me/store_credits
List store credits
5 params → 200401
GET
/api/v3/store/customers/me/store_credits/{id}
Get a store credit
4 params → 200404

Schemas 62

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

CustomerGroup
object
7 properties 6 required
AdminUser
object
8 properties 8 required
PaymentSource
object
5 properties 5 required
PaginationMeta
object
9 properties 7 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
Variant
object
38 properties 32 required
CustomField
object
10 properties 10 required
GiftCard
object
23 properties 19 required
Address
object
23 properties 23 required
Price
object
13 properties 12 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
PaymentSetupSession
object
10 properties 10 required
PaymentSource_2
object
2 properties 2 required
Payment_2
object
11 properties 11 required
Order_2
object
43 properties 43 required
AuthResponse
object
3 properties 3 required
Discount_2
object
7 properties 7 required
Fulfillment_2
object
23 properties 23 required
Customer_2
object
12 properties 12 required
GiftCard_2
object
15 properties 15 required
Address_2
object
18 properties 18 required
Country_2
object
7 properties 5 required
PaymentMethod_2
object
6 properties 6 required
DigitalLink_2
object
8 properties 8 required
CreditCard_2
object
8 properties 8 required
StockLocation_2
object
9 properties 9 required
DeliveryRate_2
object
15 properties 15 required
LineItem_2
object
28 properties 28 required
DeliveryMethod_2
object
3 properties 3 required
Market_2
object
8 properties 7 required
OptionValue_2
object
9 properties 9 required
StoreCredit_2
object
8 properties 8 required
State_2
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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