spree_api 6.0.0.beta4 → 6.0.0.rc2

data/app/serializers/spree/api/v3/media_serializer.rb

@@ -18,9 +18,7 @@ module Spree
                  large_url: [:string, nullable: true], xlarge_url: [:string, nullable: true],
                  og_image_url: [:string, nullable: true]
 
-        attribute :product_id do |asset|
-          asset.product&.prefixed_id
-        end
+        prefixed_id_attributes :product
 
         # Returns prefixed IDs of variants this media is associated with.
         # Two paths coexist in 5.5:
@@ -34,8 +32,13 @@ module Spree
           ids.compact.uniq
         end
 
-        attributes :position, :alt, :media_type,
-                   :focal_point_x, :focal_point_y, :external_video_url
+        attributes :position, :alt, :media_type, :external_video_url
+
+        # Decimal columns serialize as strings; a focal point is a 0–1
+        # position on the image, which clients read as a number.
+        %i[focal_point_x focal_point_y].each do |name|
+          attribute(name) { |asset| asset.public_send(name)&.to_f }
+        end
 
         # Spree parses the YouTube/Vimeo link once, here, so no storefront has
         # to reimplement it. Nil on anything that isn't an external video.

data/app/serializers/spree/api/v3/newsletter_subscriber_request_event_serializer.rb

@@ -0,0 +1,35 @@
+module Spree
+  module Api
+    module V3
+      # The event shape for `newsletter_subscriber.subscription_requested` and
+      # `newsletter_subscriber.unsubscribe_requested`: the tokens a storefront
+      # needs to build the confirmation or unsubscribe link itself.
+      # `verification_token` is present only on a subscription request.
+      class NewsletterSubscriberRequestEventSerializer < BaseSerializer
+        typelize email: :string, unsubscribe_token: :string, verification_token: [:string, optional: true],
+                 store_id: [:string, nullable: true], customer_id: [:string, nullable: true],
+                 redirect_url: [:string, optional: true]
+
+        attributes :email
+
+        attribute :verification_token, if: proc { params[:include_verification_token] }, &:verification_token
+
+        attribute :unsubscribe_token do |subscriber|
+          subscriber.generate_token_for(:unsubscribe)
+        end
+
+        attribute :store_id do
+          params[:store]&.prefixed_id
+        end
+
+        attribute :customer_id do |subscriber|
+          subscriber.customer&.prefixed_id
+        end
+
+        attribute :redirect_url, if: proc { params[:redirect_url].present? } do
+          params[:redirect_url]
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb

@@ -10,17 +10,13 @@ module Spree
 
         attributes :email, created_at: :iso8601, updated_at: :iso8601
 
-        attribute :verified do |subscriber|
-          subscriber.verified?
-        end
+        attribute :verified, &:verified?
 
         attribute :verified_at do |subscriber|
           subscriber.verified_at&.iso8601
         end
 
-        attribute :customer_id do |subscriber|
-          subscriber.customer&.prefixed_id
-        end
+        prefixed_id_attributes :customer
       end
     end
   end

data/app/serializers/spree/api/v3/option_value_serializer.rb

@@ -6,9 +6,7 @@ module Spree
                  option_type_name: :string, option_type_label: :string,
                  color_code: 'string | null', image_url: 'string | null'
 
-        attribute :option_type_id do |option_value|
-          option_value.option_type&.prefixed_id
-        end
+        prefixed_id_attributes :option_type
 
         attributes :name, :label, :position, :color_code
 

data/app/serializers/spree/api/v3/order_group_serializer.rb

@@ -8,9 +8,7 @@ module Spree
       # their order history shows them — with the per-seller orders nested
       # inside it, each carrying its own items, delivery and tracking.
       class OrderGroupSerializer < BaseSerializer
-        typelize number: :string, email: [:string, nullable: true], currency: :string,
-                 total: [:string, nullable: true], display_total: [:string, nullable: true],
-                 item_total: [:string, nullable: true], display_item_total: [:string, nullable: true],
+        typelize number: :string, email: [:string, nullable: true], currency: [:string, enum: Spree::Money::Rounding::CURRENCY_CODES, enum_type_name: 'CurrencyCode'],
                  fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES],
                  payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES],
                  completed_at: [:string, nullable: true],
