Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Improve and document Authentication strategies for API (#14095)

Damian Legawiec3aee8957df25
diff --git a/docs/api-reference/admin.yaml b/docs/api-reference/admin.yaml
index 6739a4ad6d..24e1ceb875 100644
--- a/docs/api-reference/admin.yaml
+++ b/docs/api-reference/admin.yaml
@@ -82,12 +82,12 @@ paths:
example:
data:
- id: admin_UkLWZg9DAJ
- first_name: Erwin
- last_name: Braun
- full_name: Erwin Braun
- created_at: '2026-05-26T12:42:46.794Z'
- updated_at: '2026-05-26T12:42:46.794Z'
+ first_name: Modesta
+ last_name: Walker
+ full_name: Modesta Walker
+ created_at: '2026-05-26T16:11:55.501Z'
+ updated_at: '2026-05-26T16:11:55.501Z'
roles:
- id: role_UkLWZg9DAJ
name: admin
@@ -145,12 +145,12 @@ paths:
application/json:
example:
id: admin_UkLWZg9DAJ
- first_name: Lakia
- last_name: Ryan
- full_name: Lakia Ryan
- created_at: '2026-05-26T12:42:47.189Z'
- updated_at: '2026-05-26T12:42:47.189Z'
+ first_name: Jordan
+ last_name: Herman
+ full_name: Jordan Herman
+ created_at: '2026-05-26T16:11:55.855Z'
+ updated_at: '2026-05-26T16:11:55.855Z'
roles:
- id: role_UkLWZg9DAJ
name: admin
@@ -203,12 +203,12 @@ paths:
application/json:
example:
id: admin_UkLWZg9DAJ
first_name: Renamed
- last_name: O'Hara
- full_name: Renamed O'Hara
- created_at: '2026-05-26T12:42:47.469Z'
- updated_at: '2026-05-26T12:42:47.487Z'
+ last_name: Reichel
+ full_name: Renamed Reichel
+ created_at: '2026-05-26T16:11:56.204Z'
+ updated_at: '2026-05-26T16:11:56.238Z'
roles:
- id: role_UkLWZg9DAJ
name: admin
@@ -317,32 +317,32 @@ paths:
key_type: publishable
token_prefix:
scopes: []
- created_at: '2026-05-26T12:42:47.777Z'
- updated_at: '2026-05-26T12:42:47.777Z'
+ created_at: '2026-05-26T16:11:56.556Z'
+ updated_at: '2026-05-26T16:11:56.556Z'
revoked_at:
last_used_at:
- plaintext_token: pk_MXpnpNbeH6Jonc9PHFAAkrRN
+ plaintext_token: pk_sMAe8wVfz8C8UEma1dzHXGuB
created_by_email:
- id: key_gbHJdmfrXB
name: Backend integration
key_type: secret
- token_prefix: sk_3wzZtNJd9
+ token_prefix: sk_8GrpM2be2
scopes:
- write_all
- created_at: '2026-05-26T12:42:47.778Z'
- updated_at: '2026-05-26T12:42:47.778Z'
+ created_at: '2026-05-26T16:11:56.558Z'
+ updated_at: '2026-05-26T16:11:56.558Z'
revoked_at:
last_used_at:
plaintext_token:
created_by_email:
- id: key_EfhxLZ9ck8
- name: facilis
+ name: libero
key_type: secret
- token_prefix: sk_rst3YWMdZ
+ token_prefix: sk_53SjiyxYD
scopes:
- write_all
- created_at: '2026-05-26T12:42:47.778Z'
- updated_at: '2026-05-26T12:42:47.778Z'
+ created_at: '2026-05-26T16:11:56.560Z'
+ updated_at: '2026-05-26T16:11:56.560Z'
revoked_at:
last_used_at:
plaintext_token:
@@ -405,15 +405,15 @@ paths:
id: key_VqXmZF31wY
name: CI key
key_type: secret
- token_prefix: sk_sySDky4Kf
+ token_prefix: sk_d2znVaYUc
scopes:
- read_orders
- created_at: '2026-05-26T12:42:48.347Z'
- updated_at: '2026-05-26T12:42:48.347Z'
+ created_at: '2026-05-26T16:11:57.239Z'
+ updated_at: '2026-05-26T16:11:57.239Z'
revoked_at:
last_used_at:
- plaintext_token: sk_sySDky4KfskBpQC6HVsRCEsU
- created_by_email: [email protected]
+ plaintext_token: sk_d2znVaYUcjv7xLXu7gNm1vGc
+ created_by_email: [email protected]
'422':
description: validation error
content:
@@ -499,11 +499,11 @@ paths:
key_type: publishable
token_prefix:
scopes: []
- created_at: '2026-05-26T12:42:48.641Z'
- updated_at: '2026-05-26T12:42:48.641Z'
+ created_at: '2026-05-26T16:11:57.532Z'
+ updated_at: '2026-05-26T16:11:57.532Z'
revoked_at:
last_used_at:
- plaintext_token: pk_Wsz6ry2mTHN8U1k4DyGQPgoE
+ plaintext_token: pk_VMqsBqSQyYziwRjbWKTyNd5h
created_by_email:
delete:
summary: Delete an API key
@@ -593,15 +593,222 @@ paths:
id: key_gbHJdmfrXB
name: Backend integration
key_type: secret
- token_prefix: sk_HSvSsXbqA
+ token_prefix: sk_LMPdjpQhR
scopes:
- write_all
- created_at: '2026-05-26T12:42:49.216Z'
- updated_at: '2026-05-26T12:42:49.498Z'
- revoked_at: '2026-05-26T12:42:49.497Z'
+ created_at: '2026-05-26T16:11:58.097Z'
+ updated_at: '2026-05-26T16:11:58.376Z'
+ revoked_at: '2026-05-26T16:11:58.374Z'
last_used_at:
plaintext_token:
created_by_email:
+ "/api/v3/admin/auth/login":
+ post:
+ summary: Login
+ tags:
+ - Authentication
+ security:
+ - api_key: []
+ description: |
+ Authenticates an admin user and returns a short-lived JWT access token.
+ The rotatable refresh token is set in an HttpOnly cookie — it is not
+ included in the response body.
+
+ Dispatches by the `provider` field to a strategy registered in
+ `Spree.admin_authentication_strategies`. When `provider` is omitted it
+ defaults to `email`, which uses the built-in email/password strategy.
+
+ To plug in a third-party identity provider (Okta, Azure AD, Google
+ Workspace SSO, a custom JWT issuer, SAML, etc.), register a
+ `Spree::Authentication::Strategies::BaseStrategy` subclass under a
+ provider key, then send `{ "provider": "<your_key>", ... }` with the
+ fields your strategy requires. The endpoint returns the same Spree-issued
+ JWT regardless of which strategy authenticated the request.
+ x-codeSamples:
+ - lang: javascript
+ label: Spree Admin SDK
+ source: |-
+ import { createAdminClient } from '@spree/admin-sdk'
+
+ const client = createAdminClient({
+ baseUrl: 'https://your-store.com',
+ secretKey: 'sk_xxx',
+ })
+
+ // The refresh token is set as an HttpOnly cookie; only `token` and `user` come back in the body.
+ const auth = await client.auth.login({
+ email: '[email protected]',
+ password: 'password123',
+ })
+ parameters:
+ - name: x-spree-api-key
+ in: header
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: login successful
+ content:
+ application/json:
+ example:
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjFiOTNkNjUzLTU0NmMtNDhlYS1hZDRiLWE1NWU5OTY0YzZkZCIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzc5ODEyMjE4fQ.FSbBqYArfkNhx4AOUgjEQi8EtOuiO0OJFtWwIfgDJkQ
+ user:
+ id: admin_UkLWZg9DAJ
+ first_name: Ruby
+ last_name: Frami
+ full_name: Ruby Frami
+ created_at: '2026-05-26T16:11:58.643Z'
+ updated_at: '2026-05-26T16:11:58.643Z'
+ roles:
+ - id: role_UkLWZg9DAJ
+ name: admin
+ schema:
+ "$ref": "#/components/schemas/AuthResponse"
+ '401':
+ description: invalid credentials
+ content:
+ application/json:
+ example:
+ error:
+ code: authentication_failed
+ message: Invalid email or password
+ schema:
+ "$ref": "#/components/schemas/ErrorResponse"
+ requestBody:
+ content:
+ application/json:
+ schema:
+ oneOf:
+ - title: EmailPasswordLogin
+ description: Built-in email/password authentication (default when
+ `provider` is omitted).
+ type: object
+ properties:
+ provider:
+ type: string
+ enum:
+ - email
+ default: email
+ email:
+ type: string
+ format: email
+ password:
+ type: string
+ example: password123
+ required:
+ - email
+ - password
+ - title: ProviderLogin
+ description: |
+ Provider-dispatched login. The `provider` key selects a registered
+ strategy class; the remaining fields are forwarded to the strategy's
+ `authenticate` method. Required fields depend on the registered strategy
+ — consult its documentation.
+ type: object
+ properties:
+ provider:
+ type: string
+ example: okta
+ description: Registered provider key (anything other than `email`).
+ not:
+ enum:
+ - email
+ required:
+ - provider
+ additionalProperties: true
+ "/api/v3/admin/auth/refresh":
+ post:
+ summary: Refresh token
+ tags:
+ - Authentication
+ security:
+ - api_key: []
+ description: |
+ Exchanges the HttpOnly refresh-token cookie for a new access JWT and a
+ rotated refresh token cookie. No request body or Authorization header
+ is required — the cookie alone authenticates the call.
+ x-codeSamples:
+ - lang: javascript
+ label: Spree Admin SDK
+ source: |-
+ import { createAdminClient } from '@spree/admin-sdk'
+
+ const client = createAdminClient({
+ baseUrl: 'https://your-store.com',
+ secretKey: 'sk_xxx',
+ })
+
+ // Driven entirely by the HttpOnly refresh-token cookie + CSRF header (set by the SDK).
+ const auth = await client.auth.refresh()
+ parameters:
+ - name: x-spree-api-key
+ in: header
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: refresh successful
+ content:
+ application/json:
+ example:
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjNhMWI5M2M4LWM2Y2UtNGNhMy04NmNkLTRjZjFlZGZjNjczNSIsImlzcyI6InNwcmVlIiwiYXVkIjoiYWRtaW5fYXBpIiwiZXhwIjoxNzc5ODEyMjE5fQ.hxO8Fmk8Emo9J8B2jWENXY8VDb0NSV8JnzvOpqR3m44
+ user:
+ id: admin_UkLWZg9DAJ
+ first_name: Melissa
+ last_name: Hills
+ full_name: Melissa Hills
+ created_at: '2026-05-26T16:11:59.743Z'
+ updated_at: '2026-05-26T16:11:59.743Z'
+ roles:
+ - id: role_UkLWZg9DAJ
+ name: admin
+ schema:
+ "$ref": "#/components/schemas/AuthResponse"
+ '401':
+ description: missing or invalid refresh-token cookie
+ content:
+ application/json:
+ example:
+ error:
+ code: invalid_refresh_token
+ message: Refresh token cookie missing
+ schema:
+ "$ref": "#/components/schemas/ErrorResponse"
+ "/api/v3/admin/auth/logout":
+ post:
+ summary: Logout
+ tags:
+ - Authentication
+ security:
+ - api_key: []
+ description: Revokes the refresh-token cookie, effectively logging the admin
+ out.
+ x-codeSamples:
+ - lang: javascript
+ label: Spree Admin SDK
+ source: |-
+ import { createAdminClient } from '@spree/admin-sdk'
+
+ const client = createAdminClient({
+ baseUrl: 'https://your-store.com',
+ secretKey: 'sk_xxx',
+ })
+
+ await client.auth.logout()
+ parameters:
+ - name: x-spree-api-key
+ in: header
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: logout successful
"/api/v3/admin/promotions/{promotion_id}/coupon_codes":
parameters:
- name: promotion_id
@@ -653,15 +860,15 @@ paths:
- id: coupon_UkLWZg9DAJ
code: AAA111
state: unused
- created_at: '2026-05-26T12:42:49.518Z'
- updated_at: '2026-05-26T12:42:49.518Z'
+ created_at: '2026-05-26T16:12:00.430Z'
+ updated_at: '2026-05-26T16:12:00.430Z'
promotion_id: promo_UkLWZg9DAJ
order_id:
- id: coupon_gbHJdmfrXB
code: BBB222
state: unused
- created_at: '2026-05-26T12:42:49.519Z'
- updated_at: '2026-05-26T12:42:49.519Z'
+ created_at: '2026-05-26T16:12:00.431Z'
+ updated_at: '2026-05-26T16:12:00.431Z'
promotion_id: promo_UkLWZg9DAJ
order_id:
meta:
@@ -739,8 +946,8 @@ paths:
field_type: short_text
resource_type: Spree::Product
storefront_visible: true
- created_at: '2026-05-26T12:42:49.819Z'
- updated_at: '2026-05-26T12:42:49.819Z'
+ created_at: '2026-05-26T16:12:00.726Z'
+ updated_at: '2026-05-26T16:12:00.726Z'
- id: cfdef_gbHJdmfrXB
namespace: custom
key: order_notes
@@ -748,8 +955,8 @@ paths:
field_type: short_text
resource_type: Spree::Order
storefront_visible: true
- created_at: '2026-05-26T12:42:49.820Z'
- updated_at: '2026-05-26T12:42:49.820Z'
+ created_at: '2026-05-26T16:12:00.727Z'
+ updated_at: '2026-05-26T16:12:00.727Z'
meta:
page: 1
limit: 25
@@ -812,8 +1019,8 @@ paths:
field_type: short_text
resource_type: Spree::Product
storefront_visible: true
- created_at: '2026-05-26T12:42:50.394Z'
- updated_at: '2026-05-26T12:42:50.394Z'
+ created_at: '2026-05-26T16:12:01.285Z'
+ updated_at: '2026-05-26T16:12:01.285Z'
requestBody:
content:
application/json:
@@ -896,8 +1103,8 @@ paths:
field_type: short_text
resource_type: Spree::Product
storefront_visible: true
- created_at: '2026-05-26T12:42:50.397Z'
- updated_at: '2026-05-26T12:42:50.397Z'
+ created_at: '2026-05-26T16:12:01.288Z'
+ updated_at: '2026-05-26T16:12:01.288Z'
patch:
summary: Update a custom field definition
tags:
@@ -936,8 +1143,8 @@ paths:
field_type: short_text
resource_type: Spree::Product
storefront_visible: false
- created_at: '2026-05-26T12:42:50.682Z'
- updated_at: '2026-05-26T12:42:50.965Z'
+ created_at: '2026-05-26T16:12:01.575Z'
+ updated_at: '2026-05-26T16:12:01.862Z'
requestBody:
content:
application/json:
@@ -1061,14 +1268,14 @@ paths:
name: VIPs
description: Top spenders
customers_count: 0
- created_at: '2026-05-26T12:42:51.261Z'
- updated_at: '2026-05-26T12:42:51.261Z'
+ created_at: '2026-05-26T16:12:02.163Z'
+ updated_at: '2026-05-26T16:12:02.163Z'
- id: cg_gbHJdmfrXB
name: Wholesale
description:
customers_count: 0
- created_at: '2026-05-26T12:42:51.262Z'
- updated_at: '2026-05-26T12:42:51.262Z'
+ created_at: '2026-05-26T16:12:02.164Z'
+ updated_at: '2026-05-26T16:12:02.164Z'
meta:
page: 1
limit: 25
@@ -1153,8 +1360,8 @@ paths:
name: Wholesale 2
description: B2B accounts
customers_count: 1
- created_at: '2026-05-26T12:42:52.143Z'
- updated_at: '2026-05-26T12:42:52.143Z'
+ created_at: '2026-05-26T16:12:03.069Z'
+ updated_at: '2026-05-26T16:12:03.069Z'
schema:
"$ref": "#/components/schemas/CustomerGroup"
'422':
@@ -1260,24 +1467,24 @@ paths:
name: VIPs
description: Top spenders
customers_count: 1
- created_at: '2026-05-26T12:42:52.761Z'
- updated_at: '2026-05-26T12:42:52.761Z'
+ created_at: '2026-05-26T16:12:03.679Z'
+ updated_at: '2026-05-26T16:12:03.679Z'
customers:
- id: cus_UkLWZg9DAJ
- first_name: Sibyl
- last_name: Ruecker
+ first_name: Avelina
+ last_name: Weber
phone:
accepts_email_marketing: false
- full_name: Sibyl Ruecker
+ full_name: Avelina Weber
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
metadata: {}
last_sign_in_at:
current_sign_in_at:
- created_at: '2026-05-26T12:42:53.023Z'
- updated_at: '2026-05-26T12:42:53.023Z'
+ created_at: '2026-05-26T16:12:03.948Z'
+ updated_at: '2026-05-26T16:12:03.948Z'
sign_in_count: 0
failed_attempts: 0
last_sign_in_ip:
@@ -1355,8 +1562,8 @@ paths:
name: VIP customers (Q1)
description: Top spenders
customers_count: 0
- created_at: '2026-05-26T12:42:53.700Z'
- updated_at: '2026-05-26T12:42:53.977Z'
+ created_at: '2026-05-26T16:12:04.532Z'
+ updated_at: '2026-05-26T16:12:04.839Z'
schema:
"$ref": "#/components/schemas/CustomerGroup"
'422':
@@ -1509,8 +1716,8 @@ paths:
state_name: New York
label:
metadata: {}
- created_at: '2026-05-26T12:42:54.830Z'
- updated_at: '2026-05-26T12:42:54.830Z'
+ created_at: '2026-05-26T16:12:05.803Z'
+ updated_at: '2026-05-26T16:12:05.803Z'
customer_id: cus_UkLWZg9DAJ
meta:
page: 1
@@ -1598,8 +1805,8 @@ paths:
state_name: New York
label: Office
metadata: {}
- created_at: '2026-05-26T12:42:56.256Z'
- updated_at: '2026-05-26T12:42:56.256Z'
+ created_at: '2026-05-26T16:12:07.161Z'
+ updated_at: '2026-05-26T16:12:07.161Z'
customer_id: cus_UkLWZg9DAJ
requestBody:
content:
@@ -1710,8 +1917,8 @@ paths:
state_name: New York
label:
metadata: {}
- created_at: '2026-05-26T12:42:56.525Z'
- updated_at: '2026-05-26T12:42:57.067Z'
+ created_at: '2026-05-26T16:12:07.438Z'
+ updated_at: '2026-05-26T16:12:08.064Z'
customer_id: cus_UkLWZg9DAJ
requestBody:
content:
@@ -1844,8 +2051,8 @@ paths:
customer_id: cus_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
metadata: {}
- created_at: '2026-05-26T12:42:58.161Z'
- updated_at: '2026-05-26T12:42:58.161Z'
+ created_at: '2026-05-26T16:12:09.473Z'
+ updated_at: '2026-05-26T16:12:09.473Z'
meta:
page: 1
limit: 25
@@ -1932,8 +2139,8 @@ paths:
customer_id: cus_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
metadata: {}
- created_at: '2026-05-26T12:42:58.710Z'
- updated_at: '2026-05-26T12:42:58.710Z'
+ created_at: '2026-05-26T16:12:10.055Z'
+ updated_at: '2026-05-26T16:12:10.055Z'
delete:
summary: Delete a customer credit card
tags:
@@ -2052,8 +2259,8 @@ paths:
currency: USD
memo:
metadata: {}
- created_at: '2026-05-26T12:43:00.094Z'
- updated_at: '2026-05-26T12:43:00.094Z'
+ created_at: '2026-05-26T16:12:11.460Z'
+ updated_at: '2026-05-26T16:12:11.460Z'
customer_id: cus_UkLWZg9DAJ
created_by_id: admin_UkLWZg9DAJ
category_id: sccat_UkLWZg9DAJ
@@ -2128,8 +2335,8 @@ paths:
currency: USD
memo: Goodwill
metadata: {}
- created_at: '2026-05-26T12:43:01.199Z'
- updated_at: '2026-05-26T12:43:01.199Z'
+ created_at: '2026-05-26T16:12:12.603Z'
+ updated_at: '2026-05-26T16:12:12.603Z'
customer_id: cus_UkLWZg9DAJ
created_by_id: admin_gbHJdmfrXB
category_id: sccat_UkLWZg9DAJ
@@ -2220,8 +2427,8 @@ paths:
currency: USD
memo: Updated
metadata: {}
- created_at: '2026-05-26T12:43:01.740Z'
- updated_at: '2026-05-26T12:43:02.024Z'
+ created_at: '2026-05-26T16:12:13.232Z'
+ updated_at: '2026-05-26T16:12:13.518Z'
customer_id: cus_UkLWZg9DAJ
created_by_id: admin_UkLWZg9DAJ
category_id: sccat_UkLWZg9DAJ
@@ -2375,8 +2582,8 @@ paths:
metadata: {}
last_sign_in_at:
current_sign_in_at:
- created_at: '2026-05-26T12:43:03.106Z'
- updated_at: '2026-05-26T12:43:03.106Z'
+ created_at: '2026-05-26T16:12:14.666Z'
+ updated_at: '2026-05-26T16:12:14.666Z'
sign_in_count: 0
failed_attempts: 0
last_sign_in_ip:
@@ -2459,8 +2666,8 @@ paths:
metadata: {}
last_sign_in_at:
current_sign_in_at:
- created_at: '2026-05-26T12:43:03.934Z'
- updated_at: '2026-05-26T12:43:03.934Z'
+ created_at: '2026-05-26T16:12:15.501Z'
+ updated_at: '2026-05-26T16:12:15.501Z'
sign_in_count: 0
failed_attempts: 0
last_sign_in_ip:
@@ -2576,8 +2783,8 @@ paths:
metadata: {}
last_sign_in_at:
current_sign_in_at:
- created_at: '2026-05-26T12:43:04.206Z'
- updated_at: '2026-05-26T12:43:04.206Z'
+ created_at: '2026-05-26T16:12:15.770Z'
+ updated_at: '2026-05-26T16:12:15.770Z'
sign_in_count: 0
failed_attempts: 0
last_sign_in_ip:
@@ -2651,8 +2858,8 @@ paths:
metadata: {}
last_sign_in_at:
current_sign_in_at:
- created_at: '2026-05-26T12:43:04.752Z'
- updated_at: '2026-05-26T12:43:05.035Z'
+ created_at: '2026-05-26T16:12:16.321Z'
+ updated_at: '2026-05-26T16:12:16.603Z'
sign_in_count: 0
failed_attempts: 0
last_sign_in_ip:
@@ -3082,11 +3289,11 @@ paths:
example:
data:
- id: exp_UkLWZg9DAJ
- number: EF532072077
+ number: EF917174541
type: Spree::Exports::Products
format: csv
- created_at: '2026-05-26T12:43:09.204Z'
- updated_at: '2026-05-26T12:43:09.204Z'
+ created_at: '2026-05-26T16:12:20.761Z'
+ updated_at: '2026-05-26T16:12:20.761Z'
user_id: admin_UkLWZg9DAJ
done: false
filename:
@@ -3153,11 +3360,11 @@ paths:
application/json:
example:
id: exp_gbHJdmfrXB
- number: EF574479198
+ number: EF717713311
type: Spree::Exports::Products
format: csv
- created_at: '2026-05-26T12:43:09.506Z'
- updated_at: '2026-05-26T12:43:09.506Z'
+ created_at: '2026-05-26T16:12:21.059Z'
+ updated_at: '2026-05-26T16:12:21.059Z'
user_id: admin_UkLWZg9DAJ
done: false
filename:
@@ -3244,11 +3451,11 @@ paths:
application/json:
example:
id: exp_UkLWZg9DAJ
- number: EF872001258
+ number: EF426554878
type: Spree::Exports::Products
format: csv
- created_at: '2026-05-26T12:43:09.778Z'
- updated_at: '2026-05-26T12:43:09.778Z'
+ created_at: '2026-05-26T16:12:21.330Z'
+ updated_at: '2026-05-26T16:12:21.330Z'
user_id: admin_UkLWZg9DAJ
done: false
filename:
@@ -3431,8 +3638,8 @@ paths:
codes_count: 2
currency: USD
prefix: WELCOME
- created_at: '2026-05-26T12:43:10.373Z'
- updated_at: '2026-05-26T12:43:10.373Z'
+ created_at: '2026-05-26T16:12:21.926Z'
+ updated_at: '2026-05-26T16:12:21.926Z'
amount: '50.0'
expires_at:
created_by_id:
@@ -3513,8 +3720,8 @@ paths:
codes_count: 5
currency: USD
prefix: NEWCAMP
- created_at: '2026-05-26T12:43:10.938Z'
- updated_at: '2026-05-26T12:43:10.938Z'
+ created_at: '2026-05-26T16:12:22.496Z'
+ updated_at: '2026-05-26T16:12:22.496Z'
amount: '25.0'
expires_at: '2030-12-31'
created_by_id: admin_UkLWZg9DAJ
@@ -3615,8 +3822,8 @@ paths:
codes_count: 2
currency: USD
prefix: WELCOME
- created_at: '2026-05-26T12:43:11.226Z'
- updated_at: '2026-05-26T12:43:11.226Z'
+ created_at: '2026-05-26T16:12:22.788Z'
+ updated_at: '2026-05-26T16:12:22.788Z'
amount: '50.0'
expires_at:
created_by_id:
@@ -3719,7 +3926,7 @@ paths:
example:
data:
- id: gc_UkLWZg9DAJ
- code: 9B9ED58051A4985A
+ code: E9E1428FD796712F
status: active
currency: USD
amount: '50.0'
@@ -3733,12 +3940,12 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-05-26T12:43:11.794Z'
- updated_at: '2026-05-26T12:43:11.794Z'
+ created_at: '2026-05-26T16:12:23.364Z'
+ updated_at: '2026-05-26T16:12:23.364Z'
customer_id:
created_by_id:
- id: gc_gbHJdmfrXB
- code: DB1278946CB996BA
+ code: D2F00134CB4D9913
status: active
currency: USD
amount: '25.0'
@@ -3752,8 +3959,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-05-26T12:43:11.795Z'
- updated_at: '2026-05-26T12:43:11.795Z'
+ created_at: '2026-05-26T16:12:23.365Z'
+ updated_at: '2026-05-26T16:12:23.365Z'
customer_id:
created_by_id:
meta:
@@ -3838,7 +4045,7 @@ paths:
application/json:
example:
id: gc_EfhxLZ9ck8
- code: AD209AAC9CF152FC
+ code: 31F056B764C08321
status: active
currency: USD
amount: '25.0'
@@ -3852,8 +4059,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-05-26T12:43:12.382Z'
- updated_at: '2026-05-26T12:43:12.382Z'
+ created_at: '2026-05-26T16:12:23.972Z'
+ updated_at: '2026-05-26T16:12:23.972Z'
customer_id:
created_by_id: admin_UkLWZg9DAJ
schema:
@@ -3959,7 +4166,7 @@ paths:
application/json:
example:
id: gc_UkLWZg9DAJ
- code: ECF343EE602414CC
+ code: F15BC55E98D6DB74
status: active
currency: USD
amount: '50.0'
@@ -3973,8 +4180,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-05-26T12:43:12.680Z'
- updated_at: '2026-05-26T12:43:12.680Z'
+ created_at: '2026-05-26T16:12:24.270Z'
+ updated_at: '2026-05-26T16:12:24.270Z'
customer_id:
created_by_id:
schema:
@@ -4034,7 +4241,7 @@ paths:
application/json:
example:
id: gc_UkLWZg9DAJ
- code: 21BB618C1AF1DE93
+ code: 32CC301C086F291F
status: active
currency: USD
amount: '75.0'
@@ -4048,8 +4255,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-05-26T12:43:13.248Z'
- updated_at: '2026-05-26T12:43:13.527Z'
+ created_at: '2026-05-26T16:12:24.842Z'
+ updated_at: '2026-05-26T16:12:25.123Z'
customer_id:
created_by_id:
schema:
@@ -4161,15 +4368,15 @@ paths:
example:
data:
- id: inv_UkLWZg9DAJ
status: pending
- created_at: '2026-05-26T12:43:14.372Z'
- updated_at: '2026-05-26T12:43:14.372Z'
- expires_at: '2026-06-09T12:43:14.370Z'
+ created_at: '2026-05-26T16:12:25.976Z'
+ updated_at: '2026-05-26T16:12:25.976Z'
+ expires_at: '2026-06-09T16:12:25.973Z'
role_id: role_UkLWZg9DAJ
role_name: admin
- inviter_email: [email protected]
- acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=Cy22mSZXN67XaQANUimVWAxP"
+ inviter_email: [email protected]
+ acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=R2VpavHrbEcsj4MK8cEG7mNx"
invitee_exists: false
store:
id: store_UkLWZg9DAJ
@@ -4230,13 +4437,13 @@ paths:
id: inv_gbHJdmfrXB
status: pending
- created_at: '2026-05-26T12:43:14.672Z'
- updated_at: '2026-05-26T12:43:14.672Z'
- expires_at: '2026-06-09T12:43:14.669Z'
+ created_at: '2026-05-26T16:12:26.278Z'
+ updated_at: '2026-05-26T16:12:26.278Z'
+ expires_at: '2026-06-09T16:12:26.275Z'
role_id: role_UkLWZg9DAJ
role_name: admin
- inviter_email: [email protected]
- acceptance_url: "/accept-invitation/inv_gbHJdmfrXB?token=BSNMzr8QmbUJBWFQ9KVmhPmZ"
+ inviter_email: [email protected]
+ acceptance_url: "/accept-invitation/inv_gbHJdmfrXB?token=gcFU19NSNVETM6Jj1uSi69yh"
invitee_exists: false
store:
id: store_UkLWZg9DAJ
@@ -4343,15 +4550,15 @@ paths:
application/json:
example:
id: inv_UkLWZg9DAJ
status: pending
- created_at: '2026-05-26T12:43:15.228Z'
- updated_at: '2026-05-26T12:43:15.228Z'
- expires_at: '2026-06-09T12:43:15.226Z'
+ created_at: '2026-05-26T16:12:26.833Z'
+ updated_at: '2026-05-26T16:12:26.833Z'
+ expires_at: '2026-06-09T16:12:26.831Z'
role_id: role_UkLWZg9DAJ
role_name: admin
- inviter_email: [email protected]
- acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=kD18oQX1d1ZVvQji3vskUXSH"
+ inviter_email: [email protected]
+ acceptance_url: "/accept-invitation/inv_UkLWZg9DAJ?token=yRB6MxhKyVFRgWXWRXJmRXey"
invitee_exists: false
store:
id: store_UkLWZg9DAJ
@@ -4433,12 +4640,12 @@ paths:
default_locale: en
tax_inclusive: false
default: false
- supported_locales:
- - en
country_isos:
- DE
- created_at: '2026-05-26T12:43:15.280Z'
- updated_at: '2026-05-26T12:43:15.280Z'
+ supported_locales:
+ - en
+ created_at: '2026-05-26T16:12:26.890Z'
+ updated_at: '2026-05-26T16:12:26.890Z'
meta:
page: 1
limit: 25
@@ -4523,13 +4730,13 @@ paths:
default_locale: fr
tax_inclusive: true
default: false
+ country_isos:
+ - FR
supported_locales:
- en
- fr
- country_isos:
- - FR
- created_at: '2026-05-26T12:43:15.886Z'
- updated_at: '2026-05-26T12:43:15.886Z'
+ created_at: '2026-05-26T16:12:27.501Z'
+ updated_at: '2026-05-26T16:12:27.501Z'
schema:
"$ref": "#/components/schemas/Market"
'422':
@@ -4658,12 +4865,12 @@ paths:
default_locale: en
tax_inclusive: false
default: false
- supported_locales:
- - en
country_isos:
- DE
- created_at: '2026-05-26T12:43:16.211Z'
- updated_at: '2026-05-26T12:43:16.211Z'
+ supported_locales:
+ - en
+ created_at: '2026-05-26T16:12:27.829Z'
+ updated_at: '2026-05-26T16:12:27.829Z'
schema:
"$ref": "#/components/schemas/Market"
'404':
@@ -4735,12 +4942,12 @@ paths:
default_locale: en
tax_inclusive: true
default: false
- supported_locales:
- - en
country_isos:
- DE
- created_at: '2026-05-26T12:43:16.815Z'
- updated_at: '2026-05-26T12:43:17.100Z'
+ supported_locales:
+ - en
+ created_at: '2026-05-26T16:12:28.435Z'
+ updated_at: '2026-05-26T16:12:28.718Z'
schema:
"$ref": "#/components/schemas/Market"
'422':
@@ -4877,12 +5084,12 @@ paths:
example:
user:
id: admin_UkLWZg9DAJ
- first_name: Milagro
- last_name: Marks
- full_name: Milagro Marks
- created_at: '2026-05-26T12:43:18.270Z'
- updated_at: '2026-05-26T12:43:18.270Z'
+ first_name: Cordell
+ last_name: Schmitt
+ full_name: Cordell Schmitt
+ created_at: '2026-05-26T16:12:29.922Z'
+ updated_at: '2026-05-26T16:12:29.922Z'
roles:
- id: role_UkLWZg9DAJ
name: admin
@@ -5032,8 +5239,8 @@ paths:
kind: dropdown
metadata: {}
filterable: true
- created_at: '2026-05-26T12:43:18.311Z'
- updated_at: '2026-05-26T12:43:18.311Z'
+ created_at: '2026-05-26T16:12:29.971Z'
+ updated_at: '2026-05-26T16:12:29.971Z'
meta:
page: 1
limit: 25
@@ -5124,8 +5331,8 @@ paths:
kind: dropdown
metadata: {}
filterable: true
- created_at: '2026-05-26T12:43:18.885Z'
- updated_at: '2026-05-26T12:43:18.885Z'
+ created_at: '2026-05-26T16:12:30.584Z'
+ updated_at: '2026-05-26T16:12:30.584Z'
schema:
"$ref": "#/components/schemas/OptionType"
'422':
@@ -5246,8 +5453,8 @@ paths:
kind: dropdown
metadata: {}
filterable: true
- created_at: '2026-05-26T12:43:19.174Z'
- updated_at: '2026-05-26T12:43:19.174Z'
+ created_at: '2026-05-26T16:12:30.884Z'
+ updated_at: '2026-05-26T16:12:30.884Z'
schema:
"$ref": "#/components/schemas/OptionType"
'404':
@@ -5319,8 +5526,8 @@ paths:
kind: dropdown
metadata: {}
filterable: true
- created_at: '2026-05-26T12:43:19.734Z'
- updated_at: '2026-05-26T12:43:20.014Z'
+ created_at: '2026-05-26T16:12:31.534Z'
+ updated_at: '2026-05-26T16:12:31.813Z'
schema:
"$ref": "#/components/schemas/OptionType"
'422':
@@ -5479,7 +5686,7 @@ paths:
example:
data:
- id: ful_UkLWZg9DAJ
- number: H72381361328
+ number: H21426817644
tracking: U10000
tracking_url:
cost: '10.0'
@@ -5504,8 +5711,8 @@ paths:
metadata: {}
adjustment_total: '0.0'
pre_tax_amount: '0.0'
- created_at: '2026-05-26T12:43:20.965Z'
- updated_at: '2026-05-26T12:43:21.034Z'
+ created_at: '2026-05-26T16:12:32.807Z'
+ updated_at: '2026-05-26T16:12:32.886Z'
order_id: or_UkLWZg9DAJ
stock_location_id: sloc_UkLWZg9DAJ
meta:
@@ -5588,7 +5795,7 @@ paths:
application/json:
example:
id: ful_UkLWZg9DAJ
- number: H55504215330
+ number: H02734152340
tracking: U10000
tracking_url:
cost: '10.0'
@@ -5613,8 +5820,8 @@ paths:
metadata: {}
adjustment_total: '0.0'
pre_tax_amount: '0.0'
- created_at: '2026-05-26T12:43:21.647Z'
- updated_at: '2026-05-26T12:43:21.706Z'
+ created_at: '2026-05-26T16:12:33.518Z'
+ updated_at: '2026-05-26T16:12:33.582Z'
order_id: or_UkLWZg9DAJ
stock_location_id: sloc_UkLWZg9DAJ
patch:
@@ -5673,7 +5880,7 @@ paths:
application/json:
example:
id: ful_UkLWZg9DAJ
- number: H24051808415
+ number: H27987471741
tracking: 1Z999AA10123456784
tracking_url: https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1Z999AA10123456784
cost: '10.0'
@@ -5698,8 +5905,8 @@ paths:
metadata: {}
adjustment_total: '0.0'
pre_tax_amount: '0.0'
- created_at: '2026-05-26T12:43:22.301Z'
- updated_at: '2026-05-26T12:43:22.638Z'
+ created_at: '2026-05-26T16:12:34.190Z'
+ updated_at: '2026-05-26T16:12:34.537Z'
order_id: or_UkLWZg9DAJ
stock_location_id: sloc_UkLWZg9DAJ
requestBody:
@@ -5768,7 +5975,7 @@ paths:
application/json:
example:
id: ful_UkLWZg9DAJ
- number: H24412245737
+ number: H69306138629
tracking: U10000
tracking_url:
cost: '10.0'
@@ -5785,7 +5992,7 @@ paths:
display_tax_total: "$0.00"
status: shipped
fulfillment_type: shipping
- fulfilled_at: '2026-05-26T12:43:23Z'
+ fulfilled_at: '2026-05-26T16:12:35Z'
items:
- item_id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
@@ -5793,8 +6000,8 @@ paths:
metadata: {}
adjustment_total: '0.0'
pre_tax_amount: '0.0'
- created_at: '2026-05-26T12:43:22.946Z'
- updated_at: '2026-05-26T12:43:23.313Z'
+ created_at: '2026-05-26T16:12:34.928Z'
+ updated_at: '2026-05-26T16:12:35.370Z'
order_id: or_UkLWZg9DAJ
stock_location_id: sloc_UkLWZg9DAJ
"/api/v3/admin/orders/{order_id}/fulfillments/{id}/cancel":
@@ -5852,7 +6059,7 @@ paths:
application/json:
example:
id: ful_UkLWZg9DAJ
- number: H57549274092
+ number: H79577206102
tracking: U10000
tracking_url:
cost: '10.0'
@@ -5877,8 +6084,8 @@ paths:
metadata: {}
adjustment_total: '0.0'
pre_tax_amount: '0.0'
- created_at: '2026-05-26T12:43:23.670Z'
- updated_at: '2026-05-26T12:43:24.005Z'
+ created_at: '2026-05-26T16:12:35.712Z'
+ updated_at: '2026-05-26T16:12:36.066Z'
order_id: or_UkLWZg9DAJ
stock_location_id: sloc_UkLWZg9DAJ
"/api/v3/admin/orders/{order_id}/fulfillments/{id}/resume":
@@ -5936,7 +6143,7 @@ paths:
application/json:
example:
id: ful_UkLWZg9DAJ
- number: H33252464732
+ number: H59689445550
tracking: U10000
tracking_url:
cost: '10.0'
@@ -5961,8 +6168,8 @@ paths:
metadata: {}
adjustment_total: '0.0'
pre_tax_amount: '0.0'
- created_at: '2026-05-26T12:43:24.327Z'
- updated_at: '2026-05-26T12:43:24.678Z'
+ created_at: '2026-05-26T16:12:36.394Z'
+ updated_at: '2026-05-26T16:12:36.772Z'
order_id: or_UkLWZg9DAJ
stock_location_id: sloc_UkLWZg9DAJ
"/api/v3/admin/orders/{order_id}/fulfillments/{id}/split":
@@ -6023,7 +6230,7 @@ paths:
example:
data:
- id: ful_gbHJdmfrXB
- number: H76063483327
+ number: H53323829337
tracking:
tracking_url:
cost: '10.0'
@@ -6048,8 +6255,8 @@ paths:
metadata: {}
adjustment_total: '0.0'
pre_tax_amount: '0.0'
- created_at: '2026-05-26T12:43:25.353Z'
- updated_at: '2026-05-26T12:43:25.395Z'
+ created_at: '2026-05-26T16:12:37.468Z'
+ updated_at: '2026-05-26T16:12:37.514Z'
order_id: or_UkLWZg9DAJ
stock_location_id: sloc_gbHJdmfrXB
requestBody:
@@ -6121,7 +6328,7 @@ paths:
application/json:
example:
id: gc_UkLWZg9DAJ
- code: 000AFB3EB6BC1603
+ code: 7C74EE58D26F1DA3
status: active
currency: USD
amount: '10.0'
@@ -6135,8 +6342,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-05-26T12:43:25.722Z'
- updated_at: '2026-05-26T12:43:26.027Z'
+ created_at: '2026-05-26T16:12:37.861Z'
+ updated_at: '2026-05-26T16:12:38.166Z'
customer_id:
created_by_id:
requestBody:
@@ -6269,8 +6476,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 2
currency: USD
- name: Product 108818
- slug: product-108818
+ name: Product 106736
+ slug: product-106736
options_text: 'Size: S'
price: '10.0'
display_price: "$10.00"
@@ -6302,12 +6509,12 @@ paths:
option_type_label: Size
image_url:
metadata: {}
- created_at: '2026-05-26T12:43:26.704Z'
- updated_at: '2026-05-26T12:43:26.704Z'
+ created_at: '2026-05-26T16:12:38.865Z'
+ updated_at: '2026-05-26T16:12:38.865Z'
digital_links: []
metadata: {}
- created_at: '2026-05-26T12:43:26.991Z'
- updated_at: '2026-05-26T12:43:26.991Z'
+ created_at: '2026-05-26T16:12:39.158Z'
+ updated_at: '2026-05-26T16:12:39.158Z'
cost_price: '17.0'
tax_category_id: taxcat_UkLWZg9DAJ
meta:
@@ -6374,8 +6581,8 @@ paths:
variant_id: variant_VqXmZF31wY
quantity: 3
currency: USD
- name: Product 129518
- slug: product-129518
+ name: Product 126379
+ slug: product-126379
options_text: 'Size: S'
price: '19.99'
display_price: "$19.99"
@@ -6407,12 +6614,12 @@ paths:
option_type_label: Size
image_url:
metadata: {}
- created_at: '2026-05-26T12:43:27.918Z'
- updated_at: '2026-05-26T12:43:27.918Z'
+ created_at: '2026-05-26T16:12:40.169Z'
+ updated_at: '2026-05-26T16:12:40.169Z'
digital_links: []
metadata: {}
- created_at: '2026-05-26T12:43:27.951Z'
- updated_at: '2026-05-26T12:43:27.951Z'
+ created_at: '2026-05-26T16:12:40.233Z'
+ updated_at: '2026-05-26T16:12:40.233Z'
cost_price: '17.0'
tax_category_id: taxcat_UkLWZg9DAJ
requestBody:
@@ -6501,8 +6708,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 2
currency: USD
- name: Product 132864
- slug: product-132864
+ name: Product 132960
+ slug: product-132960
options_text: 'Size: S'
price: '10.0'
display_price: "$10.00"
@@ -6534,12 +6741,12 @@ paths:
option_type_label: Size
image_url:
metadata: {}
- created_at: '2026-05-26T12:43:28.018Z'
- updated_at: '2026-05-26T12:43:28.018Z'
+ created_at: '2026-05-26T16:12:40.319Z'
+ updated_at: '2026-05-26T16:12:40.319Z'
digital_links: []
metadata: {}
- created_at: '2026-05-26T12:43:28.304Z'
- updated_at: '2026-05-26T12:43:28.304Z'
+ created_at: '2026-05-26T16:12:40.672Z'
+ updated_at: '2026-05-26T16:12:40.672Z'
cost_price: '17.0'
tax_category_id: taxcat_UkLWZg9DAJ
patch:
@@ -6601,8 +6808,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 5
currency: USD
- name: Product 147088
- slug: product-147088
+ name: Product 142304
+ slug: product-142304
options_text: 'Size: S'
price: '19.99'
display_price: "$19.99"
@@ -6634,12 +6841,12 @@ paths:
option_type_label: Size
image_url:
metadata: {}
- created_at: '2026-05-26T12:43:28.621Z'
- updated_at: '2026-05-26T12:43:28.621Z'
+ created_at: '2026-05-26T16:12:41.005Z'
+ updated_at: '2026-05-26T16:12:41.005Z'
digital_links: []
metadata: {}
- created_at: '2026-05-26T12:43:28.907Z'
- updated_at: '2026-05-26T12:43:29.205Z'
+ created_at: '2026-05-26T16:12:41.293Z'
+ updated_at: '2026-05-26T16:12:41.588Z'
cost_price: '17.0'
tax_category_id: taxcat_UkLWZg9DAJ
requestBody:
@@ -6765,8 +6972,8 @@ paths:
data:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: BGS-558e57f5d744
- number: PNDTT9GC
+ response_code: BGS-fb554349125f
+ number: P1B8HOBK
amount: '110.0'
display_amount: "$110.00"
status: completed
@@ -6784,14 +6991,14 @@ paths:
customer_id:
payment_method_id: pm_gbHJdmfrXB
metadata: {}
- created_at: '2026-05-26T12:43:30.195Z'
- updated_at: '2026-05-26T12:43:30.197Z'
+ created_at: '2026-05-26T16:12:42.609Z'
+ updated_at: '2026-05-26T16:12:42.611Z'
metadata: {}
avs_response:
cvv_response_code:
cvv_response_message:
- created_at: '2026-05-26T12:43:30.196Z'
- updated_at: '2026-05-26T12:43:30.196Z'
+ created_at: '2026-05-26T16:12:42.610Z'
+ updated_at: '2026-05-26T16:12:42.610Z'
captured_amount: '0.0'
order_id: or_UkLWZg9DAJ
meta:
@@ -6858,7 +7065,7 @@ paths:
id: py_gbHJdmfrXB
payment_method_id: pm_EfhxLZ9ck8
response_code:
- number: PRLXLSE1
+ number: PYKPEF6D
amount: '110.0'
display_amount: "$110.00"
status: checkout
@@ -6869,8 +7076,8 @@ paths:
avs_response:
cvv_response_code:
cvv_response_message:
- created_at: '2026-05-26T12:43:31.503Z'
- updated_at: '2026-05-26T12:43:31.503Z'
+ created_at: '2026-05-26T16:12:44.021Z'
+ updated_at: '2026-05-26T16:12:44.021Z'
captured_amount: '0.0'
order_id: or_gbHJdmfrXB
requestBody:
@@ -6960,8 +7167,8 @@ paths:
example:
id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: BGS-d877df37d6f0
- number: P2VPLRI1
+ response_code: BGS-cb0e28824009
+ number: P5L7QR1T
amount: '110.0'
display_amount: "$110.00"
status: completed
@@ -6979,14 +7186,14 @@ paths:
customer_id:
payment_method_id: pm_gbHJdmfrXB
metadata: {}
- created_at: '2026-05-26T12:43:31.879Z'
- updated_at: '2026-05-26T12:43:31.882Z'
+ created_at: '2026-05-26T16:12:44.393Z'
+ updated_at: '2026-05-26T16:12:44.396Z'
metadata: {}
avs_response:
cvv_response_code:
cvv_response_message:
- created_at: '2026-05-26T12:43:31.881Z'
- updated_at: '2026-05-26T12:43:31.881Z'
+ created_at: '2026-05-26T16:12:44.395Z'
+ updated_at: '2026-05-26T16:12:44.395Z'
captured_amount: '0.0'
order_id: or_UkLWZg9DAJ
"/api/v3/admin/orders/{order_id}/payments/{id}/capture":
@@ -7045,8 +7252,8 @@ paths:
example:
id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: BGS-854a246a7c2d
- number: PIJ45Z2M
+ response_code: BGS-bce1b7b66ee7
+ number: P5QPPK46
amount: '110.0'
display_amount: "$110.00"
status: completed
@@ -7064,14 +7271,14 @@ paths:
customer_id:
payment_method_id: pm_gbHJdmfrXB
metadata: {}
- created_at: '2026-05-26T12:43:32.537Z'
- updated_at: '2026-05-26T12:43:32.539Z'
+ created_at: '2026-05-26T16:12:45.123Z'
+ updated_at: '2026-05-26T16:12:45.126Z'
metadata: {}
avs_response:
cvv_response_code:
cvv_response_message:
- created_at: '2026-05-26T12:43:32.538Z'
- updated_at: '2026-05-26T12:43:32.866Z'
+ created_at: '2026-05-26T16:12:45.125Z'
+ updated_at: '2026-05-26T16:12:45.459Z'
captured_amount: '110.0'
order_id: or_UkLWZg9DAJ
'422':
@@ -7140,8 +7347,8 @@ paths:
example:
id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: void-BGS-2ed11968ee67
- number: PA0YA2SB
+ response_code: void-BGS-2cd9f486d559
+ number: PN45KFXM
amount: '110.0'
display_amount: "$110.00"
status: void
@@ -7159,14 +7366,14 @@ paths:
customer_id:
payment_method_id: pm_gbHJdmfrXB
metadata: {}
- created_at: '2026-05-26T12:43:33.925Z'
- updated_at: '2026-05-26T12:43:33.928Z'
+ created_at: '2026-05-26T16:12:46.548Z'
+ updated_at: '2026-05-26T16:12:46.550Z'
metadata: {}
avs_response:
cvv_response_code:
cvv_response_message:
- created_at: '2026-05-26T12:43:33.927Z'
- updated_at: '2026-05-26T12:43:34.225Z'
+ created_at: '2026-05-26T16:12:46.549Z'
+ updated_at: '2026-05-26T16:12:46.857Z'
captured_amount: '0.0'
order_id: or_UkLWZg9DAJ
"/api/v3/admin/orders/{order_id}/refunds":
@@ -7294,14 +7501,14 @@ paths:
application/json:
example:
id: re_UkLWZg9DAJ
- transaction_id: BGS-8f6bb1510833
+ transaction_id: BGS-47496253cbfc
amount: '5.0'
payment_id: py_UkLWZg9DAJ
refund_reason_id: rr_UkLWZg9DAJ
reimbursement_id:
metadata: {}
- created_at: '2026-05-26T12:43:35.559Z'
- updated_at: '2026-05-26T12:43:35.559Z'
+ created_at: '2026-05-26T16:12:48.332Z'
+ updated_at: '2026-05-26T16:12:48.332Z'
requestBody:
content:
application/json:
@@ -7373,8 +7580,8 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R911948765
+ number: R261232121
customer_note:
currency: USD
locale: en
@@ -7417,8 +7624,8 @@ paths:
metadata: {}
canceled_at:
approved_at:
- created_at: '2026-05-26T12:43:35.855Z'
- updated_at: '2026-05-26T12:43:35.906Z'
+ created_at: '2026-05-26T16:12:48.631Z'
+ updated_at: '2026-05-26T16:12:48.679Z'
preferred_stock_location_id:
tags: []
internal_note:
@@ -7589,8 +7796,8 @@ paths:
- id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R530084501
+ number: R429606837
customer_note:
currency: USD
locale: en
@@ -7633,8 +7840,8 @@ paths:
metadata: {}
canceled_at:
approved_at:
- created_at: '2026-05-26T12:43:37.653Z'
- updated_at: '2026-05-26T12:43:37.653Z'
+ created_at: '2026-05-26T16:12:50.490Z'
+ updated_at: '2026-05-26T16:12:50.490Z'
preferred_stock_location_id:
tags: []
internal_note:
@@ -7777,7 +7984,7 @@ paths:
id: or_gbHJdmfrXB
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R383898514
+ number: R970412419
customer_note:
currency: USD
@@ -7821,8 +8028,8 @@ paths:
metadata: {}
canceled_at:
approved_at:
- created_at: '2026-05-26T12:43:39.336Z'
- updated_at: '2026-05-26T12:43:39.338Z'
+ created_at: '2026-05-26T16:12:52.257Z'
+ updated_at: '2026-05-26T16:12:52.260Z'
preferred_stock_location_id: sloc_UkLWZg9DAJ
tags: []
internal_note:
@@ -8006,8 +8213,8 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R366457856
+ number: R192431263
customer_note:
currency: USD
locale: en
@@ -8050,8 +8257,8 @@ paths:
metadata: {}
canceled_at:
approved_at:
- created_at: '2026-05-26T12:43:39.618Z'
- updated_at: '2026-05-26T12:43:39.618Z'
+ created_at: '2026-05-26T16:12:52.542Z'
+ updated_at: '2026-05-26T16:12:52.542Z'
preferred_stock_location_id:
tags: []
internal_note:
@@ -8122,7 +8329,7 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R554622571
+ number: R080725845
customer_note:
currency: USD
@@ -8166,8 +8373,8 @@ paths:
metadata: {}
canceled_at:
approved_at:
- created_at: '2026-05-26T12:43:40.726Z'
- updated_at: '2026-05-26T12:43:41.017Z'
+ created_at: '2026-05-26T16:12:53.885Z'
+ updated_at: '2026-05-26T16:12:54.237Z'
preferred_stock_location_id:
tags: []
internal_note:
@@ -8348,8 +8555,8 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R277721850
+ number: R195995246
customer_note:
currency: USD
locale: en
@@ -8376,7 +8583,7 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status: ready
payment_status: paid
- completed_at: '2026-05-26T12:43:41.913Z'
+ completed_at: '2026-05-26T16:12:55.560Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -8392,8 +8599,8 @@ paths:
metadata: {}
canceled_at:
approved_at:
- created_at: '2026-05-26T12:43:41.861Z'
- updated_at: '2026-05-26T12:43:41.939Z'
+ created_at: '2026-05-26T16:12:55.464Z'
+ updated_at: '2026-05-26T16:12:55.607Z'
preferred_stock_location_id:
tags: []
internal_note:
@@ -8474,8 +8681,8 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R820951567
+ number: R675496720
customer_note:
currency: USD
locale: en
@@ -8502,7 +8709,7 @@ paths:
display_delivery_total: "$10.00"
fulfillment_status: canceled
payment_status: void
- completed_at: '2026-05-26T12:43:43.178Z'
+ completed_at: '2026-05-26T16:12:57.041Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -8516,10 +8723,10 @@ paths:
payment_total: '0.0'
display_payment_total: "$0.00"
metadata: {}
- canceled_at: '2026-05-26T12:43:43.471Z'
+ canceled_at: '2026-05-26T16:12:57.344Z'
approved_at:
- created_at: '2026-05-26T12:43:43.130Z'
- updated_at: '2026-05-26T12:43:43.511Z'
+ created_at: '2026-05-26T16:12:56.979Z'
+ updated_at: '2026-05-26T16:12:57.419Z'
preferred_stock_location_id:
tags: []
internal_note:
@@ -8578,8 +8785,8 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R358980474
+ number: R677992716
customer_note:
currency: USD
locale: en
@@ -8606,7 +8813,7 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-05-26T12:43:43.853Z'
+ completed_at: '2026-05-26T16:12:57.795Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -8621,9 +8828,9 @@ paths:
display_payment_total: "$0.00"
metadata: {}
canceled_at:
- approved_at: '2026-05-26T12:43:44.139Z'
- created_at: '2026-05-26T12:43:43.804Z'
- updated_at: '2026-05-26T12:43:43.853Z'
+ approved_at: '2026-05-26T16:12:58.093Z'
+ created_at: '2026-05-26T16:12:57.737Z'
+ updated_at: '2026-05-26T16:12:57.795Z'
preferred_stock_location_id:
tags: []
internal_note:
@@ -8682,8 +8889,8 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R199529795
+ number: R763215454
customer_note:
currency: USD
locale: en
@@ -8710,7 +8917,7 @@ paths:
display_delivery_total: "$10.00"
fulfillment_status: canceled
payment_status: void
- completed_at: '2026-05-26T12:43:44.485Z'
+ completed_at: '2026-05-26T16:12:58.511Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -8724,10 +8931,10 @@ paths:
payment_total: '0.0'
display_payment_total: "$0.00"
metadata: {}
- canceled_at: '2026-05-26T12:43:44.762Z'
+ canceled_at: '2026-05-26T16:12:58.808Z'
approved_at:
- created_at: '2026-05-26T12:43:44.432Z'
- updated_at: '2026-05-26T12:43:44.844Z'
+ created_at: '2026-05-26T16:12:58.441Z'
+ updated_at: '2026-05-26T16:12:58.901Z'
preferred_stock_location_id:
tags: []
internal_note:
@@ -8786,8 +8993,8 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R108673461
+ number: R416458573
customer_note:
currency: USD
locale: en
@@ -8814,7 +9021,7 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-05-26T12:43:45.173Z'
+ completed_at: '2026-05-26T16:12:59.293Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -8830,8 +9037,8 @@ paths:
metadata: {}
canceled_at:
approved_at:
- created_at: '2026-05-26T12:43:45.123Z'
- updated_at: '2026-05-26T12:43:45.173Z'
+ created_at: '2026-05-26T16:12:59.204Z'
+ updated_at: '2026-05-26T16:12:59.293Z'
preferred_stock_location_id:
tags: []
internal_note:
@@ -8906,8 +9113,8 @@ paths:
auto_capture:
storefront_visible: true
position: 1
- created_at: '2026-05-26T12:43:45.478Z'
- updated_at: '2026-05-26T12:43:45.480Z'
+ created_at: '2026-05-26T16:12:59.601Z'
+ updated_at: '2026-05-26T16:12:59.602Z'
preferences: {}
preference_schema: []
meta:
@@ -9047,8 +9254,8 @@ paths:
auto_capture:
storefront_visible: true
position: 1
- created_at: '2026-05-26T12:43:46.061Z'
- updated_at: '2026-05-26T12:43:46.062Z'
+ created_at: '2026-05-26T16:13:00.235Z'
+ updated_at: '2026-05-26T16:13:00.237Z'
preferences: {}
preference_schema: []
"/api/v3/admin/price_lists":
@@ -9121,8 +9328,8 @@ paths:
starts_at:
ends_at:
deleted_at:
- created_at: '2026-05-26T12:43:46.345Z'
- updated_at: '2026-05-26T12:43:46.345Z'
+ created_at: '2026-05-26T16:13:00.549Z'
+ updated_at: '2026-05-26T16:13:00.549Z'
currently_active: false
products_count: 0
prices_count: 0
@@ -9136,8 +9343,8 @@ paths:
starts_at:
ends_at:
deleted_at:
- created_at: '2026-05-26T12:43:46.346Z'
- updated_at: '2026-05-26T12:43:46.346Z'
+ created_at: '2026-05-26T16:13:00.551Z'
+ updated_at: '2026-05-26T16:13:00.551Z'
currently_active: false
products_count: 0
prices_count: 0
@@ -9201,8 +9408,8 @@ paths:
starts_at:
ends_at:
deleted_at:
- created_at: '2026-05-26T12:43:47.340Z'
- updated_at: '2026-05-26T12:43:47.342Z'
+ created_at: '2026-05-26T16:13:01.662Z'
+ updated_at: '2026-05-26T16:13:01.664Z'
currently_active: false
products_count: 1
prices_count: 2
@@ -9350,8 +9557,8 @@ paths:
starts_at:
ends_at:
deleted_at:
- created_at: '2026-05-26T12:43:47.639Z'
- updated_at: '2026-05-26T12:43:47.639Z'
+ created_at: '2026-05-26T16:13:02.010Z'
+ updated_at: '2026-05-26T16:13:02.010Z'
currently_active: false
products_count: 0
prices_count: 0
@@ -9409,8 +9616,8 @@ paths:
starts_at:
ends_at:
deleted_at:
- created_at: '2026-05-26T12:43:49.202Z'
- updated_at: '2026-05-26T12:43:49.480Z'
+ created_at: '2026-05-26T16:13:03.739Z'
+ updated_at: '2026-05-26T16:13:04.021Z'
currently_active: false
products_count: 0
prices_count: 0
@@ -9568,8 +9775,8 @@ paths:
starts_at:
ends_at:
deleted_at:
- created_at: '2026-05-26T12:43:49.788Z'
- updated_at: '2026-05-26T12:43:50.099Z'
+ created_at: '2026-05-26T16:13:04.320Z'
+ updated_at: '2026-05-26T16:13:04.604Z'
currently_active: true
products_count: 0
prices_count: 0
@@ -9617,8 +9824,8 @@ paths:
starts_at:
ends_at:
deleted_at:
- created_at: '2026-05-26T12:43:50.129Z'
- updated_at: '2026-05-26T12:43:50.432Z'
+ created_at: '2026-05-26T16:13:04.612Z'
+ updated_at: '2026-05-26T16:13:04.892Z'
currently_active: false
products_count: 0
prices_count: 0
@@ -9729,8 +9936,8 @@ paths:
display_compare_at_amount:
price_list_id:
variant_id: variant_gbHJdmfrXB
- created_at: '2026-05-26T12:43:50.504Z'
- updated_at: '2026-05-26T12:43:50.504Z'
+ created_at: '2026-05-26T16:13:04.948Z'
+ updated_at: '2026-05-26T16:13:04.948Z'
- id: price_EfhxLZ9ck8
amount: '5.0'
amount_in_cents: 500
@@ -9741,8 +9948,8 @@ paths:
display_compare_at_amount:
price_list_id: pl_UkLWZg9DAJ
variant_id: variant_gbHJdmfrXB
- created_at: '2026-05-26T12:43:50.508Z'
- updated_at: '2026-05-26T12:43:50.508Z'
+ created_at: '2026-05-26T16:13:04.955Z'
+ updated_at: '2026-05-26T16:13:04.955Z'
meta:
page: 1
limit: 25
@@ -9821,8 +10028,8 @@ paths:
display_compare_at_amount:
price_list_id:
variant_id: variant_EfhxLZ9ck8
- created_at: '2026-05-26T12:43:51.148Z'
- updated_at: '2026-05-26T12:43:51.148Z'
+ created_at: '2026-05-26T16:13:05.688Z'
+ updated_at: '2026-05-26T16:13:05.688Z'
schema:
"$ref": "#/components/schemas/Price"
requestBody:
@@ -9906,8 +10113,8 @@ paths:
display_compare_at_amount:
price_list_id: pl_UkLWZg9DAJ
variant_id: variant_gbHJdmfrXB
- created_at: '2026-05-26T12:43:51.216Z'
- updated_at: '2026-05-26T12:43:51.216Z'
+ created_at: '2026-05-26T16:13:05.792Z'
+ updated_at: '2026-05-26T16:13:05.792Z'
schema:
"$ref": "#/components/schemas/Price"
'404':
@@ -9969,8 +10176,8 @@ paths:
display_compare_at_amount:
price_list_id: pl_UkLWZg9DAJ
variant_id: variant_gbHJdmfrXB
- created_at: '2026-05-26T12:43:51.895Z'
- updated_at: '2026-05-26T12:43:52.182Z'
+ created_at: '2026-05-26T16:13:06.598Z'
+ updated_at: '2026-05-26T16:13:06.880Z'
schema:
"$ref": "#/components/schemas/Price"
requestBody:
@@ -10270,8 +10477,8 @@ paths:
field_type: short_text
key: custom.title
value: wool
- created_at: '2026-05-26T12:43:53.647Z'
- updated_at: '2026-05-26T12:43:53.647Z'
+ created_at: '2026-05-26T16:13:08.426Z'
+ updated_at: '2026-05-26T16:13:08.426Z'
storefront_visible: true
custom_field_definition_id: cfdef_UkLWZg9DAJ
meta:
@@ -10338,8 +10545,8 @@ paths:
field_type: long_text
key: custom.description
value: A longer description
- created_at: '2026-05-26T12:43:54.246Z'
- updated_at: '2026-05-26T12:43:54.246Z'
+ created_at: '2026-05-26T16:13:09.086Z'
+ updated_at: '2026-05-26T16:13:09.086Z'
storefront_visible: true
custom_field_definition_id: cfdef_gbHJdmfrXB
'422':
@@ -10423,8 +10630,8 @@ paths:
field_type: short_text
key: custom.title
value: wool
- created_at: '2026-05-26T12:43:54.597Z'
- updated_at: '2026-05-26T12:43:54.597Z'
+ created_at: '2026-05-26T16:13:09.478Z'
+ updated_at: '2026-05-26T16:13:09.478Z'
storefront_visible: true
custom_field_definition_id: cfdef_UkLWZg9DAJ
patch:
@@ -10471,8 +10678,8 @@ paths:
field_type: short_text
key: custom.title
value: cotton
- created_at: '2026-05-26T12:43:54.908Z'
- updated_at: '2026-05-26T12:43:55.194Z'
+ created_at: '2026-05-26T16:13:09.877Z'
+ updated_at: '2026-05-26T16:13:10.226Z'
storefront_visible: true
custom_field_definition_id: cfdef_UkLWZg9DAJ
requestBody:
@@ -10610,28 +10817,33 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 555940
- slug: product-555940
+ name: Product 551779
+ slug: product-551779
meta_title:
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-05-26T12:43:55.526Z'
+ available_on: '2025-05-26T16:13:10.601Z'
purchasable: true
in_stock: false
backorderable: true
available: true
- description: Sed officiis delectus neque eos tempore. Voluptatum
- tenetur reprehenderit enim cum itaque ea aut voluptatibus. Iste
- sequi explicabo rem placeat modi reprehenderit perspiciatis. Consectetur
- eveniet iure numquam vitae repellendus fuga. Illum eaque suscipit
- dolor aspernatur aperiam itaque sed. Id quia eius praesentium
- accusamus deserunt placeat. Blanditiis culpa necessitatibus eligendi
- quos explicabo temporibus iusto neque. Blanditiis ratione enim
- dignissimos laudantium fugit.
+ description: Doloribus sed culpa exercitationem harum explicabo.
+ Esse minus repudiandae dicta commodi tenetur possimus. Ut illum
+ officia sequi non aliquam. Laboriosam rem error debitis impedit
+ dolorum mollitia. Vel eos ducimus nemo sed repellat quae ex. Libero
+ quae voluptas voluptatibus occaecati quo minima natus esse. Nihil
+ facilis autem suscipit pariatur. Exercitationem nostrum sint distinctio
+ minima. Sit eveniet voluptate impedit adipisci eum. In maxime
+ iure veniam laudantium hic repellendus at sed. Et magni veniam
+ ea molestiae reprehenderit hic eius ex. Sed at soluta iusto vitae
+ impedit modi atque. Facere quia iure eligendi deleniti optio.
+ Dolorem occaecati fuga omnis officiis deleniti.
description_html: |-
- Sed officiis delectus neque eos tempore. Voluptatum tenetur reprehenderit enim cum itaque ea aut voluptatibus. Iste sequi explicabo rem placeat modi reprehenderit perspiciatis. Consectetur eveniet iure numquam vitae repellendus fuga. Illum eaque suscipit dolor aspernatur aperiam itaque sed.
- Id quia eius praesentium accusamus deserunt placeat. Blanditiis culpa necessitatibus eligendi quos explicabo temporibus iusto neque. Blanditiis ratione enim dignissimos laudantium fugit.
+ Doloribus sed culpa exercitationem harum explicabo. Esse minus repudiandae dicta commodi tenetur possimus. Ut illum officia sequi non aliquam.
+ Laboriosam rem error debitis impedit dolorum mollitia. Vel eos ducimus nemo sed repellat quae ex. Libero quae voluptas voluptatibus occaecati quo minima natus esse. Nihil facilis autem suscipit pariatur. Exercitationem nostrum sint distinctio minima.
+ Sit eveniet voluptate impedit adipisci eum. In maxime iure veniam laudantium hic repellendus at sed. Et magni veniam ea molestiae reprehenderit hic eius ex.
+ Sed at soluta iusto vitae impedit modi atque. Facere quia iure eligendi deleniti optio. Dolorem occaecati fuga omnis officiis deleniti.
default_variant_id: variant_UkLWZg9DAJ
thumbnail_url:
tags: []
@@ -10646,16 +10858,16 @@ paths:
display_compare_at_amount:
price_list_id:
variant_id: variant_UkLWZg9DAJ
- created_at: '2026-05-26T12:43:55.554Z'
- updated_at: '2026-05-26T12:43:55.554Z'
+ created_at: '2026-05-26T16:13:10.629Z'
+ updated_at: '2026-05-26T16:13:10.629Z'
original_price:
status: active
- make_active_at: '2025-05-26T12:43:55.526Z'
+ make_active_at: '2025-05-26T16:13:10.601Z'
discontinue_on:
metadata: {}
deleted_at:
- created_at: '2026-05-26T12:43:55.540Z'
- updated_at: '2026-05-26T12:43:55.555Z'
+ created_at: '2026-05-26T16:13:10.615Z'
+ updated_at: '2026-05-26T16:13:10.630Z'
tax_category_id: taxcat_UkLWZg9DAJ
meta:
page: 1
@@ -10789,8 +11001,8 @@ paths:
discontinue_on:
metadata: {}
deleted_at:
- created_at: '2026-05-26T12:43:56.215Z'
- updated_at: '2026-05-26T12:43:56.218Z'
+ created_at: '2026-05-26T16:13:11.307Z'
+ updated_at: '2026-05-26T16:13:11.309Z'
tax_category_id:
schema:
"$ref": "#/components/schemas/Product"
@@ -10970,28 +11182,35 @@ paths:
application/json:
example:
id: prod_UkLWZg9DAJ
- name: Product 599015
- slug: product-599015
+ name: Product 591287
+ slug: product-591287
meta_title:
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-05-26T12:43:56.578Z'
+ available_on: '2025-05-26T16:13:11.678Z'
purchasable: true
in_stock: false
backorderable: true
available: true
- description: Laudantium eius ea quasi recusandae vero. Nihil officia
- culpa voluptatum iusto. Tempore delectus sint minus aliquam doloribus
- quos libero. Iusto dolorum nemo alias porro modi officia fugit rerum.
- Aut facilis debitis provident omnis rerum eligendi eum a. Quam quaerat
- maiores hic aliquid perspiciatis dolorum commodi dolor. Molestiae
- provident porro expedita cupiditate asperiores adipisci dolor. Officiis
- beatae ut accusantium laborum enim sunt ex illo. Numquam natus odio
- officiis dolore nulla.
+ description: Ab vero perspiciatis repellat rem aspernatur minus. Recusandae
+ suscipit facilis culpa sunt inventore. Nemo soluta at qui eligendi
+ eveniet cumque consectetur. Omnis iure labore asperiores illo optio
+ consequatur. Sint fugit nulla atque inventore illo exercitationem.
+ Rem magnam iure porro quisquam. Laboriosam magnam vero possimus
+ incidunt harum. Aut harum doloribus alias nam eligendi numquam ducimus.
+ Ad sapiente magnam id illo consequuntur quod consectetur. Nesciunt
+ nemo commodi laborum corrupti architecto voluptatum eveniet. Libero
+ possimus optio totam cumque quasi iusto inventore. Ea amet quos
+ explicabo corporis. Unde deserunt rerum minima blanditiis repudiandae
+ tenetur amet. Atque reprehenderit recusandae cupiditate quis modi
+ error laboriosam repudiandae. Recusandae modi ipsam suscipit autem
+ perferendis eum error illum.
description_html: |-
- Laudantium eius ea quasi recusandae vero. Nihil officia culpa voluptatum iusto. Tempore delectus sint minus aliquam doloribus quos libero. Iusto dolorum nemo alias porro modi officia fugit rerum.
- Aut facilis debitis provident omnis rerum eligendi eum a. Quam quaerat maiores hic aliquid perspiciatis dolorum commodi dolor. Molestiae provident porro expedita cupiditate asperiores adipisci dolor. Officiis beatae ut accusantium laborum enim sunt ex illo. Numquam natus odio officiis dolore nulla.
+ Ab vero perspiciatis repellat rem aspernatur minus. Recusandae suscipit facilis culpa sunt inventore. Nemo soluta at qui eligendi eveniet cumque consectetur.
+ Omnis iure labore asperiores illo optio consequatur. Sint fugit nulla atque inventore illo exercitationem. Rem magnam iure porro quisquam. Laboriosam magnam vero possimus incidunt harum. Aut harum doloribus alias nam eligendi numquam ducimus.
+ Ad sapiente magnam id illo consequuntur quod consectetur. Nesciunt nemo commodi laborum corrupti architecto voluptatum eveniet. Libero possimus optio totam cumque quasi iusto inventore.
+ Ea amet quos explicabo corporis. Unde deserunt rerum minima blanditiis repudiandae tenetur amet. Atque reprehenderit recusandae cupiditate quis modi error laboriosam repudiandae. Recusandae modi ipsam suscipit autem perferendis eum error illum.
default_variant_id: variant_UkLWZg9DAJ
thumbnail_url:
tags: []
@@ -11006,16 +11225,16 @@ paths:
display_compare_at_amount:
price_list_id:
variant_id: variant_UkLWZg9DAJ
- created_at: '2026-05-26T12:43:56.602Z'
- updated_at: '2026-05-26T12:43:56.602Z'
+ created_at: '2026-05-26T16:13:11.709Z'
+ updated_at: '2026-05-26T16:13:11.709Z'
original_price:
status: active
- make_active_at: '2025-05-26T12:43:56.578Z'
+ make_active_at: '2025-05-26T16:13:11.678Z'
discontinue_on:
metadata: {}
deleted_at:
- created_at: '2026-05-26T12:43:56.590Z'
- updated_at: '2026-05-26T12:43:56.603Z'
+ created_at: '2026-05-26T16:13:11.693Z'
+ updated_at: '2026-05-26T16:13:11.710Z'
tax_category_id: taxcat_UkLWZg9DAJ
schema:
"$ref": "#/components/schemas/Product"
@@ -11082,28 +11301,22 @@ paths:
example:
id: prod_UkLWZg9DAJ
name: Updated Name
- slug: product-614078
+ slug: product-619152
meta_title:
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-05-26T12:43:57.210Z'
+ available_on: '2025-05-26T16:13:12.328Z'
purchasable: true
in_stock: false
backorderable: true
available: true
- description: Expedita officia vero atque saepe voluptatem. Cumque
- explicabo totam vitae similique alias. Sed dolore ipsa dolorum quae.
- Vero accusamus officia ea expedita. Quisquam modi quos rem ad. Dolorum
- qui quam animi explicabo vitae molestias. Iusto labore doloribus
- iste fugit nemo unde dignissimos. Distinctio illum ab ipsam omnis
- eaque nam. Tempore impedit nulla voluptatem autem sint aliquam.
- Voluptates eos quaerat similique quisquam facere unde culpa. Molestias
- ea ducimus sapiente architecto inventore sint officiis cumque.
- description_html: |-
- Expedita officia vero atque saepe voluptatem. Cumque explicabo totam vitae similique alias. Sed dolore ipsa dolorum quae.
- Vero accusamus officia ea expedita. Quisquam modi quos rem ad. Dolorum qui quam animi explicabo vitae molestias.
- Iusto labore doloribus iste fugit nemo unde dignissimos. Distinctio illum ab ipsam omnis eaque nam. Tempore impedit nulla voluptatem autem sint aliquam. Voluptates eos quaerat similique quisquam facere unde culpa. Molestias ea ducimus sapiente architecto inventore sint officiis cumque.
+ description: Veritatis quibusdam quisquam nisi doloremque asperiores.
+ Corrupti dolorem sequi odit cumque vero totam. Architecto exercitationem
+ minus nemo blanditiis iure numquam eaque.
+ description_html: Veritatis quibusdam quisquam nisi doloremque asperiores.
+ Corrupti dolorem sequi odit cumque vero totam. Architecto exercitationem
+ minus nemo blanditiis iure numquam eaque.
default_variant_id: variant_UkLWZg9DAJ
thumbnail_url:
tags: []
@@ -11118,16 +11331,16 @@ paths:
display_compare_at_amount:
price_list_id:
variant_id: variant_UkLWZg9DAJ
- created_at: '2026-05-26T12:43:57.235Z'
- updated_at: '2026-05-26T12:43:57.235Z'
+ created_at: '2026-05-26T16:13:12.353Z'
+ updated_at: '2026-05-26T16:13:12.353Z'
original_price:
status: active
- make_active_at: '2025-05-26T12:43:57.210Z'
+ make_active_at: '2025-05-26T16:13:12.328Z'
discontinue_on:
metadata: {}
deleted_at:
- created_at: '2026-05-26T12:43:57.223Z'
- updated_at: '2026-05-26T12:43:57.528Z'
+ created_at: '2026-05-26T16:13:12.341Z'
+ updated_at: '2026-05-26T16:13:12.644Z'
tax_category_id: taxcat_UkLWZg9DAJ
schema:
"$ref": "#/components/schemas/Product"
@@ -11660,8 +11873,8 @@ paths:
example:
data:
- id: pact_UkLWZg9DAJ
- created_at: '2026-05-26T12:44:00.929Z'
- updated_at: '2026-05-26T12:44:00.929Z'
+ created_at: '2026-05-26T16:13:16.258Z'
+ updated_at: '2026-05-26T16:13:16.258Z'
type: free_shipping
promotion_id: promo_UkLWZg9DAJ
preferences: {}
@@ -11722,8 +11935,8 @@ paths:
application/json:
example:
id: pact_UkLWZg9DAJ
- created_at: '2026-05-26T12:44:01.503Z'
- updated_at: '2026-05-26T12:44:01.503Z'
+ created_at: '2026-05-26T16:13:16.825Z'
+ updated_at: '2026-05-26T16:13:16.825Z'
type: free_shipping
promotion_id: promo_UkLWZg9DAJ
preferences: {}
@@ -11833,8 +12046,8 @@ paths:
example:
data:
- id: prorule_UkLWZg9DAJ
- created_at: '2026-05-26T12:44:02.087Z'
- updated_at: '2026-05-26T12:44:02.087Z'
+ created_at: '2026-05-26T16:13:17.409Z'
+ updated_at: '2026-05-26T16:13:17.409Z'
type: currency
promotion_id: promo_UkLWZg9DAJ
preferences:
@@ -11901,8 +12114,8 @@ paths:
application/json:
example:
id: prorule_UkLWZg9DAJ
- created_at: '2026-05-26T12:44:02.661Z'
- updated_at: '2026-05-26T12:44:02.661Z'
+ created_at: '2026-05-26T16:13:17.988Z'
+ updated_at: '2026-05-26T16:13:17.988Z'
type: currency
promotion_id: promo_UkLWZg9DAJ
preferences:
@@ -11975,8 +12188,8 @@ paths:
application/json:
example:
id: prorule_UkLWZg9DAJ
- created_at: '2026-05-26T12:44:02.954Z'
- updated_at: '2026-05-26T12:44:03.236Z'
+ created_at: '2026-05-26T16:13:18.276Z'
+ updated_at: '2026-05-26T16:13:18.552Z'
type: currency
promotion_id: promo_UkLWZg9DAJ
preferences:
@@ -12066,7 +12279,7 @@ paths:
name: Summer Sale
description:
code: summer
- starts_at: '2026-05-26T12:44:03.527Z'
+ starts_at: '2026-05-26T16:13:18.839Z'
expires_at:
usage_limit:
match_policy: all
@@ -12077,8 +12290,8 @@ paths:
code_prefix:
promotion_category_id:
metadata: {}
- created_at: '2026-05-26T12:44:03.529Z'
- updated_at: '2026-05-26T12:44:03.530Z'
+ created_at: '2026-05-26T16:13:18.840Z'
+ updated_at: '2026-05-26T16:13:18.841Z'
store_ids:
- store_UkLWZg9DAJ
action_ids: []
@@ -12184,7 +12397,7 @@ paths:
name: Black Friday
description:
code: blackfriday-os
- starts_at: '2026-05-26T12:44:04.446Z'
+ starts_at: '2026-05-26T16:13:19.743Z'
expires_at:
usage_limit:
match_policy: all
@@ -12195,8 +12408,8 @@ paths:
code_prefix:
promotion_category_id:
metadata: {}
- created_at: '2026-05-26T12:44:04.447Z'
- updated_at: '2026-05-26T12:44:04.468Z'
+ created_at: '2026-05-26T16:13:19.744Z'
+ updated_at: '2026-05-26T16:13:19.763Z'
store_ids:
- store_UkLWZg9DAJ
action_ids:
@@ -12349,7 +12562,7 @@ paths:
name: Summer Sale
description:
code: summer
- starts_at: '2026-05-26T12:44:04.762Z'
+ starts_at: '2026-05-26T16:13:20.066Z'
expires_at:
usage_limit:
match_policy: all
@@ -12360,8 +12573,8 @@ paths:
code_prefix:
promotion_category_id:
metadata: {}
- created_at: '2026-05-26T12:44:04.762Z'
- updated_at: '2026-05-26T12:44:04.763Z'
+ created_at: '2026-05-26T16:13:20.066Z'
+ updated_at: '2026-05-26T16:13:20.067Z'
store_ids:
- store_UkLWZg9DAJ
action_ids: []
@@ -12457,7 +12670,7 @@ paths:
name: Summer Sale
description:
code: summer
- starts_at: '2026-05-26T12:44:05.647Z'
+ starts_at: '2026-05-26T16:13:20.943Z'
expires_at:
usage_limit:
match_policy: all
@@ -12468,8 +12681,8 @@ paths:
code_prefix:
promotion_category_id:
metadata: {}
- created_at: '2026-05-26T12:44:05.648Z'
- updated_at: '2026-05-26T12:44:05.933Z'
+ created_at: '2026-05-26T16:13:20.944Z'
+ updated_at: '2026-05-26T16:13:21.228Z'
store_ids:
- store_UkLWZg9DAJ
action_ids: []
@@ -12705,15 +12918,15 @@ paths:
label: Country
description:
preference_schema:
+ - key: country_id
+ type: integer
+ default:
- key: country_iso
type: string
default:
- key: country_isos
type: array
default: []
- - key: country_id
- type: integer
- default:
- type: currency
label: Currency
description:
@@ -12821,8 +13034,8 @@ paths:
data:
- id: role_UkLWZg9DAJ
name: admin
- created_at: '2026-05-26T12:44:06.829Z'
- updated_at: '2026-05-26T12:44:06.829Z'
+ created_at: '2026-05-26T16:13:22.193Z'
+ updated_at: '2026-05-26T16:13:22.193Z'
meta:
page: 1
limit: 25
@@ -12957,8 +13170,8 @@ paths:
pickup_stock_policy: local
pickup_ready_in_minutes:
pickup_instructions:
- created_at: '2026-05-26T12:44:07.118Z'
- updated_at: '2026-05-26T12:44:07.118Z'
+ created_at: '2026-05-26T16:13:22.481Z'
+ updated_at: '2026-05-26T16:13:22.481Z'
meta:
page: 1
limit: 25
@@ -13069,8 +13282,8 @@ paths:
pickup_stock_policy: local
pickup_ready_in_minutes: 30
pickup_instructions:
- created_at: '2026-05-26T12:44:07.700Z'
- updated_at: '2026-05-26T12:44:07.700Z'
+ created_at: '2026-05-26T16:13:23.062Z'
+ updated_at: '2026-05-26T16:13:23.062Z'
schema:
"$ref": "#/components/schemas/StockLocation"
'422':
@@ -13244,8 +13457,8 @@ paths:
pickup_stock_policy: local
pickup_ready_in_minutes:
pickup_instructions:
- created_at: '2026-05-26T12:44:07.990Z'
- updated_at: '2026-05-26T12:44:07.990Z'
+ created_at: '2026-05-26T16:13:23.350Z'
+ updated_at: '2026-05-26T16:13:23.350Z'
schema:
"$ref": "#/components/schemas/StockLocation"
'404':
@@ -13330,8 +13543,8 @@ paths:
pickup_stock_policy: local
pickup_ready_in_minutes: 45
pickup_instructions:
- created_at: '2026-05-26T12:44:08.560Z'
- updated_at: '2026-05-26T12:44:08.838Z'
+ created_at: '2026-05-26T16:13:23.913Z'
+ updated_at: '2026-05-26T16:13:24.193Z'
schema:
"$ref": "#/components/schemas/StockLocation"
'422':
@@ -13534,8 +13747,8 @@ paths:
data:
- id: sccat_UkLWZg9DAJ
name: Goodwill
- created_at: '2026-05-26T12:44:09.415Z'
- updated_at: '2026-05-26T12:44:09.415Z'
+ created_at: '2026-05-26T16:13:24.773Z'
+ updated_at: '2026-05-26T16:13:24.773Z'
non_expiring: false
meta:
page: 1
@@ -13626,8 +13839,8 @@ paths:
example:
id: sccat_UkLWZg9DAJ
name: Goodwill
- created_at: '2026-05-26T12:44:09.714Z'
- updated_at: '2026-05-26T12:44:09.714Z'
+ created_at: '2026-05-26T16:13:25.067Z'
+ updated_at: '2026-05-26T16:13:25.067Z'
non_expiring: false
schema:
"$ref": "#/components/schemas/StoreCreditCategory"
@@ -13692,8 +13905,8 @@ paths:
preferred_timezone: UTC
preferred_weight_unit: lb
preferred_unit_system: imperial
- created_at: '2026-05-26T12:42:46.469Z'
- updated_at: '2026-05-26T12:44:10.290Z'
+ created_at: '2026-05-26T16:11:54.992Z'
+ updated_at: '2026-05-26T16:13:25.774Z'
url: http://www.example.com:3000
supported_currencies:
- USD
@@ -13764,8 +13977,8 @@ paths:
preferred_timezone: UTC
preferred_weight_unit: lb
preferred_unit_system: imperial
- created_at: '2026-05-26T12:42:46.469Z'
- updated_at: '2026-05-26T12:44:10.911Z'
+ created_at: '2026-05-26T16:11:54.992Z'
+ updated_at: '2026-05-26T16:13:26.386Z'
url: http://www.example.com:3000
supported_currencies:
- USD
@@ -13985,13 +14198,13 @@ paths:
weight_unit: lb
dimensions_unit:
deleted_at:
- created_at: '2026-05-26T12:44:12.335Z'
- updated_at: '2026-05-26T12:44:12.347Z'
+ created_at: '2026-05-26T16:13:27.811Z'
+ updated_at: '2026-05-26T16:13:27.825Z'
tax_category_id: taxcat_UkLWZg9DAJ
available_stock: 0
reserved_quantity: 0
total_on_hand: 0
- product_name: Product 752256
+ product_name: Product 753715
- id: variant_gbHJdmfrXB
product_id: prod_UkLWZg9DAJ
sku: SKU-94
@@ -14002,10 +14215,10 @@ paths:
purchasable: true
in_stock: false
backorderable: true
- weight: 89.39
- height: 90.94
- width: 173.91
- depth: 44.3
+ weight: 130.85
+ height: 166.65
+ width: 108.23
+ depth: 119.88
price:
id: price_gbHJdmfrXB
amount: '19.99'
@@ -14028,8 +14241,8 @@ paths:
option_type_label: Size
image_url:
metadata: {}
- created_at: '2026-05-26T12:44:12.357Z'
- updated_at: '2026-05-26T12:44:12.357Z'
+ created_at: '2026-05-26T16:13:27.836Z'
+ updated_at: '2026-05-26T16:13:27.836Z'
metadata: {}
position: 2
cost_price: '17.0'
@@ -14038,13 +14251,13 @@ paths:
weight_unit: lb
dimensions_unit:
deleted_at:
- created_at: '2026-05-26T12:44:12.354Z'
- updated_at: '2026-05-26T12:44:12.369Z'
+ created_at: '2026-05-26T16:13:27.833Z'
+ updated_at: '2026-05-26T16:13:27.847Z'
tax_category_id: taxcat_UkLWZg9DAJ
available_stock: 0
reserved_quantity: 0
total_on_hand: 0
- product_name: Product 752256
+ product_name: Product 753715
meta:
page: 1
limit: 25
@@ -14155,8 +14368,8 @@ paths:
option_type_label: Size
image_url:
metadata: {}
- created_at: '2026-05-26T12:44:13.020Z'
- updated_at: '2026-05-26T12:44:13.020Z'
+ created_at: '2026-05-26T16:13:28.503Z'
+ updated_at: '2026-05-26T16:13:28.503Z'
metadata: {}
position: 3
cost_price:
@@ -14165,13 +14378,13 @@ paths:
weight_unit: lb
dimensions_unit:
deleted_at:
- created_at: '2026-05-26T12:44:13.023Z'
- updated_at: '2026-05-26T12:44:13.025Z'
+ created_at: '2026-05-26T16:13:28.507Z'
+ updated_at: '2026-05-26T16:13:28.508Z'
tax_category_id: taxcat_UkLWZg9DAJ
available_stock: 0
reserved_quantity: 0
total_on_hand: 0
- product_name: Product 761955
+ product_name: Product 766019
'422':
description: validation error
content:
@@ -14358,10 +14571,10 @@ paths:
purchasable: true
in_stock: false
backorderable: true
- weight: 57.3
- height: 29.54
- width: 119.92
- depth: 56.73
+ weight: 18.3
+ height: 189.2
+ width: 53.43
+ depth: 41.8
price:
id: price_gbHJdmfrXB
amount: '19.99'
@@ -14384,8 +14597,8 @@ paths:
option_type_label: Size
image_url:
metadata: {}
- created_at: '2026-05-26T12:44:13.424Z'
- updated_at: '2026-05-26T12:44:13.424Z'
+ created_at: '2026-05-26T16:13:28.899Z'
+ updated_at: '2026-05-26T16:13:28.899Z'
metadata: {}
position: 2
cost_price: '17.0'
@@ -14394,13 +14607,13 @@ paths:
weight_unit: lb
dimensions_unit:
deleted_at:
- created_at: '2026-05-26T12:44:13.422Z'
- updated_at: '2026-05-26T12:44:13.436Z'
+ created_at: '2026-05-26T16:13:28.897Z'
+ updated_at: '2026-05-26T16:13:28.912Z'
tax_category_id: taxcat_UkLWZg9DAJ
available_stock: 0
reserved_quantity: 0
total_on_hand: 0
- product_name: Product 784310
+ product_name: Product 784102
'404':
description: variant not found
content:
@@ -14479,10 +14692,10 @@ paths:
purchasable: true
in_stock: false
backorderable: true
- weight: 140.27
- height: 137.84
- width: 138.66
- depth: 182.72
+ weight: 189.23
+ height: 159.19
+ width: 67.14
+ depth: 185.25
price:
id: price_gbHJdmfrXB
amount: '19.99'
@@ -14505,8 +14718,8 @@ paths:
option_type_label: Size
image_url:
metadata: {}
- created_at: '2026-05-26T12:44:14.135Z'
- updated_at: '2026-05-26T12:44:14.135Z'
+ created_at: '2026-05-26T16:13:29.599Z'
+ updated_at: '2026-05-26T16:13:29.599Z'
metadata: {}
position: 2
cost_price: '17.0'
@@ -14515,13 +14728,13 @@ paths:
weight_unit: lb
dimensions_unit:
deleted_at:
- created_at: '2026-05-26T12:44:14.133Z'
- updated_at: '2026-05-26T12:44:14.431Z'
+ created_at: '2026-05-26T16:13:29.597Z'
+ updated_at: '2026-05-26T16:13:29.890Z'
tax_category_id: taxcat_UkLWZg9DAJ
available_stock: 0
reserved_quantity: 0
total_on_hand: 0
- product_name: Product 80441
+ product_name: Product 801029
requestBody:
content:
application/json:
@@ -14790,14 +15003,10 @@ components:
token:
type: string
description: JWT access token
- refresh_token:
- type: string
- description: Refresh token for obtaining new access tokens
user:
"$ref": "#/components/schemas/AdminUser"
required:
- token
- - refresh_token
- user
PermissionRule:
type: object
@@ -16247,11 +16456,11 @@ components:
type: boolean
default:
type: boolean
- supported_locales:
+ country_isos:
type: array
items:
type: string
- country_isos:
+ supported_locales:
type: array
items:
type: string
@@ -16270,8 +16479,8 @@ components:
- default_locale
- tax_inclusive
- default
- - supported_locales
- country_isos
+ - supported_locales
- created_at
- updated_at
x-typelizer: true
diff --git a/docs/api-reference/store-api/rate-limitting.mdx b/docs/api-reference/store-api/rate-limitting.mdx
index 1eee10d83b..57d1018475 100644
--- a/docs/api-reference/store-api/rate-limitting.mdx
+++ b/docs/api-reference/store-api/rate-limitting.mdx
@@ -14,7 +14,6 @@ The Store API enforces rate limits to protect against abuse and ensure fair usag
| `POST /auth/login` | 5 requests | Per IP | 1 minute |
| `POST /customers` | 3 requests | Per IP | 1 minute |
| `POST /auth/refresh` | 10 requests | Per IP | 1 minute |
-| `POST /auth/oauth/callback` | 5 requests | Per IP | 1 minute |
The global rate limit is tracked by your publishable API key (`X-Spree-Api-Key`). If the key is not provided, the limit falls back to the client's IP address.
diff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yaml
index 96d3a88f93..aabae41f93 100644
--- a/docs/api-reference/store.yaml
+++ b/docs/api-reference/store.yaml
@@ -561,8 +561,19 @@ paths:
- Authentication
security:
- api_key: []
- description: Authenticates a customer with email/password and returns a JWT
- token
+ description: |
+ Authenticates a customer and returns a JWT access token + refresh token.
+
+ Dispatches by the `provider` field to a strategy registered in
+ `Spree.store_authentication_strategies`. When `provider` is omitted it
+ defaults to `email`, which uses the built-in email/password strategy.
+
+ To plug in a third-party identity provider (Auth0, Okta, Firebase, a
+ custom JWT issuer, SAML, etc.), register a `Spree::Authentication::Strategies::BaseStrategy`
+ subclass under a provider key, then send `{ "provider": "<your_key>", ... }`
+ with the fields your strategy requires. The endpoint returns the same
+ Spree-issued JWT + refresh token regardless of which strategy authenticated
+ the request.
x-codeSamples:
- lang: javascript
label: Spree SDK
@@ -590,16 +601,16 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImFjMTYxZjIyLTY2ODUtNDM0My1hZjhlLWFmNmZiY2Q4NzA3ZCIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5MzkwNzE2fQ.BuOWlcghPrLfW7-ka3a2yD1Giq5DAG-5amAPCOsJOvY
- refresh_token: PZZGJT4udwGkyKEPgs4WRtus
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjY0NjcwM2Q0LWY5ZjAtNDlmMi05ZmZkLTA3YTZhY2I5YWZkZiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5ODE1NjE1fQ.jlz2KHxYkB1Dd9ucl26zy6E5M7dFB5q9g-Qw0YjsX50
+ refresh_token: MQ9QZ1ToR8QocZoDd4ggC8yN
user:
id: cus_UkLWZg9DAJ
- first_name: Henriette
- last_name: Stamm
+ first_name: Colette
+ last_name: Hegmann
phone:
accepts_email_marketing: false
- full_name: Henriette Stamm
+ full_name: Colette Hegmann
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses: []
@@ -621,22 +632,45 @@ paths:
content:
application/json:
schema:
- type: object
- properties:
- provider:
- type: string
- example: email
- description: 'Authentication provider (default: email)'
- email:
- type: string
- format: email
- password:
- type: string
- example: password123
- required:
- - email
- - password
+ oneOf:
+ - title: EmailPasswordLogin
+ description: Built-in email/password authentication (default when
+ `provider` is omitted).
+ type: object
+ properties:
+ provider:
+ type: string
+ enum:
+ - email
+ default: email
+ email:
+ type: string
+ format: email
+ password:
+ type: string
+ example: password123
+ required:
+ - email
+ - password
+ - title: ProviderLogin
+ description: |
+ Provider-dispatched login. The `provider` key selects a registered
+ strategy class; the remaining fields are forwarded to the strategy's
+ `authenticate` method. Required fields depend on the registered strategy
+ — consult its documentation.
+ type: object
+ properties:
+ provider:
+ type: string
+ example: auth0
+ description: Registered provider key (anything other than `email`).
+ not:
+ enum:
+ - email
+ required:
+ - provider
+ additionalProperties: true
"/api/v3/store/auth/refresh":
post:
summary: Refresh token
@@ -672,16 +706,16 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6Ijg2NTFkMTJlLTRiMTItNDZhNi1hYjgzLTY4MjI1YWNhN2FhYyIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5MzkwNzE3fQ.mz2V3U-_6wrTzoLytYOOGc7mgH7eG71jQ_oA4mIHGtY
- refresh_token: sRppucnbaakQTvpFCoJArcde
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjNmZjU3NWU0LTVmNmItNDVjOC04MzIzLTIzMDMyMzVjZTkzMiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5ODE1NjE2fQ.OuCk-UNe-asA8DvK2yKMkp94BQz9PN_Z7_SnReeIRYE
+ refresh_token: qLuZDRo8LqywXFThqPM5V2Ug
user:
id: cus_UkLWZg9DAJ
- first_name: Richard
- last_name: Larson
+ first_name: Debi
+ last_name: Tillman
phone:
accepts_email_marketing: false
- full_name: Richard Larson
+ full_name: Debi Tillman
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses: []
@@ -717,8 +751,9 @@ paths:
- Authentication
security:
- api_key: []
- bearer_auth: []
- description: Revokes the refresh token, effectively logging the customer out.
+ description: Revokes the submitted refresh token. The refresh token itself is
+ the credential — no Authorization header is required, so a client with an
+ expired access JWT can still log out.
x-codeSamples:
- lang: javascript
label: Spree SDK
@@ -739,11 +774,6 @@ paths:
required: true
schema:
type: string
- - name: Authorization
- in: header
- required: true
- schema:
- type: string
responses:
'204':
description: logout without refresh token (no-op)
@@ -845,9 +875,9 @@ paths:
data:
- id: cart_gbHJdmfrXB
market_id:
- number: R560405209
- token: iqxaKurjyPCbwiuDRJwhMTLpUQs2SCohKfM
+ number: R537347983
+ token: yasKz5u5Uc9LkM8L2qFcbBRhWQzwP1nNUBe
customer_note:
currency: USD
locale: en
@@ -889,8 +919,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 584574
- slug: product-584574
+ name: Product 832050
+ slug: product-832050
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -915,7 +945,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H60885401848
+ number: H02359090617
tracking: U10000
tracking_url:
cost: '100.0'
@@ -944,7 +974,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Milissa Kutch
+ name: Blair Moore
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -976,7 +1006,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 105 Lovely Street
+ address1: 101 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -995,7 +1025,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 106 Lovely Street
+ address1: 102 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -1014,9 +1044,9 @@ paths:
market:
- id: cart_UkLWZg9DAJ
market_id:
- number: R504946559
- token: hC1f3UJxu4NErrgku3ZwU2LT4szVo2mJGUv
+ number: R807784030
+ token: nXX7y8d9LZ1UXEmP8CxfE2vvLYZH9s6K9Y3
customer_note:
currency: USD
locale: en
@@ -1058,8 +1088,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 576038
- slug: product-576038
+ name: Product 821901
+ slug: product-821901
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1084,7 +1114,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H14566689291
+ number: H10388427867
tracking: U10000
tracking_url:
cost: '100.0'
@@ -1113,7 +1143,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Milissa Kutch
+ name: Blair Moore
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1145,7 +1175,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 103 Lovely Street
+ address1: 99 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -1164,7 +1194,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 104 Lovely Street
+ address1: 100 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -1256,8 +1286,8 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R582709141
- token: sbMgF8VrnBNczXfdVscfNEDYvzNFowJwh2s
+ number: R386894669
+ token: AFTUr4LVpnRaQVPntcz4FE5S8AuFqksEEGH
email:
customer_note:
currency: USD
@@ -1412,9 +1442,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R911594733
- token: A3bGmry4ZwaVKavBsi7VH9dHvdws3WTttaD
+ number: R929020865
+ token: XrTGYYzWrW8pPm2d5SNuJgjFeHQ8MNN6Ufr
customer_note:
currency: USD
locale: en
@@ -1441,7 +1471,7 @@ paths:
display_delivery_total: "$0.00"
warnings:
- code: line_item_removed
- message: Product 62216 was removed because it was sold out
+ message: Product 874599 was removed because it was sold out
line_item_id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
store_credit_total: '0.0'
@@ -1466,7 +1496,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 113 Lovely Street
+ address1: 109 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -1485,7 +1515,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 114 Lovely Street
+ address1: 110 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -1583,9 +1613,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R537545049
- token: YAfcmRTUDf8ak8FPefKTgpqKXuur3RZrz5S
+ number: R179766659
+ token: LwvBFt69BRKiAP4yjrdydKDiefspHrgEEWV
customer_note: Leave at door
currency: USD
locale: en
@@ -1629,8 +1659,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 637993
- slug: product-637993
+ name: Product 888308
+ slug: product-888308
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -1655,7 +1685,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H35255737216
+ number: H67729784924
tracking:
tracking_url:
cost: '10.0'
@@ -1684,7 +1714,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Chung O'Keefe
+ name: Corazon Luettgen
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1716,7 +1746,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 117 Lovely Street
+ address1: 113 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -1735,7 +1765,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 118 Lovely Street
+ address1: 114 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -1921,9 +1951,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R231347948
- token: RnHB5VgA21xi2SsJFvCKad7qbWLdo47QGnV
+ number: R741424210
+ token: BjQx3Mm7YsM51uEQTvTjE4Jkc9QKpdQ57A4
customer_note:
currency: USD
locale: en
@@ -1965,8 +1995,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 653132
- slug: product-653132
+ name: Product 907994
+ slug: product-907994
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1991,7 +2021,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H45239248483
+ number: H95245243522
tracking: U10000
tracking_url:
cost: '100.0'
@@ -2020,7 +2050,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Dexter Boyer
+ name: Agatha Hoppe
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -2052,7 +2082,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 123 Lovely Street
+ address1: 119 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -2071,7 +2101,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 124 Lovely Street
+ address1: 120 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -2155,8 +2185,8 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R264397359
+ number: R464982887
customer_note:
currency: USD
locale: en
@@ -2183,7 +2213,7 @@ paths:
display_delivery_total: "$10.00"
fulfillment_status: backorder
payment_status: paid
- completed_at: '2026-05-21T18:12:04.119Z'
+ completed_at: '2026-05-26T16:13:41.957Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -2193,8 +2223,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 679791
- slug: product-679791
+ name: Product 924411
+ slug: product-924411
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -2219,7 +2249,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_gbHJdmfrXB
- number: H72789993064
+ number: H02978405768
tracking:
tracking_url:
cost: '10.0'
@@ -2248,7 +2278,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Gabriela Kemmer
+ name: Zachery Smith
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -2277,8 +2307,8 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: BGS-6d4860421892
- number: PDDA4ACI
+ response_code: BGS-176dea87fe0d
+ number: PYQMKAGA
amount: '29.99'
display_amount: "$29.99"
status: completed
@@ -2305,7 +2335,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 131 Lovely Street
+ address1: 127 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -2324,7 +2354,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 132 Lovely Street
+ address1: 128 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -2412,8 +2442,8 @@ paths:
example:
data:
- id: ctg_UkLWZg9DAJ
- name: taxonomy_1
- permalink: taxonomy-1
+ name: taxonomy_3
+ permalink: taxonomy-3
position: 0
depth: 0
meta_title:
@@ -2429,8 +2459,8 @@ paths:
is_child: false
is_leaf: false
- id: ctg_gbHJdmfrXB
- name: taxon_1
- permalink: taxonomy-1/taxon-1
+ name: taxon_3
+ permalink: taxonomy-3/taxon-3
position: 0
depth: 1
meta_title:
@@ -2446,8 +2476,8 @@ paths:
is_child: true
is_leaf: false
- id: ctg_EfhxLZ9ck8
- name: taxon_2
- permalink: taxonomy-1/taxon-1/taxon-2
+ name: taxon_4
+ permalink: taxonomy-3/taxon-3/taxon-4
position: 0
depth: 2
meta_title:
@@ -2546,8 +2576,8 @@ paths:
application/json:
example:
id: ctg_gbHJdmfrXB
- name: taxon_10
- permalink: taxonomy-7/taxon-10
+ name: taxon_12
+ permalink: taxonomy-9/taxon-12
position: 0
depth: 1
meta_title:
@@ -3134,16 +3164,16 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImRhYjViODFiLWZkODQtNDU1NC1iZjJkLWFlYWUzZWJjYWEyZiIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5MzkwNzMwfQ.A7ZqLfCc-PN69iuQHuMdSM6U_leCsrC5gV5ABpuwtbc
- refresh_token: S8rzSN7cnzSAwzjbRFiTKHL8
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjU1YjA5Yzc4LTUzMTYtNDRjYy05ZjJiLThmN2E2MzViMmRlNSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5ODE1NjI4fQ.FX2Te4WfdAu3kN_fvvfHsH92_axvIZTI1d8Zmw8R1mE
+ refresh_token: Be2HUCjiJVRjgidFuYU7GRRh
user:
id: cus_UkLWZg9DAJ
- first_name: Denita
- last_name: Rau
+ first_name: Randa
+ last_name: O'Hara
phone:
accepts_email_marketing: false
- full_name: Denita Rau
+ full_name: Randa O'Hara
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses: []
@@ -3316,8 +3346,8 @@ paths:
- id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R600105954
+ number: R096824993
customer_note:
currency: USD
locale: en
@@ -3344,7 +3374,7 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-05-21T18:12:11.464Z'
+ completed_at: '2026-05-26T16:13:49.079Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -3354,8 +3384,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 767917
- slug: product-767917
+ name: Product 1016128
+ slug: product-1016128
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3380,7 +3410,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H90711662288
+ number: H70742962050
tracking: U10000
tracking_url:
cost: '100.0'
@@ -3409,7 +3439,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Annie Marks
+ name: Britany Halvorson
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3441,7 +3471,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 151 Lovely Street
+ address1: 147 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -3460,7 +3490,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 152 Lovely Street
+ address1: 148 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -3572,8 +3602,8 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R060306455
+ number: R695830260
customer_note:
currency: USD
locale: en
@@ -3600,7 +3630,7 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-05-21T18:12:12.168Z'
+ completed_at: '2026-05-26T16:13:49.771Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -3610,8 +3640,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 787709
- slug: product-787709
+ name: Product 1033099
+ slug: product-1033099
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3636,7 +3666,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H26048702619
+ number: H08221240082
tracking: U10000
tracking_url:
cost: '100.0'
@@ -3665,7 +3695,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Nyla Rau
+ name: Aleen Reynolds
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3697,7 +3727,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 157 Lovely Street
+ address1: 153 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -3716,7 +3746,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 158 Lovely Street
+ address1: 154 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -3785,8 +3815,8 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6ImVkNGE2MDhlLTdmNmUtNDc5NS1iNDc0LWU0MGQ2NGY1NjM0NCIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5MzkwNzMzfQ.zdjx-98AkEn-FCaKaIeYCOa0VzQacbTGsoD8RtSVrIc
- refresh_token: JmzdDVvP1CZnWvpsNvAwkEos
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImp0aSI6IjlmZGNlNTdjLTY2NGQtNGZkNy1hOTU2LWQ1MjEzZjdhMjljYSIsImlzcyI6InNwcmVlIiwiYXVkIjoic3RvcmVfYXBpIiwiZXhwIjoxNzc5ODE1NjMwfQ.vLRThKiR034rnZQYwpQGrIOeQSdrYNKnFVJZ86pCuUo
+ refresh_token: GVssZP2L5Zk7uKQzTmwSQ4i5
user:
id: cus_UkLWZg9DAJ
@@ -3900,12 +3930,12 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
- first_name: Zackary
- last_name: Lind
+ first_name: Catarina
+ last_name: Padberg
phone: 555-555-0199
accepts_email_marketing: false
- full_name: Zackary Lind
+ full_name: Catarina Padberg
available_store_credit_total: '0'
display_available_store_credit_total: "$0.00"
addresses:
@@ -3913,7 +3943,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 164 Lovely Street
+ address1: 160 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -3931,7 +3961,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 163 Lovely Street
+ address1: 159 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -3950,7 +3980,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 164 Lovely Street
+ address1: 160 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -3969,7 +3999,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 163 Lovely Street
+ address1: 159 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4039,7 +4069,7 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
first_name: Updated
last_name: Name
phone: 555-555-0199
@@ -4052,7 +4082,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 166 Lovely Street
+ address1: 162 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4070,7 +4100,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 165 Lovely Street
+ address1: 161 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4089,7 +4119,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 166 Lovely Street
+ address1: 162 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4108,7 +4138,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 165 Lovely Street
+ address1: 161 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4279,9 +4309,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R983640452
- token: FUsN4w2fk57RAyQxK2uwVh1EFUSeoApoNWz
+ number: R549797108
+ token: dtJjZuWMLKEesDsMRZvLQQgWuYY9MuUwL2U
customer_note:
currency: USD
locale: en
@@ -4330,8 +4360,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 868984
- slug: product-868984
+ name: Product 1111931
+ slug: product-1111931
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4356,7 +4386,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H01257048332
+ number: H10253682077
tracking: U10000
tracking_url:
cost: '100.0'
@@ -4385,7 +4415,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Idell Corkery
+ name: Clark Gerlach
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4417,7 +4447,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 183 Lovely Street
+ address1: 179 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4436,7 +4466,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 184 Lovely Street
+ address1: 180 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4539,9 +4569,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R506477402
- token: ZbbF51wzUqPGTMG3ngYRzSSDbLK3Ee9wdcW
+ number: R750836348
+ token: uesByPtiBKoM7CoRrEKxrNXDHDLP4WQHVEg
customer_note:
currency: USD
locale: en
@@ -4583,8 +4613,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 883927
- slug: product-883927
+ name: Product 1136391
+ slug: product-1136391
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4609,7 +4639,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H66163861804
+ number: H71965274390
tracking: U10000
tracking_url:
cost: '100.0'
@@ -4638,7 +4668,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Faye Kertzmann
+ name: Drusilla Greenfelder
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4670,7 +4700,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 191 Lovely Street
+ address1: 187 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4689,7 +4719,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 192 Lovely Street
+ address1: 188 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4781,9 +4811,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R787693305
- token: naZG9yps6zPNYyBArZBgKKY6nnqYpGC5rTw
+ number: R495333435
+ token: vr5NsDydPesecXCDNmvqdhrE1FH96kV3K9s
customer_note:
currency: USD
locale: en
@@ -4827,8 +4857,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 905832
- slug: product-905832
+ name: Product 1159495
+ slug: product-1159495
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -4853,7 +4883,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H48213234073
+ number: H32451339376
tracking: U10000
tracking_url:
cost: '100.0'
@@ -4882,7 +4912,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Kerri Hahn
+ name: Danika Wiza
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4914,7 +4944,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 199 Lovely Street
+ address1: 195 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -4933,7 +4963,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 200 Lovely Street
+ address1: 196 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -5039,9 +5069,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R501407956
- token: mBMtKueSANaxHuT7o3H1zs5CWXfBtLZR76a
+ number: R144554045
+ token: RuTHka2EQdEPmHa7PXXzb8EAr5c9vSivWun
customer_note:
currency: USD
locale: en
@@ -5080,8 +5110,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 923228
- slug: product-923228
+ name: Product 1174034
+ slug: product-1174034
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5106,7 +5136,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H63891944560
+ number: H20393389861
tracking: U10000
tracking_url:
cost: '100.0'
@@ -5135,7 +5165,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Julieann Kuhn
+ name: Gordon Pfeffer
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -5164,8 +5194,8 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260521181222228580
- number: PLBPL882
+ response_code: 1-SC-20260526161400395109
+ number: PGO55NWN
amount: '50.0'
display_amount: "$50.00"
status: checkout
@@ -5192,7 +5222,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 207 Lovely Street
+ address1: 203 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -5211,7 +5241,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 208 Lovely Street
+ address1: 204 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -5344,9 +5374,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R971301843
- token: TAXrAS6nE34CGB4J4SM9jYAC7D1LAfEdvuB
+ number: R375402748
+ token: zK6CyYENcBq5VLBnwSXE35w1RrR7o2sTgky
customer_note:
currency: USD
locale: en
@@ -5388,8 +5418,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 966445
- slug: product-966445
+ name: Product 1215119
+ slug: product-1215119
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5414,7 +5444,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H50426852278
+ number: H49636801244
tracking: U10000
tracking_url:
cost: '100.0'
@@ -5443,7 +5473,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Hilda Gorczany
+ name: Melvina Gottlieb
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -5472,8 +5502,8 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260521181224917306
- number: P50IZG86
+ response_code: 1-SC-20260526161402955039
+ number: PIQFGKXI
amount: '50.0'
display_amount: "$50.00"
status: invalid
@@ -5500,7 +5530,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 223 Lovely Street
+ address1: 219 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -5519,7 +5549,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 224 Lovely Street
+ address1: 220 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -5597,7 +5627,7 @@ paths:
example:
data:
- id: gc_UkLWZg9DAJ
- code: DFE1B771D0A9F320
+ code: 91F1E57C6C99A62C
status: active
currency: USD
amount: '10.0'
@@ -5693,7 +5723,7 @@ paths:
application/json:
example:
id: gc_UkLWZg9DAJ
- code: B3971A4B112F7143
+ code: 76D77B6CFFA255C8
status: active
currency: USD
amount: '10.0'
@@ -5784,9 +5814,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R881799706
- token: RVbjRddtDRtcExjXQRpMB8Bim5LNSShGBH6
+ number: R128024977
+ token: snfWbJhSsShSGdMgtj6NVNbk7SVZvg984Xb
customer_note:
currency: USD
locale: en
@@ -5834,8 +5864,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 996441
- slug: product-996441
+ name: Product 1244584
+ slug: product-1244584
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5862,8 +5892,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 1009810
- slug: product-1009810
+ name: Product 1253628
+ slug: product-1253628
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -5893,7 +5923,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 238 Lovely Street
+ address1: 234 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -6006,9 +6036,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R794423726
- token: 1sJMUmLYsh3UaeGjL4VQKgK3DMj8h2YAx2z
+ number: R216067679
+ token: HBo9TtU6Kra7Pkqey8Rhw5WW93WSsLFKbcb
customer_note:
currency: USD
locale: en
@@ -6053,8 +6083,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1039114
- slug: product-1039114
+ name: Product 1289337
+ slug: product-1289337
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -6084,7 +6114,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 247 Lovely Street
+ address1: 243 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -6177,9 +6207,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R184817343
- token: vPBcAwTjPCjFLRYvznh9D9dkaWZt8aapnyH
+ number: R262930205
+ token: 6F91AsEuASghgSqqpwTgtCCF84SEMYm1ozP
customer_note:
currency: USD
locale: en
@@ -6230,7 +6260,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 250 Lovely Street
+ address1: 246 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -6370,6 +6400,8 @@ paths:
default_locale: en
tax_inclusive: false
default: true
+ country_isos:
+ - US
supported_locales:
- en
- es
@@ -6385,6 +6417,9 @@ paths:
default_locale: de
tax_inclusive: true
default: false
+ country_isos:
+ - DE
+ - FR
supported_locales:
- de
- en
@@ -6469,6 +6504,9 @@ paths:
default_locale: de
tax_inclusive: true
default: false
+ country_isos:
+ - DE
+ - FR
supported_locales:
- de
- en
@@ -6549,6 +6587,9 @@ paths:
default_locale: de
tax_inclusive: true
default: false
+ country_isos:
+ - DE
+ - FR
supported_locales:
- de
- en
@@ -6757,9 +6798,6 @@ paths:
const subscriber = await client.newsletterSubscribers.create({
- // Where the verification token should land. Must be in the store's
- // allowed origins. The storefront's webhook handler will send the
- // confirmation email with a link to `<redirect_url>?token=<token>`.
redirect_url: 'https://your-store.com/newsletter/confirm',
})
parameters:
@@ -6782,11 +6820,11 @@ paths:
application/json:
example:
id: sub_UkLWZg9DAJ
- created_at: '2026-05-21T18:12:32.551Z'
- updated_at: '2026-05-21T18:12:32.553Z'
+ created_at: '2026-05-26T16:14:11.183Z'
+ updated_at: '2026-05-26T16:14:11.186Z'
verified: true
- verified_at: '2026-05-21T18:12:32Z'
+ verified_at: '2026-05-26T16:14:11Z'
customer_id: cus_UkLWZg9DAJ
schema:
"$ref": "#/components/schemas/NewsletterSubscriber"
@@ -6865,10 +6903,10 @@ paths:
example:
id: sub_UkLWZg9DAJ
- created_at: '2026-05-21T18:12:32.578Z'
- updated_at: '2026-05-21T18:12:32.591Z'
+ created_at: '2026-05-26T16:14:11.236Z'
+ updated_at: '2026-05-26T16:14:11.255Z'
verified: true
- verified_at: '2026-05-21T18:12:32Z'
+ verified_at: '2026-05-26T16:14:11Z'
customer_id:
schema:
"$ref": "#/components/schemas/NewsletterSubscriber"
@@ -6966,7 +7004,7 @@ paths:
id: or_UkLWZg9DAJ
market_id:
channel_id: ch_UkLWZg9DAJ
- number: R444420762
+ number: R528526445
customer_note:
currency: USD
@@ -6994,7 +7032,7 @@ paths:
display_delivery_total: "$100.00"
fulfillment_status:
payment_status:
- completed_at: '2026-05-21T18:12:33.331Z'
+ completed_at: '2026-05-26T16:14:12.058Z'
store_credit_total: '0.0'
display_store_credit_total: "$0.00"
covered_by_store_credit: false
@@ -7004,8 +7042,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1079404
- slug: product-1079404
+ name: Product 1325879
+ slug: product-1325879
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -7030,7 +7068,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H37244671113
+ number: H26728427796
tracking: U10000
tracking_url:
cost: '100.0'
@@ -7059,7 +7097,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Bud Bartoletti
+ name: Maida Rogahn
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -7091,7 +7129,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 260 Lovely Street
+ address1: 256 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -7110,7 +7148,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 261 Lovely Street
+ address1: 257 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -7204,9 +7242,9 @@ paths:
id: ps_gbHJdmfrXB
status: pending
currency: USD
- external_id: bogus_799f9d0cdd2a024b44a972f2
+ external_id: bogus_7d70cfacf0ae7492cf904547
external_data:
- client_secret: bogus_secret_e705380ff182660e
+ client_secret: bogus_secret_ede104f24aa5154c
customer_external_id:
expires_at:
amount: '110.0'
@@ -7304,7 +7342,7 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_aecf7276c91c09ca9e9ec79a
+ external_id: bogus_4c7d24178351b3d5952b3cf5
external_data:
client_secret: secret_123
customer_external_id:
@@ -7366,7 +7404,7 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_4d892ef9777434a81f39f60d
+ external_id: bogus_331c7200fe221193bf414698
external_data:
client_secret: secret_123
customer_external_id:
@@ -7468,7 +7506,7 @@ paths:
id: ps_UkLWZg9DAJ
status: completed
currency: USD
- external_id: bogus_a8a35246fb9e9da3d0a251b8
+ external_id: bogus_2ebf387c2f1e00f23440c181
external_data:
client_secret: secret_123
customer_external_id:
@@ -7553,8 +7591,8 @@ paths:
example:
id: pss_gbHJdmfrXB
status: pending
- external_id: bogus_seti_c85316f2ab8114ec81687ed4
- external_client_secret: bogus_seti_secret_a15e9cd71178a98c
+ external_id: bogus_seti_e60689fe4c66251e2b4dd2f4
+ external_client_secret: bogus_seti_secret_633045dc9ddab700
external_data: {}
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
@@ -7653,8 +7691,8 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: pending
- external_id: seti_test_674107c9a4a65317bbdc129d
- external_client_secret: seti_secret_66eb1d151fa172598a741e14
+ external_id: seti_test_7ac50408dcea6ac09aa04e3d
+ external_client_secret: seti_secret_77e80c695165694be5ef56b9
external_data:
client_secret: secret_123
payment_method_id: pm_UkLWZg9DAJ
@@ -7730,8 +7768,8 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: completed
- external_id: seti_test_047d39fe078d8f5dfb59fc7a
- external_client_secret: seti_secret_8320035d2ef40c47c4e63f5b
+ external_id: seti_test_6cb96d4ae6cdc1eadf02b1dc
+ external_client_secret: seti_secret_bb0a7727be4c699d8584292f
external_data:
client_secret: secret_123
payment_method_id: pm_UkLWZg9DAJ
@@ -7825,7 +7863,7 @@ paths:
id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
response_code:
- number: PDW8QZGM
+ number: P6M3ZHJE
amount: '110.0'
display_amount: "$110.00"
status: checkout
@@ -7921,7 +7959,7 @@ paths:
body_html: ''
- id: pol_OIJLhNcSbf
name: Privacy Policy
- slug: privacy-policy-64c6fe11-a85d-4ac3-bcf3-2d7e2f51e471
+ slug: privacy-policy-006f63da-6062-4a3f-9fd7-aa690f7b356c
body: We respect your privacy.
body_html: |
<div class="trix-content">
@@ -8165,13 +8203,13 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 117952
- slug: product-117952
+ name: Product 1421251
+ slug: product-1421251
meta_title:
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-05-21T18:12:43.946Z'
+ available_on: '2025-05-26T16:14:22.402Z'
purchasable: true
in_stock: false
backorderable: true
@@ -8193,34 +8231,43 @@ paths:
price_list_id:
original_price:
- id: prod_gbHJdmfrXB
- name: Product 1184416
- slug: product-1184416
+ name: Product 1435220
+ slug: product-1435220
meta_title:
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-05-21T18:12:44.008Z'
+ available_on: '2025-05-26T16:14:22.472Z'
purchasable: true
in_stock: false
backorderable: true
available: true
- description: Impedit quam aliquid ducimus magni. Quas nulla placeat
- totam suscipit doloribus quos inventore earum. Veniam officiis
- ad ipsum sed optio error perferendis. Doloremque molestias magnam
- harum consequatur at accusamus tempore sunt. Deleniti voluptatum
- laborum vero nisi. Sunt delectus soluta amet hic consequuntur
- occaecati. Molestias illum minima velit ullam. Modi animi temporibus
- adipisci veritatis voluptatum libero unde. Sunt mollitia tenetur
- fugit enim. Accusantium minima id culpa laudantium molestias.
- Rerum saepe necessitatibus repellat tempora quis. Unde saepe laborum
- iure non quisquam nesciunt sed. Voluptas debitis placeat asperiores
- dolorem quia facilis rem. Atque quae enim at quis accusamus sequi
- vel.
+ description: Architecto dignissimos nemo inventore incidunt enim.
+ Odit accusamus repellat error saepe culpa unde eius. Cupiditate
+ officiis voluptatem autem perferendis qui vitae omnis sunt. Debitis
+ dolor tempore ad impedit itaque reprehenderit delectus. Doloremque
+ laudantium iure recusandae iusto debitis laborum consequuntur.
+ Impedit eum optio commodi tempora cum quidem. Facere voluptatum
+ nam possimus veritatis nostrum explicabo dolore ex. Adipisci iure
+ unde nobis itaque amet nesciunt voluptatibus impedit. Numquam
+ in accusantium magni itaque exercitationem. Quas vero maxime voluptatem
+ rem impedit inventore. Esse perferendis asperiores ea expedita
+ aut tenetur soluta. Enim accusantium dolor adipisci impedit. Error
+ maxime neque accusamus facere provident eum. Cum officia velit
+ asperiores quod cupiditate fugiat. Possimus tenetur aut consequuntur
+ iusto cumque quas. Ab velit ullam qui pariatur veritatis omnis.
+ Accusantium vero occaecati explicabo neque animi commodi. Necessitatibus
+ perspiciatis iste culpa totam quibusdam voluptate distinctio.
+ Quod aliquam ut et autem. Saepe ut asperiores et quisquam perspiciatis
+ molestiae. Vel recusandae sunt nemo et accusamus veniam ducimus.
+ Laborum modi quasi perferendis culpa laboriosam quaerat magnam.
+ Facere at tempora iusto ex magni aliquam modi debitis.
description_html: |-
- Impedit quam aliquid ducimus magni. Quas nulla placeat totam suscipit doloribus quos inventore earum. Veniam officiis ad ipsum sed optio error perferendis.
- Doloremque molestias magnam harum consequatur at accusamus tempore sunt. Deleniti voluptatum laborum vero nisi. Sunt delectus soluta amet hic consequuntur occaecati.
- Molestias illum minima velit ullam. Modi animi temporibus adipisci veritatis voluptatum libero unde. Sunt mollitia tenetur fugit enim. Accusantium minima id culpa laudantium molestias.
- Rerum saepe necessitatibus repellat tempora quis. Unde saepe laborum iure non quisquam nesciunt sed. Voluptas debitis placeat asperiores dolorem quia facilis rem. Atque quae enim at quis accusamus sequi vel.
+ Architecto dignissimos nemo inventore incidunt enim. Odit accusamus repellat error saepe culpa unde eius. Cupiditate officiis voluptatem autem perferendis qui vitae omnis sunt. Debitis dolor tempore ad impedit itaque reprehenderit delectus. Doloremque laudantium iure recusandae iusto debitis laborum consequuntur.
+ Impedit eum optio commodi tempora cum quidem. Facere voluptatum nam possimus veritatis nostrum explicabo dolore ex. Adipisci iure unde nobis itaque amet nesciunt voluptatibus impedit. Numquam in accusantium magni itaque exercitationem. Quas vero maxime voluptatem rem impedit inventore.
+ Esse perferendis asperiores ea expedita aut tenetur soluta. Enim accusantium dolor adipisci impedit. Error maxime neque accusamus facere provident eum. Cum officia velit asperiores quod cupiditate fugiat. Possimus tenetur aut consequuntur iusto cumque quas.
+ Ab velit ullam qui pariatur veritatis omnis. Accusantium vero occaecati explicabo neque animi commodi. Necessitatibus perspiciatis iste culpa totam quibusdam voluptate distinctio. Quod aliquam ut et autem. Saepe ut asperiores et quisquam perspiciatis molestiae.
+ Vel recusandae sunt nemo et accusamus veniam ducimus. Laborum modi quasi perferendis culpa laboriosam quaerat magnam. Facere at tempora iusto ex magni aliquam modi debitis.
default_variant_id: variant_EfhxLZ9ck8
thumbnail_url:
tags: []
@@ -8322,13 +8369,13 @@ paths:
application/json:
example:
id: prod_UkLWZg9DAJ
- name: Product 1453321
- slug: product-1453321
+ name: Product 1702106
+ slug: product-1702106
meta_title:
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-05-21T18:12:45.816Z'
+ available_on: '2025-05-26T16:14:24.749Z'
purchasable: true
in_stock: false
backorderable: true
@@ -8355,7 +8402,7 @@ paths:
amount_in_cents: 999
currency: USD
display_amount: "$9.99"
- recorded_at: '2026-05-06T18:12:45Z'
+ recorded_at: '2026-05-11T16:14:24Z'
schema:
"$ref": "#/components/schemas/Product"
'404':
@@ -8451,7 +8498,7 @@ paths:
options:
- id: ctg_EfhxLZ9ck8
name: Shirts
- permalink: taxonomy-25/taxon-32/shirts
+ permalink: taxonomy-27/taxon-34/shirts
count: 2
sort_options:
- id: manual
@@ -8730,9 +8777,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R563436707
- token: MEKMkDqDZiwtriHVLkLzxZ7hGj4nxCtmBig
+ number: R903776007
+ token: oPFUDLqngFUNHBsLi5NZyBfVqQFVkab5S48
customer_note:
currency: USD
locale: en
@@ -8771,8 +8818,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1657
- slug: product-1657
+ name: Product 1909153
+ slug: product-1909153
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -8797,7 +8844,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H22654230230
+ number: H71098380344
tracking: U10000
tracking_url:
cost: '100.0'
@@ -8826,7 +8873,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Marissa Sipes
+ name: Twanna Stamm
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -8855,8 +8902,8 @@ paths:
payments:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
- response_code: 1-SC-20260521181251050531
- number: PFR3QR4H
+ response_code: 1-SC-20260526161430523363
+ number: P1X82P2A
amount: '10.0'
display_amount: "$10.00"
status: checkout
@@ -8883,7 +8930,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 324 Lovely Street
+ address1: 320 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -8902,7 +8949,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 325 Lovely Street
+ address1: 321 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -8999,9 +9046,9 @@ paths:
example:
id: cart_UkLWZg9DAJ
market_id:
- number: R554787846
- token: vfB6PnFw9cPg6LbJqQKBA7jHh5zQGzRLtnz
+ number: R646602683
+ token: c5RmvpB42n2ZRwYZ246jBJSFzvFgSLjsY5V
customer_note:
currency: USD
locale: en
@@ -9043,8 +9090,8 @@ paths:
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1673494
- slug: product-1673494
+ name: Product 1922421
+ slug: product-1922421
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -9069,7 +9116,7 @@ paths:
digital_links: []
fulfillments:
- id: ful_UkLWZg9DAJ
- number: H45381203670
+ number: H93482247486
tracking: U10000
tracking_url:
cost: '100.0'
@@ -9098,7 +9145,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: NY
- name: Ozella Hirthe
+ name: Carolina Kovacek
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -9130,7 +9177,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 332 Lovely Street
+ address1: 328 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -9149,7 +9196,7 @@ paths:
first_name: John
last_name: Doe
full_name: John Doe
- address1: 333 Lovely Street
+ address1: 329 Lovely Street
address2: Northwest
postal_code: '10118'
city: New York
@@ -9228,7 +9275,7 @@ paths:
data:
- id: wl_UkLWZg9DAJ
name: My Wishlist
- token: czkimqa2wGQpziZPiHu4TETD
+ token: KrDYvpcWeMWWCVsEuRj9V8Xm
is_default: false
is_private: true
meta:
@@ -9304,7 +9351,7 @@ paths:
example:
id: wl_gbHJdmfrXB
name: Birthday Ideas
- token: HkhGZqtmkmgvuTiENz7zMHwA
+ token: LoTGXDT4V69PBMZXRWaS9Sjg
is_default: false
is_private: true
schema:
@@ -9400,7 +9447,7 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: My Wishlist
- token: URczbyJbeCgRS1a82JhitHvQ
+ token: K1j4ej8u38Y4P9whWrjPs2R9
is_default: false
is_private: true
schema:
@@ -9462,7 +9509,7 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: Updated Name
- token: RbsVopS8AJBteR6s51rRT9tN
+ token: xVUpUiksViqHLiWcenRTEGZx
is_default: false
is_private: true
schema:
@@ -9577,7 +9624,7 @@ paths:
variant:
id: variant_gbHJdmfrXB
product_id: prod_gbHJdmfrXB
- sku: SKU-202
+ sku: SKU-239
options_text: ''
track_inventory: true
media_count: 0
@@ -11001,6 +11048,10 @@ components:
type: boolean
default:
type: boolean
+ country_isos:
+ type: array
+ items:
+ type: string
supported_locales:
type: array
items:
@@ -11016,6 +11067,7 @@ components:
- default_locale
- tax_inclusive
- default
+ - country_isos
- supported_locales
x-typelizer: true
Media:
diff --git a/docs/developer/how-to/custom-api-authentication.mdx b/docs/developer/how-to/custom-api-authentication.mdx
new file mode 100644
index 0000000000..ae9fa6adc6
--- /dev/null
+++ b/docs/developer/how-to/custom-api-authentication.mdx
@@ -0,0 +1,308 @@
+---
+title: Integrate a Third-Party Identity Provider
+description: Step-by-step guide to plugging a custom identity provider (Auth0, Okta, Firebase, Cognito, or any JWT issuer) into the Spree Store API.
+---
+
+import { Since } from '/snippets/since.mdx';
+
+<Since version="5.5" />
+
+## Overview
+
+Spree's Store API ships with a pluggable authentication system. You register a **strategy class** for a named provider, and the existing login endpoints will dispatch to it — no controller patching, no route overrides, no fork.
+
+By the end of this guide you'll have:
+
+- A custom strategy that verifies a third-party JWT against a JWKS endpoint
+- A user account auto-provisioned on first login, reused on subsequent logins
+- A standard **Spree-issued JWT + refresh token** returned to the client
+- All Store API endpoints (cart, checkout, account) protected by Spree's own JWT — the third-party token is only used at the exchange step
+
+<Info>
+The same pattern works for Admin API integrations via `admin_authentication_strategies`. Examples in this guide target the Store API; substitute `Spree.admin_user_class` and the admin endpoints where noted.
+</Info>
+
+## Architecture
+
+```
+Client → POST /api/v3/store/auth/login
+ { provider: "my_idp", token: "<third-party JWT>" }
+ │
+ ▼
+ AuthController looks up the strategy by `provider` key
+ │
+ ▼
+ YourStrategy#authenticate
+ • verifies the JWT against the IdP's JWKS
+ • finds or creates a Spree::UserIdentity → Spree user
+ • returns success(user) or failure(message)
+ │
+ ▼
+ Spree issues its own JWT (HS256, iss=spree, aud=store_api)
+ + a rotatable RefreshToken
+ │
+ ▼
+Client → subsequent calls with `Authorization: Bearer <Spree JWT>`
+```
+
+The third-party JWT proves identity **once, at login**. After that, the client uses the Spree JWT for everything, and `/auth/refresh` rotates it via Spree's own refresh-token mechanism. Your existing CanCanCan rules, `current_user`, and serializer params just work.
+
+## Step 1: Create the Strategy Class
+
+Subclass `Spree::Authentication::Strategies::BaseStrategy` and implement two methods: `provider` (a string identifier) and `authenticate` (returns a `Spree::ServiceModule::Result`).
+
+```ruby app/models/my_app/auth/external_jwt_strategy.rb
+module MyApp
+ module Auth
+ class ExternalJwtStrategy < Spree::Authentication::Strategies::BaseStrategy
+ PROVIDER = 'external_idp'.freeze
+
+ def provider
+ PROVIDER
+ end
+
+ def authenticate
+ token = params[:token] || extract_bearer
+ return failure(I18n.t('spree.api.unauthorized')) if token.blank?
+
+ payload = verify_with_jwks(token)
+
+ user = find_or_create_user_from_oauth(
+ provider: PROVIDER,
+ uid: payload.fetch('sub'),
+ info: {
+ email: payload['email'],
+ first_name: payload['given_name'],
+ last_name: payload['family_name']
+ }
+ )
+
+ success(user)
+ rescue JWT::DecodeError, JWT::ExpiredSignature, JWT::InvalidIssuerError, JWT::InvalidAudError, KeyError => e
+ failure(e.message)
+ end
+
+ private
+
+ def verify_with_jwks(token)
+ jwks_loader = ->(opts) { jwks(force: opts[:invalidate]) }
+
+ JWT.decode(
+ token, nil, true,
+ algorithms: ['RS256'],
+ iss: ENV.fetch('EXTERNAL_IDP_ISSUER'),
+ aud: ENV.fetch('EXTERNAL_IDP_AUDIENCE'),
+ verify_iss: true,
+ verify_aud: true,
+ jwks: jwks_loader
+ ).first
+ end
+
+ def jwks(force: false)
+ Rails.cache.fetch('external_idp:jwks', expires_in: 1.hour, force: force) do
+ uri = URI(ENV.fetch('EXTERNAL_IDP_JWKS_URL'))
+ JSON.parse(Net::HTTP.get(uri))
+ end
+ end
+
+ def extract_bearer
+ header = request_env['HTTP_AUTHORIZATION'].to_s
+ header.start_with?('Bearer ') ? header.split(' ', 2).last : nil
+ end
+ end
+ end
+end
+```
+
+### What the base class gives you
+
+`Spree::Authentication::Strategies::BaseStrategy` (in `spree_core`) exposes a few helpers so your subclass stays small:
+
+| Helper | Purpose |
+|---|---|
+| `success(user)` | Wrap a user in a successful `ServiceModule::Result` |
+| `failure(message)` | Wrap an error message in a failed result |
+| `find_user_by_email(email)` | Lookup against `Spree.user_class` |
+| `find_or_create_user_from_oauth(provider:, uid:, info:, tokens: {})` | Calls `Spree::UserIdentity.find_or_create_from_oauth` with the right `user_class` |
+| `params`, `request_env`, `user_class` | Reader access to the controller-supplied inputs |
+
+`find_or_create_user_from_oauth` returns the **user**, not the identity. It creates the `Spree::UserIdentity` row on first login (mapping `provider + uid → user`) and reuses it on subsequent logins — so repeat sign-ins land on the same Spree customer.
+
+## Step 2: Register the Strategy
+
+Add the strategy to `Spree.store_authentication_strategies` in an initializer. The key you choose here is what clients will send as `provider` in the login payload.
+
+```ruby config/initializers/spree.rb
+Rails.application.config.after_initialize do
+ Spree.store_authentication_strategies.add(:external_idp, MyApp::Auth::ExternalJwtStrategy)
+end
+```
+
+`Spree.store_authentication_strategies` is a `Spree::Authentication::StrategyRegistry`. The full API:
+
+| Method | Purpose |
+|---|---|
+| `add(key, strategy_class)` | Register a strategy. Overwrites any existing entry under the same key — that's how you swap the built-in `:email` strategy. |
+| `remove(key)` | Unregister a strategy. Idempotent (returns `nil` if the key was never registered). |
+| `[key]` | Look up a registered class. |
+| `key?(key)`, `keys`, `values`, `each`, `to_h` | Standard introspection. |
+
+<Warning>
+`Spree::UserIdentity` validates that `provider` is a registered strategy key. Registration must happen during boot — before the first login attempt.
+</Warning>
+
+For an admin-side equivalent, register under `Spree.admin_authentication_strategies` instead and instantiate your strategy against `Spree.admin_user_class`:
+
+```ruby
+Spree.admin_authentication_strategies.add(:okta, MyApp::Auth::OktaStrategy)
+```
+
+## Step 3: Call the Exchange Endpoint
+
+`POST /api/v3/store/auth/login` is the single dispatcher. The `provider` field in the body selects the strategy — omit it for built-in email/password, set it to your registered key for everything else. The remaining body fields are whatever your strategy reads from `params`.
+
+```http
+POST /api/v3/store/auth/login
+X-Spree-API-Key: pk_your_publishable_key
+Content-Type: application/json
+
+{
+ "provider": "external_idp",
+ "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIs..."
+}
+```
+
+The response is the standard Spree auth payload:
+
+```json
+{
+ "token": "<Spree HS256 JWT, aud=store_api>",
+ "refresh_token": "rt_xxxxxxxxxxxx",
+ "user": { "id": "user_...", "email": "...", "first_name": "...", "...": "..." }
+}
+```
+
+From here, the client sends `Authorization: Bearer <Spree JWT>` on every subsequent Store API call. When the JWT expires (default: 1 hour), the client hits `POST /api/v3/store/auth/refresh` with the refresh token to rotate both.
+
+From `@spree/sdk` the same call looks like:
+
+```ts
+import { createClient } from '@spree/sdk'
+
+const client = createClient({ baseUrl: 'https://your-store.com', publishableKey: '<pk>' })
+
+const auth = await client.auth.login({
+ provider: 'external_idp',
+ token: thirdPartyJwt,
+})
+```
+
+`LoginCredentials` is a discriminated union — pass `{ email, password }` for the built-in strategy, or `{ provider, ...customFields }` for any strategy you registered.
+
+## Account Linking
+
+The naive flow above will create a brand new Spree user the first time a given `(provider, uid)` is seen — even if a user with the same email already exists from a password signup. If you want **same-email-means-same-customer**, look up by email first and attach an identity to the existing user:
+
+```ruby
+def authenticate
+ payload = verify_with_jwks(params[:token])
+ email = payload.fetch('email')
+
+ user = find_user_by_email(email)
+
+ if user
+ user.identities.find_or_create_by!(provider: PROVIDER, uid: payload['sub']) do |identity|
+ identity.info = { email: email, name: payload['name'] }
+ end
+ else
+ user = find_or_create_user_from_oauth(
+ provider: PROVIDER,
+ uid: payload['sub'],
+ info: { email: email, first_name: payload['given_name'], last_name: payload['family_name'] }
+ )
+ end
+
+ success(user)
+end
+```
+
+<Warning>
+**Only link by email if your IdP guarantees `email_verified`.** Silent linking against an unverified email is a known account-takeover vector: an attacker registers `[email protected]` at the IdP without proving ownership, then logs into Spree as the real victim. Check the `email_verified` claim (or equivalent) before linking, and reject otherwise.
+</Warning>
+
+## Logout
+
+```http
+POST /api/v3/store/auth/logout
+Content-Type: application/json
+
+{ "refresh_token": "rt_xxxxxxxxxxxx" }
+```
+
+This revokes the Spree refresh token. The Spree JWT itself remains valid until it expires naturally (short-lived by design — default 1 hour). Spree does **not** call the IdP's revocation endpoint; if you need single sign-out, do that from the client.
+
+## Security Notes
+
+A few things worth getting right:
+
+- **Don't try to pass the third-party JWT through to protected endpoints.** Spree's `JwtAuthentication` concern verifies `iss: 'spree'` and `aud: 'store_api'` with HS256 against the Spree secret — a foreign RS256 token will never validate, and you don't want it to. The exchange-at-login model is the right one.
+- **JWKS caching and rotation.** Cache the JWKS (the example uses a 1-hour TTL) but make sure your loader honors the `invalidate: true` option so that an unrecognized `kid` triggers a refetch. Otherwise key rotation at the IdP locks users out for up to the TTL.
+- **Validate `iss` and `aud` claims.** Always. The example passes `verify_iss: true, verify_aud: true` to `JWT.decode` — don't drop those.
+- **Algorithm pinning.** Hard-code `algorithms: ['RS256']` (or whatever your IdP uses). Never let the token's own `alg` header decide — the classic `alg: none` and HS-as-RS confusion attacks both exploit lax algorithm selection.
+- **Rate limiting.** `POST /auth/login` is rate-limited per IP via `Spree::Api::Config[:rate_limit_login]`. Tune it in your app config if needed — the same limit applies to email/password and provider-dispatched logins.
+
+## Testing
+
+A strategy is a plain Ruby class — test it in isolation without booting a controller:
+
+```ruby spec/models/my_app/auth/external_jwt_strategy_spec.rb
+require 'rails_helper'
+
+RSpec.describe MyApp::Auth::ExternalJwtStrategy do
+ let(:rsa_private) { OpenSSL::PKey::RSA.generate(2048) }
+ let(:jwks) { { keys: [JWT::JWK.new(rsa_private).export] } }
+
+ let(:token) do
+ JWT.encode(
+ { sub: 'idp-user-123', email: '[email protected]', iss: 'https://idp.example', aud: 'spree' },
+ rsa_private, 'RS256'
+ )
+ end
+
+ before do
+ stub_request(:get, ENV['EXTERNAL_IDP_JWKS_URL']).to_return(body: jwks.to_json)
+ end
+
+ subject(:result) do
+ described_class.new(
+ params: { provider: 'external_idp', token: token },
+ request_env: {}
+ ).authenticate
+ end
+
+ it 'provisions a Spree user on first login' do
+ expect { result }.to change(Spree.user_class, :count).by(1)
+ expect(result).to be_success
+ expect(result.value.email).to eq('[email protected]')
+ end
+
+ it 'reuses the user on subsequent logins' do
+ described_class.new(params: { token: token }, request_env: {}).authenticate
+ expect { result }.not_to change(Spree.user_class, :count)
+ end
+
+ it 'fails on an expired token' do
+ expired = JWT.encode({ sub: 'x', exp: 1.hour.ago.to_i, iss: 'https://idp.example', aud: 'spree' }, rsa_private, 'RS256')
+ result = described_class.new(params: { token: expired }, request_env: {}).authenticate
+ expect(result).not_to be_success
+ end
+end
+```
+
+## Reference
+
+- `Spree::Authentication::Strategies::BaseStrategy` — `spree/core/app/models/spree/authentication/strategies/base_strategy.rb`
+- `Spree::UserIdentity` — `spree/core/app/models/spree/user_identity.rb`
+- `Spree::Api::V3::Store::AuthController` — `spree/api/app/controllers/spree/api/v3/store/auth_controller.rb`
+- `Spree::Api::V3::JwtAuthentication` — `spree/api/app/controllers/concerns/spree/api/v3/jwt_authentication.rb`
+- See also: [Authentication](/developer/customization/authentication) for `Spree.user_class` integration.
diff --git a/docs/docs.json b/docs/docs.json
index 6df9770f55..626d9d11d5 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -337,6 +337,11 @@
"group": "Search",
"icon": "search",
"pages": ["developer/how-to/custom-search-provider"]
+ },
+ {
+ "group": "Authentication",
+ "icon": "key",
+ "pages": ["developer/how-to/custom-api-authentication"]
}
]
},
diff --git a/docs/plans/6.0-platform-auth.md b/docs/plans/6.0-platform-auth.md
index f7bee5e61d..6694414f38 100644
--- a/docs/plans/6.0-platform-auth.md
+++ b/docs/plans/6.0-platform-auth.md
@@ -185,10 +185,9 @@ end
```
# Store API
-POST /api/v3/store/auth/login # email+password → access JWT + refresh token
+POST /api/v3/store/auth/login # provider-dispatched login (email default, OAuth/SSO/custom JWT via `provider` key) → access JWT + refresh token
POST /api/v3/store/auth/refresh # refresh token → new access JWT + rotated refresh token
POST /api/v3/store/auth/logout # revoke refresh token
-POST /api/v3/store/auth/oauth/callback # OAuth provider callback → JWT + refresh token
POST /api/v3/store/customers # register → JWT + refresh token
POST /api/v3/store/customer/password_resets # request reset email
diff --git a/packages/admin-sdk/.changeset/login-provider-dispatch.md b/packages/admin-sdk/.changeset/login-provider-dispatch.md
new file mode 100644
index 0000000000..8e08967e7d
--- /dev/null
+++ b/packages/admin-sdk/.changeset/login-provider-dispatch.md
@@ -0,0 +1,5 @@
+---
+'@spree/admin-sdk': minor
+---
+
+Add provider-dispatched login. `client.auth.login()` now accepts third-party identity-provider payloads (e.g. `{ provider: 'okta', token: '<jwt>' }`) in addition to the existing `{ email, password }` shape — `LoginCredentials` is now a discriminated union of `EmailPasswordLogin | ProviderLogin`, both newly exported. Pairs with the server-side strategy registry at `Spree.admin_authentication_strategies`. Existing email/password calls are unchanged.
diff --git a/packages/admin-sdk/examples/auth/login.ts b/packages/admin-sdk/examples/auth/login.ts
new file mode 100644
index 0000000000..883a41915a
--- /dev/null
+++ b/packages/admin-sdk/examples/auth/login.ts
@@ -0,0 +1,16 @@
+import { createAdminClient } from '@spree/admin-sdk'
+
+const client = createAdminClient({
+ baseUrl: 'https://your-store.com',
+ secretKey: 'sk_xxx',
+})
+
+// region:example
+// The refresh token is set as an HttpOnly cookie; only `token` and `user` come back in the body.
+const auth = await client.auth.login({
+ email: '[email protected]',
+ password: 'password123',
+})
+// endregion:example
+
+export { auth }
diff --git a/packages/admin-sdk/examples/auth/logout.ts b/packages/admin-sdk/examples/auth/logout.ts
new file mode 100644
index 0000000000..2a18c9b084
--- /dev/null
+++ b/packages/admin-sdk/examples/auth/logout.ts
@@ -0,0 +1,12 @@
+import { createAdminClient } from '@spree/admin-sdk'
+
+const client = createAdminClient({
+ baseUrl: 'https://your-store.com',
+ secretKey: 'sk_xxx',
+})
+
+// region:example
+await client.auth.logout()
+// endregion:example
+
+export {}
diff --git a/packages/admin-sdk/examples/auth/refresh.ts b/packages/admin-sdk/examples/auth/refresh.ts
new file mode 100644
index 0000000000..14a6f721a3
--- /dev/null
+++ b/packages/admin-sdk/examples/auth/refresh.ts
@@ -0,0 +1,13 @@
+import { createAdminClient } from '@spree/admin-sdk'
+
+const client = createAdminClient({
+ baseUrl: 'https://your-store.com',
+ secretKey: 'sk_xxx',
+})
+
+// region:example
+// Driven entirely by the HttpOnly refresh-token cookie + CSRF header (set by the SDK).
+const auth = await client.auth.refresh()
+// endregion:example
+
+export { auth }
diff --git a/packages/admin-sdk/src/admin-client.ts b/packages/admin-sdk/src/admin-client.ts
index 392edcfc3a..56b8c5750b 100644
--- a/packages/admin-sdk/src/admin-client.ts
+++ b/packages/admin-sdk/src/admin-client.ts
@@ -1,4 +1,12 @@
-import type { ListParams, PaginatedResponse, RequestFn, RequestOptions } from '@spree/sdk-core'
+import type {
+ EmailPasswordLogin,
+ ListParams,
+ LoginCredentials,
+ PaginatedResponse,
+ ProviderLogin,
+ RequestFn,
+ RequestOptions,
+} from '@spree/sdk-core'
import { getParams, transformListParams } from '@spree/sdk-core'
export interface DashboardAnalytics {
@@ -38,11 +46,6 @@ export interface AuthTokens {
user: AdminUser
}
-export interface LoginCredentials {
- email: string
- password: string
-}
-
export interface PermissionRule {
/** true for `can`, false for `cannot` */
allow: boolean
@@ -2045,4 +2048,11 @@ export class AdminClient {
}
// Re-export for type convenience
-export type { ListParams, PaginatedResponse, RequestOptions }
+export type {
+ EmailPasswordLogin,
+ ListParams,
+ LoginCredentials,
+ PaginatedResponse,
+ ProviderLogin,
+ RequestOptions,
+}
diff --git a/packages/sdk-core/src/index.ts b/packages/sdk-core/src/index.ts
index ecec11b050..f1883cff5b 100644
--- a/packages/sdk-core/src/index.ts
+++ b/packages/sdk-core/src/index.ts
@@ -17,10 +17,13 @@ export { createRequestFn, SpreeError } from './request'
// Shared types
export type {
AddressParams,
+ EmailPasswordLogin,
ErrorResponse,
ListParams,
ListResponse,
LocaleDefaults,
+ LoginCredentials,
PaginatedResponse,
PaginationMeta,
+ ProviderLogin,
} from './types'
diff --git a/packages/sdk-core/src/types.ts b/packages/sdk-core/src/types.ts
index 37777567aa..73d978f7d7 100644
--- a/packages/sdk-core/src/types.ts
+++ b/packages/sdk-core/src/types.ts
@@ -69,3 +69,27 @@ export interface AddressParams {
/** Set as default shipping address */
is_default_shipping?: boolean
}
+
+// Authentication
+
+/**
+ * Built-in email/password login. The default when `provider` is omitted.
+ */
+export interface EmailPasswordLogin {
+ provider?: 'email'
+ email: string
+ password: string
+}
+
+/**
+ * Provider-dispatched login. The `provider` field selects a strategy registered
+ * server-side in `Spree.store_authentication_strategies` (or `admin_authentication_strategies`).
+ * Additional fields are forwarded to the strategy's `authenticate` method — consult its
+ * documentation for the required shape (e.g. `{ provider: 'auth0', token: '<jwt>' }`).
+ */
+export interface ProviderLogin {
+ provider: string
+ [key: string]: unknown
+}
+
+export type LoginCredentials = EmailPasswordLogin | ProviderLogin
diff --git a/packages/sdk/.changeset/login-provider-dispatch.md b/packages/sdk/.changeset/login-provider-dispatch.md
new file mode 100644
index 0000000000..96a38803c8
--- /dev/null
+++ b/packages/sdk/.changeset/login-provider-dispatch.md
@@ -0,0 +1,5 @@
+---
+'@spree/sdk': minor
+---
+
+Add provider-dispatched login. `client.auth.login()` now accepts third-party identity-provider payloads (e.g. `{ provider: 'auth0', token: '<jwt>' }`) in addition to the existing `{ email, password }` shape — `LoginCredentials` is now a discriminated union of `EmailPasswordLogin | ProviderLogin`, both newly exported. Pairs with the server-side strategy registry at `Spree.store_authentication_strategies`. Existing email/password calls are unchanged.
diff --git a/packages/sdk/src/types/index.ts b/packages/sdk/src/types/index.ts
index 3d561252cb..ab7c8cff1f 100644
--- a/packages/sdk/src/types/index.ts
+++ b/packages/sdk/src/types/index.ts
@@ -85,10 +85,7 @@ export interface AuthTokens {
}
}
-export interface LoginCredentials {
- email: string
- password: string
-}
+export type { EmailPasswordLogin, LoginCredentials, ProviderLogin } from '@spree/sdk-core'
export interface RequestPasswordResetParams {
email: string
diff --git a/spree/api/app/controllers/spree/api/v3/admin/auth_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/auth_controller.rb
index f105a4a277..ec8be3f480 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/auth_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/auth_controller.rb
@@ -76,7 +76,7 @@ module Spree
def authentication_strategy
provider = params[:provider].presence || 'email'
- strategy_class = Rails.application.config.spree.admin_authentication_strategies[provider.to_sym]
+ strategy_class = Spree.admin_authentication_strategies[provider]
unless strategy_class
render_error(
diff --git a/spree/api/app/controllers/spree/api/v3/store/auth_controller.rb b/spree/api/app/controllers/spree/api/v3/store/auth_controller.rb
index c9f6a72083..0eecf9b910 100644
--- a/spree/api/app/controllers/spree/api/v3/store/auth_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/store/auth_controller.rb
@@ -6,10 +6,9 @@ module Spree
# Tighter rate limits for auth endpoints (per IP to prevent brute force)
rate_limit to: Spree::Api::Config[:rate_limit_login], within: Spree::Api::Config[:rate_limit_window].seconds, store: Rails.cache, only: :create, with: RATE_LIMIT_RESPONSE
rate_limit to: Spree::Api::Config[:rate_limit_refresh], within: Spree::Api::Config[:rate_limit_window].seconds, store: Rails.cache, only: :refresh, with: RATE_LIMIT_RESPONSE
- rate_limit to: Spree::Api::Config[:rate_limit_oauth], within: Spree::Api::Config[:rate_limit_window].seconds, store: Rails.cache, only: :oauth_callback, with: RATE_LIMIT_RESPONSE
rate_limit to: Spree::Api::Config[:rate_limit_refresh], within: Spree::Api::Config[:rate_limit_window].seconds, store: Rails.cache, only: :logout, with: RATE_LIMIT_RESPONSE
- skip_before_action :authenticate_user, only: [:create, :refresh, :oauth_callback]
+ skip_before_action :authenticate_user, only: [:create, :refresh, :logout]
# POST /api/v3/store/auth/login
# Supports multiple authentication providers via :provider param
@@ -69,37 +68,18 @@ module Spree
# POST /api/v3/store/auth/logout
# Accepts: { "refresh_token": "rt_xxx" }
- # Revokes the refresh token
+ # Revokes the submitted refresh token. The token itself is the
+ # credential — no access JWT is required, so clients with an expired
+ # access token can still log out. Matches Saleor's `tokenRevoke` and
+ # Shopify's `customerAccessTokenDelete` model.
def logout
refresh_token_value = params[:refresh_token]
- if refresh_token_value.present?
- Spree::RefreshToken.find_by(token: refresh_token_value)&.destroy
- end
+ Spree::RefreshToken.find_by(token: refresh_token_value)&.destroy if refresh_token_value.present?
head :no_content
end
- # POST /api/v3/store/auth/oauth/callback
- # OAuth callback endpoint for server-side OAuth flows
- def oauth_callback
- strategy = authentication_strategy
- return unless strategy # Error already rendered by determine_strategy
-
- result = strategy.authenticate
-
- if result.success?
- user = result.value
- render json: auth_response(user)
- else
- render_error(
- code: ERROR_CODES[:authentication_failed],
- message: result.error,
- status: :unauthorized
- )
- end
- end
-
protected
def serializer_params
@@ -133,6 +113,8 @@ module Spree
def authentication_strategy
strategy_class = determine_strategy
+ return nil unless strategy_class
+
strategy_class.new(
params: params,
request_env: request.headers.env,
@@ -142,10 +124,9 @@ module Spree
def determine_strategy
provider = params[:provider].presence || 'email'
- provider_key = provider.to_sym
# Retrieve pre-loaded strategy class from configuration
- strategy_class = Rails.application.config.spree.store_authentication_strategies[provider_key]
+ strategy_class = Spree.store_authentication_strategies[provider]
unless strategy_class
render_error(
diff --git a/spree/api/config/routes.rb b/spree/api/config/routes.rb
index 86c4af34a5..a625332798 100644
--- a/spree/api/config/routes.rb
+++ b/spree/api/config/routes.rb
@@ -6,7 +6,6 @@ Spree::Core::Engine.add_routes do
post 'auth/login', to: 'auth#create'
post 'auth/refresh', to: 'auth#refresh'
post 'auth/logout', to: 'auth#logout'
- post 'auth/oauth/callback', to: 'auth#oauth_callback'
# Markets
resources :markets, only: [:index, :show] do
diff --git a/spree/api/lib/spree/api/configuration.rb b/spree/api/lib/spree/api/configuration.rb
index 7fff758eea..435c9b6965 100644
--- a/spree/api/lib/spree/api/configuration.rb
+++ b/spree/api/lib/spree/api/configuration.rb
@@ -20,7 +20,6 @@ module Spree
preference :rate_limit_login, :integer, default: 5 # per IP
preference :rate_limit_register, :integer, default: 3 # per IP
preference :rate_limit_refresh, :integer, default: 10 # per IP
- preference :rate_limit_oauth, :integer, default: 5 # per IP
preference :rate_limit_password_reset, :integer, default: 3 # per IP
# Request body size limit in bytes
diff --git a/spree/api/lib/spree/api/openapi/schema_helper.rb b/spree/api/lib/spree/api/openapi/schema_helper.rb
index 7e6fd5233c..9d64f4882b 100644
--- a/spree/api/lib/spree/api/openapi/schema_helper.rb
+++ b/spree/api/lib/spree/api/openapi/schema_helper.rb
@@ -195,8 +195,16 @@ module Spree
def admin_schemas
schemas = common_schemas
- # Override AuthResponse to reference AdminUser instead of Customer
- schemas[:AuthResponse][:properties][:user] = { '$ref' => '#/components/schemas/AdminUser' }
+ # Override AuthResponse for admin: reference AdminUser, and drop refresh_token from the body
+ # (admin sets the refresh token as an HttpOnly cookie, not in the JSON response).
+ schemas[:AuthResponse] = {
+ type: :object,
+ properties: {
+ token: { type: :string, description: 'JWT access token' },
+ user: { '$ref' => '#/components/schemas/AdminUser' }
+ },
+ required: %w[token user]
+ }
begin
schemas.merge!(typelizer_schemas(:admin))
diff --git a/spree/api/spec/controllers/concerns/spree/api/v3/rate_limiting_spec.rb b/spree/api/spec/controllers/concerns/spree/api/v3/rate_limiting_spec.rb
index 2554469b59..3b5ace67f5 100644
--- a/spree/api/spec/controllers/concerns/spree/api/v3/rate_limiting_spec.rb
+++ b/spree/api/spec/controllers/concerns/spree/api/v3/rate_limiting_spec.rb
@@ -47,10 +47,6 @@ RSpec.describe 'Rate Limiting', type: :controller do
expect(Spree::Api::Config[:rate_limit_refresh]).to eq(10)
end
- it 'exposes rate_limit_oauth as a configurable preference' do
- expect(Spree::Api::Config[:rate_limit_oauth]).to eq(5)
- end
-
it 'exposes rate_limit_window as a configurable preference' do
expect(Spree::Api::Config[:rate_limit_window]).to eq(60)
end
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/auth_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/auth_controller_spec.rb
index c03286c83c..a9dd6992a8 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/auth_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/auth_controller_spec.rb
@@ -116,10 +116,89 @@ RSpec.describe Spree::Api::V3::Admin::AuthController, type: :controller do
expect(response).to have_http_status(:unauthorized)
end
end
+
+ context 'with a custom identity provider' do
+ let(:strategy_class) do
+ Class.new(Spree::Authentication::Strategies::BaseStrategy) do
+ def provider
+ 'okta'
+ end
+
+ def authenticate
+ token = params[:token]
+ return failure('invalid_token') if token != 'valid-jwt'
+
+ user = find_or_create_user_from_oauth(
+ provider: 'okta',
+ uid: 'okta-admin-1',
+ info: { email: '[email protected]', first_name: 'Sso', last_name: 'Admin' }
+ )
+ success(user)
+ end
+ end
+ end
+
+ around do |example|
+ Spree.admin_authentication_strategies.add(:okta, strategy_class)
+ example.run
+ ensure
+ Spree.admin_authentication_strategies.remove(:okta)
+ end
+
+ it 'dispatches to the registered strategy and returns a Spree admin JWT' do
+ post :create, params: { provider: 'okta', token: 'valid-jwt' }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['token']).to be_present
+ expect(json_response['user']['email']).to eq('[email protected]')
+ payload = JWT.decode(json_response['token'], Rails.application.secret_key_base, true, algorithm: 'HS256').first
+ expect(payload['aud']).to eq('admin_api')
+ expect(payload['user_type']).to eq('admin')
+ end
+
+ it 'sets the HttpOnly refresh cookie on a strategy success' do
+ post :create, params: { provider: 'okta', token: 'valid-jwt' }
+
+ line = set_cookie_for('spree_admin_refresh_token')
+ expect(line).to be_present
+ expect(line).to include('httponly')
+ end
+
+ it 'creates a UserIdentity mapped to an admin user on first login' do
+ expect {
+ post :create, params: { provider: 'okta', token: 'valid-jwt' }
+ }.to change(Spree::UserIdentity, :count).by(1)
+
+ identity = Spree::UserIdentity.last
+ expect(identity.provider).to eq('okta')
+ expect(identity.uid).to eq('okta-admin-1')
+ expect(identity.user_type).to eq(Spree.admin_user_class.name)
+ end
+
+ it 'reuses the existing admin user on subsequent logins' do
+ post :create, params: { provider: 'okta', token: 'valid-jwt' }
+ first_user_id = json_response['user']['id']
+
+ expect {
+ post :create, params: { provider: 'okta', token: 'valid-jwt' }
+ }.not_to change(Spree.admin_user_class, :count)
+
+ expect(json_response['user']['id']).to eq(first_user_id)
+ end
+
+ it 'returns unauthorized when the strategy fails and sets no cookie' do
+ post :create, params: { provider: 'okta', token: 'bad-jwt' }
+
+ expect(response).to have_http_status(:unauthorized)
+ expect(json_response['error']['code']).to eq('authentication_failed')
+ expect(json_response['error']['message']).to eq('invalid_token')
+ expect(set_cookie_for('spree_admin_refresh_token')).to be_nil
+ end
+ end
end
describe 'POST #refresh' do
- let(:refresh_token) { Spree::RefreshToken.create_for(admin_user, request_env: { ip_address: '127.0.0.1', user_agent: 'test' }) }
+ let(:refresh_token) { create(:refresh_token, user: admin_user, ip_address: '127.0.0.1', user_agent: 'test') }
context 'with a valid refresh cookie' do
before do
@@ -175,7 +254,7 @@ RSpec.describe Spree::Api::V3::Admin::AuthController, type: :controller do
end
describe 'POST #logout' do
- let(:refresh_token) { Spree::RefreshToken.create_for(admin_user, request_env: { ip_address: '127.0.0.1', user_agent: 'test' }) }
+ let(:refresh_token) { create(:refresh_token, user: admin_user, ip_address: '127.0.0.1', user_agent: 'test') }
context 'with a valid refresh cookie' do
before do
diff --git a/spree/api/spec/controllers/spree/api/v3/store/auth_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/auth_controller_spec.rb
index 6ea10e3774..0d068688a3 100644
--- a/spree/api/spec/controllers/spree/api/v3/store/auth_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/store/auth_controller_spec.rb
@@ -82,11 +82,93 @@ RSpec.describe Spree::Api::V3::Store::AuthController, type: :controller do
expect(response).to have_http_status(:unauthorized)
end
end
+
+ context 'with a custom identity provider' do
+ let(:strategy_class) do
+ Class.new(Spree::Authentication::Strategies::BaseStrategy) do
+ def provider
+ 'external_idp'
+ end
+
+ def authenticate
+ token = params[:token]
+ return failure('invalid_token') if token != 'valid-jwt'
+
+ user = find_or_create_user_from_oauth(
+ provider: 'external_idp',
+ uid: 'idp-user-1',
+ info: { email: '[email protected]', first_name: 'Alice' }
+ )
+ success(user)
+ end
+ end
+ end
+
+ around do |example|
+ Spree.store_authentication_strategies.add(:external_idp, strategy_class)
+ example.run
+ ensure
+ Spree.store_authentication_strategies.remove(:external_idp)
+ end
+
+ it 'dispatches to the registered strategy and returns a Spree JWT' do
+ post :create, params: { provider: 'external_idp', token: 'valid-jwt' }
+
+ expect(response).to have_http_status(:ok)
+ expect(json_response['token']).to be_present
+ expect(json_response['refresh_token']).to be_present
+ expect(json_response['user']['email']).to eq('[email protected]')
+ end
+
+ it 'creates a UserIdentity mapping on first login' do
+ expect {
+ post :create, params: { provider: 'external_idp', token: 'valid-jwt' }
+ }.to change(Spree::UserIdentity, :count).by(1)
+
+ identity = Spree::UserIdentity.last
+ expect(identity.provider).to eq('external_idp')
+ expect(identity.uid).to eq('idp-user-1')
+ end
+
+ it 'reuses the existing user on subsequent logins' do
+ post :create, params: { provider: 'external_idp', token: 'valid-jwt' }
+ first_user_id = json_response['user']['id']
+
+ expect {
+ post :create, params: { provider: 'external_idp', token: 'valid-jwt' }
+ }.not_to change(Spree.user_class, :count)
+
+ expect(json_response['user']['id']).to eq(first_user_id)
+ end
+
+ it 'returns unauthorized when the strategy fails' do
+ post :create, params: { provider: 'external_idp', token: 'bad-jwt' }
+
+ expect(response).to have_http_status(:unauthorized)
+ expect(json_response['error']['code']).to eq('authentication_failed')
+ expect(json_response['error']['message']).to eq('invalid_token')
+ end
+
+ it 'does not create a RefreshToken when the strategy fails' do
+ expect {
+ post :create, params: { provider: 'external_idp', token: 'bad-jwt' }
+ }.not_to change(Spree::RefreshToken, :count)
+ end
+ end
+
+ context 'with an unregistered provider' do
+ it 'returns bad_request' do
+ post :create, params: { provider: 'nope', token: 'whatever' }
+
+ expect(response).to have_http_status(:bad_request)
+ expect(json_response['error']['code']).to eq('invalid_provider')
+ end
+ end
end
describe 'POST #refresh' do
let!(:existing_user) { create(:user, password: 'password123', password_confirmation: 'password123') }
- let!(:refresh_token) { Spree::RefreshToken.create_for(existing_user) }
+ let!(:refresh_token) { create(:refresh_token, user: existing_user) }
it 'returns a new access token and rotated refresh token' do
post :refresh, params: { refresh_token: refresh_token.token }
@@ -149,7 +231,7 @@ RSpec.describe Spree::Api::V3::Store::AuthController, type: :controller do
describe 'POST #logout' do
let!(:existing_user) { create(:user, password: 'password123', password_confirmation: 'password123') }
- let!(:refresh_token) { Spree::RefreshToken.create_for(existing_user) }
+ let!(:refresh_token) { create(:refresh_token, user: existing_user) }
it 'revokes the refresh token' do
expect {
@@ -159,6 +241,14 @@ RSpec.describe Spree::Api::V3::Store::AuthController, type: :controller do
expect(response).to have_http_status(:no_content)
end
+ it 'works without an access token (the refresh token is the credential)' do
+ expect {
+ post :logout, params: { refresh_token: refresh_token.token }
+ }.to change(Spree::RefreshToken, :count).by(-1)
+
+ expect(response).to have_http_status(:no_content)
+ end
+
it 'succeeds even with invalid refresh token' do
post :logout, params: { refresh_token: 'nonexistent' }
diff --git a/spree/api/spec/integration/spree/api/v3/admin/auth_spec.rb b/spree/api/spec/integration/spree/api/v3/admin/auth_spec.rb
index e69de29bb2..78965fcfce 100644
--- a/spree/api/spec/integration/spree/api/v3/admin/auth_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/admin/auth_spec.rb
@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require 'swagger_helper'
+
+RSpec.describe 'Admin Authentication API', type: :request, swagger_doc: 'api-reference/admin.yaml' do
+ include_context 'API v3 Admin'
+
+ let!(:existing_admin) { create(:admin_user, email: '[email protected]', password: 'password123') }
+
+ path '/api/v3/admin/auth/login' do
+ post 'Login' do
+ tags 'Authentication'
+ consumes 'application/json'
+ produces 'application/json'
+ security [api_key: []]
+ description <<~DESC
+ Authenticates an admin user and returns a short-lived JWT access token.
+ The rotatable refresh token is set in an HttpOnly cookie — it is not
+ included in the response body.
+
+ Dispatches by the `provider` field to a strategy registered in
+ `Spree.admin_authentication_strategies`. When `provider` is omitted it
+ defaults to `email`, which uses the built-in email/password strategy.
+
+ To plug in a third-party identity provider (Okta, Azure AD, Google
+ Workspace SSO, a custom JWT issuer, SAML, etc.), register a
+ `Spree::Authentication::Strategies::BaseStrategy` subclass under a
+ provider key, then send `{ "provider": "<your_key>", ... }` with the
+ fields your strategy requires. The endpoint returns the same Spree-issued
+ JWT regardless of which strategy authenticated the request.
+ DESC
+
+ admin_sdk_example 'auth/login'
+
+ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
+ parameter name: :body, in: :body, schema: {
+ oneOf: [
+ {
+ title: 'EmailPasswordLogin',
+ description: 'Built-in email/password authentication (default when `provider` is omitted).',
+ type: :object,
+ properties: {
+ provider: { type: :string, enum: ['email'], default: 'email' },
+ email: { type: :string, format: 'email', example: '[email protected]' },
+ password: { type: :string, example: 'password123' }
+ },
+ required: %w[email password]
+ },
+ {
+ title: 'ProviderLogin',
+ description: <<~D,
+ Provider-dispatched login. The `provider` key selects a registered
+ strategy class; the remaining fields are forwarded to the strategy's
+ `authenticate` method. Required fields depend on the registered strategy
+ — consult its documentation.
+ D
+ type: :object,
+ properties: {
+ provider: {
+ type: :string,
+ example: 'okta',
+ description: 'Registered provider key (anything other than `email`).',
+ not: { enum: ['email'] }
+ }
+ },
+ required: %w[provider],
+ additionalProperties: true
+ }
+ ]
+ }
+
+ response '200', 'login successful' do
+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }
+ let(:body) { { email: existing_admin.email, password: 'password123' } }
+
+ schema '$ref' => '#/components/schemas/AuthResponse'
+
+ run_test! do |response|
+ data = JSON.parse(response.body)
+ expect(data['token']).to be_present
+ expect(data['user']).to be_present
+ expect(data['user']['email']).to eq(existing_admin.email)
+ expect(data).not_to have_key('refresh_token')
+ end
+ end
+
+ response '401', 'invalid credentials' do
+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }
+ let(:body) { { email: existing_admin.email, password: 'wrong_password' } }
+
+ schema '$ref' => '#/components/schemas/ErrorResponse'
+
+ run_test!
+ end
+ end
+ end
+
+ path '/api/v3/admin/auth/refresh' do
+ post 'Refresh token' do
+ tags 'Authentication'
+ produces 'application/json'
+ security [api_key: []]
+ description <<~DESC
+ Exchanges the HttpOnly refresh-token cookie for a new access JWT and a
+ rotated refresh token cookie. No request body or Authorization header
+ is required — the cookie alone authenticates the call.
+ DESC
+
+ admin_sdk_example 'auth/refresh'
+
+ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
+
+ response '200', 'refresh successful' do
+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }
+ let(:refresh_token_record) { create(:refresh_token, user: existing_admin) }
+
+ # rswag drives requests through Rack::Test, whose cookie jar can't sign cookies the
+ # way Rails does. Stub the cookie reader on the controller concern so the integration
+ # test can exercise the refresh-success path without reimplementing Rails' signing.
+ before do
+ token = refresh_token_record.token
+ allow_any_instance_of(Spree::Api::V3::Admin::AuthCookies).to receive(:refresh_token_from_cookie).and_return(token)
+ end
+
+ schema '$ref' => '#/components/schemas/AuthResponse'
+
+ run_test! do |response|
+ data = JSON.parse(response.body)
+ expect(data['token']).to be_present
+ expect(data['user']).to be_present
+ expect(data).not_to have_key('refresh_token')
+ end
+ end
+
+ response '401', 'missing or invalid refresh-token cookie' do
+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }
+
+ schema '$ref' => '#/components/schemas/ErrorResponse'
+
+ run_test!
+ end
+ end
+ end
+
+ path '/api/v3/admin/auth/logout' do
+ post 'Logout' do
+ tags 'Authentication'
+ produces 'application/json'
+ security [api_key: []]
+ description 'Revokes the refresh-token cookie, effectively logging the admin out.'
+
+ admin_sdk_example 'auth/logout'
+
+ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
+
+ response '204', 'logout successful' do
+ let(:'x-spree-api-key') { secret_api_key.plaintext_token }
+
+ run_test!
+ end
+ end
+ end
+end
diff --git a/spree/api/spec/integration/spree/api/v3/store/auth_spec.rb b/spree/api/spec/integration/spree/api/v3/store/auth_spec.rb
index 99aa459a69..6c8b1957e7 100644
--- a/spree/api/spec/integration/spree/api/v3/store/auth_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/auth_spec.rb
@@ -13,19 +13,58 @@ RSpec.describe 'Authentication API', type: :request, swagger_doc: 'api-reference
consumes 'application/json'
produces 'application/json'
security [api_key: []]
- description 'Authenticates a customer with email/password and returns a JWT token'
+ description <<~DESC
+ Authenticates a customer and returns a JWT access token + refresh token.
+
+ Dispatches by the `provider` field to a strategy registered in
+ `Spree.store_authentication_strategies`. When `provider` is omitted it
+ defaults to `email`, which uses the built-in email/password strategy.
+
+ To plug in a third-party identity provider (Auth0, Okta, Firebase, a
+ custom JWT issuer, SAML, etc.), register a `Spree::Authentication::Strategies::BaseStrategy`
+ subclass under a provider key, then send `{ "provider": "<your_key>", ... }`
+ with the fields your strategy requires. The endpoint returns the same
+ Spree-issued JWT + refresh token regardless of which strategy authenticated
+ the request.
+ DESC
sdk_example 'auth/login'
parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
parameter name: :body, in: :body, schema: {
- type: :object,
- properties: {
- provider: { type: :string, example: 'email', description: 'Authentication provider (default: email)' },
- email: { type: :string, format: 'email', example: '[email protected]' },
- password: { type: :string, example: 'password123' }
- },
- required: %w[email password]
+ oneOf: [
+ {
+ title: 'EmailPasswordLogin',
+ description: 'Built-in email/password authentication (default when `provider` is omitted).',
+ type: :object,
+ properties: {
+ provider: { type: :string, enum: ['email'], default: 'email' },
+ email: { type: :string, format: 'email', example: '[email protected]' },
+ password: { type: :string, example: 'password123' }
+ },
+ required: %w[email password]
+ },
+ {
+ title: 'ProviderLogin',
+ description: <<~D,
+ Provider-dispatched login. The `provider` key selects a registered
+ strategy class; the remaining fields are forwarded to the strategy's
+ `authenticate` method. Required fields depend on the registered strategy
+ — consult its documentation.
+ D
+ type: :object,
+ properties: {
+ provider: {
+ type: :string,
+ example: 'auth0',
+ description: 'Registered provider key (anything other than `email`).',
+ not: { enum: ['email'] }
+ }
+ },
+ required: %w[provider],
+ additionalProperties: true
+ }
+ ]
}
response '200', 'login successful' do
@@ -92,7 +131,7 @@ RSpec.describe 'Authentication API', type: :request, swagger_doc: 'api-reference
response '200', 'token refreshed' do
let(:'x-spree-api-key') { api_key.token }
- let(:refresh_token_record) { Spree::RefreshToken.create_for(existing_user) }
+ let(:refresh_token_record) { create(:refresh_token, user: existing_user) }
let(:body) { { refresh_token: refresh_token_record.token } }
schema '$ref' => '#/components/schemas/AuthResponse'
@@ -121,13 +160,12 @@ RSpec.describe 'Authentication API', type: :request, swagger_doc: 'api-reference
tags 'Authentication'
consumes 'application/json'
produces 'application/json'
- security [api_key: [], bearer_auth: []]
- description 'Revokes the refresh token, effectively logging the customer out.'
+ security [api_key: []]
+ description 'Revokes the submitted refresh token. The refresh token itself is the credential — no Authorization header is required, so a client with an expired access JWT can still log out.'
sdk_example 'auth/logout'
parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
- parameter name: 'Authorization', in: :header, type: :string, required: true
parameter name: :body, in: :body, schema: {
type: :object,
properties: {
@@ -137,8 +175,7 @@ RSpec.describe 'Authentication API', type: :request, swagger_doc: 'api-reference
response '204', 'logout successful' do
let(:'x-spree-api-key') { api_key.token }
- let(:'Authorization') { "Bearer #{jwt_token}" }
- let(:refresh_token_record) { Spree::RefreshToken.create_for(existing_user) }
+ let(:refresh_token_record) { create(:refresh_token, user: existing_user) }
let(:body) { { refresh_token: refresh_token_record.token } }
run_test! do
@@ -148,7 +185,6 @@ RSpec.describe 'Authentication API', type: :request, swagger_doc: 'api-reference
response '204', 'logout without refresh token (no-op)' do
let(:'x-spree-api-key') { api_key.token }
- let(:'Authorization') { "Bearer #{jwt_token}" }
let(:body) { {} }
run_test!
diff --git a/spree/core/app/models/spree/authentication/strategy_registry.rb b/spree/core/app/models/spree/authentication/strategy_registry.rb
new file mode 100644
index 0000000000..847fe86656
--- /dev/null
+++ b/spree/core/app/models/spree/authentication/strategy_registry.rb
@@ -0,0 +1,72 @@
+require 'forwardable'
+
+module Spree
+ module Authentication
+ # Keyed registry of authentication strategy classes for the Store and Admin APIs.
+ #
+ # Strategies are dispatched by the `provider` value the client sends to the auth
+ # endpoint, so the registry is a key → class map. The `:email` key is reserved for
+ # the built-in {Spree::Authentication::Strategies::EmailPasswordStrategy}; integrators
+ # can override it by adding a different class under the same key.
+ #
+ # @example Registering a custom provider
+ # Spree.store_authentication_strategies.add(:auth0, MyApp::Auth::Auth0Strategy)
+ #
+ # @example Removing a provider
+ # Spree.store_authentication_strategies.remove(:email)
+ #
+ # @example Reading a strategy class
+ # Spree.store_authentication_strategies[:email]
+ class StrategyRegistry
+ extend Forwardable
+ include Enumerable
+
+ def_delegators :@strategies, :keys, :values, :each
+
+ def initialize(strategies = {})
+ @strategies = {}
+ strategies.each { |key, klass| add(key, klass) }
+ end
+
+ # Register a strategy class under the given provider key. Overwrites any
+ # existing entry for that key.
+ #
+ # @param key [Symbol, String] provider identifier sent by the client
+ # @param strategy_class [Class] strategy class (typically a subclass of
+ # {Spree::Authentication::Strategies::BaseStrategy})
+ # @return [Class] the registered class
+ def add(key, strategy_class)
+ @strategies[key.to_sym] = strategy_class
+ end
+
+ # Unregister a strategy. Idempotent — returns `nil` if the key is not present.
+ #
+ # @param key [Symbol, String]
+ # @return [Class, nil] the removed class, or nil if no such key
+ def remove(key)
+ @strategies.delete(key.to_sym)
+ end
+
+ # Look up a registered strategy class.
+ #
+ # @param key [Symbol, String] provider identifier
+ # @return [Class, nil] the registered strategy class, or nil if no such key
+ def [](key)
+ @strategies[key.to_sym]
+ end
+
+ # Whether a strategy is registered under the given provider key.
+ #
+ # @param key [Symbol, String]
+ # @return [Boolean]
+ def key?(key)
+ @strategies.key?(key.to_sym)
+ end
+
+ # @return [Hash{Symbol => Class}] a shallow copy of the underlying map
+ def to_h
+ @strategies.dup
+ end
+ end
+ end
+end
diff --git a/spree/core/app/models/spree/user_identity.rb b/spree/core/app/models/spree/user_identity.rb
index 25ab7e5584..87d763bc3a 100644
--- a/spree/core/app/models/spree/user_identity.rb
+++ b/spree/core/app/models/spree/user_identity.rb
@@ -9,8 +9,7 @@ module Spree
validates :provider, inclusion: {
in: ->(_record) {
- config = Rails.application.config.spree
- (config.store_authentication_strategies.keys + config.admin_authentication_strategies.keys).uniq.map(&:to_s)
+ (Spree.store_authentication_strategies.keys + Spree.admin_authentication_strategies.keys).uniq.map(&:to_s)
}
}
diff --git a/spree/core/lib/spree/core.rb b/spree/core/lib/spree/core.rb
index 68c08e9dde..f69d46155a 100644
--- a/spree/core/lib/spree/core.rb
+++ b/spree/core/lib/spree/core.rb
@@ -354,6 +354,36 @@ module Spree
Rails.application.config.spree.pricing = value
end
+ # Registry of authentication strategy classes for the Store API.
+ # @return [Spree::Authentication::StrategyRegistry]
+ # @example Registering a third-party identity provider
+ # Spree.store_authentication_strategies.add(:auth0, MyApp::Auth::Auth0Strategy)
+ # @example Removing a strategy
+ # Spree.store_authentication_strategies.remove(:email)
+ def self.store_authentication_strategies
+ Rails.application.config.spree.store_authentication_strategies
+ end
+
+ # @param value [Spree::Authentication::StrategyRegistry] the registry to use for Store API authentication dispatch
+ # @return [Spree::Authentication::StrategyRegistry] the assigned registry
+ def self.store_authentication_strategies=(value)
+ Rails.application.config.spree.store_authentication_strategies = value
+ end
+
+ # Registry of authentication strategy classes for the Admin API.
+ # @return [Spree::Authentication::StrategyRegistry]
+ # @example Registering an SSO strategy for admin users
+ # Spree.admin_authentication_strategies.add(:okta, MyApp::Auth::OktaStrategy)
+ def self.admin_authentication_strategies
+ Rails.application.config.spree.admin_authentication_strategies
+ end
+
+ # @param value [Spree::Authentication::StrategyRegistry] the registry to use for Admin API authentication dispatch
+ # @return [Spree::Authentication::StrategyRegistry] the assigned registry
+ def self.admin_authentication_strategies=(value)
+ Rails.application.config.spree.admin_authentication_strategies = value
+ end
+
def self.analytics
@analytics ||= AnalyticsConfig.new
end
diff --git a/spree/core/lib/spree/core/engine.rb b/spree/core/lib/spree/core/engine.rb
index c4adfce923..dc298a17a8 100644
--- a/spree/core/lib/spree/core/engine.rb
+++ b/spree/core/lib/spree/core/engine.rb
@@ -320,12 +320,12 @@ module Spree
]
# Pre-load authentication strategy classes to avoid reflection at request time
- Rails.application.config.spree.store_authentication_strategies = {
+ Rails.application.config.spree.store_authentication_strategies = Spree::Authentication::StrategyRegistry.new(
email: Spree::Authentication::Strategies::EmailPasswordStrategy
- }
- Rails.application.config.spree.admin_authentication_strategies = {
+ )
+ Rails.application.config.spree.admin_authentication_strategies = Spree::Authentication::StrategyRegistry.new(
email: Spree::Authentication::Strategies::EmailPasswordStrategy
- }
+ )
end
initializer 'spree.promo.register.promotions.actions' do |app|
diff --git a/spree/core/lib/spree/testing_support/factories/refresh_token_factory.rb b/spree/core/lib/spree/testing_support/factories/refresh_token_factory.rb
new file mode 100644
index 0000000000..94cc80ef26
--- /dev/null
+++ b/spree/core/lib/spree/testing_support/factories/refresh_token_factory.rb
@@ -0,0 +1,15 @@
+FactoryBot.define do
+ factory :refresh_token, class: 'Spree::RefreshToken' do
+ association :user, factory: :user
+ user_type { user.class.to_s }
+ expires_at { Spree::RefreshToken.default_expiry.from_now }
+
+ trait :for_admin do
+ association :user, factory: :admin_user
+ end
+
+ trait :expired do
+ expires_at { 1.minute.ago }
+ end
+ end
+end
diff --git a/spree/core/spec/models/spree/authentication/strategy_registry_spec.rb b/spree/core/spec/models/spree/authentication/strategy_registry_spec.rb
new file mode 100644
index 0000000000..16a585a73e
--- /dev/null
+++ b/spree/core/spec/models/spree/authentication/strategy_registry_spec.rb
@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe Spree::Authentication::StrategyRegistry do
+ let(:strategy_class) { Class.new }
+ let(:other_strategy_class) { Class.new }
+
+ describe '#add' do
+ it 'registers a strategy under the given key' do
+ registry = described_class.new
+ registry.add(:auth0, strategy_class)
+ expect(registry[:auth0]).to eq(strategy_class)
+ end
+
+ it 'symbolizes string keys' do
+ registry = described_class.new
+ registry.add('okta', strategy_class)
+ expect(registry[:okta]).to eq(strategy_class)
+ end
+
+ it 'overwrites an existing entry under the same key' do
+ registry = described_class.new(email: strategy_class)
+ registry.add(:email, other_strategy_class)
+ expect(registry[:email]).to eq(other_strategy_class)
+ end
+
+ it 'returns the registered class' do
+ registry = described_class.new
+ expect(registry.add(:auth0, strategy_class)).to eq(strategy_class)
+ end
+ end
+
+ describe '#remove' do
+ it 'unregisters the strategy and returns it' do
+ registry = described_class.new(email: strategy_class)
+ expect(registry.remove(:email)).to eq(strategy_class)
+ expect(registry[:email]).to be_nil
+ end
+
+ it 'returns nil for a missing key (idempotent)' do
+ registry = described_class.new
+ expect(registry.remove(:unknown)).to be_nil
+ end
+
+ it 'accepts string keys' do
+ registry = described_class.new(email: strategy_class)
+ expect(registry.remove('email')).to eq(strategy_class)
+ end
+ end
+
+ describe '#[]' do
+ it 'symbolizes string lookups' do
+ registry = described_class.new(email: strategy_class)
+ expect(registry['email']).to eq(strategy_class)
+ end
+
+ it 'returns nil for unknown keys' do
+ expect(described_class.new[:nope]).to be_nil
+ end
+ end
+
+ describe '#key?' do
+ it 'is true for registered keys' do
+ registry = described_class.new(email: strategy_class)
+ expect(registry.key?(:email)).to be true
+ expect(registry.key?('email')).to be true
+ end
+
+ it 'is false for unknown keys' do
+ expect(described_class.new.key?(:nope)).to be false
+ end
+ end
+
+ describe '#keys / #values / #each' do
+ let(:registry) { described_class.new(email: strategy_class, auth0: other_strategy_class) }
+
+ it 'exposes the registered keys' do
+ expect(registry.keys).to contain_exactly(:email, :auth0)
+ end
+
+ it 'exposes the registered classes' do
+ expect(registry.values).to contain_exactly(strategy_class, other_strategy_class)
+ end
+
+ it 'iterates key/class pairs (Enumerable)' do
+ expect(registry.map { |k, v| [k, v] }).to contain_exactly([:email, strategy_class], [:auth0, other_strategy_class])
+ end
+ end
+
+ describe '#to_h' do
+ it 'returns a copy of the underlying hash' do
+ registry = described_class.new(email: strategy_class)
+ copy = registry.to_h
+ copy[:tampered] = Object
+ expect(registry.key?(:tampered)).to be false
+ end
+ end
+end
diff --git a/spree/core/spec/models/spree/user_identity_spec.rb b/spree/core/spec/models/spree/user_identity_spec.rb
index 0d1b26408f..4b274d336e 100644
--- a/spree/core/spec/models/spree/user_identity_spec.rb
+++ b/spree/core/spec/models/spree/user_identity_spec.rb
@@ -30,11 +30,11 @@ describe Spree::UserIdentity, type: :model do
end
it 'allows same uid for different providers' do
- Rails.application.config.spree.store_authentication_strategies[:other] = Class.new
+ Spree.store_authentication_strategies.add(:other, Class.new)
different_provider = build(:user_identity, user: user, provider: 'other', uid: '12345')
expect(different_provider).to be_valid
ensure
- Rails.application.config.spree.store_authentication_strategies.delete(:other)
+ Spree.store_authentication_strategies.remove(:other)
end
it 'allows same uid for different user types' do