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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Expose cart_id on order payloads
Damian Legawiec6fbaa2ef7af7
diff --git a/packages/admin-sdk/src/types/generated/Order.ts b/packages/admin-sdk/src/types/generated/Order.tsindex 21fedd395c..608004701b 100644--- a/packages/admin-sdk/src/types/generated/Order.ts+++ b/packages/admin-sdk/src/types/generated/Order.ts@@ -1,4 +1,4 @@-// Typelizer digest 8b878c9b00bbfb1e3cf62a5b088a1418+// Typelizer digest 84f69b556d7fd0474620bd95f64989a4//// DO NOT MODIFY: This file was automatically generated by Typelizer.import type {AppliedPromotion, LineItem, Fulfillment, Payment, Address, GiftCard, Market, Channel, StockLocation, PaymentMethod, Customer, ReturnAuthorization, Reimbursement} from '@/types'@@ -6,6 +6,7 @@ import type {AppliedPromotion, LineItem, Fulfillment, Payment, Address, GiftCardinterface Order {id: string;market_id: string | null;+ cart_id: string | null;channel_id: string | null;number: string;email: string;diff --git a/packages/sdk/src/types/generated/Order.ts b/packages/sdk/src/types/generated/Order.tsindex 13058ecc15..a022a9c34e 100644--- a/packages/sdk/src/types/generated/Order.ts+++ b/packages/sdk/src/types/generated/Order.ts@@ -1,4 +1,4 @@-// Typelizer digest 077bc4d594f125cf29c01c1083841241+// Typelizer digest c6899223ead7a2ef2dfef98a38dc73a3//// DO NOT MODIFY: This file was automatically generated by Typelizer.import type {AppliedPromotion, LineItem, Fulfillment, Payment, Address, GiftCard, Market} from '@/types'@@ -6,6 +6,7 @@ import type {AppliedPromotion, LineItem, Fulfillment, Payment, Address, GiftCardinterface Order {id: string;market_id: string | null;+ cart_id: string | null;channel_id: string | null;number: string;email: string;diff --git a/packages/sdk/src/zod/generated/Order.ts b/packages/sdk/src/zod/generated/Order.tsindex bfb9d44240..90f6f47678 100644--- a/packages/sdk/src/zod/generated/Order.ts+++ b/packages/sdk/src/zod/generated/Order.ts@@ -11,6 +11,7 @@ import { PaymentSchema } from './Payment';export const OrderSchema = z.object({id: z.string(),market_id: z.string().nullable(),+ cart_id: z.string().nullable(),channel_id: z.string().nullable(),number: z.string(),email: z.string(),diff --git a/spree/api/app/serializers/spree/api/v3/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/order_serializer.rbindex 72e5da3183..a4d68a1c35 100644--- a/spree/api/app/serializers/spree/api/v3/order_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/order_serializer.rb@@ -4,7 +4,8 @@ module Spree# Store API Order Serializer# Post-purchase order data (completed orders)class OrderSerializer < BaseSerializer- typelize number: :string, email: :string,+ typelize cart_id: [:string, nullable: true],+ number: :string, email: :string,customer_note: [:string, nullable: true],market_id: [:string, nullable: true], channel_id: [:string, nullable: true],currency: :string, locale: [:string, nullable: true], total_quantity: :number,@@ -30,6 +31,14 @@ module Spreeorder.market&.prefixed_idend+ # The checkout handle this order was born from (nil for admin drafts).+ # Lets abandonment tooling match cart.* events to the conversion.+ # Encoded from the FK — loading the cart row just for its id would be+ # an N+1 on order lists.+ attribute :cart_id do |order|+ Spree::Cart.prefixed_id_for(order.cart_id)+ end+attribute :channel_id do |order|order.channel&.prefixed_idenddiff --git a/spree/core/app/models/concerns/spree/prefixed_id.rb b/spree/core/app/models/concerns/spree/prefixed_id.rbindex 4e21ad77e7..44af78b27f 100644--- a/spree/core/app/models/concerns/spree/prefixed_id.rb+++ b/spree/core/app/models/concerns/spree/prefixed_id.rb@@ -132,6 +132,17 @@ module Spreeendend+ # Builds the prefixed id for a raw primary key without loading the row —+ # for serializing foreign keys (e.g. Order#cart_id) where fetching the+ # associated record just to re-encode its id would be wasted I/O.+ # @param id [Integer, String, nil]+ # @return [String, nil]+ def prefixed_id_for(id)+ return nil if id.blank?++ "#{_prefix_id_prefix}_#{Spree::PrefixedId::SQIDS.encode([id.to_i])}"+ end+def find_by_prefix_id!(prefixed_id)decoded = decode_own_prefixed_id(prefixed_id)raise ActiveRecord::RecordNotFound.new("Couldn't find #{name} with prefixed id=#{prefixed_id}", name) unless decodeddiff --git a/spree/core/spec/models/spree/concerns/prefixed_id_spec.rb b/spree/core/spec/models/spree/concerns/prefixed_id_spec.rbindex 079e94ded8..f51e1991d1 100644--- a/spree/core/spec/models/spree/concerns/prefixed_id_spec.rb+++ b/spree/core/spec/models/spree/concerns/prefixed_id_spec.rb@@ -20,6 +20,15 @@ RSpec.describe Spree::PrefixedId doendend+ describe '.prefixed_id_for' do+ it 'encodes a raw id without loading the row' do+ cart = create(:cart)++ expect(Spree::Cart.prefixed_id_for(cart.id)).to eq(cart.prefixed_id)+ expect(Spree::Cart.prefixed_id_for(nil)).to be_nil+ end+ end+describe '#prefixed_id' doit 'returns a prefixed ID for persisted records' doproduct = create(:product)