@@ -18,31 +16,14 @@ module Spree
 
         attributes :number, :email, :currency
 
-        attribute :total do |group|
-          group.total.to_s
-        end
-
-        attribute :display_total do |group|
-          group.display_total.to_s
-        end
-
-        attribute :item_total do |group|
-          group.item_total.to_s
-        end
-
-        attribute :display_item_total do |group|
-          group.display_item_total.to_s
-        end
+        # Every figure is rolled up from the children, never prorated back
+        # down. The payments are the group's own: a split checkout pays once,
+        # against the group, so a child holds none.
+        include Spree::Api::V3::PurchaseSummary
 
         # Rolled up across the children rather than stored, so it can never
         # disagree with the orders it describes.
-        attribute :fulfillment_status do |group|
-          group.fulfillment_status
-        end
-
-        attribute :payment_status do |group|
-          group.payment_status
-        end
+        attributes :fulfillment_status, :payment_status
 
         attribute :completed_at do |group|
           group.created_at
@@ -51,6 +32,12 @@ module Spree
         one :billing_address, resource: proc { Spree.api.address_serializer }
         one :shipping_address, resource: proc { Spree.api.address_serializer }
 
+        # The card itself is deliberately not nested here — the split copies it
+        # onto every child, so it is already in the payload, and a group this
+        # deep pushes the generated Zod schema past what TypeScript will
+        # serialize into a declaration file. `gift_card_total` is the figure a
+        # summary needs, and only the group can answer it.
+
         # The whole point of the group: the customer sees one purchase, and the
         # seller orders inside it are how it will arrive.
         many :orders, resource: proc { Spree.api.order_serializer }

data/app/serializers/spree/api/v3/order_serializer.rb

@@ -4,40 +4,21 @@ module Spree
       # Store API Order Serializer
       # Post-purchase order data (completed orders)
       class OrderSerializer < BaseSerializer
-        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],
-                 company_id: [:string, nullable: true], company_name: [:string, nullable: true],
-                 po_number: [:string, nullable: true],
-                 po_document_filename: [:string, nullable: true],
-                 po_document_byte_size: ['number | null'],
-                 currency: :string, locale: [:string, nullable: true], total_quantity: :number,
+        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], company_id: [:string, nullable: true],
+                 company_name: [:string, nullable: true], po_number: [:string, nullable: true],
+                 po_document_filename: [:string, nullable: true], po_document_byte_size: ['number | null'],
+                 currency: [:string, enum: Spree::Money::Rounding::CURRENCY_CODES, enum_type_name: 'CurrencyCode'], locale: [:string, nullable: true, enum: Spree::Locales::ALL, enum_type_name: 'LocaleCode'], total_quantity: :number,
                  coupon_code: [:string, nullable: true],
                  fulfillment_status: [:string, nullable: true, enum: Spree::Order::FULFILLMENT_STATUSES],
                  payment_status: [:string, nullable: true, enum: Spree::Order::PAYMENT_STATUSES],
-                 item_total: [:string, nullable: true], display_item_total: [:string, nullable: true],
-                 delivery_total: [:string, nullable: true], display_delivery_total: [:string, nullable: true],
-                 adjustment_total: [:string, nullable: true], display_adjustment_total: [:string, nullable: true],
-                 discount_total: [:string, nullable: true], display_discount_total: [:string, nullable: true],
-                 tax_total: [:string, nullable: true], display_tax_total: [:string, nullable: true],
-                 included_tax_total: [:string, nullable: true], display_included_tax_total: [:string, nullable: true],
-                 additional_tax_total: [:string, nullable: true], display_additional_tax_total: [:string, nullable: true],
-                 fee_total: [:string, nullable: true], display_fee_total: [:string, nullable: true],
-                 store_credit_total: [:string, nullable: true], display_store_credit_total: [:string, nullable: true],
-                 gift_card_total: [:string, nullable: true], display_gift_card_total: [:string, nullable: true],
-                 covered_by_store_credit: :boolean,
-                 total: [:string, nullable: true], display_total: [:string, nullable: true],
-                 amount_due: [:string, nullable: true], display_amount_due: [:string, nullable: true],
                  completed_at: [:string, nullable: true],
