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
Removed timestamps from Store API serializers
Damian Legawiec467e031d0741
diff --git a/docs/api-reference/store-api/metadata.mdx b/docs/api-reference/store-api/metadata.mdxindex de6ceb3808..f5e77e5c8e 100644--- a/docs/api-reference/store-api/metadata.mdx+++ b/docs/api-reference/store-api/metadata.mdx@@ -167,7 +167,7 @@ Spree has two permanent, complementary systems for custom data — **metadata fo| **Purpose** | Developer escape hatch — integration IDs, sync state | Merchant-defined structured attributes || **Schema** | Schemaless JSON — no definition required | Defined via MetafieldDefinitions (typed, validated) || **Validation** | None | Type-specific validation |-| **Visibility** | Write-only in Store API, readable in Admin API | Configurable (front-end, back-end, both) |+| **Visibility** | Write-only in Store API, readable in Admin API | Configurable (admin-only or public) || **Admin UI** | JSON preview | Dedicated form fields || **Best for** | Integration data, tracking, attribution, write-and-forget | Product specs, custom attributes, customer-facing data || **API access** | Write via Store API, read via Admin API | Read/write via both APIs |diff --git a/docs/developer/core-concepts/metafields.mdx b/docs/developer/core-concepts/metafields.mdxindex 3b16e86b84..7aa0d58fd1 100644--- a/docs/developer/core-concepts/metafields.mdx+++ b/docs/developer/core-concepts/metafields.mdx@@ -182,7 +182,7 @@ Spree has two permanent, complementary systems for custom data — **metadata fo| **Purpose** | Merchant-defined structured attributes | Developer escape hatch — integration IDs, sync state || **Schema** | Defined via MetafieldDefinitions | Schemaless JSON — no definition required || **Validation** | Type-specific (text, number, boolean, etc.) | None — accepts any JSON-serializable data |-| **Visibility** | Configurable (front-end, back-end, both) | Write-only in Store API, readable in Admin API |+| **Visibility** | Configurable (admin-only or public) | Write-only in Store API, readable in Admin API || **Admin UI** | Dedicated management forms | JSON preview || **Data Types** | 6 specific types | Any JSON value || **Organization** | Namespaced (`namespace.key`) | Flat key-value structure |diff --git a/docs/developer/customization/metadata.mdx b/docs/developer/customization/metadata.mdxindex 1f710bf2fc..fae40c24d1 100644--- a/docs/developer/customization/metadata.mdx+++ b/docs/developer/customization/metadata.mdx@@ -148,7 +148,7 @@ When there is no metadata, the field is `null`.### Reading and writing-Every model that includes `Spree::Metadata` has a `metadata` accessor. Always use `metadata` — do not use `public_metadata` or `private_metadata` directly:+Every model that includes `Spree::Metadata` has a `metadata` accessor. Always use `metadata` in Ruby code — do not call `public_metadata=` or `private_metadata=` directly. (SQL queries still reference the underlying `private_metadata` column name — see querying examples below.)```rubyorder = Spree::Order.find_by!(number: 'R123456')diff --git a/packages/sdk/.changeset/remove-timestamps-store-api.md b/packages/sdk/.changeset/remove-timestamps-store-api.mdnew file mode 100644index 0000000000..a56117e134--- /dev/null+++ b/packages/sdk/.changeset/remove-timestamps-store-api.md@@ -0,0 +1,5 @@+---+"@spree/sdk": patch+---++Remove `created_at` and `updated_at` from Store API responses. These internal timestamps are now only available in Admin API responses. Business timestamps like `completed_at` and `expires_at` are unchanged.diff --git a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb b/spree/api/app/serializers/spree/api/v3/cart_serializer.rbindex 9a7da246cc..55fc521456 100644--- a/spree/api/app/serializers/spree/api/v3/cart_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/cart_serializer.rb@@ -38,8 +38,7 @@ module Spree:additional_tax_total, :display_additional_tax_total, :total, :display_total,:gift_card_total, :display_gift_card_total,:amount_due, :display_amount_due,- :delivery_total, :display_delivery_total, :warnings,- created_at: :iso8601, updated_at: :iso8601+ :delivery_total, :display_delivery_total, :warningsattribute :store_credit_total do |order|order.total_applied_store_credit.to_sdiff --git a/spree/api/app/serializers/spree/api/v3/category_serializer.rb b/spree/api/app/serializers/spree/api/v3/category_serializer.rbindex 92ecc5cf18..e0511bebba 100644--- a/spree/api/app/serializers/spree/api/v3/category_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/category_serializer.rb@@ -11,8 +11,7 @@ module Spreeattributes :name, :permalink, :position, :depth,:meta_title, :meta_description, :meta_keywords,- :children_count,- created_at: :iso8601, updated_at: :iso8601+ :children_countattribute :parent_id do |category|category.parent&.prefixed_iddiff --git a/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb b/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rbindex cd4fa994e2..20b1cea8c2 100644--- a/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/gift_card_serializer.rb@@ -55,7 +55,6 @@ module Spreegift_card.active?end- attributes created_at: :iso8601, updated_at: :iso8601endendenddiff --git a/spree/api/app/serializers/spree/api/v3/order_serializer.rb b/spree/api/app/serializers/spree/api/v3/order_serializer.rbindex 0b5c73f3da..e99a4badbc 100644--- a/spree/api/app/serializers/spree/api/v3/order_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/order_serializer.rb@@ -33,7 +33,7 @@ module Spree:gift_card_total, :display_gift_card_total,:amount_due, :display_amount_due,:delivery_total, :display_delivery_total, :fulfillment_status, :payment_status,- completed_at: :iso8601, created_at: :iso8601, updated_at: :iso8601+ completed_at: :iso8601attribute :store_credit_total do |order|order.total_applied_store_credit.to_sdiff --git a/spree/api/app/serializers/spree/api/v3/payment_session_serializer.rb b/spree/api/app/serializers/spree/api/v3/payment_session_serializer.rbindex aa485c8ca5..44f5cd237e 100644--- a/spree/api/app/serializers/spree/api/v3/payment_session_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/payment_session_serializer.rb@@ -9,7 +9,7 @@ module Spreeattributes :status, :currency, :external_id, :external_data,:customer_external_id,- expires_at: :iso8601, created_at: :iso8601, updated_at: :iso8601+ expires_at: :iso8601attribute :amount do |session|session.amount&.to_sdiff --git a/spree/api/app/serializers/spree/api/v3/payment_setup_session_serializer.rb b/spree/api/app/serializers/spree/api/v3/payment_setup_session_serializer.rbindex e36a0a421f..a6f970b2b5 100644--- a/spree/api/app/serializers/spree/api/v3/payment_setup_session_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/payment_setup_session_serializer.rb@@ -7,8 +7,7 @@ module Spreepayment_method_id: [:string, nullable: true], payment_source_id: [:string, nullable: true],payment_source_type: [:string, nullable: true], customer_id: [:string, nullable: true]- attributes :status, :external_id, :external_client_secret, :external_data,- created_at: :iso8601, updated_at: :iso8601+ attributes :status, :external_id, :external_client_secret, :external_dataattribute :payment_method_id do |session|session.payment_method&.prefixed_iddiff --git a/spree/api/app/serializers/spree/api/v3/policy_serializer.rb b/spree/api/app/serializers/spree/api/v3/policy_serializer.rbindex 7e39d73b0f..77cfa252f6 100644--- a/spree/api/app/serializers/spree/api/v3/policy_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/policy_serializer.rb@@ -15,7 +15,6 @@ module Spreepolicy.body&.body&.to_s.to_send- attributes created_at: :iso8601, updated_at: :iso8601endendenddiff --git a/spree/api/app/serializers/spree/api/v3/report_serializer.rb b/spree/api/app/serializers/spree/api/v3/report_serializer.rbindex df460bb00d..2ff2290fb8 100644--- a/spree/api/app/serializers/spree/api/v3/report_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/report_serializer.rb@@ -9,8 +9,7 @@ module Spreecurrency: [:string, nullable: true],date_from: [:string, nullable: true], date_to: [:string, nullable: true]- attributes :type, :currency,- created_at: :iso8601, updated_at: :iso8601+ attributes :type, :currencyattribute :user_id do |report|report.user&.prefixed_iddiff --git a/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb b/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rbindex 32dcabd02c..b9f8f1801b 100644--- a/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/wishlist_item_serializer.rb@@ -12,8 +12,7 @@ module Spreewished_item.wishlist&.prefixed_idend- attributes :quantity,- created_at: :iso8601, updated_at: :iso8601+ attributes :quantityone :variant, resource: Spree.api.variant_serializerenddiff --git a/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb b/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rbindex 3c1a7b35b4..84cfde6294 100644--- a/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb+++ b/spree/api/app/serializers/spree/api/v3/wishlist_serializer.rb@@ -4,8 +4,7 @@ module Spreeclass WishlistSerializer < BaseSerializertypelize name: :string, token: :string, is_default: :boolean, is_private: :boolean- attributes :name, :token,- created_at: :iso8601, updated_at: :iso8601+ attributes :name, :tokenattribute :is_default do |wishlist|wishlist.is_default?diff --git a/spree/api/spec/serializers/spree/api/v3/gift_card_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/gift_card_serializer_spec.rbindex 4fdb79daf6..8560fd0448 100644--- a/spree/api/spec/serializers/spree/api/v3/gift_card_serializer_spec.rb+++ b/spree/api/spec/serializers/spree/api/v3/gift_card_serializer_spec.rb@@ -13,7 +13,6 @@ RSpec.describe Spree::Api::V3::GiftCardSerializer doamount amount_used amount_authorized amount_remainingdisplay_amount display_amount_used display_amount_remainingexpires_at redeemed_at expired active- created_at updated_at])end@@ -56,9 +55,9 @@ RSpec.describe Spree::Api::V3::GiftCardSerializer doexpect(subject['redeemed_at']).to be_nilend- it 'returns ISO 8601 timestamps' do- expect(subject['created_at']).to be_present- expect(subject['updated_at']).to be_present+ it 'does not include timestamps in Store API' do+ expect(subject).not_to have_key('created_at')+ expect(subject).not_to have_key('updated_at')endcontext 'with expired gift card' dodiff --git a/spree/api/spec/serializers/spree/api/v3/line_item_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/line_item_serializer_spec.rbindex 5942f087f3..7fa660fc25 100644--- a/spree/api/spec/serializers/spree/api/v3/line_item_serializer_spec.rb+++ b/spree/api/spec/serializers/spree/api/v3/line_item_serializer_spec.rb@@ -43,9 +43,9 @@ RSpec.describe Spree::Api::V3::LineItemSerializer doexpect(subject).to have_key('display_included_tax_total')end- it 'includes timestamp attributes' do- expect(subject).to have_key('created_at')- expect(subject).to have_key('updated_at')+ it 'does not include timestamps in Store API' do+ expect(subject).not_to have_key('created_at')+ expect(subject).not_to have_key('updated_at')endit 'includes option_values array' dodiff --git a/spree/api/spec/serializers/spree/api/v3/payment_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/payment_serializer_spec.rbindex 416e093b8c..544dfece97 100644--- a/spree/api/spec/serializers/spree/api/v3/payment_serializer_spec.rb+++ b/spree/api/spec/serializers/spree/api/v3/payment_serializer_spec.rb@@ -27,9 +27,9 @@ RSpec.describe Spree::Api::V3::PaymentSerializer doexpect(subject['display_amount']).to be_presentend- it 'includes timestamp attributes' do- expect(subject).to have_key('created_at')- expect(subject).to have_key('updated_at')+ it 'does not include timestamps in Store API' do+ expect(subject).not_to have_key('created_at')+ expect(subject).not_to have_key('updated_at')endit 'includes payment_method association' dodiff --git a/spree/api/spec/serializers/spree/api/v3/payment_session_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/payment_session_serializer_spec.rbindex a5059d481a..e49573bc31 100644--- a/spree/api/spec/serializers/spree/api/v3/payment_session_serializer_spec.rb+++ b/spree/api/spec/serializers/spree/api/v3/payment_session_serializer_spec.rb@@ -41,9 +41,9 @@ RSpec.describe Spree::Api::V3::PaymentSessionSerializer doexpect(subject['order_id']).to eq(order.prefixed_id)end- it 'includes timestamp attributes' do- expect(subject).to have_key('created_at')- expect(subject).to have_key('updated_at')+ it 'does not include timestamps in Store API' do+ expect(subject).not_to have_key('created_at')+ expect(subject).not_to have_key('updated_at')endit 'includes expires_at' dodiff --git a/spree/api/spec/serializers/spree/api/v3/refund_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/refund_serializer_spec.rbindex edd998e261..9cce47f765 100644--- a/spree/api/spec/serializers/spree/api/v3/refund_serializer_spec.rb+++ b/spree/api/spec/serializers/spree/api/v3/refund_serializer_spec.rb@@ -12,7 +12,7 @@ RSpec.describe Spree::Api::V3::RefundSerializer doit 'includes all expected attributes' doexpect(subject.keys).to match_array(%w[- id amount transaction_id payment_id refund_reason_id reimbursement_id created_at updated_at+ id amount transaction_id payment_id refund_reason_id reimbursement_id])enddiff --git a/spree/api/spec/serializers/spree/api/v3/reimbursement_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/reimbursement_serializer_spec.rbindex f97505a659..b21f257f93 100644--- a/spree/api/spec/serializers/spree/api/v3/reimbursement_serializer_spec.rb+++ b/spree/api/spec/serializers/spree/api/v3/reimbursement_serializer_spec.rb@@ -11,7 +11,7 @@ RSpec.describe Spree::Api::V3::ReimbursementSerializer doit 'includes all expected attributes' doexpect(subject.keys).to match_array(%w[- id number reimbursement_status total order_id customer_return_id created_at updated_at+ id number reimbursement_status total order_id customer_return_id])enddiff --git a/spree/api/spec/serializers/spree/api/v3/report_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/report_serializer_spec.rbindex 532d119e81..539df6592d 100644--- a/spree/api/spec/serializers/spree/api/v3/report_serializer_spec.rb+++ b/spree/api/spec/serializers/spree/api/v3/report_serializer_spec.rb@@ -11,7 +11,7 @@ RSpec.describe Spree::Api::V3::ReportSerializer doit 'includes all expected attributes' doexpect(subject.keys).to match_array(%w[- id type user_id currency date_from date_to created_at updated_at+ id type user_id currency date_from date_to])enddiff --git a/spree/api/spec/serializers/spree/api/v3/return_authorization_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/return_authorization_serializer_spec.rbindex 75c299c5f3..2222ee0479 100644--- a/spree/api/spec/serializers/spree/api/v3/return_authorization_serializer_spec.rb+++ b/spree/api/spec/serializers/spree/api/v3/return_authorization_serializer_spec.rb@@ -11,7 +11,7 @@ RSpec.describe Spree::Api::V3::ReturnAuthorizationSerializer doit 'includes all expected attributes' doexpect(subject.keys).to match_array(%w[- id number status order_id stock_location_id return_authorization_reason_id created_at updated_at+ id number status order_id stock_location_id return_authorization_reason_id])enddiff --git a/spree/api/spec/serializers/spree/api/v3/stock_item_serializer_spec.rb b/spree/api/spec/serializers/spree/api/v3/stock_item_serializer_spec.rbindex 5eedb03e9f..5144fe3bc5 100644--- a/spree/api/spec/serializers/spree/api/v3/stock_item_serializer_spec.rb+++ b/spree/api/spec/serializers/spree/api/v3/stock_item_serializer_spec.rb@@ -11,7 +11,7 @@ RSpec.describe Spree::Api::V3::StockItemSerializer doit 'includes all expected attributes' doexpect(subject.keys).to match_array(%w[- id count_on_hand backorderable stock_location_id variant_id created_at updated_at+ id count_on_hand backorderable stock_location_id variant_id])end