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.

Expose `Product.option_values` in the Store API (#14110)

Damian Legawiecb1677d269e9e
diff --git a/packages/admin-sdk/.changeset/product-option-values.md b/packages/admin-sdk/.changeset/product-option-values.md
new file mode 100644
index 0000000000..1a5f2ed9d8
--- /dev/null
+++ b/packages/admin-sdk/.changeset/product-option-values.md
@@ -0,0 +1,7 @@
+---
+'@spree/admin-sdk': patch
+---
+
+Expose `Product.option_values` in the Admin API.
+
+The `Product` type now includes an optional `option_values: Array<OptionValue>` field, listing the option values that are actually in use across the product's variants — useful for rendering option pickers and variant matrices in the admin without iterating over every variant.
diff --git a/packages/admin-sdk/src/types/generated/Product.ts b/packages/admin-sdk/src/types/generated/Product.ts
index f19e32ae19..94c78af88b 100644
--- a/packages/admin-sdk/src/types/generated/Product.ts
+++ b/packages/admin-sdk/src/types/generated/Product.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 4149bfbe8a94fe137a240c3659f25b4a
+// Typelizer digest 2411aa1f976ec0e72496ed05c62de6bc
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Price, PriceHistory, Media, Variant, OptionType, Category, CustomField} from '@/types'
+import type {Price, PriceHistory, Media, Variant, OptionType, OptionValue, Category, CustomField} from '@/types'
interface Product {
id: string;
@@ -28,6 +28,7 @@ interface Product {
variants?: Array<Variant>;
default_variant?: Variant;
option_types?: Array<OptionType>;
+ option_values?: Array<OptionValue>;
categories?: Array<Category>;
custom_fields?: Array<CustomField>;
prior_price?: PriceHistory | null;
diff --git a/packages/sdk/.changeset/product-option-values.md b/packages/sdk/.changeset/product-option-values.md
new file mode 100644
index 0000000000..02f2e8e046
--- /dev/null
+++ b/packages/sdk/.changeset/product-option-values.md
@@ -0,0 +1,7 @@
+---
+'@spree/sdk': patch
+---
+
+Expose `Product.option_values` in the Store API.
+
+The `Product` type now includes an optional `option_values: Array<OptionValue>` field, listing the option values that are actually in use across the product's variants. This lets storefronts render option pickers (size, color, etc.) without iterating over every variant to collect them.
diff --git a/packages/sdk/src/types/generated/Product.ts b/packages/sdk/src/types/generated/Product.ts
index 544a44b5a5..03c3a6f049 100644
--- a/packages/sdk/src/types/generated/Product.ts
+++ b/packages/sdk/src/types/generated/Product.ts
@@ -1,7 +1,7 @@
-// Typelizer digest 405e991312f2bbec79feee8c8a2c25d7
+// Typelizer digest ef41571c2a6ddef3302e99ef8d160d96
//
// DO NOT MODIFY: This file was automatically generated by Typelizer.
-import type {Price, PriceHistory, Media, Variant, OptionType, Category, CustomField} from '@/types'
+import type {Price, PriceHistory, Media, Variant, OptionType, OptionValue, Category, CustomField} from '@/types'
interface Product {
id: string;
@@ -28,6 +28,7 @@ interface Product {
variants?: Array<Variant>;
default_variant?: Variant;
option_types?: Array<OptionType>;
+ option_values?: Array<OptionValue>;
categories?: Array<Category>;
custom_fields?: Array<CustomField>;
prior_price?: PriceHistory | null;
diff --git a/packages/sdk/src/zod/generated/Product.ts b/packages/sdk/src/zod/generated/Product.ts
index e0507794d9..a4326f9a92 100644
--- a/packages/sdk/src/zod/generated/Product.ts
+++ b/packages/sdk/src/zod/generated/Product.ts
@@ -4,6 +4,7 @@ import { CategorySchema } from './Category';
import { CustomFieldSchema } from './CustomField';
import { MediaSchema } from './Media';
import { OptionTypeSchema } from './OptionType';
+import { OptionValueSchema } from './OptionValue';
import { PriceSchema } from './Price';
import { PriceHistorySchema } from './PriceHistory';
import { VariantSchema } from './Variant';
@@ -33,6 +34,7 @@ export const ProductSchema = z.object({
variants: z.array(VariantSchema).optional(),
default_variant: VariantSchema.optional(),
option_types: z.array(OptionTypeSchema).optional(),
+ option_values: z.array(OptionValueSchema).optional(),
categories: z.array(z.lazy(() => CategorySchema)).optional(),
custom_fields: z.array(CustomFieldSchema).optional(),
prior_price: PriceHistorySchema.nullable().optional(),
diff --git a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
index 637effa0af..8274392ccb 100644
--- a/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/admin/product_serializer.rb
@@ -58,6 +58,10 @@ module Spree
resource: Spree.api.admin_option_type_serializer,
if: proc { expand?('option_types') }
+ many :option_values,
+ resource: Spree.api.admin_option_value_serializer,
+ if: proc { expand?('option_values') }
+
many :taxons,
proc { |taxons, params|
taxons.select { |t| t.taxonomy.store_id == params[:store].id }
diff --git a/spree/api/app/serializers/spree/api/v3/product_serializer.rb b/spree/api/app/serializers/spree/api/v3/product_serializer.rb
index 7beda14d46..2a68d2ad69 100644
--- a/spree/api/app/serializers/spree/api/v3/product_serializer.rb
+++ b/spree/api/app/serializers/spree/api/v3/product_serializer.rb
@@ -100,6 +100,10 @@ module Spree
resource: Spree.api.option_type_serializer,
if: proc { expand?('option_types') }
+ many :option_values,
+ resource: Spree.api.option_value_serializer,
+ if: proc { expand?('option_values') }
+
many :taxons,
proc { |taxons, params|
taxons.select { |t| t.taxonomy.store_id == params[:store].id }