-                 withdrawal_period_ends_at: [:string, nullable: true],
-                 within_withdrawal_period: :boolean,
+                 withdrawal_period_ends_at: [:string, nullable: true], within_withdrawal_period: :boolean,
                  billing_address: { nullable: true }, shipping_address: { nullable: true },
                  gift_card: { nullable: true }, market: { nullable: true }
 
-        attribute :market_id do |order|
-          order.market&.prefixed_id
-        end
+        prefixed_id_attributes :market
 
         # The EU cooling-off deadline. Customer-facing by design: a buyer
         # deciding whether they can still send something back should not have
@@ -46,9 +27,7 @@ module Spree
           order.withdrawal_period_ends_at&.iso8601
         end
 
-        attribute :within_withdrawal_period do |order|
-          order.within_withdrawal_period?
-        end
+        attribute :within_withdrawal_period, &:within_withdrawal_period?
 
         # The checkout handle this order was born from (nil for admin drafts).
         # Lets abandonment tooling match cart.* events to the conversion.
@@ -58,14 +37,10 @@ module Spree
           Spree::Cart.prefixed_id_for(order.cart_id)
         end
 
-        attribute :channel_id do |order|
-          order.channel&.prefixed_id
-        end
+        prefixed_id_attributes :channel
 
         # Which company node the order was placed for — frozen at completion.
-        attribute :company_id do |order|
-          order.company&.prefixed_id
-        end
+        prefixed_id_attributes :company
 
         attribute :company_name do |order|
           order.company&.name
@@ -88,27 +63,9 @@ module Spree
 
         # Nulled for gated (prices_hidden) guests, consistent with cart and
         # catalog price hiding.
-        money_attributes :item_total, :display_item_total,
-                         :adjustment_total, :display_adjustment_total,
-                         :discount_total, :display_discount_total,
-                         :tax_total, :display_tax_total, :included_tax_total, :display_included_tax_total,
-                         :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,
-                         :fee_total, :display_fee_total
-
-        attribute :store_credit_total do |order|
-          order.total_applied_store_credit.to_s unless params[:hide_prices]
-        end
-
-        attribute :display_store_credit_total do |order|
-          order.display_total_applied_store_credit.to_s unless params[:hide_prices]
-        end
-
-        attribute :covered_by_store_credit do |order|
-          order.covered_by_store_credit?
-        end
+        include Spree::Api::V3::PurchaseSummary
+        money_attributes :adjustment_total, :display_adjustment_total,
+                         descriptions: { adjustment_total: 'Every discount, fee and added tax together, as one amount.' }
 
         many :order_promotions, key: :discounts, resource: proc { Spree.api.applied_promotion_serializer }
         # Itemized charges (duties, surcharges, COD, handling) — see the cart
@@ -116,7 +73,6 @@ module Spree
         many :fees, resource: proc { Spree.api.fee_serializer }
         many :line_items, key: :items, resource: proc { Spree.api.line_item_serializer }
         many :fulfillments, resource: proc { Spree.api.fulfillment_serializer }
-        many :payments, resource: proc { Spree.api.payment_serializer }
         one :billing_address, resource: proc { Spree.api.address_serializer }
         one :shipping_address, resource: proc { Spree.api.address_serializer }
         one :gift_card, resource: proc { Spree.api.gift_card_serializer }

data/app/serializers/spree/api/v3/password_reset_requested_event_serializer.rb

@@ -0,0 +1,29 @@
+module Spree
+  module Api
+    module V3
+      # The event shape for `customer.password_reset_requested`,
+      # `admin_user.password_reset_requested` and
+      # `seller_user.password_reset_requested`: what a storefront or back office
+      # needs to email the reset link itself. `reset_token` is a live credential,
+      # so these events reach only endpoints that name them.
+      class PasswordResetRequestedEventSerializer < BaseSerializer
+        typelize email: :string, reset_token: :string, store_id: [:string, nullable: true],
+                 redirect_url: [:string, optional: true]
+
+        attributes :email
+
+        attribute :reset_token do
+          params[:reset_token]
+        end
+
+        attribute :store_id do
+          params[:store]&.prefixed_id
+        end
+
+        attribute :redirect_url, if: proc { params[:redirect_url].present? } do
+          params[:redirect_url]
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/payment_method_serializer.rb

