Skip to content
Customer API

Customer API Overview

Everything a shopper can do, over HTTP. Build custom storefronts, mobile apps, or headless experiences on the /customer surface.

Authentication

JWT access + refresh tokens, or server-side sessions for the built-in storefront

Format

REST over JSON with a consistent { success, data } envelope

GraphQL

The same surface is also available at /graphql

Authentication flow

Register or log in to get an access token and refresh token.

# Register
POST /customer/identity/register
# Log in → accessToken + refreshToken
POST /customer/identity/token
# Authenticated requests
Authorization: Bearer <accessToken>
# Refresh when the access token expires
POST /customer/identity/token/refresh

What it covers

  • ✓Identity — register, login, refresh, reset, verify
  • ✓Catalog — products, variants, categories, search
  • ✓Basket — guest and authenticated, merge on login
  • ✓Checkout — shipping, billing, payment sessions
  • ✓Orders — history, tracking, returns
  • ✓Account — profile, addresses, preferences
  • ✓Loyalty — points, rewards, redemptions
  • ✓Subscriptions & memberships
  • ✓Support tickets & GDPR requests
  • ✓Content — pages, blog, menus

Full endpoint reference

Every customer operation — parameters, payloads, and responses — is generated from the OpenAPI spec in the repo.

Browse the API Reference