Spree Commerce

Spree Commerce Customers API

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

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 45

GET /api/v3/admin/customer_groups List customer groups #
POST /api/v3/admin/customer_groups Create a customer group #
GET /api/v3/admin/customer_groups/{id} Get a customer group #
PATCH /api/v3/admin/customer_groups/{id} Update a customer group #
DELETE /api/v3/admin/customer_groups/{id} Delete a customer group #
GET /api/v3/admin/customers/{customer_id}/addresses List customer addresses #
POST /api/v3/admin/customers/{customer_id}/addresses Create a customer address #
PATCH /api/v3/admin/customers/{customer_id}/addresses/{id} Update a customer address #
DELETE /api/v3/admin/customers/{customer_id}/addresses/{id} Delete a customer address #
GET /api/v3/admin/customers/{customer_id}/credit_cards List customer credit cards #
GET /api/v3/admin/customers/{customer_id}/credit_cards/{id} Show a customer credit card #
DELETE /api/v3/admin/customers/{customer_id}/credit_cards/{id} Delete a customer credit card #
GET /api/v3/admin/customers/{customer_id}/store_credits List customer store credits #
POST /api/v3/admin/customers/{customer_id}/store_credits Issue a store credit to a customer #
PATCH /api/v3/admin/customers/{customer_id}/store_credits/{id} Update a store credit #
DELETE /api/v3/admin/customers/{customer_id}/store_credits/{id} Delete a store credit #
GET /api/v3/admin/customers List customers #
POST /api/v3/admin/customers Create a customer #
GET /api/v3/admin/customers/{id} Show a customer #
PATCH /api/v3/admin/customers/{id} Update a customer #
DELETE /api/v3/admin/customers/{id} Delete a customer #
POST /api/v3/admin/customers/bulk_add_to_groups Bulk-add customers to groups #
POST /api/v3/admin/customers/bulk_remove_from_groups Bulk-remove customers from groups #
POST /api/v3/admin/customers/bulk_add_tags Bulk-add tags to customers #
POST /api/v3/admin/customers/bulk_remove_tags Bulk-remove tags from customers #
GET /api/v3/store/customers/me/addresses List customer addresses #
POST /api/v3/store/customers/me/addresses Create an address #
GET /api/v3/store/customers/me/addresses/{id} Get an address #
PATCH /api/v3/store/customers/me/addresses/{id} Update an address #
DELETE /api/v3/store/customers/me/addresses/{id} Delete an address #
GET /api/v3/store/customers/me/credit_cards List saved credit cards #
GET /api/v3/store/customers/me/credit_cards/{id} Get a credit card #
DELETE /api/v3/store/customers/me/credit_cards/{id} Delete a credit card #
GET /api/v3/store/customers/me/orders List orders #
GET /api/v3/store/customers/me/orders/{id} Get an order #
POST /api/v3/store/customers Register a new customer #
GET /api/v3/store/customers/me Get current customer profile #
PATCH /api/v3/store/customers/me Update current customer profile #
GET /api/v3/store/customers/me/gift_cards List gift cards #
GET /api/v3/store/customers/me/gift_cards/{id} Get a gift card #
POST /api/v3/store/customers/me/payment_setup_sessions Create payment setup session #
GET /api/v3/store/customers/me/payment_setup_sessions/{id} Get payment setup session #
PATCH /api/v3/store/customers/me/payment_setup_sessions/{id}/complete Complete payment setup session #
GET /api/v3/store/customers/me/store_credits List store credits #
GET /api/v3/store/customers/me/store_credits/{id} Get a store credit #

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-customers-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-customers-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-customers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Spree Commerce Customers API
  version: v3
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: 'Operations tagged Customers across 2 of this provider''s published API definitions: spree-commerce-admin-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 (209 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spree-commerce/refs/heads/main/openapi/spree-commerce-customers-api-openapi.yml