@@ -11,13 +11,9 @@ module Spree
           payment_method.class.api_type
         end
 
-        attribute :session_required do |payment_method|
-          payment_method.session_required?
-        end
+        attribute :session_required, &:session_required?
 
-        attribute :source_required do |payment_method|
-          payment_method.source_required?
-        end
+        attribute :source_required, &:source_required?
       end
     end
   end

data/app/serializers/spree/api/v3/payment_serializer.rb

@@ -2,15 +2,12 @@ module Spree
   module Api
     module V3
       class PaymentSerializer < BaseSerializer
-        typelize status: [:string, enum: Spree::Payment.statuses, enum_type_name: 'PaymentStatus'], payment_method_id: :string, response_code: [:string, nullable: true],
-                 number: :string, amount: [:string, nullable: true], display_amount: [:string, nullable: true],
+        typelize status: [:string, enum: Spree::Payment.statuses, enum_type_name: 'PaymentStatus'],
+                 payment_method_id: :string, response_code: [:string, nullable: true], number: :string,
                  source_type: [:string, nullable: true, enum: %w[credit_card store_credit payment_source]],
-                 source_id: [:string, nullable: true],
-                 source: 'CreditCard | StoreCredit | PaymentSource | null'
+                 source_id: [:string, nullable: true], source: 'CreditCard | StoreCredit | PaymentSource | null'
 
-        attribute :payment_method_id do |payment|
-          payment.payment_method&.prefixed_id
-        end
+        prefixed_id_attributes :payment_method
 
         attributes :response_code, :number, :status
 
@@ -31,9 +28,7 @@ module Spree
           end
         end
 
-        attribute :source_id do |payment|
-          payment.source&.prefixed_id
-        end
+        prefixed_id_attributes :source
 
         attribute :source do |payment|
           next nil if payment.source.blank?

data/app/serializers/spree/api/v3/payment_session_serializer.rb

@@ -2,7 +2,7 @@ module Spree
   module Api
     module V3
       class PaymentSessionSerializer < BaseSerializer
-        typelize status: [:string, enum: Spree::PaymentSession.statuses, enum_type_name: 'PaymentSessionStatus'], amount: :string, currency: :string,
+        typelize status: [:string, enum: Spree::PaymentSession.statuses, enum_type_name: 'PaymentSessionStatus'], currency: [:string, enum: Spree::Money::Rounding::CURRENCY_CODES, enum_type_name: 'CurrencyCode'],
                  external_id: :string, external_data: 'Record<string, unknown>',
                  expires_at: [:string, nullable: true], customer_external_id: [:string, nullable: true],
                  payment_method_id: :string, order_id: [:string, nullable: true],
@@ -12,23 +12,15 @@ module Spree
                    :customer_external_id,
                    expires_at: :iso8601
 
-        attribute :amount do |session|
-          session.amount&.to_s
-        end
+        money_attributes :amount
 
-        attribute :payment_method_id do |session|
-          session.payment_method&.prefixed_id
-        end
+        prefixed_id_attributes :payment_method
 
         # Bridge: reports the owner (cart during checkout, order after
         # completion) until clients migrate to cart_id/order_id.
-        attribute :order_id do |session|
-          session.owner&.prefixed_id
-        end
+        prefixed_id_attributes order_id: :owner
 
-        attribute :cart_id do |session|
-          session.cart&.prefixed_id
-        end
+        prefixed_id_attributes :cart
 
         one :payment_method, resource: proc { Spree.api.payment_method_serializer }
         one :payment, resource: proc { Spree.api.payment_serializer },

data/app/serializers/spree/api/v3/payment_setup_session_serializer.rb

@@ -9,21 +9,13 @@ module Spree
 
         attributes :status, :external_id, :external_client_secret, :external_data
 
-        attribute :payment_method_id do |session|
-          session.payment_method&.prefixed_id
-        end
-
-        attribute :payment_source_id do |session|
-          session.payment_source&.prefixed_id
-        end
+        prefixed_id_attributes :payment_method, :payment_source
 
         attribute :payment_source_type do |session|
