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.

Simplify Currencies and Countries APIs (#13636)

Damian Legawiecd9a7de96a8bb
diff --git a/CLAUDE.md b/CLAUDE.md
index d3d131f5c4..c563f632bc 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -642,6 +642,8 @@ products = Spree::Product.includes(:variants, :thumbnail)
- Explain non-obvious code patterns
- Use YARD documentation format for public APIs
- Keep comments up-to-date with code changes
+- Please check and update documentation in docs/developer
+- Always re-generate OpenAPI documentation using rswag when changing API
## Error Handling
diff --git a/backend/engines/api/app/controllers/spree/api/v3/store/countries_controller.rb b/backend/engines/api/app/controllers/spree/api/v3/store/countries_controller.rb
new file mode 100644
index 0000000000..0a3145f562
--- /dev/null
+++ b/backend/engines/api/app/controllers/spree/api/v3/store/countries_controller.rb
@@ -0,0 +1,31 @@
+module Spree
+ module Api
+ module V3
+ module Store
+ class CountriesController < Store::BaseController
+ # GET /api/v3/store/countries
+ def index
+ countries = current_store.countries_from_markets
+
+ render json: {
+ data: countries.map { |country| serialize_country(country) }
+ }
+ end
+
+ # GET /api/v3/store/countries/:id
+ def show
+ country = current_store.countries_from_markets.find_by!(iso: params[:id].upcase)
+
+ render json: serialize_country(country)
+ end
+
+ private
+
+ def serialize_country(country)
+ Spree.api.country_serializer.new(country, params: serializer_params).to_h
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/backend/engines/api/app/controllers/spree/api/v3/store/currencies_controller.rb b/backend/engines/api/app/controllers/spree/api/v3/store/currencies_controller.rb
new file mode 100644
index 0000000000..d37dd1a613
--- /dev/null
+++ b/backend/engines/api/app/controllers/spree/api/v3/store/currencies_controller.rb
@@ -0,0 +1,18 @@
+module Spree
+ module Api
+ module V3
+ module Store
+ class CurrenciesController < Store::BaseController
+ # GET /api/v3/store/currencies
+ def index
+ currencies = current_store.supported_currencies_list
+
+ render json: {
+ data: currencies.map { |currency| Spree.api.currency_serializer.new(currency).to_h }
+ }
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/backend/engines/api/app/controllers/spree/api/v3/store/locales_controller.rb b/backend/engines/api/app/controllers/spree/api/v3/store/locales_controller.rb
new file mode 100644
index 0000000000..b4d284b8d5
--- /dev/null
+++ b/backend/engines/api/app/controllers/spree/api/v3/store/locales_controller.rb
@@ -0,0 +1,24 @@
+module Spree
+ module Api
+ module V3
+ module Store
+ class LocalesController < Store::BaseController
+ # GET /api/v3/store/locales
+ def index
+ locales = current_store.supported_locales_list
+
+ render json: {
+ data: locales.map { |code| Spree.api.locale_serializer.new(OpenStruct.new(code: code, name: locale_name(code))).to_h }
+ }
+ end
+
+ private
+
+ def locale_name(code)
+ I18n.t('spree.i18n.this_file_language', locale: code, default: code)
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/backend/engines/api/app/controllers/spree/api/v3/store/markets/countries_controller.rb b/backend/engines/api/app/controllers/spree/api/v3/store/markets/countries_controller.rb
deleted file mode 100644
index 46170e0a10..0000000000
--- a/backend/engines/api/app/controllers/spree/api/v3/store/markets/countries_controller.rb
+++ /dev/null
@@ -1,45 +0,0 @@
-module Spree
- module Api
- module V3
- module Store
- module Markets
- class CountriesController < Store::BaseController
- # GET /api/v3/store/markets/:market_id/countries
- # Returns countries in the market (for checkout address dropdown)
- def index
- countries = market.countries.order(:name)
-
- render json: {
- data: countries.map { |country| serialize_country(country) }
- }
- end
-
- # GET /api/v3/store/markets/:market_id/countries/:id
- # Returns a single country with states (for address form validation)
- def show
- country = market.countries.find_by!(iso: params[:id].upcase)
-
- render json: serialize_country(country, include_states: true)
- end
-
- private
-
- def market
- @market ||= current_store.markets.find_by_prefix_id!(params[:market_id])
- end
-
- def serialize_country(country, include_states: false)
- data = Spree.api.country_serializer.new(country, params: { includes: [] }).to_h
-
- if include_states
- data[:states] = country.states.order(:name).map { |s| Spree.api.state_serializer.new(s).to_h }
- end
-
- data
- end
- end
- end
- end
- end
- end
-end
diff --git a/backend/engines/api/app/controllers/spree/api/v3/store/markets_controller.rb b/backend/engines/api/app/controllers/spree/api/v3/store/markets_controller.rb
deleted file mode 100644
index fd2e3eb36f..0000000000
--- a/backend/engines/api/app/controllers/spree/api/v3/store/markets_controller.rb
+++ /dev/null
@@ -1,48 +0,0 @@
-module Spree
- module Api
- module V3
- module Store
- class MarketsController < Store::BaseController
- # GET /api/v3/store/markets
- # Returns all markets with nested countries (for country/currency switcher)
- def index
- markets = current_store.markets.order(:position).includes(:countries)
-
- render json: {
- data: markets.map { |market| serialize_market(market) }
- }
- end
-
- # GET /api/v3/store/markets/:id
- # Returns a single market with countries
- def show
- market = current_store.markets.find_by_prefix_id!(params[:id])
-
- render json: serialize_market(market)
- end
-
- # GET /api/v3/store/markets/resolve?country=DE
- # Resolves country ISO code to market
- def resolve
- country_iso = params[:country]&.upcase
- return render_error(code: 'invalid_params', message: 'country parameter is required', status: :bad_request) if country_iso.blank?
-
- country = Spree::Country.find_by(iso: country_iso)
- return render_error(code: 'record_not_found', message: 'country not found', status: :not_found) unless country
-
- market = current_store.market_for_country(country)
- return render_error(code: 'record_not_found', message: 'no market found for country', status: :not_found) unless market
-
- render json: serialize_market(market)
- end
-
- private
-
- def serialize_market(market)
- Spree.api.market_serializer.new(market, params: serializer_params).to_h
- end
- end
- end
- end
- end
-end
diff --git a/backend/engines/api/app/serializers/spree/api/v3/country_serializer.rb b/backend/engines/api/app/serializers/spree/api/v3/country_serializer.rb
index 6de62b7d2e..471dd87cef 100644
--- a/backend/engines/api/app/serializers/spree/api/v3/country_serializer.rb
+++ b/backend/engines/api/app/serializers/spree/api/v3/country_serializer.rb
@@ -7,10 +7,25 @@ module Spree
# ISO 3166-1 codes - iso is the identifier, no redundant id field
typelize iso: :string, iso3: :string, name: :string,
- states_required: :boolean, zipcode_required: :boolean
+ states_required: :boolean, zipcode_required: :boolean,
+ currency: [:string, nullable: true],
+ default_locale: [:string, nullable: true],
+ supported_locales: [:string, multi: true]
attributes :iso, :iso3, :name, :states_required, :zipcode_required
+ attribute :currency do |country|
+ country.market_currency
+ end
+
+ attribute :default_locale do |country|
+ country.market_locale
+ end
+
+ attribute :supported_locales do |country|
+ country.market_supported_locales
+ end
+
many :states,
resource: Spree.api.state_serializer,
if: proc { params[:includes]&.include?('states') }
diff --git a/backend/engines/api/app/serializers/spree/api/v3/currency_serializer.rb b/backend/engines/api/app/serializers/spree/api/v3/currency_serializer.rb
new file mode 100644
index 0000000000..822a69703c
--- /dev/null
+++ b/backend/engines/api/app/serializers/spree/api/v3/currency_serializer.rb
@@ -0,0 +1,14 @@
+module Spree
+ module Api
+ module V3
+ class CurrencySerializer
+ include Alba::Resource
+ include Typelizer::DSL
+
+ typelize iso_code: :string, name: :string, symbol: :string
+
+ attributes :iso_code, :name, :symbol
+ end
+ end
+ end
+end
diff --git a/backend/engines/api/app/serializers/spree/api/v3/locale_serializer.rb b/backend/engines/api/app/serializers/spree/api/v3/locale_serializer.rb
new file mode 100644
index 0000000000..43978bfe15
--- /dev/null
+++ b/backend/engines/api/app/serializers/spree/api/v3/locale_serializer.rb
@@ -0,0 +1,14 @@
+module Spree
+ module Api
+ module V3
+ class LocaleSerializer
+ include Alba::Resource
+ include Typelizer::DSL
+
+ typelize code: :string, name: :string
+
+ attributes :code, :name
+ end
+ end
+ end
+end
diff --git a/backend/engines/api/app/serializers/spree/api/v3/market_serializer.rb b/backend/engines/api/app/serializers/spree/api/v3/market_serializer.rb
deleted file mode 100644
index 53bb5b780e..0000000000
--- a/backend/engines/api/app/serializers/spree/api/v3/market_serializer.rb
+++ /dev/null
@@ -1,24 +0,0 @@
-module Spree
- module Api
- module V3
- class MarketSerializer < BaseSerializer
- typelize name: :string, currency: :string,
- default_locale: :string, supported_locales: 'string[]',
- tax_inclusive: :boolean, default: :boolean,
- countries: 'StoreCountry[]'
-
- attributes :name, :currency, :default_locale, :tax_inclusive, :default
-
- attribute :supported_locales do |market|
- market.supported_locales_list
- end
-
- attribute :countries do |market|
- market.countries.order(:name).map do |country|
- Spree.api.country_serializer.new(country, params: { includes: [] }).to_h
- end
- end
- end
- end
- end
-end
diff --git a/backend/engines/api/config/routes.rb b/backend/engines/api/config/routes.rb
index 1aef70562c..632bac3f34 100644
--- a/backend/engines/api/config/routes.rb
+++ b/backend/engines/api/config/routes.rb
@@ -11,13 +11,10 @@ Spree::Core::Engine.add_routes do
# Store
resource :store, only: [:show]
- # Markets - geography + currency + locale bundles
- resources :markets, only: [:index, :show] do
- collection do
- get :resolve
- end
- resources :countries, only: [:index, :show], controller: 'markets/countries'
- end
+ # Countries, Currencies, Locales (flat, market-aware)
+ resources :countries, only: [:index, :show]
+ resources :currencies, only: [:index]
+ resources :locales, only: [:index]
# Catalog
resources :products, only: [:index, :show] do
diff --git a/backend/engines/api/lib/spree/api/dependencies.rb b/backend/engines/api/lib/spree/api/dependencies.rb
index 760e2f9ee3..b9ab220d34 100644
--- a/backend/engines/api/lib/spree/api/dependencies.rb
+++ b/backend/engines/api/lib/spree/api/dependencies.rb
@@ -122,7 +122,8 @@ module Spree
order_promotion_serializer: 'Spree::Api::V3::OrderPromotionSerializer',
digital_link_serializer: 'Spree::Api::V3::DigitalLinkSerializer',
gift_card_serializer: 'Spree::Api::V3::GiftCardSerializer',
- market_serializer: 'Spree::Api::V3::MarketSerializer',
+ currency_serializer: 'Spree::Api::V3::CurrencySerializer',
+ locale_serializer: 'Spree::Api::V3::LocaleSerializer',
metafield_serializer: 'Spree::Api::V3::MetafieldSerializer',
# v3 admin serializers (API v3 Admin)
diff --git a/backend/engines/api/spec/controllers/spree/api/v3/store/markets/countries_controller_spec.rb b/backend/engines/api/spec/controllers/spree/api/v3/store/markets/countries_controller_spec.rb
deleted file mode 100644
index 37f84047e0..0000000000
--- a/backend/engines/api/spec/controllers/spree/api/v3/store/markets/countries_controller_spec.rb
+++ /dev/null
@@ -1,56 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Spree::Api::V3::Store::Markets::CountriesController, type: :controller do
- render_views
-
- include_context 'API v3 Store'
-
- let(:country) { create(:country) }
- let!(:market) { create(:market, store: store, countries: [country]) }
-
- before do
- request.headers['x-spree-api-key'] = api_key.token
- end
-
- describe 'GET #index' do
- it 'returns countries from the market zone' do
- get :index, params: { market_id: market.prefixed_id }
-
- expect(response).to have_http_status(:ok)
- expect(json_response['data'].size).to eq(1)
- expect(json_response['data'].first['iso']).to eq(country.iso)
- end
-
- it 'does not include states by default' do
- create(:state, country: country)
- get :index, params: { market_id: market.prefixed_id }
-
- expect(json_response['data'].first).not_to have_key('states')
- end
- end
-
- describe 'GET #show' do
- it 'returns country with states' do
- state = create(:state, country: country)
- get :show, params: { market_id: market.prefixed_id, id: country.iso }
-
- expect(response).to have_http_status(:ok)
- expect(json_response['iso']).to eq(country.iso)
- expect(json_response['states']).to be_present
- expect(json_response['states'].first['abbr']).to eq(state.abbr)
- end
-
- it 'returns not found for country not in market' do
- other_country = create(:country)
- get :show, params: { market_id: market.prefixed_id, id: other_country.iso }
-
- expect(response).to have_http_status(:not_found)
- end
-
- it 'returns not found for invalid market' do
- get :show, params: { market_id: 'mkt_nonexistent', id: country.iso }
-
- expect(response).to have_http_status(:not_found)
- end
- end
-end
diff --git a/backend/engines/api/spec/controllers/spree/api/v3/store/markets_controller_spec.rb b/backend/engines/api/spec/controllers/spree/api/v3/store/markets_controller_spec.rb
deleted file mode 100644
index 3a2ccc0f23..0000000000
--- a/backend/engines/api/spec/controllers/spree/api/v3/store/markets_controller_spec.rb
+++ /dev/null
@@ -1,91 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe Spree::Api::V3::Store::MarketsController, type: :controller do
- render_views
-
- include_context 'API v3 Store'
-
- let(:country) { create(:country) }
- let!(:market) { create(:market, :default, store: store, countries: [country], name: 'North America', currency: 'USD') }
-
- before do
- request.headers['x-spree-api-key'] = api_key.token
- end
-
- describe 'GET #index' do
- it 'returns list of markets' do
- get :index
-
- expect(response).to have_http_status(:ok)
- expect(json_response['data'].size).to eq(1)
- end
-
- it 'returns market attributes with countries' do
- get :index
-
- market_data = json_response['data'].first
- expect(market_data['id']).to eq(market.prefixed_id)
- expect(market_data['name']).to eq('North America')
- expect(market_data['currency']).to eq('USD')
- expect(market_data['default_locale']).to eq('en')
- expect(market_data['supported_locales']).to eq(['en'])
- expect(market_data['default']).to be true
- expect(market_data['countries']).to be_an(Array)
- end
-
- context 'without API key' do
- before { request.headers['x-spree-api-key'] = nil }
-
- it 'returns unauthorized' do
- get :index
-
- expect(response).to have_http_status(:unauthorized)
- end
- end
- end
-
- describe 'GET #show' do
- it 'returns the market' do
- get :show, params: { id: market.prefixed_id }
-
- expect(response).to have_http_status(:ok)
- expect(json_response['id']).to eq(market.prefixed_id)
- expect(json_response['name']).to eq('North America')
- expect(json_response['countries']).to be_an(Array)
- end
-
- it 'returns not found for non-existent market' do
- get :show, params: { id: 'mkt_nonexistent' }
-
- expect(response).to have_http_status(:not_found)
- end
- end
-
- describe 'GET #resolve' do
- it 'resolves country to market' do
- get :resolve, params: { country: country.iso }
-
- expect(response).to have_http_status(:ok)
- expect(json_response['id']).to eq(market.prefixed_id)
- end
-
- it 'returns not found for country not in any market' do
- other_country = create(:country)
- get :resolve, params: { country: other_country.iso }
-
- expect(response).to have_http_status(:not_found)
- end
-
- it 'returns bad request without country param' do
- get :resolve, params: {}
-
- expect(response).to have_http_status(:bad_request)
- end
-
- it 'returns not found for invalid country ISO' do
- get :resolve, params: { country: 'XX' }
-
- expect(response).to have_http_status(:not_found)
- end
- end
-end
diff --git a/backend/engines/api/spec/integration/spree/api/v3/store/countries_spec.rb b/backend/engines/api/spec/integration/spree/api/v3/store/countries_spec.rb
index 567ed71039..a2d0bdf0be 100644
--- a/backend/engines/api/spec/integration/spree/api/v3/store/countries_spec.rb
+++ b/backend/engines/api/spec/integration/spree/api/v3/store/countries_spec.rb
@@ -2,7 +2,7 @@
require 'swagger_helper'
-RSpec.describe 'Markets Countries API', type: :request, swagger_doc: 'api-reference/store.yaml' do
+RSpec.describe 'Countries API', type: :request, swagger_doc: 'api-reference/store.yaml' do
include_context 'API v3 Store'
let!(:usa) { Spree::Country.find_by(iso: 'US') || create(:country, iso: 'US', name: 'United States', states_required: true) }
@@ -10,19 +10,17 @@ RSpec.describe 'Markets Countries API', type: :request, swagger_doc: 'api-refere
let!(:new_york) { Spree::State.find_by(abbr: 'NY', country: usa) || create(:state, country: usa, name: 'New York', abbr: 'NY') }
let!(:germany) { Spree::Country.find_by(iso: 'DE') || create(:country, iso: 'DE', name: 'Germany', states_required: false) }
- let!(:market) { create(:market, :default, store: store, countries: [usa, germany]) }
- let(:market_id) { market.prefixed_id }
+ let!(:na_market) { create(:market, :default, name: 'North America', store: store, countries: [usa], currency: 'USD', default_locale: 'en', supported_locales: 'en,es') }
+ let!(:eu_market) { create(:market, name: 'Europe', store: store, countries: [germany], currency: 'EUR', default_locale: 'de', supported_locales: 'de,en') }
- path '/api/v3/store/markets/{market_id}/countries' do
- get 'List countries in a market' do
- tags 'Countries'
+ path '/api/v3/store/countries' do
+ get 'List countries' do
+ tags 'Internationalization'
produces 'application/json'
security [api_key: []]
- description 'Returns countries available in the market (for checkout address dropdown)'
+ description 'Returns countries available in the store with their currency and locale (derived from markets)'
parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
- parameter name: :market_id, in: :path, type: :string, required: true,
- description: 'Market prefixed ID (e.g., "mkt_abc123")'
response '200', 'countries found' do
let(:'x-spree-api-key') { api_key.token }
@@ -31,28 +29,27 @@ RSpec.describe 'Markets Countries API', type: :request, swagger_doc: 'api-refere
properties: {
data: {
type: :array,
- items: {
- type: :object,
- properties: {
- iso: { type: :string, description: 'ISO 3166-1 alpha-2 code' },
- iso3: { type: :string, description: 'ISO 3166-1 alpha-3 code' },
- name: { type: :string },
- states_required: { type: :boolean },
- zipcode_required: { type: :boolean }
- },
- required: %w[iso iso3 name states_required zipcode_required]
- }
+ items: { '$ref' => '#/components/schemas/StoreCountry' }
}
},
required: ['data']
run_test! do |response|
data = JSON.parse(response.body)
- expect(data['data']).to be_an(Array)
+ expect(data['data'].size).to eq(2)
+
us_country = data['data'].find { |c| c['iso'] == 'US' }
expect(us_country).to be_present
expect(us_country['name']).to be_present
- expect(us_country).not_to have_key('states')
+ expect(us_country['currency']).to eq('USD')
+ expect(us_country['default_locale']).to eq('en')
+ expect(us_country['supported_locales']).to match_array(['en', 'es'])
+
+ de_country = data['data'].find { |c| c['iso'] == 'DE' }
+ expect(de_country).to be_present
+ expect(de_country['currency']).to eq('EUR')
+ expect(de_country['default_locale']).to eq('de')
+ expect(de_country['supported_locales']).to match_array(['de', 'en'])
end
end
@@ -66,18 +63,16 @@ RSpec.describe 'Markets Countries API', type: :request, swagger_doc: 'api-refere
end
end
- path '/api/v3/store/markets/{market_id}/countries/{iso}' do
- get 'Get a country with states' do
- tags 'Countries'
+ path '/api/v3/store/countries/{iso}' do
+ get 'Get a country' do
+ tags 'Internationalization'
produces 'application/json'
security [api_key: []]
- description 'Returns a single country by ISO code with its states (for address form validation)'
+ description 'Returns a single country by ISO code with currency and locale. Supports ?include=states for address forms.'
parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
- parameter name: :market_id, in: :path, type: :string, required: true,
- description: 'Market prefixed ID (e.g., "mkt_abc123")'
parameter name: :iso, in: :path, type: :string, required: true,
- description: 'Country ISO 3166-1 alpha-2 code (e.g., "US", "DE", "CA")'
+ description: 'Country ISO 3166-1 alpha-2 code (e.g., "US", "DE")'
response '200', 'country found' do
let(:'x-spree-api-key') { api_key.token }
@@ -85,31 +80,34 @@ RSpec.describe 'Markets Countries API', type: :request, swagger_doc: 'api-refere
schema type: :object,
properties: {
- iso: { type: :string, description: 'ISO 3166-1 alpha-2 code' },
- iso3: { type: :string, description: 'ISO 3166-1 alpha-3 code' },
+ iso: { type: :string },
+ iso3: { type: :string },
name: { type: :string },
states_required: { type: :boolean },
zipcode_required: { type: :boolean },
+ currency: { type: :string, nullable: true },
+ default_locale: { type: :string, nullable: true },
+ supported_locales: { type: :array, items: { type: :string } },
states: {
type: :array,
items: {
type: :object,
properties: {
- abbr: { type: :string, description: 'State abbreviation code' },
+ abbr: { type: :string },
name: { type: :string }
},
required: %w[abbr name]
}
}
},
- required: %w[iso iso3 name states_required zipcode_required states]
+ required: %w[iso iso3 name states_required zipcode_required]
run_test! do |response|
data = JSON.parse(response.body)
expect(data['iso']).to eq('US')
- expect(data['states']).to be_an(Array)
- state_abbrs = data['states'].map { |s| s['abbr'] }
- expect(state_abbrs).to include('CA', 'NY')
+ expect(data['currency']).to eq('USD')
+ expect(data['default_locale']).to eq('en')
+ expect(data['supported_locales']).to match_array(['en', 'es'])
end
end
@@ -123,4 +121,17 @@ RSpec.describe 'Markets Countries API', type: :request, swagger_doc: 'api-refere
end
end
end
+
+ # Non-swagger test for ?include=states functionality
+ describe 'GET /api/v3/store/countries/:iso?include=states' do
+ it 'includes states when requested' do
+ get "/api/v3/store/countries/US?include=states", headers: { 'x-spree-api-key' => api_key.token }
+
+ expect(response).to have_http_status(:ok)
+ data = JSON.parse(response.body)
+ expect(data['states']).to be_an(Array)
+ state_abbrs = data['states'].map { |s| s['abbr'] }
+ expect(state_abbrs).to match_array(['CA', 'NY'])
+ end
+ end
end
diff --git a/backend/engines/api/spec/integration/spree/api/v3/store/currencies_spec.rb b/backend/engines/api/spec/integration/spree/api/v3/store/currencies_spec.rb
new file mode 100644
index 0000000000..90e714e37e
--- /dev/null
+++ b/backend/engines/api/spec/integration/spree/api/v3/store/currencies_spec.rb
@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'swagger_helper'
+
+RSpec.describe 'Currencies API', type: :request, swagger_doc: 'api-reference/store.yaml' do
+ include_context 'API v3 Store'
+
+ let!(:usa) { Spree::Country.find_by(iso: 'US') || create(:country, iso: 'US', name: 'United States') }
+ let!(:germany) { Spree::Country.find_by(iso: 'DE') || create(:country, iso: 'DE', name: 'Germany') }
+
+ let!(:na_market) { create(:market, :default, name: 'North America', store: store, countries: [usa], currency: 'USD', default_locale: 'en') }
+ let!(:eu_market) { create(:market, name: 'Europe', store: store, countries: [germany], currency: 'EUR', default_locale: 'de') }
+
+ path '/api/v3/store/currencies' do
+ get 'List supported currencies' do
+ tags 'Internationalization'
+ produces 'application/json'
+ security [api_key: []]
+ description 'Returns currencies supported by the store (derived from markets)'
+
+ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
+
+ response '200', 'currencies found' do
+ let(:'x-spree-api-key') { api_key.token }
+
+ schema type: :object,
+ properties: {
+ data: {
+ type: :array,
+ items: { '$ref' => '#/components/schemas/StoreCurrency' }
+ }
+ },
+ required: ['data']
+
+ run_test! do |response|
+ data = JSON.parse(response.body)
+ iso_codes = data['data'].map { |c| c['iso_code'] }
+ expect(iso_codes).to include('USD', 'EUR')
+
+ usd = data['data'].find { |c| c['iso_code'] == 'USD' }
+ expect(usd['name']).to be_present
+ expect(usd['symbol']).to be_present
+ end
+ end
+
+ response '401', 'unauthorized' do
+ let(:'x-spree-api-key') { 'invalid' }
+
+ schema '$ref' => '#/components/schemas/ErrorResponse'
+
+ run_test!
+ end
+ end
+ end
+end
diff --git a/backend/engines/api/spec/integration/spree/api/v3/store/locales_spec.rb b/backend/engines/api/spec/integration/spree/api/v3/store/locales_spec.rb
new file mode 100644
index 0000000000..e31da838eb
--- /dev/null
+++ b/backend/engines/api/spec/integration/spree/api/v3/store/locales_spec.rb
@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'swagger_helper'
+
+RSpec.describe 'Locales API', type: :request, swagger_doc: 'api-reference/store.yaml' do
+ include_context 'API v3 Store'
+
+ let!(:usa) { Spree::Country.find_by(iso: 'US') || create(:country, iso: 'US', name: 'United States') }
+ let!(:germany) { Spree::Country.find_by(iso: 'DE') || create(:country, iso: 'DE', name: 'Germany') }
+
+ let!(:na_market) { create(:market, :default, name: 'North America', store: store, countries: [usa], currency: 'USD', default_locale: 'en') }
+ let!(:eu_market) { create(:market, name: 'Europe', store: store, countries: [germany], currency: 'EUR', default_locale: 'de') }
+
+ path '/api/v3/store/locales' do
+ get 'List supported locales' do
+ tags 'Internationalization'
+ produces 'application/json'
+ security [api_key: []]
+ description 'Returns locales supported by the store (derived from markets)'
+
+ parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
+
+ response '200', 'locales found' do
+ let(:'x-spree-api-key') { api_key.token }
+
+ schema type: :object,
+ properties: {
+ data: {
+ type: :array,
+ items: { '$ref' => '#/components/schemas/StoreLocale' }
+ }
+ },
+ required: ['data']
+
+ run_test! do |response|
+ data = JSON.parse(response.body)
+ codes = data['data'].map { |l| l['code'] }
+ expect(codes).to include('en', 'de')
+
+ data['data'].each do |locale|
+ expect(locale['code']).to be_present
+ expect(locale['name']).to be_present
+ end
+ end
+ end
+
+ response '401', 'unauthorized' do
+ let(:'x-spree-api-key') { 'invalid' }
+
+ schema '$ref' => '#/components/schemas/ErrorResponse'
+
+ run_test!
+ end
+ end
+ end
+end
diff --git a/backend/engines/api/spec/integration/spree/api/v3/store/markets_spec.rb b/backend/engines/api/spec/integration/spree/api/v3/store/markets_spec.rb
deleted file mode 100644
index 6f7ed5985d..0000000000
--- a/backend/engines/api/spec/integration/spree/api/v3/store/markets_spec.rb
+++ /dev/null
@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-require 'swagger_helper'
-
-RSpec.describe 'Markets API', type: :request, swagger_doc: 'api-reference/store.yaml' do
- include_context 'API v3 Store'
-
- let!(:usa) { Spree::Country.find_by(iso: 'US') || create(:country, iso: 'US', name: 'United States') }
- let!(:germany) { Spree::Country.find_by(iso: 'DE') || create(:country, iso: 'DE', name: 'Germany') }
-
- let!(:na_market) { create(:market, :default, name: 'North America', store: store, countries: [usa], currency: 'USD', default_locale: 'en') }
- let!(:eu_market) { create(:market, name: 'Europe', store: store, countries: [germany], currency: 'EUR', default_locale: 'de') }
-
- path '/api/v3/store/markets' do
- get 'List all markets' do
- tags 'Markets'
- produces 'application/json'
- security [api_key: []]
- description 'Returns all markets for the store with their countries. Used to build country/currency switcher.'
-
- parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
-
- response '200', 'markets found' do
- let(:'x-spree-api-key') { api_key.token }
-
- schema type: :object,
- properties: {
- data: {
- type: :array,
- items: { '$ref' => '#/components/schemas/StoreMarket' }
- }
- },
- required: ['data']
-
- run_test! do |response|
- data = JSON.parse(response.body)
- expect(data['data'].size).to eq(2)
- market_names = data['data'].map { |m| m['name'] }
- expect(market_names).to include('North America', 'Europe')
- na = data['data'].find { |m| m['name'] == 'North America' }
- expect(na['currency']).to eq('USD')
- expect(na['countries']).to be_an(Array)
- end
- end
-
- response '401', 'unauthorized' do
- let(:'x-spree-api-key') { 'invalid' }
-
- schema '$ref' => '#/components/schemas/ErrorResponse'
-
- run_test!
- end
- end
- end
-
- path '/api/v3/store/markets/{id}' do
- get 'Get a market' do
- tags 'Markets'
- produces 'application/json'
- security [api_key: []]
- description 'Returns a single market by prefixed ID with its countries'
-
- parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
- parameter name: :id, in: :path, type: :string, required: true,
- description: 'Market prefixed ID (e.g., "mkt_abc123")'
-
- response '200', 'market found' do
- let(:'x-spree-api-key') { api_key.token }
- let(:id) { na_market.prefixed_id }
-
- schema '$ref' => '#/components/schemas/StoreMarket'
-
- run_test! do |response|
- data = JSON.parse(response.body)
- expect(data['name']).to eq('North America')
- expect(data['currency']).to eq('USD')
- expect(data['default_locale']).to eq('en')
- expect(data['countries']).to be_an(Array)
- end
- end
-
- response '404', 'market not found' do
- let(:'x-spree-api-key') { api_key.token }
- let(:id) { 'mkt_nonexistent' }
-
- schema '$ref' => '#/components/schemas/ErrorResponse'
-
- run_test!
- end
- end
- end
-
- path '/api/v3/store/markets/resolve' do
- get 'Resolve market for a country' do
- tags 'Markets'
- produces 'application/json'
- security [api_key: []]
- description 'Resolves which market a country belongs to. Used when customer selects a country.'
-
- parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
- parameter name: :country, in: :query, type: :string, required: true,
- description: 'ISO 3166-1 alpha-2 country code (e.g., "US", "DE")'
-
- response '200', 'market resolved' do
- let(:'x-spree-api-key') { api_key.token }
- let(:country) { 'DE' }
-
- schema '$ref' => '#/components/schemas/StoreMarket'
-
- run_test! do |response|
- data = JSON.parse(response.body)
- expect(data['name']).to eq('Europe')
- expect(data['currency']).to eq('EUR')
- end
- end
-
- response '400', 'missing country parameter' do
- let(:'x-spree-api-key') { api_key.token }
- let(:country) { '' }
-
- schema '$ref' => '#/components/schemas/ErrorResponse'
-
- run_test!
- end
-
- response '404', 'country not found or no market' do
- let(:'x-spree-api-key') { api_key.token }
- let(:country) { 'XX' }
-
- schema '$ref' => '#/components/schemas/ErrorResponse'
-
- run_test!
- end
- end
- end
-end
diff --git a/backend/engines/api/spec/integration/spree/api/v3/store/products_spec.rb b/backend/engines/api/spec/integration/spree/api/v3/store/products_spec.rb
index 28f4aeede7..4fd426041e 100644
--- a/backend/engines/api/spec/integration/spree/api/v3/store/products_spec.rb
+++ b/backend/engines/api/spec/integration/spree/api/v3/store/products_spec.rb
@@ -25,7 +25,7 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/store
path '/api/v3/store/products' do
get 'List products' do
- tags 'Products'
+ tags 'Product Catalog'
produces 'application/json'
security [api_key: []]
description 'Returns a paginated list of active products for the current store'
@@ -75,7 +75,7 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/store
path '/api/v3/store/products/{id}' do
get 'Get a product' do
- tags 'Products'
+ tags 'Product Catalog'
produces 'application/json'
security [api_key: []]
description 'Returns a single product by slug or prefix ID'
@@ -147,7 +147,7 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/store
path '/api/v3/store/products/filters' do
get 'Get product filters' do
- tags 'Products'
+ tags 'Product Catalog'
produces 'application/json'
security [api_key: []]
description <<~DESC
diff --git a/backend/engines/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb b/backend/engines/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb
index 50126176a7..916d10b4c1 100644
--- a/backend/engines/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb
+++ b/backend/engines/api/spec/integration/spree/api/v3/store/taxonomies_spec.rb
@@ -12,7 +12,7 @@ RSpec.describe 'Taxonomies API', type: :request, swagger_doc: 'api-reference/sto
path '/api/v3/store/taxonomies' do
get 'List taxonomies' do
- tags 'Taxons'
+ tags 'Product Catalog'
produces 'application/json'
security [api_key: []]
description 'Returns a list of taxonomies (category hierarchies) for the current store'
@@ -50,7 +50,7 @@ RSpec.describe 'Taxonomies API', type: :request, swagger_doc: 'api-reference/sto
path '/api/v3/store/taxonomies/{id}' do
get 'Get a taxonomy' do
- tags 'Taxons'
+ tags 'Product Catalog'
produces 'application/json'
security [api_key: []]
description 'Returns a single taxonomy with its taxon tree'
diff --git a/backend/engines/api/spec/integration/spree/api/v3/store/taxons_spec.rb b/backend/engines/api/spec/integration/spree/api/v3/store/taxons_spec.rb
index 87476c8af4..d690e37aa3 100644
--- a/backend/engines/api/spec/integration/spree/api/v3/store/taxons_spec.rb
+++ b/backend/engines/api/spec/integration/spree/api/v3/store/taxons_spec.rb
@@ -16,7 +16,7 @@ RSpec.describe 'Taxons API', type: :request, swagger_doc: 'api-reference/store.y
path '/api/v3/store/taxons' do
get 'List taxons' do
- tags 'Taxons'
+ tags 'Product Catalog'
produces 'application/json'
security [api_key: []]
description 'Returns a paginated list of taxons (categories) for the current store'
@@ -58,7 +58,7 @@ RSpec.describe 'Taxons API', type: :request, swagger_doc: 'api-reference/store.y
path '/api/v3/store/taxons/{id}' do
get 'Get a taxon' do
- tags 'Taxons'
+ tags 'Product Catalog'
produces 'application/json'
security [api_key: []]
description 'Returns a single taxon by permalink or prefix ID'
@@ -124,7 +124,7 @@ RSpec.describe 'Taxons API', type: :request, swagger_doc: 'api-reference/store.y
path '/api/v3/store/taxons/{taxon_id}/products' do
get 'List products in a taxon' do
- tags 'Taxons'
+ tags 'Product Catalog'
produces 'application/json'
security [api_key: []]
description 'Returns a paginated list of products belonging to the specified taxon'
diff --git a/backend/engines/api/spec/swagger_helper.rb b/backend/engines/api/spec/swagger_helper.rb
index bc35712b1f..b6470fc3ab 100644
--- a/backend/engines/api/spec/swagger_helper.rb
+++ b/backend/engines/api/spec/swagger_helper.rb
@@ -70,10 +70,8 @@ RSpec.configure do |config|
tags: [
{ name: 'Authentication', description: 'Customer authentication and registration' },
{ name: 'Store', description: 'Store information and settings' },
- { name: 'Products', description: 'Product catalog browsing' },
- { name: 'Taxons', description: 'Taxonomies and categories' },
- { name: 'Markets', description: 'Markets (region + currency + locale bundles) and market resolution' },
- { name: 'Countries', description: 'Countries within a market zone' },
+ { name: 'Product Catalog', description: 'Products, taxonomies, and categories' },
+ { name: 'Internationalization', description: 'Countries, currencies, and locales available in the store' },
{ name: 'Cart', description: 'Shopping cart management' },
{ name: 'Checkout', description: 'Checkout flow and order updates' },
{ name: 'Orders', description: 'Order lookup' },
@@ -82,8 +80,8 @@ RSpec.configure do |config|
{ name: 'Digitals', description: 'Digital product downloads' }
],
'x-tagGroups': [
- { name: 'Store', tags: %w[Store Markets Countries] },
- { name: 'Catalog', tags: %w[Products Taxons] },
+ { name: 'Store', tags: %w[Store Internationalization] },
+ { name: 'Catalog', tags: ['Product Catalog'] },
{ name: 'Cart', tags: ['Cart'] },
{ name: 'Checkout', tags: ['Checkout'] },
{ name: 'Orders', tags: ['Orders'] },
diff --git a/backend/engines/core/app/models/concerns/spree/stores/markets.rb b/backend/engines/core/app/models/concerns/spree/stores/markets.rb
index f7a8d2bbc1..67ef94c869 100644
--- a/backend/engines/core/app/models/concerns/spree/stores/markets.rb
+++ b/backend/engines/core/app/models/concerns/spree/stores/markets.rb
@@ -42,6 +42,14 @@ module Spree
Spree::Market.for_country(country, store: self)
end
+ # Returns countries from all markets as an ActiveRecord relation
+ # @return [ActiveRecord::Relation<Spree::Country>]
+ def countries_from_markets
+ Spree::Country
+ .where(id: Spree::Country.joins(market_countries: :market).where(Spree::Market.table_name => { store_id: id, deleted_at: nil }).select(:id))
+ .order(:name)
+ end
+
# Returns the countries available for checkout, derived from markets or checkout_zone
# @return [Array<Spree::Country>]
def countries_available_for_checkout
diff --git a/backend/engines/core/app/models/spree/country.rb b/backend/engines/core/app/models/spree/country.rb
index 71f5965d9c..1e759621ce 100644
--- a/backend/engines/core/app/models/spree/country.rb
+++ b/backend/engines/core/app/models/spree/country.rb
@@ -11,6 +11,8 @@ module Spree
dependent: :destroy,
foreign_key: :zoneable_id
has_many :zones, through: :zone_members, class_name: 'Spree::Zone'
+ has_many :market_countries, class_name: 'Spree::MarketCountry', dependent: :destroy
+ has_many :markets, through: :market_countries, class_name: 'Spree::Market'
validates :name, :iso_name, :iso, :iso3, presence: true, uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope }
@@ -36,6 +38,29 @@ module Spree
iso.upcase.chars.map { |c| (c.ord + 127397).chr(Encoding::UTF_8) }.join
end
+ # Returns the currency for this country from its market in the current store.
+ # Looks up which market contains this country and returns that market's currency.
+ #
+ # @return [String, nil] currency code (e.g., 'USD', 'EUR') or nil if no market found
+ def market_currency
+ Spree::Current.store&.market_for_country(self)&.currency
+ end
+
+ # Returns the default locale for this country from its market in the current store.
+ # Looks up which market contains this country and returns that market's default locale.
+ #
+ # @return [String, nil] locale code (e.g., 'en', 'de') or nil if no market found
+ def market_locale
+ Spree::Current.store&.market_for_country(self)&.default_locale
+ end
+
+ # Returns the supported locales for this country from its market in the current store.
+ #
+ # @return [Array<String>] locale codes (e.g., ['en', 'fr']) or empty array if no market found
+ def market_supported_locales
+ Spree::Current.store&.market_for_country(self)&.supported_locales_list || []
+ end
+
def <=>(other)
name <=> other.name
end
diff --git a/backend/engines/core/spec/models/spree/country_spec.rb b/backend/engines/core/spec/models/spree/country_spec.rb
index 744da35bbf..1483ddfd25 100644
--- a/backend/engines/core/spec/models/spree/country_spec.rb
+++ b/backend/engines/core/spec/models/spree/country_spec.rb
@@ -89,4 +89,85 @@ describe Spree::Country, type: :model do
expect(invalid_country.default_locale).to be_nil
end
end
+
+ describe '#market_currency' do
+ before { Spree::Current.store = store }
+ after { Spree::Current.reset }
+
+ context 'when country belongs to a market' do
+ let!(:market) { create(:market, :default, store: store, countries: [america], currency: 'EUR') }
+
+ it 'returns the market currency' do
+ expect(america.market_currency).to eq('EUR')
+ end
+ end
+
+ context 'when country does not belong to any market' do
+ it 'returns nil' do
+ expect(canada.market_currency).to be_nil
+ end
+ end
+
+ context 'when no current store is set' do
+ before { Spree::Current.store = nil }
+
+ it 'returns nil' do
+ expect(america.market_currency).to be_nil
+ end
+ end
+ end
+
+ describe '#market_locale' do
+ before { Spree::Current.store = store }
+ after { Spree::Current.reset }
+
+ context 'when country belongs to a market' do
+ let!(:market) { create(:market, :default, store: store, countries: [america], default_locale: 'de') }
+
+ it 'returns the market default locale' do
+ expect(america.market_locale).to eq('de')
+ end
+ end
+
+ context 'when country does not belong to any market' do
+ it 'returns nil' do
+ expect(canada.market_locale).to be_nil
+ end
+ end
+
+ context 'when no current store is set' do
+ before { Spree::Current.store = nil }
+
+ it 'returns nil' do
+ expect(america.market_locale).to be_nil
+ end
+ end
+ end
+
+ describe '#market_supported_locales' do
+ before { Spree::Current.store = store }
+ after { Spree::Current.reset }
+
+ context 'when country belongs to a market' do
+ let!(:market) { create(:market, :default, store: store, countries: [america], default_locale: 'en', supported_locales: 'en,fr') }
+
+ it 'returns the market supported locales' do
+ expect(america.market_supported_locales).to match_array(['en', 'fr'])
+ end
+ end
+
+ context 'when country does not belong to any market' do
+ it 'returns an empty array' do
+ expect(canada.market_supported_locales).to eq([])
+ end
+ end
+
+ context 'when no current store is set' do
+ before { Spree::Current.store = nil }
+
+ it 'returns an empty array' do
+ expect(america.market_supported_locales).to eq([])
+ end
+ end
+ end
end
diff --git a/backend/engines/core/spec/models/spree/store_spec.rb b/backend/engines/core/spec/models/spree/store_spec.rb
index 61e02b72db..53dd10d5be 100644
--- a/backend/engines/core/spec/models/spree/store_spec.rb
+++ b/backend/engines/core/spec/models/spree/store_spec.rb
@@ -775,6 +775,50 @@ describe Spree::Store, type: :model, without_global_store: true do
end
end
+ describe '#countries_from_markets' do
+ let!(:store) { create(:store) }
+ let!(:country_a) { create(:country) }
+ let!(:country_b) { create(:country) }
+ let!(:country_c) { create(:country) }
+
+ context 'with markets' do
+ before do
+ create(:market, :default, store: store, countries: [country_a, country_b], currency: 'USD')
+ create(:market, store: store, countries: [country_c], currency: 'EUR')
+ end
+
+ it 'returns countries from all markets' do
+ countries = store.countries_from_markets
+ expect(countries.pluck(:iso)).to contain_exactly(country_a.iso, country_b.iso, country_c.iso)
+ end
+
+ it 'returns an ActiveRecord relation' do
+ expect(store.countries_from_markets).to be_a(ActiveRecord::Relation)
+ end
+
+ it 'orders by name' do
+ names = store.countries_from_markets.pluck(:name)
+ expect(names).to eq(names.sort)
+ end
+
+ it 'does not include countries not in any market' do
+ other_country = create(:country)
+ expect(store.countries_from_markets.pluck(:iso)).not_to include(other_country.iso)
+ end
+
+ it 'does not duplicate countries shared across markets' do
+ store.markets.last.countries << country_a rescue nil
+ expect(store.countries_from_markets.where(iso: country_a.iso).count).to eq(1)
+ end
+ end
+
+ context 'without markets' do
+ it 'returns empty relation' do
+ expect(store.countries_from_markets).to be_empty
+ end
+ end
+ end
+
describe '#favicon' do
subject(:favicon) { store.favicon }
diff --git a/docs/api-reference/store.yaml b/docs/api-reference/store.yaml
index fe755fc1c8..751c2be4a7 100644
--- a/docs/api-reference/store.yaml
+++ b/docs/api-reference/store.yaml
@@ -530,14 +530,14 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImV4cCI6MTc3MTY4NTk3N30.VgnynEptFoM-d2vXBbJgzl6WYu9J3Uc2nWdGVy-Qh5o
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImV4cCI6MTc3MTc1MTIxMH0.rQScCOhPN-AoB2H_liaHoZU0FgU7WMoJUjEfvO8tidE
user:
id: cus_UkLWZg9DAJ
- first_name: Marina
- last_name: Rogahn
- created_at: '2026-02-20T14:59:37.318Z'
- updated_at: '2026-02-20T14:59:37.318Z'
+ first_name: Lashaunda
+ last_name: Schoen
+ created_at: '2026-02-21T09:06:50.419Z'
+ updated_at: '2026-02-21T09:06:50.419Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -593,14 +593,14 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImV4cCI6MTc3MTY4NTk3OH0.YyXSh40eY0F1rqsIJ1na5m4X5uZQkSaOxR_suvz2R6Y
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImV4cCI6MTc3MTc1MTIxMX0.ZnuzcK1EWXfR4Lj1UBjp7kZK8dI3aqtwbfswAWh_0eY
user:
id: cus_UkLWZg9DAJ
first_name: John
last_name: Doe
- created_at: '2026-02-20T14:59:38.700Z'
- updated_at: '2026-02-20T14:59:38.700Z'
+ created_at: '2026-02-21T09:06:51.801Z'
+ updated_at: '2026-02-21T09:06:51.801Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -672,14 +672,14 @@ paths:
content:
application/json:
example:
- token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImV4cCI6MTc3MTY4NTk3OX0.hIjxAWyuVesA4bC4_5HO6U6zu8XzW1jtpB7Vk_BY7xY
+ token: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJjdXN0b21lciIsImV4cCI6MTc3MTc1MTIxMn0.pl5BztnaRkK4P9RGHpUz4NyyqGo3X0sLa8I8FUGWVxU
user:
id: cus_UkLWZg9DAJ
- first_name: Danelle
- last_name: Kub
- created_at: '2026-02-20T14:59:39.251Z'
- updated_at: '2026-02-20T14:59:39.251Z'
+ first_name: Lindsy
+ last_name: O'Conner
+ created_at: '2026-02-21T09:06:52.361Z'
+ updated_at: '2026-02-21T09:06:52.361Z'
addresses: []
default_billing_address:
default_shipping_address:
@@ -724,10 +724,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R446099536
+ number: R816477482
state: cart
- token: Zrhw9yjVHgsEs8UKDMCM1Cf4VoeC1JrnoyT
+ token: 6MP4Pf9hQcQDg3pwBDTPc2u5Fq2pVWFaczb
special_instructions:
currency: USD
item_count: 0
@@ -750,8 +750,8 @@ paths:
total: '0.0'
display_total: "$0.00"
completed_at:
- created_at: '2026-02-20T14:59:39.853Z'
- updated_at: '2026-02-20T14:59:39.853Z'
+ created_at: '2026-02-21T09:06:52.989Z'
+ updated_at: '2026-02-21T09:06:52.989Z'
order_promotions: []
line_items: []
shipments: []
@@ -806,10 +806,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R288981797
+ number: R155147700
state: cart
- token: gGNB4yo3bXTXw69MbVxTvn7XJvR6LDxix7H
+ token: 1jEpcbHpNKxjGeQ2AUiyCaZKS6JMaYvKjtD
special_instructions:
currency: USD
item_count: 1
@@ -832,16 +832,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T14:59:40.944Z'
- updated_at: '2026-02-20T14:59:41.159Z'
+ created_at: '2026-02-21T09:06:54.057Z'
+ updated_at: '2026-02-21T09:06:54.197Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 23898
- slug: product-23898
+ name: Product 22878
+ slug: product-22878
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -860,23 +860,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T14:59:41.104Z'
- updated_at: '2026-02-20T14:59:41.104Z'
+ created_at: '2026-02-21T09:06:54.143Z'
+ updated_at: '2026-02-21T09:06:54.143Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_UkLWZg9DAJ
- number: H77830670795
+ number: H14672948036
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T14:59:41.121Z'
- updated_at: '2026-02-20T14:59:41.147Z'
+ created_at: '2026-02-21T09:06:54.160Z'
+ updated_at: '2026-02-21T09:06:54.185Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -884,7 +884,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_41
- name: Kathi Luettgen
+ name: Lurlene Hayes
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -991,10 +991,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R925578431
+ number: R432918187
state: cart
- token: hzLWFutaEvZnfQmsTfX31C7VkNwyyY5jk9F
+ token: mryDfe3AJ3HX73KQa3V5K6qTHBiroM3hKso
special_instructions:
currency: USD
item_count: 1
@@ -1017,16 +1017,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T14:59:41.189Z'
- updated_at: '2026-02-20T14:59:41.322Z'
+ created_at: '2026-02-21T09:06:54.231Z'
+ updated_at: '2026-02-21T09:06:54.389Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 35049
- slug: product-35049
+ name: Product 37379
+ slug: product-37379
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1045,23 +1045,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T14:59:41.264Z'
- updated_at: '2026-02-20T14:59:41.264Z'
+ created_at: '2026-02-21T09:06:54.296Z'
+ updated_at: '2026-02-21T09:06:54.296Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_UkLWZg9DAJ
- number: H33199178299
+ number: H87220099802
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T14:59:41.283Z'
- updated_at: '2026-02-20T14:59:41.309Z'
+ created_at: '2026-02-21T09:06:54.317Z'
+ updated_at: '2026-02-21T09:06:54.366Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -1069,7 +1069,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_45
- name: Xzbdulia Oga
+ name: Jacquelyne Wehner
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1143,27 +1143,21 @@ paths:
message: Order not found
schema:
"$ref": "#/components/schemas/ErrorResponse"
- "/api/v3/store/markets/{market_id}/countries":
+ "/api/v3/store/countries":
get:
- summary: List countries in a market
+ summary: List countries
tags:
- - Countries
+ - Internationalization
security:
- api_key: []
- description: Returns countries available in the market zone (for checkout address
- dropdown)
+ description: Returns countries available in the store with their currency and
+ locale (derived from markets)
parameters:
- name: x-spree-api-key
in: header
required: true
schema:
type: string
- - name: market_id
- in: path
- required: true
- description: Market prefixed ID (e.g., "mkt_abc123")
- schema:
- type: string
responses:
'200':
description: countries found
@@ -1176,37 +1170,28 @@ paths:
name: Germany
states_required: false
zipcode_required: true
+ currency: EUR
+ default_locale: de
+ supported_locales:
+ - de
+ - en
- iso: US
iso3: USA
name: United States of America
states_required: true
zipcode_required: true
+ currency: USD
+ default_locale: en
+ supported_locales:
+ - en
+ - es
schema:
type: object
properties:
data:
type: array
items:
- type: object
- properties:
- iso:
- type: string
- description: ISO 3166-1 alpha-2 code
- iso3:
- type: string
- description: ISO 3166-1 alpha-3 code
- name:
- type: string
- states_required:
- type: boolean
- zipcode_required:
- type: boolean
- required:
- - iso
- - iso3
- - name
- - states_required
- - zipcode_required
+ "$ref": "#/components/schemas/StoreCountry"
required:
- data
'401':
@@ -1219,31 +1204,25 @@ paths:
message: Valid API key required
schema:
"$ref": "#/components/schemas/ErrorResponse"
- "/api/v3/store/markets/{market_id}/countries/{iso}":
+ "/api/v3/store/countries/{iso}":
get:
- summary: Get a country with states
+ summary: Get a country
tags:
- - Countries
+ - Internationalization
security:
- api_key: []
- description: Returns a single country by ISO code with its states (for address
- form validation)
+ description: Returns a single country by ISO code with currency and locale.
+ Supports ?include=states for address forms.
parameters:
- name: x-spree-api-key
in: header
required: true
schema:
type: string
- - name: market_id
- in: path
- required: true
- description: Market prefixed ID (e.g., "mkt_abc123")
- schema:
- type: string
- name: iso
in: path
required: true
- description: Country ISO 3166-1 alpha-2 code (e.g., "US", "DE", "CA")
+ description: Country ISO 3166-1 alpha-2 code (e.g., "US", "DE")
schema:
type: string
responses:
@@ -1257,26 +1236,34 @@ paths:
name: United States of America
states_required: true
zipcode_required: true
- states:
- - abbr: CA
- name: California
- - abbr: NY
- name: New York
+ currency: USD
+ default_locale: en
+ supported_locales:
+ - en
+ - es
schema:
type: object
properties:
iso:
type: string
- description: ISO 3166-1 alpha-2 code
iso3:
type: string
- description: ISO 3166-1 alpha-3 code
name:
type: string
states_required:
type: boolean
zipcode_required:
type: boolean
+ currency:
+ type: string
+ nullable: true
+ default_locale:
+ type: string
+ nullable: true
+ supported_locales:
+ type: array
+ items:
+ type: string
states:
type: array
items:
@@ -1284,7 +1271,6 @@ paths:
properties:
abbr:
type: string
- description: State abbreviation code
name:
type: string
required:
@@ -1296,7 +1282,6 @@ paths:
- name
- states_required
- zipcode_required
- - states
'404':
description: country not found
content:
@@ -1349,10 +1334,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R808875817
+ number: R122441799
state: cart
- token: 8uFyBQRQvcTTZX753pA4tGAqnapCFKVLUcM
+ token: ZTQhWqNG7KNsFjExwEcRdL2MJqTi8TQrvwB
special_instructions:
currency: USD
item_count: 1
@@ -1375,16 +1360,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T14:59:45.770Z'
- updated_at: '2026-02-20T14:59:45.943Z'
+ created_at: '2026-02-21T09:06:58.888Z'
+ updated_at: '2026-02-21T09:06:59.056Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 89148
- slug: product-89148
+ name: Product 87116
+ slug: product-87116
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1403,23 +1388,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T14:59:45.839Z'
- updated_at: '2026-02-20T14:59:45.839Z'
+ created_at: '2026-02-21T09:06:58.941Z'
+ updated_at: '2026-02-21T09:06:58.941Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_UkLWZg9DAJ
- number: H64635866947
+ number: H96877656792
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T14:59:45.853Z'
- updated_at: '2026-02-20T14:59:45.875Z'
+ created_at: '2026-02-21T09:06:58.957Z'
+ updated_at: '2026-02-21T09:06:58.989Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -1427,7 +1412,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_65
- name: Efren Heaney
+ name: Ann Fahey
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1449,12 +1434,12 @@ paths:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
state: checkout
- response_code: 1-SC-20260220145945938129
- number: P39GXJM8
+ response_code: 1-SC-20260221090659051384
+ number: P5YZDW18
amount: '50.0'
display_amount: "$50.00"
- created_at: '2026-02-20T14:59:45.942Z'
- updated_at: '2026-02-20T14:59:45.942Z'
+ created_at: '2026-02-21T09:06:59.055Z'
+ updated_at: '2026-02-21T09:06:59.055Z'
source_type: store_credit
source_id: credit_UkLWZg9DAJ
source:
@@ -1590,10 +1575,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R659386591
+ number: R079222725
state: cart
- token: ZjKri8qhBQc17kNuEVyxZqimCaGQ6dBqdTE
+ token: aQwnCvMgDqKB23ZgNWYiiuBks9zhU9LYie5
special_instructions:
currency: USD
item_count: 1
@@ -1616,16 +1601,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T14:59:47.903Z'
- updated_at: '2026-02-20T14:59:48.110Z'
+ created_at: '2026-02-21T09:07:01.095Z'
+ updated_at: '2026-02-21T09:07:01.298Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 112363
- slug: product-112363
+ name: Product 112419
+ slug: product-112419
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1644,23 +1629,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T14:59:47.963Z'
- updated_at: '2026-02-20T14:59:48.096Z'
+ created_at: '2026-02-21T09:07:01.157Z'
+ updated_at: '2026-02-21T09:07:01.285Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_UkLWZg9DAJ
- number: H94589310733
+ number: H86601737123
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T14:59:47.977Z'
- updated_at: '2026-02-20T14:59:48.009Z'
+ created_at: '2026-02-21T09:07:01.171Z'
+ updated_at: '2026-02-21T09:07:01.192Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -1668,7 +1653,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_77
- name: Judy Turcotte
+ name: Fransisca Champlin
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -1894,6 +1879,52 @@ paths:
message: Credit card not found
schema:
"$ref": "#/components/schemas/ErrorResponse"
+ "/api/v3/store/currencies":
+ get:
+ summary: List supported currencies
+ tags:
+ - Internationalization
+ security:
+ - api_key: []
+ description: Returns currencies supported by the store (derived from markets)
+ parameters:
+ - name: x-spree-api-key
+ in: header
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ description: currencies found
+ content:
+ application/json:
+ example:
+ data:
+ - iso_code: USD
+ name: United States Dollar
+ symbol: "$"
+ - iso_code: EUR
+ name: Euro
+ symbol: "€"
+ schema:
+ type: object
+ properties:
+ data:
+ type: array
+ items:
+ "$ref": "#/components/schemas/StoreCurrency"
+ required:
+ - data
+ '401':
+ description: unauthorized
+ content:
+ application/json:
+ example:
+ error:
+ code: invalid_token
+ message: Valid API key required
+ schema:
+ "$ref": "#/components/schemas/ErrorResponse"
"/api/v3/store/customer/orders":
get:
summary: List customer orders
@@ -1944,10 +1975,10 @@ paths:
example:
data:
- id: or_UkLWZg9DAJ
- number: R455524931
+ number: R877690416
state: cart
- token: xLjUakxTBssBiCv6PEp9XjvizyJvkoNrJVy
+ token: cWNrHnapnP2zHKVu69b4DAdSorWJUhgdQXb
special_instructions:
currency: USD
item_count: 1
@@ -1970,16 +2001,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T14:59:52.951Z'
- updated_at: '2026-02-20T14:59:53.074Z'
+ created_at: '2026-02-21T09:07:06.066Z'
+ updated_at: '2026-02-21T09:07:06.205Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 132484
- slug: product-132484
+ name: Product 13907
+ slug: product-13907
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -1998,23 +2029,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T14:59:53.018Z'
- updated_at: '2026-02-20T14:59:53.018Z'
+ created_at: '2026-02-21T09:07:06.149Z'
+ updated_at: '2026-02-21T09:07:06.149Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_UkLWZg9DAJ
- number: H78437939265
+ number: H77753424595
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T14:59:53.034Z'
- updated_at: '2026-02-20T14:59:53.059Z'
+ created_at: '2026-02-21T09:07:06.167Z'
+ updated_at: '2026-02-21T09:07:06.193Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -2022,7 +2053,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_100
- name: Kellye Hand
+ name: Lamar Murazik
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -2131,11 +2162,11 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
- first_name: Thomasena
- last_name: Bogan
- created_at: '2026-02-20T14:59:54.041Z'
- updated_at: '2026-02-20T14:59:54.324Z'
+ first_name: Shona
+ last_name: Hoppe
+ created_at: '2026-02-21T09:07:07.252Z'
+ updated_at: '2026-02-21T09:07:07.541Z'
addresses:
- id: addr_gbHJdmfrXB
firstname: John
@@ -2237,11 +2268,11 @@ paths:
application/json:
example:
id: cus_UkLWZg9DAJ
first_name: Updated
last_name: Name
- created_at: '2026-02-20T14:59:54.625Z'
- updated_at: '2026-02-20T14:59:54.917Z'
+ created_at: '2026-02-21T09:07:08.049Z'
+ updated_at: '2026-02-21T09:07:08.344Z'
addresses:
- id: addr_gbHJdmfrXB
firstname: John
@@ -2436,7 +2467,7 @@ paths:
example:
data:
- id: gc_UkLWZg9DAJ
- code: 73575B725409C9B4
+ code: 7B2B71E47E69119F
state: active
currency: USD
amount: 10.0
@@ -2450,8 +2481,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-02-20T14:59:58.610Z'
- updated_at: '2026-02-20T14:59:58.610Z'
+ created_at: '2026-02-21T09:07:12.773Z'
+ updated_at: '2026-02-21T09:07:12.773Z'
meta:
page: 1
limit: 25
@@ -2513,7 +2544,7 @@ paths:
application/json:
example:
id: gc_UkLWZg9DAJ
- code: 7E5B1C6D959FC1F3
+ code: 84263A77811BCCD5
state: active
currency: USD
amount: 10.0
@@ -2527,8 +2558,8 @@ paths:
redeemed_at:
expired: false
active: true
- created_at: '2026-02-20T14:59:59.729Z'
- updated_at: '2026-02-20T14:59:59.729Z'
+ created_at: '2026-02-21T09:07:13.939Z'
+ updated_at: '2026-02-21T09:07:13.939Z'
schema:
"$ref": "#/components/schemas/StoreGiftCard"
'404':
@@ -2582,10 +2613,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R702369330
+ number: R605735545
state: cart
- token: diHPSTGC3vFWwGMzDnSvrKDnfGW2wEsWDeb
+ token: rGXPHttNAV6ckpe3pzNUaGenxxKG9z3PURQ
special_instructions:
currency: USD
item_count: 3
@@ -2608,16 +2639,16 @@ paths:
total: '49.98'
display_total: "$49.98"
completed_at:
- created_at: '2026-02-20T15:00:00.857Z'
- updated_at: '2026-02-20T15:00:01.009Z'
+ created_at: '2026-02-21T09:07:15.156Z'
+ updated_at: '2026-02-21T09:07:15.325Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 219993
- slug: product-219993
+ name: Product 215856
+ slug: product-215856
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -2636,8 +2667,8 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:00.930Z'
- updated_at: '2026-02-20T15:00:00.930Z'
+ created_at: '2026-02-21T09:07:15.239Z'
+ updated_at: '2026-02-21T09:07:15.239Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -2646,8 +2677,8 @@ paths:
variant_id: variant_gbHJdmfrXB
quantity: 2
currency: USD
- name: Product 227919
- slug: product-227919
+ name: Product 227913
+ slug: product-227913
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -2666,8 +2697,8 @@ paths:
discounted_amount: '39.98'
display_discounted_amount: "$39.98"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:01.009Z'
- updated_at: '2026-02-20T15:00:01.009Z'
+ created_at: '2026-02-21T09:07:15.325Z'
+ updated_at: '2026-02-21T09:07:15.325Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -2763,10 +2794,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R359232710
+ number: R647337648
state: cart
- token: nHJJJ9iT2ng46rZSyCBrp1utbQca27EcXzA
+ token: pp3CURpVczFpgM7Khvt5spjVgajjcdDvP7H
special_instructions:
currency: USD
item_count: 5
@@ -2789,16 +2820,16 @@ paths:
total: '99.95'
display_total: "$99.95"
completed_at:
- created_at: '2026-02-20T15:00:02.979Z'
- updated_at: '2026-02-20T15:00:03.063Z'
+ created_at: '2026-02-21T09:07:17.485Z'
+ updated_at: '2026-02-21T09:07:17.569Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 5
currency: USD
- name: Product 25919
- slug: product-25919
+ name: Product 251142
+ slug: product-251142
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -2817,8 +2848,8 @@ paths:
discounted_amount: '99.95'
display_discounted_amount: "$99.95"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:03.042Z'
- updated_at: '2026-02-20T15:00:03.073Z'
+ created_at: '2026-02-21T09:07:17.549Z'
+ updated_at: '2026-02-21T09:07:17.579Z'
compare_at_amount:
thumbnail_url:
option_values: []
@@ -2898,10 +2929,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R697196052
+ number: R991780472
state: cart
- token: KMPdkqnCgHvQMWfY3DMWNmL5tMYR9W6p6Cr
+ token: MmFvas1navEcBEhwhynWnBQaKi7TqR11eLP
special_instructions:
currency: USD
item_count: 0
@@ -2924,8 +2955,8 @@ paths:
total: '0.0'
display_total: "$0.00"
completed_at:
- created_at: '2026-02-20T15:00:03.641Z'
- updated_at: '2026-02-20T15:00:03.737Z'
+ created_at: '2026-02-21T09:07:18.184Z'
+ updated_at: '2026-02-21T09:07:18.282Z'
order_promotions: []
line_items: []
shipments: []
@@ -2960,15 +2991,14 @@ paths:
message: Line item not found
schema:
"$ref": "#/components/schemas/ErrorResponse"
- "/api/v3/store/markets":
+ "/api/v3/store/locales":
get:
- summary: List all markets
+ summary: List supported locales
tags:
- - Markets
+ - Internationalization
security:
- api_key: []
- description: Returns all markets for the store with their countries. Used to
- build country/currency switcher.
+ description: Returns locales supported by the store (derived from markets)
parameters:
- name: x-spree-api-key
in: header
@@ -2977,46 +3007,22 @@ paths:
type: string
responses:
'200':
- description: markets found
+ description: locales found
content:
application/json:
example:
data:
- - id: mkt_UkLWZg9DAJ
- name: North America
- currency: USD
- default_locale: en
- tax_inclusive: false
- default: true
- supported_locales:
- - en
- countries:
- - iso: US
- iso3: USA
- name: United States of America
- states_required: true
- zipcode_required: true
- - id: mkt_gbHJdmfrXB
- name: Europe
- currency: EUR
- default_locale: de
- tax_inclusive: false
- default: false
- supported_locales:
- - de
- countries:
- - iso: DE
- iso3: IS34
- name: Germany
- states_required: false
- zipcode_required: true
+ - code: de
+ name: de
+ - code: en
+ name: English (US)
schema:
type: object
properties:
data:
type: array
items:
- "$ref": "#/components/schemas/StoreMarket"
+ "$ref": "#/components/schemas/StoreLocale"
required:
- data
'401':
@@ -3029,121 +3035,6 @@ paths:
message: Valid API key required
schema:
"$ref": "#/components/schemas/ErrorResponse"
- "/api/v3/store/markets/{id}":
- get:
- summary: Get a market
- tags:
- - Markets
- security:
- - api_key: []
- description: Returns a single market by prefixed ID with its countries
- parameters:
- - name: x-spree-api-key
- in: header
- required: true
- schema:
- type: string
- - name: id
- in: path
- required: true
- description: Market prefixed ID (e.g., "mkt_abc123")
- schema:
- type: string
- responses:
- '200':
- description: market found
- content:
- application/json:
- example:
- id: mkt_UkLWZg9DAJ
- name: North America
- currency: USD
- default_locale: en
- tax_inclusive: false
- default: true
- supported_locales:
- - en
- countries:
- - iso: US
- iso3: USA
- name: United States of America
- states_required: true
- zipcode_required: true
- schema:
- "$ref": "#/components/schemas/StoreMarket"
- '404':
- description: market not found
- content:
- application/json:
- example:
- error:
- code: record_not_found
- message: Market not found
- schema:
- "$ref": "#/components/schemas/ErrorResponse"
- "/api/v3/store/markets/resolve":
- get:
- summary: Resolve market for a country
- tags:
- - Markets
- security:
- - api_key: []
- description: Resolves which market a country belongs to. Used when customer
- selects a country.
- parameters:
- - name: x-spree-api-key
- in: header
- required: true
- schema:
- type: string
- - name: country
- in: query
- required: true
- description: ISO 3166-1 alpha-2 country code (e.g., "US", "DE")
- schema:
- type: string
- responses:
- '200':
- description: market resolved
- content:
- application/json:
- example:
- id: mkt_gbHJdmfrXB
- name: Europe
- currency: EUR
- default_locale: de
- tax_inclusive: false
- default: false
- supported_locales:
- - de
- countries:
- - iso: DE
- iso3: IS38
- name: Germany
- states_required: false
- zipcode_required: true
- schema:
- "$ref": "#/components/schemas/StoreMarket"
- '400':
- description: missing country parameter
- content:
- application/json:
- example:
- error:
- code: invalid_params
- message: country parameter is required
- schema:
- "$ref": "#/components/schemas/ErrorResponse"
- '404':
- description: country not found or no market
- content:
- application/json:
- example:
- error:
- code: record_not_found
- message: country not found
- schema:
- "$ref": "#/components/schemas/ErrorResponse"
"/api/v3/store/orders/{id}":
get:
summary: Get an order
@@ -3189,9 +3080,9 @@ paths:
application/json:
example:
id: or_gbHJdmfrXB
- number: R008040273
+ number: R229150177
state: cart
- token: 7wzFBMBhZC5qGLb7DAgMGnFPENqkYxCbzym
+ token: WZpkoykp3EaZ3ryQd8KJRQ8z74rGdRkuc3e
email:
special_instructions:
currency: USD
@@ -3215,16 +3106,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T15:00:05.993Z'
- updated_at: '2026-02-20T15:00:06.114Z'
+ created_at: '2026-02-21T09:07:20.345Z'
+ updated_at: '2026-02-21T09:07:20.446Z'
order_promotions: []
line_items:
- id: li_gbHJdmfrXB
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 309522
- slug: product-309522
+ name: Product 303826
+ slug: product-303826
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3243,23 +3134,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:06.069Z'
- updated_at: '2026-02-20T15:00:06.069Z'
+ created_at: '2026-02-21T09:07:20.402Z'
+ updated_at: '2026-02-21T09:07:20.402Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_gbHJdmfrXB
- number: H00030200861
+ number: H09969643397
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T15:00:06.086Z'
- updated_at: '2026-02-20T15:00:06.104Z'
+ created_at: '2026-02-21T09:07:20.417Z'
+ updated_at: '2026-02-21T09:07:20.436Z'
shipping_method:
id: shpm_gbHJdmfrXB
name: UPS Ground
@@ -3267,7 +3158,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_153
- name: Rochell Grant
+ name: Lanell O'Hara
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3367,10 +3258,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R341238186
+ number: R461378992
state: cart
- token: mWr4SnS8VP69mSddzTWchaxGX6U6y1DUon4
+ token: mqcN8FVETFH8D8f8uEkepQnfUyWAnppAQBv
special_instructions: Leave at door
currency: USD
item_count: 1
@@ -3393,16 +3284,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T15:00:08.313Z'
- updated_at: '2026-02-20T15:00:08.449Z'
+ created_at: '2026-02-21T09:07:22.886Z'
+ updated_at: '2026-02-21T09:07:23.039Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 335395
- slug: product-335395
+ name: Product 332045
+ slug: product-332045
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3421,23 +3312,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:08.383Z'
- updated_at: '2026-02-20T15:00:08.383Z'
+ created_at: '2026-02-21T09:07:22.965Z'
+ updated_at: '2026-02-21T09:07:22.965Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_UkLWZg9DAJ
- number: H32834877408
+ number: H59904077682
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T15:00:08.401Z'
- updated_at: '2026-02-20T15:00:08.428Z'
+ created_at: '2026-02-21T09:07:22.985Z'
+ updated_at: '2026-02-21T09:07:23.015Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -3445,7 +3336,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_168
- name: Niki Boehm
+ name: Retha Douglas
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3624,10 +3515,10 @@ paths:
application/json:
example:
id: or_gbHJdmfrXB
- number: R587687844
+ number: R407702133
state: address
- token: 7Pc989BsUV6weZDHcg5Ld2anC1QVxXej6XY
+ token: NQs5rFVzST6ssaZ9xxrRttk5cN9RWZDydvF
special_instructions:
currency: USD
item_count: 1
@@ -3650,16 +3541,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T15:00:10.142Z'
- updated_at: '2026-02-20T15:00:10.275Z'
+ created_at: '2026-02-21T09:07:24.668Z'
+ updated_at: '2026-02-21T09:07:24.971Z'
order_promotions: []
line_items:
- id: li_gbHJdmfrXB
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 371872
- slug: product-371872
+ name: Product 373827
+ slug: product-373827
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -3678,23 +3569,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:10.218Z'
- updated_at: '2026-02-20T15:00:10.218Z'
+ created_at: '2026-02-21T09:07:24.830Z'
+ updated_at: '2026-02-21T09:07:24.830Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_gbHJdmfrXB
- number: H60949188972
+ number: H32914381966
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T15:00:10.234Z'
- updated_at: '2026-02-20T15:00:10.254Z'
+ created_at: '2026-02-21T09:07:24.906Z'
+ updated_at: '2026-02-21T09:07:24.947Z'
shipping_method:
id: shpm_gbHJdmfrXB
name: UPS Ground
@@ -3702,7 +3593,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_178
- name: Janine Larson
+ name: Clarice Leannon
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3804,10 +3695,10 @@ paths:
application/json:
example:
id: or_gbHJdmfrXB
- number: R664098895
+ number: R546557324
state: payment
- token: iJ5byNNPgju2F4uBfzPAmvG8hiJLXDJL1uQ
+ token: 8c3aerLqrskXdYa5cp2r2peqbxFkhVDE83z
special_instructions:
currency: USD
item_count: 1
@@ -3830,16 +3721,16 @@ paths:
total: '29.99'
display_total: "$29.99"
completed_at:
- created_at: '2026-02-20T15:00:11.675Z'
- updated_at: '2026-02-20T15:00:11.901Z'
+ created_at: '2026-02-21T09:07:26.636Z'
+ updated_at: '2026-02-21T09:07:26.850Z'
order_promotions: []
line_items:
- id: li_gbHJdmfrXB
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 405201
- slug: product-405201
+ name: Product 403723
+ slug: product-403723
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -3858,23 +3749,23 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:11.737Z'
- updated_at: '2026-02-20T15:00:11.812Z'
+ created_at: '2026-02-21T09:07:26.693Z'
+ updated_at: '2026-02-21T09:07:26.760Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_EfhxLZ9ck8
- number: H48610513576
+ number: H16916321354
state: pending
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
shipped_at:
- created_at: '2026-02-20T15:00:11.832Z'
- updated_at: '2026-02-20T15:00:11.857Z'
+ created_at: '2026-02-21T09:07:26.788Z'
+ updated_at: '2026-02-21T09:07:26.815Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -3882,7 +3773,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_188
- name: Riley Kemmer
+ name: Melba Little
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -3983,10 +3874,10 @@ paths:
application/json:
example:
id: or_gbHJdmfrXB
- number: R187908927
+ number: R509490059
state: complete
- token: a4ZbxD3eKjQ8zq7YTyBbeKurucyrdFS9Zgv
+ token: mA7jJSYpRFm6sLrpT5yRPLcmasfBf7rPMgB
special_instructions:
currency: USD
item_count: 1
@@ -4008,17 +3899,17 @@ paths:
display_additional_tax_total: "$0.00"
total: '29.99'
display_total: "$29.99"
- completed_at: '2026-02-20T15:00:13.004Z'
- created_at: '2026-02-20T15:00:12.602Z'
- updated_at: '2026-02-20T15:00:13.004Z'
+ completed_at: '2026-02-21T09:07:27.877Z'
+ created_at: '2026-02-21T09:07:27.526Z'
+ updated_at: '2026-02-21T09:07:27.877Z'
order_promotions: []
line_items:
- id: li_gbHJdmfrXB
variant_id: variant_gbHJdmfrXB
quantity: 1
currency: USD
- name: Product 428216
- slug: product-428216
+ name: Product 424406
+ slug: product-424406
options_text: ''
price: '19.99'
display_price: "$19.99"
@@ -4037,23 +3928,23 @@ paths:
discounted_amount: '19.99'
display_discounted_amount: "$19.99"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:12.741Z'
- updated_at: '2026-02-20T15:00:12.998Z'
+ created_at: '2026-02-21T09:07:27.584Z'
+ updated_at: '2026-02-21T09:07:27.870Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_EfhxLZ9ck8
- number: H66615954280
+ number: H75437754070
state: pending
tracking:
tracking_url:
cost: '10.0'
display_cost: "$10.00"
shipped_at:
- created_at: '2026-02-20T15:00:12.857Z'
- updated_at: '2026-02-20T15:00:12.979Z'
+ created_at: '2026-02-21T09:07:27.715Z'
+ updated_at: '2026-02-21T09:07:27.851Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -4061,7 +3952,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_194
- name: Deja Herman
+ name: Camelia Kuphal
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -4094,11 +3985,11 @@ paths:
payment_method_id: pm_UkLWZg9DAJ
state: checkout
response_code: '12345'
- number: PJN5JEKP
+ number: PHZPD89J
amount: '29.99'
display_amount: "$29.99"
- created_at: '2026-02-20T15:00:12.945Z'
- updated_at: '2026-02-20T15:00:12.945Z'
+ created_at: '2026-02-21T09:07:27.815Z'
+ updated_at: '2026-02-21T09:07:27.815Z'
source_type: credit_card
source_id: card_UkLWZg9DAJ
source:
@@ -4292,13 +4183,13 @@ paths:
id: ps_gbHJdmfrXB
status: pending
currency: USD
- external_id: bogus_bdbcecc6c06bce2262d89b07
+ external_id: bogus_c46f6004f924d4dec2d106bb
external_data:
- client_secret: bogus_secret_a7a26e8478170f06
+ client_secret: bogus_secret_cfe4c7cadb9016c6
customer_external_id:
expires_at:
- created_at: '2026-02-20T15:00:16.017Z'
- updated_at: '2026-02-20T15:00:16.017Z'
+ created_at: '2026-02-21T09:07:30.974Z'
+ updated_at: '2026-02-21T09:07:30.974Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -4389,13 +4280,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_9ca684c4df117cd62c2edf1b
+ external_id: bogus_278f0c1827f2b180959055db
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-02-20T15:00:17.399Z'
- updated_at: '2026-02-20T15:00:17.399Z'
+ created_at: '2026-02-21T09:07:32.466Z'
+ updated_at: '2026-02-21T09:07:32.466Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -4436,13 +4327,13 @@ paths:
id: ps_UkLWZg9DAJ
status: pending
currency: USD
- external_id: bogus_7cda5f2950b12b9cad6ed584
+ external_id: bogus_d5930cb89cfc96efbc3bfc9c
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-02-20T15:00:18.961Z'
- updated_at: '2026-02-20T15:00:18.975Z'
+ created_at: '2026-02-21T09:07:33.913Z'
+ updated_at: '2026-02-21T09:07:33.926Z'
amount: '50.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -4517,13 +4408,13 @@ paths:
id: ps_UkLWZg9DAJ
status: completed
currency: USD
- external_id: bogus_18c8d4a81f670bcacd2e311d
+ external_id: bogus_16d73598a2ad31b8ed790224
external_data:
client_secret: secret_123
customer_external_id:
expires_at:
- created_at: '2026-02-20T15:00:19.649Z'
- updated_at: '2026-02-20T15:00:19.668Z'
+ created_at: '2026-02-21T09:07:34.601Z'
+ updated_at: '2026-02-21T09:07:34.613Z'
amount: '110.0'
payment_method_id: pm_UkLWZg9DAJ
order_id: or_UkLWZg9DAJ
@@ -4587,11 +4478,11 @@ paths:
example:
id: pss_gbHJdmfrXB
status: pending
- external_id: bogus_seti_6c492d9230d6597a0b97bc2c
- external_client_secret: bogus_seti_secret_aaa9591470c19c29
+ external_id: bogus_seti_703c412fe38e6b8630fac999
+ external_client_secret: bogus_seti_secret_bbff2501d5972a54
external_data: {}
- created_at: '2026-02-20T15:00:21.187Z'
- updated_at: '2026-02-20T15:00:21.187Z'
+ created_at: '2026-02-21T09:07:35.877Z'
+ updated_at: '2026-02-21T09:07:35.877Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -4674,12 +4565,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: pending
- external_id: seti_test_5660f0595798a57764015c7d
- external_client_secret: seti_secret_593e5dfa54e5724e4f015795
+ external_id: seti_test_81df5ce2552aadf28f39cb74
+ external_client_secret: seti_secret_eaa6962ddb545d1620a53258
external_data:
client_secret: secret_123
- created_at: '2026-02-20T15:00:22.895Z'
- updated_at: '2026-02-20T15:00:22.895Z'
+ created_at: '2026-02-21T09:07:37.566Z'
+ updated_at: '2026-02-21T09:07:37.566Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id:
payment_source_type:
@@ -4738,12 +4629,12 @@ paths:
example:
id: pss_UkLWZg9DAJ
status: completed
- external_id: seti_test_5ebdb96fb5df0969b2329220
- external_client_secret: seti_secret_1812a6b13515139d100a5d35
+ external_id: seti_test_0057f0f2d25d0db0c8db5d6d
+ external_client_secret: seti_secret_8af79e81d0c7168674850aba
external_data:
client_secret: secret_123
- created_at: '2026-02-20T15:00:24.038Z'
- updated_at: '2026-02-20T15:00:24.054Z'
+ created_at: '2026-02-21T09:07:38.934Z'
+ updated_at: '2026-02-21T09:07:38.953Z'
payment_method_id: pm_UkLWZg9DAJ
payment_source_id: card_UkLWZg9DAJ
payment_source_type: Spree::CreditCard
@@ -4812,11 +4703,11 @@ paths:
payment_method_id: pm_UkLWZg9DAJ
state: checkout
response_code: '12345'
- number: P3GO1JVZ
+ number: PXRM3TYH
amount: '110.0'
display_amount: "$110.00"
- created_at: '2026-02-20T15:00:25.402Z'
- updated_at: '2026-02-20T15:00:25.402Z'
+ created_at: '2026-02-21T09:07:40.332Z'
+ updated_at: '2026-02-21T09:07:40.332Z'
source_type: credit_card
source_id: card_UkLWZg9DAJ
source:
@@ -4896,11 +4787,11 @@ paths:
payment_method_id: pm_UkLWZg9DAJ
state: checkout
response_code: '12345'
- number: PJU2R95Z
+ number: PKKGFQV9
amount: '110.0'
display_amount: "$110.00"
- created_at: '2026-02-20T15:00:26.818Z'
- updated_at: '2026-02-20T15:00:26.818Z'
+ created_at: '2026-02-21T09:07:41.839Z'
+ updated_at: '2026-02-21T09:07:41.839Z'
source_type: credit_card
source_id: card_UkLWZg9DAJ
source:
@@ -4934,7 +4825,7 @@ paths:
get:
summary: List products
tags:
- - Products
+ - Product Catalog
security:
- api_key: []
description: Returns a paginated list of active products for the current store
@@ -4984,19 +4875,20 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 593922
+ name: Product 596465
description: |-
- Soluta ratione unde laborum adipisci placeat aliquid est eaque. Maiores eaque officiis fugit quod modi doloribus ratione. Ab neque eos eveniet consequuntur ipsa doloribus minus ea. Dignissimos fuga corporis aut ab. Fuga culpa voluptates sed non provident quisquam.
- Enim fuga praesentium atque autem. Earum autem doloremque delectus voluptate molestiae dolorem veniam. Asperiores nemo iusto sed delectus error. In hic minus assumenda facere porro commodi iusto ex.
- Aliquam modi sit harum blanditiis occaecati repellat. Delectus id quis sequi dicta. Quaerat similique repudiandae ut inventore.
- Aspernatur repudiandae consequatur iure asperiores iste exercitationem laudantium expedita. Optio minus enim eligendi delectus. Saepe beatae exercitationem quas corrupti assumenda maxime ipsum deleniti. Nisi ad officia explicabo aspernatur tempora alias.
- slug: product-593922
+ Neque suscipit qui eum temporibus doloribus quisquam consectetur nostrum. Est repudiandae quidem cumque unde consectetur possimus dignissimos. Voluptas repellat vero temporibus praesentium minima. Neque eius a tempore adipisci esse asperiores. Aspernatur officiis nulla harum ipsum nisi.
+ Laboriosam deserunt deleniti amet iste quod tempora corrupti. Inventore sequi magnam asperiores assumenda. Soluta culpa deserunt repellat mollitia quibusdam. Atque maiores nihil totam rerum velit in.
+ Veniam expedita aliquid laboriosam necessitatibus amet eligendi nobis nam. Exercitationem fugiat veritatis non illum labore cum esse. Distinctio optio facere velit est.
+ Qui magni porro labore cum facilis impedit eos fugit. Totam debitis ab provident voluptatibus. Accusantium deleniti ipsum voluptas nisi aperiam quae.
+ Omnis eos vero aperiam qui nesciunt voluptate mollitia. Fuga minima ullam autem nihil necessitatibus nobis assumenda reiciendis. Velit iusto autem voluptatem excepturi. Magni recusandae nesciunt excepturi fugit voluptatem quos nihil.
+ slug: product-596465
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-02-20T15:00:27.586Z'
- created_at: '2026-02-20T15:00:27.604Z'
- updated_at: '2026-02-20T15:00:27.791Z'
+ available_on: '2025-02-21T09:07:42.613Z'
+ created_at: '2026-02-21T09:07:42.633Z'
+ updated_at: '2026-02-21T09:07:42.728Z'
purchasable: true
in_stock: false
backorderable: true
@@ -5016,20 +4908,18 @@ paths:
price_list_id:
original_price:
- id: prod_gbHJdmfrXB
- name: Product 608816
+ name: Product 604179
description: |-
- Quidem corporis distinctio aspernatur reiciendis esse quod soluta. Alias maiores pariatur veritatis architecto dolorem. Inventore iusto fugiat quaerat quo debitis assumenda exercitationem.
- Quaerat perferendis deserunt quibusdam deleniti aliquam. Aut quas illo numquam sunt dolor saepe consequatur exercitationem. Modi fuga et dolorem libero asperiores voluptatum quibusdam dolor.
- Numquam quia sapiente assumenda sint cumque sunt aut. Debitis dolorum repudiandae corrupti praesentium laboriosam facilis veritatis sequi. Qui consectetur saepe facilis id possimus magnam.
- Aperiam modi aspernatur quod fuga repellat debitis. Asperiores a similique facere nihil suscipit saepe cumque reprehenderit. Ullam voluptatem sed perferendis fuga maxime.
- Deserunt repudiandae optio temporibus perspiciatis similique architecto. Tempora delectus magnam quisquam reprehenderit laboriosam harum. Illum in perspiciatis quam adipisci eius non. Perspiciatis quibusdam cumque aliquam facilis natus. Dignissimos sed impedit quos doloribus iusto cum ipsa maxime.
- slug: product-608816
+ Aliquid provident eaque repellat odio. Beatae in vitae nesciunt quis vel neque laboriosam. Explicabo sint doloremque vel nobis mollitia pariatur. Saepe cupiditate accusamus in quos nulla delectus tempora.
+ Velit natus quod laborum error. Illo aut cum atque nobis. Magni officia rerum laudantium quidem. Saepe cumque enim earum quia.
+ Ullam facilis vel commodi voluptates blanditiis corporis quasi. Alias labore qui laborum corporis cum dignissimos quo. Et sapiente occaecati voluptate voluptas doloremque est porro. Amet quasi ipsum quis laborum nam iste sed. Repellat illum numquam animi minima voluptatem tempora.
+ slug: product-604179
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-02-20T15:00:27.815Z'
- created_at: '2026-02-20T15:00:27.828Z'
- updated_at: '2026-02-20T15:00:27.854Z'
+ available_on: '2025-02-21T09:07:42.747Z'
+ created_at: '2026-02-21T09:07:42.758Z'
+ updated_at: '2026-02-21T09:07:42.784Z'
purchasable: true
in_stock: false
backorderable: true
@@ -5084,7 +4974,7 @@ paths:
get:
summary: Get a product
tags:
- - Products
+ - Product Catalog
security:
- api_key: []
description: Returns a single product by slug or prefix ID
@@ -5114,18 +5004,20 @@ paths:
application/json:
example:
id: prod_UkLWZg9DAJ
- name: Product 715447
+ name: Product 717071
description: |-
- Tenetur architecto facere libero non eligendi nam nobis. Odit fugiat asperiores cumque quos. Maxime occaecati quam omnis cupiditate sunt quibusdam inventore id. Quos molestias perferendis illum unde vitae. Eligendi voluptatem expedita aperiam sunt provident.
- Est odit eaque sunt nesciunt quas. Labore aperiam mollitia et dolore officia. Voluptates impedit numquam quis deserunt optio soluta.
- Animi qui odit doloremque dolores illum numquam. Consectetur repellendus porro reiciendis eius beatae. Suscipit inventore aliquid reiciendis odio.
- slug: product-715447
+ In placeat nesciunt numquam magnam modi reiciendis ratione at. Eum eos quo assumenda corrupti pariatur quia qui. Ratione odio in suscipit cumque qui sed atque. Iusto qui laboriosam veritatis sunt maxime nemo. Non perferendis atque recusandae nulla pariatur quae veritatis consequatur.
+ Assumenda esse sunt consequatur voluptatem culpa occaecati quasi. Molestias veniam odit optio fugiat sequi cumque nam. Suscipit accusamus animi quis quos debitis amet. Reprehenderit deleniti magni exercitationem unde aliquid perspiciatis. Ea sapiente quod iusto magnam adipisci beatae.
+ Minus libero impedit expedita tempora sit omnis. Saepe corporis explicabo ipsam consequuntur iure id debitis. Consectetur sint ipsam rem pariatur. Culpa eum fugiat voluptates incidunt quasi cupiditate.
+ Nam optio facere veniam distinctio minima voluptas ipsam. Quidem veniam quae voluptates minus. Harum quo deserunt repellat fugit recusandae soluta facilis. Quasi quibusdam rerum sapiente odio labore velit. Modi doloribus temporibus porro ipsa eum iusto.
+ Qui iure alias quas hic. Unde pariatur autem doloremque facere. Numquam tenetur molestias repudiandae sequi. Laudantium nesciunt vero sint illum excepturi ducimus qui. Reprehenderit dolorum aliquid fuga repellat nobis.
+ slug: product-717071
meta_description:
meta_keywords:
variant_count: 1
- available_on: '2025-02-20T15:00:29.151Z'
- created_at: '2026-02-20T15:00:29.168Z'
- updated_at: '2026-02-20T15:00:29.259Z'
+ available_on: '2025-02-21T09:07:44.066Z'
+ created_at: '2026-02-21T09:07:44.089Z'
+ updated_at: '2026-02-21T09:07:44.249Z'
purchasable: true
in_stock: false
backorderable: true
@@ -5160,7 +5052,7 @@ paths:
get:
summary: Get product filters
tags:
- - Products
+ - Product Catalog
security:
- api_key: []
description: |
@@ -5330,15 +5222,15 @@ paths:
example:
data:
- id: ship_UkLWZg9DAJ
- number: H74499216409
+ number: H92321187493
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T15:00:33.345Z'
- updated_at: '2026-02-20T15:00:33.374Z'
+ created_at: '2026-02-21T09:07:48.108Z'
+ updated_at: '2026-02-21T09:07:48.132Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -5346,7 +5238,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_280
- name: Rudolf Bins
+ name: Wilburn Abernathy
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -5443,15 +5335,15 @@ paths:
application/json:
example:
id: ship_UkLWZg9DAJ
- number: H37071494625
+ number: H97897945880
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T15:00:34.707Z'
- updated_at: '2026-02-20T15:00:34.735Z'
+ created_at: '2026-02-21T09:07:49.564Z'
+ updated_at: '2026-02-21T09:07:49.587Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -5459,7 +5351,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_288
- name: Asa Kiehn
+ name: Deanna Hartmann
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -5532,10 +5424,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R502443473
+ number: R114491162
state: delivery
- token: dkHLk6CA7dJCqFGbCrN8ccbU7ZCTAowCncE
+ token: pYoCRrQGvWFMyA3Z32dyJZkrgj7i44ZMPT3
special_instructions:
currency: USD
item_count: 1
@@ -5558,16 +5450,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T15:00:35.987Z'
- updated_at: '2026-02-20T15:00:36.124Z'
+ created_at: '2026-02-21T09:07:50.911Z'
+ updated_at: '2026-02-21T09:07:51.041Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1033455
- slug: product-1033455
+ name: Product 1033509
+ slug: product-1033509
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5586,23 +5478,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:36.061Z'
- updated_at: '2026-02-20T15:00:36.061Z'
+ created_at: '2026-02-21T09:07:50.978Z'
+ updated_at: '2026-02-21T09:07:50.978Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_UkLWZg9DAJ
- number: H54377042243
+ number: H23772260292
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T15:00:36.077Z'
- updated_at: '2026-02-20T15:00:36.123Z'
+ created_at: '2026-02-21T09:07:50.991Z'
+ updated_at: '2026-02-21T09:07:51.040Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -5610,7 +5502,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_296
- name: Keneth Nolan
+ name: Ranae Miller
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -5723,10 +5615,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R604832972
+ number: R653643949
state: cart
- token: ALRorHZLWJRAUTVuWuUBcBR4VDbZNqksJJJ
+ token: vYxQnmaQZqaAYneLrntLhXrqJrXknEQYAYy
special_instructions:
currency: USD
item_count: 1
@@ -5749,16 +5641,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T15:00:37.461Z'
- updated_at: '2026-02-20T15:00:37.985Z'
+ created_at: '2026-02-21T09:07:52.285Z'
+ updated_at: '2026-02-21T09:07:52.783Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1056123
- slug: product-1056123
+ name: Product 1053008
+ slug: product-1053008
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5777,23 +5669,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:37.526Z'
- updated_at: '2026-02-20T15:00:37.526Z'
+ created_at: '2026-02-21T09:07:52.342Z'
+ updated_at: '2026-02-21T09:07:52.342Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_UkLWZg9DAJ
- number: H20558347011
+ number: H60098250614
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T15:00:37.541Z'
- updated_at: '2026-02-20T15:00:37.566Z'
+ created_at: '2026-02-21T09:07:52.355Z'
+ updated_at: '2026-02-21T09:07:52.389Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -5801,7 +5693,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_304
- name: Rosalie Wiegand
+ name: Debra Luettgen
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -5823,12 +5715,12 @@ paths:
- id: py_UkLWZg9DAJ
payment_method_id: pm_UkLWZg9DAJ
state: checkout
- response_code: 1-SC-20260220150037980223
- number: P6QD1ZWH
+ response_code: 1-SC-20260221090752778888
+ number: PBDEME1X
amount: '10.0'
display_amount: "$10.00"
- created_at: '2026-02-20T15:00:37.985Z'
- updated_at: '2026-02-20T15:00:37.985Z'
+ created_at: '2026-02-21T09:07:52.783Z'
+ updated_at: '2026-02-21T09:07:52.783Z'
source_type: store_credit
source_id: credit_UkLWZg9DAJ
source:
@@ -5942,10 +5834,10 @@ paths:
application/json:
example:
id: or_UkLWZg9DAJ
- number: R946574670
+ number: R619244500
state: cart
- token: xHDETjBJjTqoF6gLDcXZNMd1qYgWScnRGmR
+ token: NccsrUrGDLnU3qCgaVK6EK3op4oczEuMyou
special_instructions:
currency: USD
item_count: 1
@@ -5968,16 +5860,16 @@ paths:
total: '110.0'
display_total: "$110.00"
completed_at:
- created_at: '2026-02-20T15:00:39.281Z'
- updated_at: '2026-02-20T15:00:39.408Z'
+ created_at: '2026-02-21T09:07:54.112Z'
+ updated_at: '2026-02-21T09:07:54.235Z'
order_promotions: []
line_items:
- id: li_UkLWZg9DAJ
variant_id: variant_UkLWZg9DAJ
quantity: 1
currency: USD
- name: Product 1075877
- slug: product-1075877
+ name: Product 1075408
+ slug: product-1075408
options_text: ''
price: '10.0'
display_price: "$10.00"
@@ -5996,23 +5888,23 @@ paths:
discounted_amount: '10.0'
display_discounted_amount: "$10.00"
display_compare_at_amount: "$0.00"
- created_at: '2026-02-20T15:00:39.355Z'
- updated_at: '2026-02-20T15:00:39.355Z'
+ created_at: '2026-02-21T09:07:54.177Z'
+ updated_at: '2026-02-21T09:07:54.177Z'
compare_at_amount:
thumbnail_url:
option_values: []
digital_links: []
shipments:
- id: ship_UkLWZg9DAJ
- number: H22387213561
+ number: H46331343101
state: pending
tracking: U10000
tracking_url:
cost: '100.0'
display_cost: "$100.00"
shipped_at:
- created_at: '2026-02-20T15:00:39.371Z'
- updated_at: '2026-02-20T15:00:39.396Z'
+ created_at: '2026-02-21T09:07:54.193Z'
+ updated_at: '2026-02-21T09:07:54.222Z'
shipping_method:
id: shpm_UkLWZg9DAJ
name: UPS Ground
@@ -6020,7 +5912,7 @@ paths:
stock_location:
id: sloc_UkLWZg9DAJ
state_abbr: STATE_ABBR_312
- name: Alison Volkman
+ name: Ora Beahan
address1: 1600 Pennsylvania Ave NW
city: Washington
zipcode: '20500'
@@ -6108,8 +6000,8 @@ paths:
instagram: spreecommerce
customer_support_email: [email protected]
default_locale: en
- created_at: '2026-02-20T14:59:29.860Z'
- updated_at: '2026-02-20T14:59:29.968Z'
+ created_at: '2026-02-21T09:06:42.736Z'
+ updated_at: '2026-02-21T09:06:42.881Z'
default_country_iso: US
supported_currencies:
- USD
@@ -6137,7 +6029,7 @@ paths:
get:
summary: List taxonomies
tags:
- - Taxons
+ - Product Catalog
security:
- api_key: []
description: Returns a list of taxonomies (category hierarchies) for the current
@@ -6174,32 +6066,32 @@ paths:
- id: txnmy_UkLWZg9DAJ
name: Categories
position: 1
- created_at: '2026-02-20T14:59:29.869Z'
- updated_at: '2026-02-20T14:59:29.889Z'
+ created_at: '2026-02-21T09:06:42.746Z'
+ updated_at: '2026-02-21T09:06:42.776Z'
root_id: txn_UkLWZg9DAJ
- id: txnmy_gbHJdmfrXB
name: Brands
position: 2
- created_at: '2026-02-20T14:59:29.890Z'
- updated_at: '2026-02-20T14:59:29.899Z'
+ created_at: '2026-02-21T09:06:42.777Z'
+ updated_at: '2026-02-21T09:06:42.791Z'
root_id: txn_gbHJdmfrXB
- id: txnmy_EfhxLZ9ck8
name: Collections
position: 3
- created_at: '2026-02-20T14:59:29.901Z'
- updated_at: '2026-02-20T14:59:29.971Z'
+ created_at: '2026-02-21T09:06:42.793Z'
+ updated_at: '2026-02-21T09:06:42.884Z'
root_id: txn_EfhxLZ9ck8
- id: txnmy_VqXmZF31wY
name: taxonomy_11
position: 4
- created_at: '2026-02-20T15:00:39.458Z'
- updated_at: '2026-02-20T15:00:39.467Z'
+ created_at: '2026-02-21T09:07:54.290Z'
+ updated_at: '2026-02-21T09:07:54.299Z'
root_id: txn_OIJLhNcSbf
- id: txnmy_uw2YK1rnl0
name: taxonomy_12
position: 5
- created_at: '2026-02-20T15:00:39.468Z'
- updated_at: '2026-02-20T15:00:39.476Z'
+ created_at: '2026-02-21T09:07:54.300Z'
+ updated_at: '2026-02-21T09:07:54.308Z'
root_id: txn_AXs1igzRC6
meta:
page: 1
@@ -6234,7 +6126,7 @@ paths:
get:
summary: Get a taxonomy
tags:
- - Taxons
+ - Product Catalog
security:
- api_key: []
description: Returns a single taxonomy with its taxon tree
@@ -6265,8 +6157,8 @@ paths:
id: txnmy_VqXmZF31wY
name: taxonomy_17
position: 4
- created_at: '2026-02-20T15:00:39.743Z'
- updated_at: '2026-02-20T15:00:39.751Z'
+ created_at: '2026-02-21T09:07:54.577Z'
+ updated_at: '2026-02-21T09:07:54.585Z'
root_id: txn_OIJLhNcSbf
schema:
"$ref": "#/components/schemas/StoreTaxonomy"
@@ -6284,7 +6176,7 @@ paths:
get:
summary: List taxons
tags:
- - Taxons
+ - Product Catalog
security:
- api_key: []
description: Returns a paginated list of taxons (categories) for the current
@@ -6327,8 +6219,8 @@ paths:
meta_description:
meta_keywords:
children_count: 0
- created_at: '2026-02-20T14:59:29.880Z'
- updated_at: '2026-02-20T14:59:29.887Z'
+ created_at: '2026-02-21T09:06:42.762Z'
+ updated_at: '2026-02-21T09:06:42.773Z'
parent_id:
taxonomy_id: txnmy_UkLWZg9DAJ
description: ''
@@ -6347,8 +6239,8 @@ paths:
meta_description:
meta_keywords:
children_count: 0
- created_at: '2026-02-20T14:59:29.893Z'
- updated_at: '2026-02-20T14:59:29.897Z'
+ created_at: '2026-02-21T09:06:42.779Z'
+ updated_at: '2026-02-21T09:06:42.784Z'
parent_id:
taxonomy_id: txnmy_gbHJdmfrXB
description: ''
@@ -6367,8 +6259,8 @@ paths:
meta_description:
meta_keywords:
children_count: 2
- created_at: '2026-02-20T14:59:29.904Z'
- updated_at: '2026-02-20T14:59:29.971Z'
+ created_at: '2026-02-21T09:06:42.802Z'
+ updated_at: '2026-02-21T09:06:42.884Z'
parent_id:
taxonomy_id: txnmy_EfhxLZ9ck8
description: ''
@@ -6387,8 +6279,8 @@ paths:
meta_description:
meta_keywords:
children_count: 0
- created_at: '2026-02-20T14:59:29.915Z'
- updated_at: '2026-02-20T14:59:29.917Z'
+ created_at: '2026-02-21T09:06:42.820Z'
+ updated_at: '2026-02-21T09:06:42.822Z'
parent_id: txn_EfhxLZ9ck8
taxonomy_id: txnmy_EfhxLZ9ck8
description: ''
@@ -6407,8 +6299,8 @@ paths:
meta_description:
meta_keywords:
children_count: 0
- created_at: '2026-02-20T14:59:29.927Z'
- updated_at: '2026-02-20T14:59:29.928Z'
+ created_at: '2026-02-21T09:06:42.832Z'
+ updated_at: '2026-02-21T09:06:42.833Z'
parent_id: txn_EfhxLZ9ck8
taxonomy_id: txnmy_EfhxLZ9ck8
description: ''
@@ -6427,8 +6319,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-02-20T15:00:40.184Z'
- updated_at: '2026-02-20T15:00:40.244Z'
+ created_at: '2026-02-21T09:07:55.114Z'
+ updated_at: '2026-02-21T09:07:55.177Z'
parent_id:
taxonomy_id: txnmy_VqXmZF31wY
description: ''
@@ -6447,8 +6339,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-02-20T15:00:40.190Z'
- updated_at: '2026-02-20T15:00:40.243Z'
+ created_at: '2026-02-21T09:07:55.122Z'
+ updated_at: '2026-02-21T09:07:55.177Z'
parent_id: txn_OIJLhNcSbf
taxonomy_id: txnmy_VqXmZF31wY
description: ''
@@ -6467,8 +6359,8 @@ paths:
meta_description:
meta_keywords:
children_count: 0
- created_at: '2026-02-20T15:00:40.200Z'
- updated_at: '2026-02-20T15:00:40.207Z'
+ created_at: '2026-02-21T09:07:55.132Z'
+ updated_at: '2026-02-21T09:07:55.138Z'
parent_id: txn_AXs1igzRC6
taxonomy_id: txnmy_VqXmZF31wY
description: ''
@@ -6511,7 +6403,7 @@ paths:
get:
summary: Get a taxon
tags:
- - Taxons
+ - Product Catalog
security:
- api_key: []
description: Returns a single taxon by permalink or prefix ID
@@ -6549,8 +6441,8 @@ paths:
meta_description:
meta_keywords:
children_count: 1
- created_at: '2026-02-20T15:00:41.015Z'
- updated_at: '2026-02-20T15:00:41.054Z'
+ created_at: '2026-02-21T09:07:56.096Z'
+ updated_at: '2026-02-21T09:07:56.145Z'
parent_id: txn_OIJLhNcSbf
taxonomy_id: txnmy_VqXmZF31wY
description: ''
@@ -6586,7 +6478,7 @@ paths:
get:
summary: List products in a taxon
tags:
- - Taxons
+ - Product Catalog
security:
- api_key: []
description: Returns a paginated list of products belonging to the specified
@@ -6621,19 +6513,19 @@ paths:
example:
data:
- id: prod_UkLWZg9DAJ
- name: Product 1152940
- description: Excepturi id dolores animi atque vero ipsam eius. Hic
- officiis dolorum perferendis provident amet eum. Labore corrupti
- nisi nemo vero excepturi dolor cupiditate. Ipsam tempore itaque
- quo tempora repellendus placeat. Iste sequi voluptate inventore
- ullam.
- slug: product-1152940
+ name: Product 1157954
+ description: Exercitationem vitae commodi non aliquam rem eos architecto
+ ex. Eius iusto cumque maiores expedita repellat excepturi. Molestiae
+ omnis atque unde harum neque delectus officia maxime. Debitis
+ rerum fuga praesentium officia mollitia assumenda. Non id optio
+ inventore minus harum nisi temporibus.
+ slug: product-1157954
meta_description:
meta_keywords:
variant_count: 0
- available_on: '2025-02-20T15:00:42.137Z'
- created_at: '2026-02-20T15:00:42.153Z'
- updated_at: '2026-02-20T15:00:42.179Z'
+ available_on: '2025-02-21T09:07:57.397Z'
+ created_at: '2026-02-21T09:07:57.414Z'
+ updated_at: '2026-02-21T09:07:57.442Z'
purchasable: true
in_stock: false
backorderable: true
@@ -6730,9 +6622,9 @@ paths:
data:
- id: wl_UkLWZg9DAJ
name: My Wishlist
- token: FfRVg5DN1LBEMa9Vo41WYjFK
- created_at: '2026-02-20T15:00:43.357Z'
- updated_at: '2026-02-20T15:00:43.357Z'
+ token: PnNzDNuBRb2AiEZGqqcnV1PK
+ created_at: '2026-02-21T09:07:59.938Z'
+ updated_at: '2026-02-21T09:07:59.938Z'
is_default: false
is_private: true
meta:
@@ -6791,9 +6683,9 @@ paths:
example:
id: wl_gbHJdmfrXB
name: Birthday Ideas
- token: Cv9suGkd4JtN7awMoUFx9cz7
- created_at: '2026-02-20T15:00:44.718Z'
- updated_at: '2026-02-20T15:00:44.718Z'
+ token: gvkadCSc5Xs344Qg9exv4Het
+ created_at: '2026-02-21T09:08:01.511Z'
+ updated_at: '2026-02-21T09:08:01.511Z'
is_default: false
is_private: true
schema:
@@ -6866,9 +6758,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: My Wishlist
- token: jAbbQqGE4wL7hBptZTrVweug
- created_at: '2026-02-20T15:00:45.905Z'
- updated_at: '2026-02-20T15:00:45.905Z'
+ token: BQAgT3BnmVVCttFTCtAgqzi5
+ created_at: '2026-02-21T09:08:02.762Z'
+ updated_at: '2026-02-21T09:08:02.762Z'
is_default: false
is_private: true
schema:
@@ -6914,9 +6806,9 @@ paths:
example:
id: wl_UkLWZg9DAJ
name: Updated Name
- token: x5Sdr1z5RwZvbWurVCuTjqS8
- created_at: '2026-02-20T15:00:47.229Z'
- updated_at: '2026-02-20T15:00:47.343Z'
+ token: B4dNAawiCFZso3cYvooe8bFM
+ created_at: '2026-02-21T09:08:04.053Z'
+ updated_at: '2026-02-21T09:08:04.137Z'
is_default: false
is_private: true
schema:
@@ -6997,8 +6889,8 @@ paths:
variant_id: variant_gbHJdmfrXB
wishlist_id: wl_UkLWZg9DAJ
quantity: 1
- created_at: '2026-02-20T15:00:48.669Z'
- updated_at: '2026-02-20T15:00:48.669Z'
+ created_at: '2026-02-21T09:08:05.469Z'
+ updated_at: '2026-02-21T09:08:05.469Z'
variant:
id: variant_gbHJdmfrXB
product_id: prod_gbHJdmfrXB
@@ -7007,8 +6899,8 @@ paths:
options_text: ''
track_inventory: true
image_count: 0
- created_at: '2026-02-20T15:00:48.622Z'
- updated_at: '2026-02-20T15:00:48.646Z'
+ created_at: '2026-02-21T09:08:05.421Z'
+ updated_at: '2026-02-21T09:08:05.445Z'
thumbnail:
purchasable: true
in_stock: false
@@ -7095,14 +6987,10 @@ tags:
description: Customer authentication and registration
- name: Store
description: Store information and settings
-- name: Products
- description: Product catalog browsing
-- name: Taxons
- description: Taxonomies and categories
-- name: Markets
- description: Markets (region + currency + locale bundles) and market resolution
-- name: Countries
- description: Countries within a market zone
+- name: Product Catalog
+ description: Products, taxonomies, and categories
+- name: Internationalization
+ description: Countries, currencies, and locales available in the store
- name: Cart
description: Shopping cart management
- name: Checkout
@@ -7119,12 +7007,10 @@ x-tagGroups:
- name: Store
tags:
- Store
- - Markets
- - Countries
+ - Internationalization
- name: Catalog
tags:
- - Products
- - Taxons
+ - Product Catalog
- name: Cart
tags:
- Cart
@@ -7968,6 +7854,16 @@ components:
type: boolean
zipcode_required:
type: boolean
+ currency:
+ type: string
+ nullable: true
+ default_locale:
+ type: string
+ nullable: true
+ supported_locales:
+ type: array
+ items:
+ type: string
states:
type: array
items:
@@ -7978,6 +7874,9 @@ components:
- name
- states_required
- zipcode_required
+ - currency
+ - default_locale
+ - supported_locales
x-typelizer: true
StoreCreditCard:
type: object
@@ -8010,6 +7909,20 @@ components:
- default
- gateway_payment_profile_id
x-typelizer: true
+ StoreCurrency:
+ type: object
+ properties:
+ iso_code:
+ type: string
+ name:
+ type: string
+ symbol:
+ type: string
+ required:
+ - iso_code
+ - name
+ - symbol
+ x-typelizer: true
StoreCustomer:
type: object
properties:
@@ -8296,38 +8209,16 @@ components:
- option_values
- digital_links
x-typelizer: true
- StoreMarket:
+ StoreLocale:
type: object
properties:
- id:
+ code:
type: string
name:
type: string
- currency:
- type: string
- default_locale:
- type: string
- tax_inclusive:
- type: boolean
- default:
- type: boolean
- supported_locales:
- type: array
- items:
- type: string
- countries:
- type: array
- items:
- "$ref": "#/components/schemas/StoreCountry"
required:
- - id
+ - code
- name
- - currency
- - default_locale
- - tax_inclusive
- - default
- - supported_locales
- - countries
x-typelizer: true
StoreMetafield:
type: object
diff --git a/packages/next/.changeset/line-item-currency.md b/packages/next/.changeset/line-item-currency.md
deleted file mode 100644
index c58abbc998..0000000000
--- a/packages/next/.changeset/line-item-currency.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-"@spree/next": patch
----
-
-Bump @spree/sdk dependency for StoreLineItem currency field
diff --git a/packages/next/.changeset/rename-user-to-customer.md b/packages/next/.changeset/rename-user-to-customer.md
deleted file mode 100644
index af6cab128c..0000000000
--- a/packages/next/.changeset/rename-user-to-customer.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-"@spree/next": patch
----
-
-Update type references from StoreUser to StoreCustomer following @spree/sdk rename
diff --git a/packages/next/CHANGELOG.md b/packages/next/CHANGELOG.md
index f55d5a74d0..8797257bd6 100644
--- a/packages/next/CHANGELOG.md
+++ b/packages/next/CHANGELOG.md
@@ -1,5 +1,20 @@
# @spree/next
+## 0.5.0
+
+### Minor Changes
+
+- Replace market data functions with flat countries, currencies, and locales
+
+ - Remove `listMarkets`, `getMarket`, `resolveMarket`, `listMarketCountries`, `getMarketCountry`
+ - Add `listCountries`, `getCountry` — countries with currency and locale from markets
+ - Add `listCurrencies` — supported currencies
+ - Add `listLocales` — supported locales
+ - Export `StoreCurrency` and `StoreLocale` types, remove `StoreMarket`
+
+- Updated dependencies:
+
## 0.4.0
### Minor Changes
diff --git a/packages/next/package.json b/packages/next/package.json
index 6b20311abb..ba89508638 100644
--- a/packages/next/package.json
+++ b/packages/next/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/next",
- "version": "0.4.0",
+ "version": "0.5.0",
"description": "Next.js integration for Spree Commerce — server actions, caching, and cookie-based auth",
"type": "module",
"main": "./dist/index.js",
@@ -55,7 +55,7 @@
"url": "https://github.com/spree/spree/issues"
},
"peerDependencies": {
- "@spree/sdk": ">=0.4.0",
+ "@spree/sdk": ">=0.5.0",
"next": ">=15.0.0",
"react": ">=19.0.0"
},
diff --git a/packages/next/src/data/countries.ts b/packages/next/src/data/countries.ts
new file mode 100644
index 0000000000..504c7952a4
--- /dev/null
+++ b/packages/next/src/data/countries.ts
@@ -0,0 +1,32 @@
+import type { StoreCountry } from '@spree/sdk';
+import { getClient } from '../config';
+import type { SpreeNextOptions } from '../types';
+
+/**
+ * List countries available in the store.
+ * Each country includes currency and default_locale derived from its market.
+ */
+export async function listCountries(
+ options?: SpreeNextOptions
+): Promise<{ data: StoreCountry[] }> {
+ return getClient().store.countries.list({
+ locale: options?.locale,
+ currency: options?.currency,
+ });
+}
+
+/**
+ * Get a country by ISO code.
+ * @param iso - ISO 3166-1 alpha-2 code (e.g., "US", "DE")
+ * @param params - Optional params (e.g., { include: 'states' } for address forms)
+ */
+export async function getCountry(
+ iso: string,
+ params?: { include?: string },
+ options?: SpreeNextOptions
+): Promise<StoreCountry> {
+ return getClient().store.countries.get(iso, params, {
+ locale: options?.locale,
+ currency: options?.currency,
+ });
+}
diff --git a/packages/next/src/data/currencies.ts b/packages/next/src/data/currencies.ts
new file mode 100644
index 0000000000..c3de4584a2
--- /dev/null
+++ b/packages/next/src/data/currencies.ts
@@ -0,0 +1,15 @@
+import type { StoreCurrency } from '@spree/sdk';
+import { getClient } from '../config';
+import type { SpreeNextOptions } from '../types';
+
+/**
+ * List currencies supported by the store (derived from markets).
+ */
+export async function listCurrencies(
+ options?: SpreeNextOptions
+): Promise<{ data: StoreCurrency[] }> {
+ return getClient().store.currencies.list({
+ locale: options?.locale,
+ currency: options?.currency,
+ });
+}
diff --git a/packages/next/src/data/locales.ts b/packages/next/src/data/locales.ts
new file mode 100644
index 0000000000..4ee0a1f2b1
--- /dev/null
+++ b/packages/next/src/data/locales.ts
@@ -0,0 +1,15 @@
+import type { StoreLocale } from '@spree/sdk';
+import { getClient } from '../config';
+import type { SpreeNextOptions } from '../types';
+
+/**
+ * List locales supported by the store (derived from markets).
+ */
+export async function listLocales(
+ options?: SpreeNextOptions
+): Promise<{ data: StoreLocale[] }> {
+ return getClient().store.locales.list({
+ locale: options?.locale,
+ currency: options?.currency,
+ });
+}
diff --git a/packages/next/src/data/markets.ts b/packages/next/src/data/markets.ts
deleted file mode 100644
index 3541772ed1..0000000000
--- a/packages/next/src/data/markets.ts
+++ /dev/null
@@ -1,70 +0,0 @@
-import type { StoreMarket, StoreCountry } from '@spree/sdk';
-import { getClient } from '../config';
-import type { SpreeNextOptions } from '../types';
-
-/**
- * List all markets with their countries.
- * Used to build a country/currency switcher.
- */
-export async function listMarkets(
- options?: SpreeNextOptions
-): Promise<{ data: StoreMarket[] }> {
- return getClient().store.markets.list({
- locale: options?.locale,
- currency: options?.currency,
- });
-}
-
-/**
- * Get a single market by prefixed ID.
- */
-export async function getMarket(
- id: string,
- options?: SpreeNextOptions
-): Promise<StoreMarket> {
- return getClient().store.markets.get(id, {
- locale: options?.locale,
- currency: options?.currency,
- });
-}
-
-/**
- * Resolve which market a country belongs to.
- * @param countryIso - ISO 3166-1 alpha-2 code (e.g., "US", "DE")
- */
-export async function resolveMarket(
- countryIso: string,
- options?: SpreeNextOptions
-): Promise<StoreMarket> {
- return getClient().store.markets.resolve(countryIso, {
- locale: options?.locale,
- currency: options?.currency,
- });
-}
-
-/**
- * List countries in a market's zone (for checkout address forms).
- */
-export async function listMarketCountries(
- marketId: string,
- options?: SpreeNextOptions
-): Promise<{ data: StoreCountry[] }> {
- return getClient().store.markets.countries.list(marketId, {
- locale: options?.locale,
- currency: options?.currency,
- });
-}
-
-/**
- * Get a country by ISO code with states (for address form validation).
- */
-export async function getMarketCountry(
- marketId: string,
- iso: string,
- options?: SpreeNextOptions
-): Promise<StoreCountry> {
- return getClient().store.markets.countries.get(marketId, iso, {
- locale: options?.locale,
- currency: options?.currency,
- });
-}
diff --git a/packages/next/src/index.ts b/packages/next/src/index.ts
index 27145fa200..dd1d01b2e1 100644
--- a/packages/next/src/index.ts
+++ b/packages/next/src/index.ts
@@ -7,7 +7,9 @@ export { listProducts, getProduct, getProductFilters } from './data/products';
export { listTaxons, getTaxon, listTaxonProducts } from './data/taxons';
export { listTaxonomies, getTaxonomy } from './data/taxonomies';
export { getStore } from './data/store';
-export { listMarkets, getMarket, resolveMarket, listMarketCountries, getMarketCountry } from './data/markets';
+export { listCountries, getCountry } from './data/countries';
+export { listCurrencies } from './data/currencies';
+export { listLocales } from './data/locales';
// Server actions (mutations + auth-dependent reads)
export {
@@ -74,7 +76,8 @@ export type {
StoreTaxon,
StoreTaxonomy,
StoreCountry,
- StoreMarket,
+ StoreCurrency,
+ StoreLocale,
StoreStore,
StoreAddress,
StoreCustomer,
diff --git a/packages/next/tsup.config.ts b/packages/next/tsup.config.ts
index b68e62b56c..c18a014cb3 100644
--- a/packages/next/tsup.config.ts
+++ b/packages/next/tsup.config.ts
@@ -11,7 +11,9 @@ export default defineConfig([
'data/taxons': 'src/data/taxons.ts',
'data/taxonomies': 'src/data/taxonomies.ts',
'data/store': 'src/data/store.ts',
- 'data/markets': 'src/data/markets.ts',
+ 'data/countries': 'src/data/countries.ts',
+ 'data/currencies': 'src/data/currencies.ts',
+ 'data/locales': 'src/data/locales.ts',
},
format: ['esm'],
dts: true,
diff --git a/packages/sdk/.changeset/line-item-currency.md b/packages/sdk/.changeset/line-item-currency.md
deleted file mode 100644
index 12dba164cc..0000000000
--- a/packages/sdk/.changeset/line-item-currency.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-"@spree/sdk": patch
----
-
-Add currency attribute to StoreLineItem type and Zod schema
diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md
index 52795f4f43..4fc1b4ecb3 100644
--- a/packages/sdk/CHANGELOG.md
+++ b/packages/sdk/CHANGELOG.md
@@ -1,5 +1,23 @@
# @spree/sdk
+## 0.5.0
+
+### Minor Changes
+
+- Replace markets API with flat countries, currencies, and locales endpoints
+
+ - Remove `store.markets` (list, get, resolve, countries) methods
+ - Add `store.countries` (list, get) — each country includes `currency` and `default_locale` from its market
+ - Add `store.currencies` (list) — supported currencies derived from markets
+ - Add `store.locales` (list) — supported locales derived from markets
+ - Add `StoreCurrency` and `StoreLocale` types
+ - Update `StoreCountry` type with `currency` and `default_locale` fields
+ - Remove `StoreMarket` type
+
+### Patch Changes
+
+- Add currency attribute to StoreLineItem type and Zod schema
+
## 0.4.0
### Minor Changes
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
index 0f7db3890c..87d602e265 100644
--- a/packages/sdk/package.json
+++ b/packages/sdk/package.json
@@ -1,6 +1,6 @@
{
"name": "@spree/sdk",
- "version": "0.4.0",
+ "version": "0.5.0",
"description": "Official TypeScript SDK for Spree Commerce API",
"type": "module",
"main": "./dist/index.cjs",
diff --git a/packages/sdk/src/store-client.ts b/packages/sdk/src/store-client.ts
index 2a57b633e8..3b6e0e6ec0 100644
--- a/packages/sdk/src/store-client.ts
+++ b/packages/sdk/src/store-client.ts
@@ -24,7 +24,8 @@ import type {
StoreProduct,
StoreOrder,
StoreCountry,
- StoreMarket,
+ StoreCurrency,
+ StoreLocale,
StoreTaxonomy,
StoreTaxon,
StorePayment,
@@ -208,71 +209,47 @@ export class StoreClient {
};
// ============================================
- // Markets & Geography
+ // Countries, Currencies & Locales
// ============================================
- readonly markets = {
+ readonly countries = {
/**
- * List all markets with their countries
- * Used to build a country/currency switcher on the frontend
+ * List countries available in the store
+ * Each country includes currency and default_locale derived from its market
*/
- list: (options?: RequestOptions): Promise<{ data: StoreMarket[] }> =>
- this.request<{ data: StoreMarket[] }>('GET', '/markets', options),
+ list: (options?: RequestOptions): Promise<{ data: StoreCountry[] }> =>
+ this.request<{ data: StoreCountry[] }>('GET', '/countries', options),
/**
- * Get a single market by prefixed ID
- * @param id - Market prefixed ID (e.g., "mkt_abc123")
+ * Get a country by ISO code
+ * Use `?include=states` to include states for address forms
+ * @param iso - ISO 3166-1 alpha-2 code (e.g., "US", "DE")
*/
- get: (id: string, options?: RequestOptions): Promise<StoreMarket> =>
- this.request<StoreMarket>('GET', `/markets/${id}`, options),
-
- /**
- * Resolve which market a country belongs to
- * @param countryIso - ISO 3166-1 alpha-2 code (e.g., "US", "DE")
- */
- resolve: (
- countryIso: string,
+ get: (
+ iso: string,
+ params?: { include?: string },
options?: RequestOptions
- ): Promise<StoreMarket> =>
- this.request<StoreMarket>('GET', '/markets/resolve', {
+ ): Promise<StoreCountry> =>
+ this.request<StoreCountry>('GET', `/countries/${iso}`, {
...options,
- params: { country: countryIso },
+ params,
}),
+ };
+ readonly currencies = {
/**
- * Nested resource: Countries within a market (for checkout address forms)
+ * List currencies supported by the store (derived from markets)
*/
- countries: {
- /**
- * List countries in a market's zone
- * @param marketId - Market prefixed ID (e.g., "mkt_abc123")
- */
- list: (
- marketId: string,
- options?: RequestOptions
- ): Promise<{ data: StoreCountry[] }> =>
- this.request<{ data: StoreCountry[] }>(
- 'GET',
- `/markets/${marketId}/countries`,
- options
- ),
+ list: (options?: RequestOptions): Promise<{ data: StoreCurrency[] }> =>
+ this.request<{ data: StoreCurrency[] }>('GET', '/currencies', options),
+ };
- /**
- * Get a country by ISO code with states (for address form validation)
- * @param marketId - Market prefixed ID (e.g., "mkt_abc123")
- * @param iso - ISO 3166-1 alpha-2 code (e.g., "US", "DE")
- */
- get: (
- marketId: string,
- iso: string,
- options?: RequestOptions
- ): Promise<StoreCountry> =>
- this.request<StoreCountry>(
- 'GET',
- `/markets/${marketId}/countries/${iso}`,
- options
- ),
- },
+ readonly locales = {
+ /**
+ * List locales supported by the store (derived from markets)
+ */
+ list: (options?: RequestOptions): Promise<{ data: StoreLocale[] }> =>
+ this.request<{ data: StoreLocale[] }>('GET', '/locales', options),
};
// ============================================
diff --git a/packages/sdk/src/types/generated/StoreCountry.ts b/packages/sdk/src/types/generated/StoreCountry.ts
index 5a7d963b1c..f1ad7129be 100644
--- a/packages/sdk/src/types/generated/StoreCountry.ts
+++ b/packages/sdk/src/types/generated/StoreCountry.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 9cec9b196b3857ffdab3e40ffd0ad55b
+// Typelizer digest 79a79179390a45b7da4d55fd1026b998
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
import type {StoreState} from '@/types'
@@ -9,6 +9,9 @@ type StoreCountry = {
name: string;
states_required: boolean;
zipcode_required: boolean;
+ currency: string | null;
+ default_locale: string | null;
+ supported_locales: Array<string>;
states?: Array<StoreState>;
}
diff --git a/packages/sdk/src/types/generated/StoreCurrency.ts b/packages/sdk/src/types/generated/StoreCurrency.ts
new file mode 100644
index 0000000000..565be61cf4
--- /dev/null
+++ b/packages/sdk/src/types/generated/StoreCurrency.ts
@@ -0,0 +1,11 @@
+// Typelizer digest 4a74dff60101bd5a4d9493fa0b57563a
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+type StoreCurrency = {
+ iso_code: string;
+ name: string;
+ symbol: string;
+}
+
+export default StoreCurrency;
diff --git a/packages/sdk/src/types/generated/StoreLocale.ts b/packages/sdk/src/types/generated/StoreLocale.ts
new file mode 100644
index 0000000000..bc7cade727
--- /dev/null
+++ b/packages/sdk/src/types/generated/StoreLocale.ts
@@ -0,0 +1,10 @@
+// Typelizer digest e34e95cbf6ca45a9ea77fc2367e24e7e
+//
+// DO NOT MODIFY: This file was automatically generated by Typelizer.
+
+type StoreLocale = {
+ code: string;
+ name: string;
+}
+
+export default StoreLocale;
diff --git a/packages/sdk/src/types/generated/StoreMarket.ts b/packages/sdk/src/types/generated/StoreMarket.ts
deleted file mode 100644
index 5c009ee44f..0000000000
--- a/packages/sdk/src/types/generated/StoreMarket.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-// Typelizer digest 20481a2c126447a1ac656a125edb9145
-//
-// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {StoreCountry} from '@/types'
-
-type StoreMarket = {
- id: string;
- name: string;
- currency: string;
- default_locale: string;
- tax_inclusive: boolean;
- default: boolean;
- supported_locales: Array<string>;
- countries: Array<StoreCountry>;
-}
-
-export default StoreMarket;
diff --git a/packages/sdk/src/types/generated/index.ts b/packages/sdk/src/types/generated/index.ts
index 9308e82ce1..3c43427906 100644
--- a/packages/sdk/src/types/generated/index.ts
+++ b/packages/sdk/src/types/generated/index.ts
@@ -1,4 +1,4 @@
-// Typelizer digest 1643aed7c6e7e519a529b750155272d4
+// Typelizer digest 8891b39beca3cb4c025fc2e141b8e372
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
export type { default as StoreAddress } from './StoreAddress'
@@ -13,12 +13,13 @@ export type { default as AdminVariant } from './AdminVariant'
export type { default as StoreBase } from './StoreBase'
export type { default as StoreCountry } from './StoreCountry'
export type { default as StoreCreditCard } from './StoreCreditCard'
+export type { default as StoreCurrency } from './StoreCurrency'
export type { default as StoreCustomer } from './StoreCustomer'
export type { default as StoreDigitalLink } from './StoreDigitalLink'
export type { default as StoreGiftCard } from './StoreGiftCard'
export type { default as StoreImage } from './StoreImage'
export type { default as StoreLineItem } from './StoreLineItem'
-export type { default as StoreMarket } from './StoreMarket'
+export type { default as StoreLocale } from './StoreLocale'
export type { default as StoreMetafield } from './StoreMetafield'
export type { default as StoreOptionType } from './StoreOptionType'
export type { default as StoreOptionValue } from './StoreOptionValue'
diff --git a/packages/sdk/src/zod/generated/StoreCountry.ts b/packages/sdk/src/zod/generated/StoreCountry.ts
index 941f3cee2c..6fa13a12d4 100644
--- a/packages/sdk/src/zod/generated/StoreCountry.ts
+++ b/packages/sdk/src/zod/generated/StoreCountry.ts
@@ -8,6 +8,9 @@ export const StoreCountrySchema = z.object({
name: z.string(),
states_required: z.boolean(),
zipcode_required: z.boolean(),
+ currency: z.string().nullable(),
+ default_locale: z.string().nullable(),
+ supported_locales: z.array(z.string()),
states: z.array(StoreStateSchema).optional(),
});
diff --git a/packages/sdk/src/zod/generated/StoreCurrency.ts b/packages/sdk/src/zod/generated/StoreCurrency.ts
new file mode 100644
index 0000000000..abb38d7c8c
--- /dev/null
+++ b/packages/sdk/src/zod/generated/StoreCurrency.ts
@@ -0,0 +1,10 @@
+// This file is auto-generated. Do not edit directly.
+import { z } from 'zod';
+
+export const StoreCurrencySchema = z.object({
+ iso_code: z.string(),
+ name: z.string(),
+ symbol: z.string(),
+});
+
+export type StoreCurrency = z.infer<typeof StoreCurrencySchema>;
diff --git a/packages/sdk/src/zod/generated/StoreLocale.ts b/packages/sdk/src/zod/generated/StoreLocale.ts
new file mode 100644
index 0000000000..dc100c5653
--- /dev/null
+++ b/packages/sdk/src/zod/generated/StoreLocale.ts
@@ -0,0 +1,9 @@
+// This file is auto-generated. Do not edit directly.
+import { z } from 'zod';
+
+export const StoreLocaleSchema = z.object({
+ code: z.string(),
+ name: z.string(),
+});
+
+export type StoreLocale = z.infer<typeof StoreLocaleSchema>;
diff --git a/packages/sdk/src/zod/generated/StoreMarket.ts b/packages/sdk/src/zod/generated/StoreMarket.ts
deleted file mode 100644
index 8ed48b3040..0000000000
--- a/packages/sdk/src/zod/generated/StoreMarket.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-// This file is auto-generated. Do not edit directly.
-import { z } from 'zod';
-import { StoreCountrySchema } from './StoreCountry';
-
-export const StoreMarketSchema = z.object({
- id: z.string(),
- name: z.string(),
- currency: z.string(),
- default_locale: z.string(),
- tax_inclusive: z.boolean(),
- default: z.boolean(),
- supported_locales: z.array(z.string()),
- countries: z.array(StoreCountrySchema),
-});
-
-export type StoreMarket = z.infer<typeof StoreMarketSchema>;
diff --git a/packages/sdk/src/zod/generated/index.ts b/packages/sdk/src/zod/generated/index.ts
index 858d333620..6e0558bbf9 100644
--- a/packages/sdk/src/zod/generated/index.ts
+++ b/packages/sdk/src/zod/generated/index.ts
@@ -11,12 +11,13 @@ export { StoreAddressSchema, type StoreAddress } from './StoreAddress';
export { StoreBaseSchema, type StoreBase } from './StoreBase';
export { StoreCountrySchema, type StoreCountry } from './StoreCountry';
export { StoreCreditCardSchema, type StoreCreditCard } from './StoreCreditCard';
+export { StoreCurrencySchema, type StoreCurrency } from './StoreCurrency';
export { StoreCustomerSchema, type StoreCustomer } from './StoreCustomer';
export { StoreDigitalLinkSchema, type StoreDigitalLink } from './StoreDigitalLink';
export { StoreGiftCardSchema, type StoreGiftCard } from './StoreGiftCard';
export { StoreImageSchema, type StoreImage } from './StoreImage';
export { StoreLineItemSchema, type StoreLineItem } from './StoreLineItem';
-export { StoreMarketSchema, type StoreMarket } from './StoreMarket';
+export { StoreLocaleSchema, type StoreLocale } from './StoreLocale';
export { StoreMetafieldSchema, type StoreMetafield } from './StoreMetafield';
export { StoreOptionTypeSchema, type StoreOptionType } from './StoreOptionType';
export { StoreOptionValueSchema, type StoreOptionValue } from './StoreOptionValue';
diff --git a/packages/sdk/tests/client.test.ts b/packages/sdk/tests/client.test.ts
index 9a2806110f..107d25f860 100644
--- a/packages/sdk/tests/client.test.ts
+++ b/packages/sdk/tests/client.test.ts
@@ -137,7 +137,9 @@ describe('SpreeClient', () => {
expect(client.store.products).toBeDefined();
expect(client.store.taxonomies).toBeDefined();
expect(client.store.taxons).toBeDefined();
- expect(client.store.markets).toBeDefined();
+ expect(client.store.countries).toBeDefined();
+ expect(client.store.currencies).toBeDefined();
+ expect(client.store.locales).toBeDefined();
expect(client.store.cart).toBeDefined();
expect(client.store.orders).toBeDefined();
expect(client.store.customer).toBeDefined();
diff --git a/packages/sdk/tests/markets.test.ts b/packages/sdk/tests/markets.test.ts
index 98333010f4..4bb147cf9f 100644
--- a/packages/sdk/tests/markets.test.ts
+++ b/packages/sdk/tests/markets.test.ts
@@ -3,52 +3,58 @@ import { createTestClient } from './helpers';
import { fixtures } from './mocks/handlers';
import type { SpreeClient } from '../src';
-describe('markets', () => {
+describe('countries', () => {
let client: SpreeClient;
beforeAll(() => { client = createTestClient(); });
describe('list', () => {
- it('returns all markets', async () => {
- const result = await client.store.markets.list();
+ it('returns all countries', async () => {
+ const result = await client.store.countries.list();
expect(result.data).toHaveLength(1);
- expect(result.data[0].name).toBe('North America');
+ expect(result.data[0].iso).toBe('US');
expect(result.data[0].currency).toBe('USD');
- expect(result.data[0].countries).toBeInstanceOf(Array);
+ expect(result.data[0].default_locale).toBe('en');
});
});
describe('get', () => {
- it('returns a market by prefixed ID', async () => {
- const result = await client.store.markets.get('mkt_1');
- expect(result.name).toBe(fixtures.market.name);
+ it('returns a country by ISO code', async () => {
+ const result = await client.store.countries.get('US');
+ expect(result.iso).toBe(fixtures.country.iso);
expect(result.currency).toBe('USD');
+ expect(result.default_locale).toBe('en');
});
});
+});
- describe('resolve', () => {
- it('resolves a market from country ISO code', async () => {
- const result = await client.store.markets.resolve('US');
- expect(result.name).toBe(fixtures.market.name);
- expect(result.currency).toBe('USD');
+describe('currencies', () => {
+ let client: SpreeClient;
+ beforeAll(() => { client = createTestClient(); });
+
+ describe('list', () => {
+ it('returns all currencies', async () => {
+ const result = await client.store.currencies.list();
+
+ expect(result.data).toHaveLength(1);
+ expect(result.data[0].iso_code).toBe('USD');
+ expect(result.data[0].name).toBe('United States Dollar');
+ expect(result.data[0].symbol).toBe('$');
});
});
+});
- describe('countries', () => {
- describe('list', () => {
- it('returns countries in a market', async () => {
- const result = await client.store.markets.countries.list('mkt_1');
- expect(result.data).toHaveLength(1);
- expect(result.data[0].iso).toBe('US');
- });
- });
+describe('locales', () => {
+ let client: SpreeClient;
+ beforeAll(() => { client = createTestClient(); });
- describe('get', () => {
- it('returns a country by ISO code within a market', async () => {
- const result = await client.store.markets.countries.get('mkt_1', 'US');
- expect(result.name).toBe(fixtures.country.name);
- expect(result.iso).toBe('US');
- });
+ describe('list', () => {
+ it('returns all locales', async () => {
+ const result = await client.store.locales.list();
+
+ expect(result.data).toHaveLength(1);
+ expect(result.data[0].code).toBe('en');
+ expect(result.data[0].name).toBe('English');
});
});
});
diff --git a/packages/sdk/tests/mocks/handlers.ts b/packages/sdk/tests/mocks/handlers.ts
index 4ebf0c3881..c397256cc7 100644
--- a/packages/sdk/tests/mocks/handlers.ts
+++ b/packages/sdk/tests/mocks/handlers.ts
@@ -65,22 +65,23 @@ export const fixtures = {
position: 1,
},
country: {
- id: 'country_1',
iso: 'US',
+ iso3: 'USA',
name: 'United States',
- states: [],
- },
- market: {
- id: 'mkt_1',
- name: 'North America',
+ states_required: true,
+ zipcode_required: true,
currency: 'USD',
default_locale: 'en',
- supported_locales: ['en'],
- tax_inclusive: false,
- default: true,
- countries: [
- { id: 'country_1', iso: 'US', name: 'United States', states_required: true, zipcode_required: true },
- ],
+ supported_locales: ['en', 'es'],
+ },
+ currency: {
+ iso_code: 'USD',
+ name: 'United States Dollar',
+ symbol: '$',
+ },
+ locale: {
+ code: 'en',
+ name: 'English',
},
wishlist: {
id: 'wl_1',
@@ -156,25 +157,23 @@ export const handlers = [
HttpResponse.json(fixtures.taxon)
),
- // Markets
- http.get(`${API_PREFIX}/markets`, () =>
- HttpResponse.json({ data: [fixtures.market] })
- ),
-
- http.get(`${API_PREFIX}/markets/resolve`, () =>
- HttpResponse.json(fixtures.market)
+ // Countries
+ http.get(`${API_PREFIX}/countries`, () =>
+ HttpResponse.json({ data: [fixtures.country] })
),
- http.get(`${API_PREFIX}/markets/:id`, () =>
- HttpResponse.json(fixtures.market)
+ http.get(`${API_PREFIX}/countries/:iso`, () =>
+ HttpResponse.json(fixtures.country)
),
- http.get(`${API_PREFIX}/markets/:marketId/countries`, () =>
- HttpResponse.json({ data: [fixtures.country] })
+ // Currencies
+ http.get(`${API_PREFIX}/currencies`, () =>
+ HttpResponse.json({ data: [fixtures.currency] })
),
- http.get(`${API_PREFIX}/markets/:marketId/countries/:iso`, () =>
- HttpResponse.json(fixtures.country)
+ // Locales
+ http.get(`${API_PREFIX}/locales`, () =>
+ HttpResponse.json({ data: [fixtures.locale] })
),
// Cart