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.

More updates aroung in stock scopes and sorting

Damian Legawiec612646c03f57
diff --git a/packages/sdk/src/params.ts b/packages/sdk/src/params.ts
index 42d0a54558..ef28b92b73 100644
--- a/packages/sdk/src/params.ts
+++ b/packages/sdk/src/params.ts
@@ -21,7 +21,8 @@ export function transformListParams(
if (value === undefined) continue;
if (PASSTHROUGH_KEYS.has(key)) {
- result[key] = value as ParamValue;
+ // Join arrays for passthrough keys (e.g., includes: ['variants', 'images'] → 'variants,images')
+ result[key] = Array.isArray(value) ? (value as (string | number)[]).join(',') : value as ParamValue;
continue;
}
@@ -31,9 +32,9 @@ export function transformListParams(
continue;
}
- // Handle array bracket keys: `foo[]` → `q[foo][]`
- if (key.endsWith('[]')) {
- const base = key.slice(0, -2);
+ // Array values get [] suffix automatically: `foo: [1,2]` → `q[foo][]`
+ if (Array.isArray(value)) {
+ const base = key.endsWith('[]') ? key.slice(0, -2) : key;
result[`q[${base}][]`] = value as ParamValue;
} else {
result[`q[${key}]`] = value as ParamValue;
diff --git a/packages/sdk/src/types/index.ts b/packages/sdk/src/types/index.ts
index 3f44bf609d..3807a2c8e8 100644
--- a/packages/sdk/src/types/index.ts
+++ b/packages/sdk/src/types/index.ts
@@ -57,11 +57,12 @@ export interface RegisterParams {
export interface ListParams {
page?: number;
per_page?: number;
- includes?: string;
+ /** Associations to include. Accepts array or comma-separated string. */
+ includes?: string[] | string;
}
export interface ProductListParams extends ListParams {
- /** Sort: 'price-low-to-high', 'price-high-to-low', 'best-selling', or Ransack e.g. 'name asc' */
+ /** Sort: 'price asc', 'price desc', 'best_selling', 'name asc', 'name desc', 'available_on desc', 'available_on asc' */
sort?: string;
/** Full-text search across name and SKU */
multi_search?: string;
@@ -71,10 +72,12 @@ export interface ProductListParams extends ListParams {
price_gte?: number;
/** Filter: price <= value */
price_lte?: number;
+ /** Filter by option value prefix IDs */
+ with_option_value_ids?: string[];
/** Filter: only in-stock products */
- in_stock_items?: boolean;
+ in_stock?: boolean;
/** Filter: only out-of-stock products */
- out_of_stock_items?: boolean;
+ out_of_stock?: boolean;
/** Filter: products in taxon */
taxons_id_eq?: string;
/** Any additional Ransack predicate */
diff --git a/packages/sdk/tests/params.test.ts b/packages/sdk/tests/params.test.ts
index 2716d9b33a..c85f2f808d 100644
--- a/packages/sdk/tests/params.test.ts
+++ b/packages/sdk/tests/params.test.ts
@@ -7,11 +7,16 @@ describe('transformListParams', () => {
expect(result).toEqual({ page: 2, per_page: 10 });
});
- it('passes through includes param unchanged', () => {
+ it('passes through includes string unchanged', () => {
const result = transformListParams({ includes: 'variants,images' });
expect(result).toEqual({ includes: 'variants,images' });
});
+ it('joins includes array into comma-separated string', () => {
+ const result = transformListParams({ includes: ['variants', 'images'] });
+ expect(result).toEqual({ includes: 'variants,images' });
+ });
+
it('passes through include param unchanged', () => {
const result = transformListParams({ include: 'variants' });
expect(result).toEqual({ include: 'variants' });
@@ -55,15 +60,24 @@ describe('transformListParams', () => {
expect(result).toEqual({ page: 1 });
});
- it('wraps array bracket keys correctly: foo[] → q[foo][]', () => {
+ it('wraps array values with [] suffix automatically', () => {
const result = transformListParams({
- 'with_option_value_ids[]': ['optval_abc', 'optval_def'],
+ with_option_value_ids: ['optval_abc', 'optval_def'],
});
expect(result).toEqual({
'q[with_option_value_ids][]': ['optval_abc', 'optval_def'],
});
});
+ it('handles array values even when key already has [] suffix', () => {
+ const result = transformListParams({
+ 'with_option_value_ids[]': ['optval_abc'],
+ });
+ expect(result).toEqual({
+ 'q[with_option_value_ids][]': ['optval_abc'],
+ });
+ });
+
it('handles a full combined query', () => {
const result = transformListParams({
page: 1,
diff --git a/spree/api/spec/integration/spree/api/v3/store/products_spec.rb b/spree/api/spec/integration/spree/api/v3/store/products_spec.rb
index 310422fb79..5bd92dbe81 100644
--- a/spree/api/spec/integration/spree/api/v3/store/products_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/products_spec.rb
@@ -34,7 +34,12 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/store
const products = await client.store.products.list({
page: 1,
per_page: 25,
- includes: 'variants,images',
+ sort: 'price asc',
+ name_cont: 'shirt',
+ price_gte: 20,
+ price_lte: 100,
+ with_option_value_ids: ['optval_abc', 'optval_def'],
+ includes: ['variants', 'images'],
})
JS
@@ -44,10 +49,20 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/store
description: 'Page number (default: 1)'
parameter name: :per_page, in: :query, type: :integer, required: false,
description: 'Number of items per page (default: 25, max: 100)'
+ parameter name: :sort, in: :query, type: :string, required: false,
+ description: 'Sort order. Values: price asc, price desc, best_selling, name asc, name desc, available_on desc, available_on asc'
parameter name: 'q[name_cont]', in: :query, type: :string, required: false,
description: 'Filter by name containing string'
parameter name: 'q[taxons_id_eq]', in: :query, type: :string, required: false,
description: 'Filter by taxon ID'
+ parameter name: 'q[price_gte]', in: :query, type: :number, required: false,
+ description: 'Filter by minimum price'
+ parameter name: 'q[price_lte]', in: :query, type: :number, required: false,
+ description: 'Filter by maximum price'
+ parameter name: 'q[with_option_value_ids][]', in: :query, type: :string, required: false,
+ description: 'Filter by option value prefix IDs (e.g., optval_abc). Pass multiple values for OR logic.'
+ parameter name: 'q[in_stock]', in: :query, type: :boolean, required: false,
+ description: 'Filter to only in-stock products'
parameter name: :includes, in: :query, type: :string, required: false,
description: 'Comma-separated associations to include (variants, images, taxons, option_types)'
@@ -90,7 +105,7 @@ RSpec.describe 'Products API', type: :request, swagger_doc: 'api-reference/store
sdk_example <<~JS
const product = await client.store.products.get('spree-tote', {
- includes: 'variants,images',
+ includes: ['variants', 'images'],
})
JS
diff --git a/spree/api/spec/integration/spree/api/v3/store/taxons_spec.rb b/spree/api/spec/integration/spree/api/v3/store/taxons_spec.rb
index 8d53b57907..83d6cb9b69 100644
--- a/spree/api/spec/integration/spree/api/v3/store/taxons_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/store/taxons_spec.rb
@@ -143,17 +143,31 @@ RSpec.describe 'Taxons API', type: :request, swagger_doc: 'api-reference/store.y
description 'Returns a paginated list of products belonging to the specified taxon'
sdk_example <<~JS
- const products = await client.store.taxons.products.list('taxon_abc123', {
+ const products = await client.store.taxons.products.list('categories/clothing', {
page: 1,
per_page: 25,
+ sort: 'price asc',
+ with_option_value_ids: ['optval_abc'],
})
JS
parameter name: 'x-spree-api-key', in: :header, type: :string, required: true
parameter name: :taxon_id, in: :path, type: :string, required: true,
description: 'Taxon permalink or prefix ID'
- parameter name: :page, in: :query, type: :integer, required: false
- parameter name: :per_page, in: :query, type: :integer, required: false
+ parameter name: :page, in: :query, type: :integer, required: false,
+ description: 'Page number (default: 1)'
+ parameter name: :per_page, in: :query, type: :integer, required: false,
+ description: 'Number of items per page (default: 25, max: 100)'
+ parameter name: :sort, in: :query, type: :string, required: false,
+ description: 'Sort order. Values: price asc, price desc, best_selling, name asc, name desc, available_on desc, available_on asc'
+ parameter name: 'q[price_gte]', in: :query, type: :number, required: false,
+ description: 'Filter by minimum price'
+ parameter name: 'q[price_lte]', in: :query, type: :number, required: false,
+ description: 'Filter by maximum price'
+ parameter name: 'q[with_option_value_ids][]', in: :query, type: :string, required: false,
+ description: 'Filter by option value prefix IDs'
+ parameter name: 'q[in_stock]', in: :query, type: :boolean, required: false,
+ description: 'Filter to only in-stock products'
response '200', 'products found' do
let(:'x-spree-api-key') { api_key.token }