-          session.payment_source_type
+          Spree::Base.polymorphic_api_type(session.payment_source_type)
         end
 
-        attribute :customer_id do |session|
-          session.customer&.prefixed_id
-        end
+        prefixed_id_attributes :customer
 
         one :payment_method, resource: proc { Spree.api.payment_method_serializer }
       end

data/app/serializers/spree/api/v3/policy_serializer.rb

@@ -11,9 +11,7 @@ module Spree
           Spree::RichTextHelper.to_plain_text(policy.body)
         end
 
-        attribute :body_html do |policy|
-          policy.body_html
-        end
+        attributes :body_html
 
         # The one timestamp a store serializer carries. When a legal document
         # last changed is what a shopper is entitled to see on the page —

data/app/serializers/spree/api/v3/price_history_serializer.rb

@@ -4,17 +4,15 @@ module Spree
   module Api
     module V3
       class PriceHistorySerializer < BaseSerializer
-        typelize amount: :string,
-                 amount_in_cents: :number,
-                 display_amount: :string,
-                 currency: :string,
+        typelize display_amount: display_money_type(:display_amount, nullable: false),
+                 currency: [:string, enum: Spree::Money::Rounding::CURRENCY_CODES, enum_type_name: 'CurrencyCode'],
                  recorded_at: :string
 
-        attributes :amount, :amount_in_cents, :currency
+        attributes :currency
 
-        attribute :display_amount do |price_history|
-          price_history.display_amount
-        end
+        money_attributes :amount, unit_price: true
+
+        attributes :display_amount
 
         attribute :recorded_at do |price_history|
           price_history.recorded_at&.iso8601

data/app/serializers/spree/api/v3/price_serializer.rb

@@ -5,17 +5,14 @@ module Spree
       # Represents a resolved/calculated price for storefront display
       # Can represent either a calculated price (with price list resolution) or a base price
       class PriceSerializer < BaseSerializer
-        typelize amount: [:string, nullable: true],
-                 amount_in_cents: [:number, nullable: true],
-                 display_amount: [:string, nullable: true],
-                 compare_at_amount: [:string, nullable: true],
-                 compare_at_amount_in_cents: [:number, nullable: true],
-                 display_compare_at_amount: [:string, nullable: true],
-                 currency: [:string, nullable: true],
+        typelize display_amount: display_money_type(:display_amount),
+                 display_compare_at_amount: display_money_type(:display_compare_at_amount),
+                 currency: [:string, nullable: true, enum: Spree::Money::Rounding::CURRENCY_CODES, enum_type_name: 'CurrencyCode'],
                  price_list_id: [:string, nullable: true]
 
-        attributes :amount, :amount_in_cents, :compare_at_amount,
-                   :compare_at_amount_in_cents, :currency
+        attributes :currency
+
+        money_attributes :amount, :compare_at_amount, unit_price: true
 
         attribute :display_amount do |price|
           price.display_amount&.to_s
@@ -25,9 +22,7 @@ module Spree
           price.display_compare_at_amount&.to_s
         end
 
-        attribute :price_list_id do |price|
-          price.price_list&.prefixed_id
-        end
+        prefixed_id_attributes :price_list
       end
     end
   end

data/app/serializers/spree/api/v3/product_filter_price_range_serializer.rb

@@ -4,11 +4,17 @@ module Spree
       class ProductFilterPriceRangeSerializer < BaseSerializer
         typelize id: :string,
                  type: "'price_range'",
-                 min: :number,
-                 max: :number,
-                 currency: :string
+                 min: :string,
+                 max: :string,
+                 currency: [:string, enum: Spree::Money::Rounding::CURRENCY_CODES, enum_type_name: 'CurrencyCode']
 
-        attributes :id, :type, :min, :max, :currency
+        attributes :id, :type
+
+        # Search providers hand the bounds over as numbers.
+        attribute(:min) { |range| Spree::Money::Rounding.format(range[:min], range[:currency], unit_price: true) }
+        attribute(:max) { |range| Spree::Money::Rounding.format(range[:max], range[:currency], unit_price: true) }
+
+        attributes :currency
       end
     end
   end

data/app/serializers/spree/api/v3/product_publication_serializer.rb

@@ -9,13 +9,7 @@ module Spree
 
         attributes published_at: :iso8601, unpublished_at: :iso8601
 
-        attribute :product_id do |publication|
-          publication.product&.prefixed_id
-        end
-
-        attribute :channel_id do |publication|
-          publication.channel&.prefixed_id
-        end
+        prefixed_id_attributes :product, :channel
       end
     end
   end

data/app/serializers/spree/api/v3/product_serializer.rb

@@ -24,27 +24,17 @@ module Spree
                    :variant_count,
                    available_on: :iso8601, preorder_ships_at: :iso8601
 
-        attribute :purchasable do |product|
-          product.purchasable?
-        end
+        attribute :purchasable, &:purchasable?
 
         # True when this product is currently offered as a pre-order on the
         # requesting channel.
-        attribute :preorder do |product|
-          product.preorder?
-        end
+        attribute :preorder, &:preorder?
 
-        attribute :in_stock do |product|
-          product.in_stock?
-        end
+        attribute :in_stock, &:in_stock?
 
-        attribute :backorderable do |product|
-          product.backorderable?
-        end
+        attribute :backorderable, &:backorderable?
 
-        attribute :available do |product|
-          product.available?
-        end
+        attribute :available, &:available?
 
         attribute :description do |product|
           next if product.description.blank?
@@ -60,9 +50,7 @@ module Spree
         # buy-box winner: that moves with price and stock, and a client that
         # cached or linked this id must not find it pointing at a different
         # row tomorrow. On a single-seller catalog the two coincide anyway.
-        attribute :default_variant_id do |product|
-          product.default_variant&.prefixed_id
-        end
+        prefixed_id_attributes :default_variant
 
         # The offer a storefront should lead with when several sellers share
         # the listing — the buy-box winner in the request's currency. Nil when
@@ -91,7 +79,7 @@ module Spree
         # single-seller catalog winner and default variant are the same row.
         attribute :price do |product|
           price = price_for(featured_variant(product))
-          Spree.api.price_serializer.new(price, params: params).to_h if price.present?
+          price_serializer.new(price, params: params).to_h if price.present?
         end
 
         # Original price - base price without price list resolution (for showing strikethrough)
@@ -102,16 +90,14 @@ module Spree
           base = price_in(variant)
 
           if calculated.present? && base.present? && calculated.id != base.id
-            Spree.api.price_serializer.new(base, params: params).to_h
+            price_serializer.new(base, params: params).to_h
           end
         end
 
         # Nil on the marketplace's own first-party products. The id is always
         # present so a storefront can group or link by seller without paying
         # for the expand; `?expand=seller` adds the public profile.
-        attribute :seller_id do |product|
-          product.seller&.prefixed_id
-        end
+        prefixed_id_attributes :seller
 
         # Conditional associations
         one :seller,
@@ -162,7 +148,7 @@ module Spree
         attribute :prior_price,
                   if: proc { expand?('prior_price') } do |product|
           record = price_in(featured_variant(product))&.prior_price
-          Spree.api.price_history_serializer.new(record, params: params).to_h if record
+          price_history_serializer.new(record, params: params).to_h if record
         end
       end
     end

data/app/serializers/spree/api/v3/product_submission_serializer.rb

@@ -0,0 +1,26 @@
+module Spree
+  module Api
+    module V3
+      # The marketplace's answer on a listing, as the seller sees it and as
+      # the `product_submission.*` webhook events carry it.
+      #
+      # The reviewer's identity is deliberately absent: a seller needs to
+      # know what to change, not which member of the marketplace's staff
+      # decided (docs/plans/6.0-seller-product-submission.md).
+      class ProductSubmissionSerializer < BaseSerializer
+        typelize status: [:string, enum: Spree::ProductSubmission.statuses, enum_type_name: 'ProductSubmissionStatus'],
+                 product_id: :string,
+                 review_note: [:string, nullable: true],
+                 reviewed_at: [:string, nullable: true]
+
+        attributes :status, :review_note,
+                   reviewed_at: :iso8601,
+                   created_at: :iso8601
+
+        # A subscriber holding only the submission id would otherwise have to
+        # fetch the row back to learn which product was decided on.
+        prefixed_id_attributes :product
+      end
+    end
+  end
+end