spree_api 5.3.4 → 5.4.0.beta

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

@@ -0,0 +1,108 @@
+module Spree
+  module Api
+    module V3
+      # Store API Product Serializer
+      # Customer-facing product data with limited fields
+      class ProductSerializer < BaseSerializer
+        typelize name: :string, description: [:string, nullable: true], slug: :string,
+                 meta_description: [:string, nullable: true], meta_keywords: [:string, nullable: true],
+                 variant_count: :number,
+                 default_variant_id: :string,
+                 thumbnail_url: [:string, nullable: true],
+                 available_on: [:string, nullable: true],
+                 purchasable: :boolean, in_stock: :boolean, backorderable: :boolean, available: :boolean,
+                 price: 'StorePrice',
+                 original_price: ['StorePrice', nullable: true],
+                 tags: [:string, multi: true]
+
+        attributes :name, :description, :slug,
+                   :meta_description, :meta_keywords,
+                   :variant_count,
+                   available_on: :iso8601, created_at: :iso8601, updated_at: :iso8601
+
+        attribute :purchasable do |product|
+          product.purchasable?
+        end
+
+        attribute :in_stock do |product|
+          product.in_stock?
+        end
+
+        attribute :backorderable do |product|
+          product.backorderable?
+        end
+
+        attribute :available do |product|
+          product.available?
+        end
+
+        attribute :default_variant_id do |product|
+          product.default_variant&.prefixed_id
+        end
+
+        # Main product image URL for listings (cached thumbnail)
+        attribute :thumbnail_url do |product|
+          image_url_for(product.thumbnail)
+        end
+
+        attribute :tags do |product|
+          product.taggings.map(&:tag)
+        end
+
+        # Price object - calculated price with price list resolution
+        attribute :price do |product|
+          price = price_for(product.default_variant)
+          Spree.api.price_serializer.new(price, params: params).to_h if price.present?
+        end
+
+        # Original price - base price without price list resolution (for showing strikethrough)
+        # Returns null when same as calculated price, only populated when a price list discount is applied
+        attribute :original_price do |product|
+          variant = product.default_variant
+          calculated = price_for(variant)
+          base = price_in(variant)
+
+          if calculated.present? && base.present? && calculated.id != base.id
+            Spree.api.price_serializer.new(base, params: params).to_h
+          end
+        end
+
+        # Conditional associations
+        many :variant_images,
+             key: :images,
+             resource: Spree.api.image_serializer,
+             if: proc { params[:includes]&.include?('images') }
+
+        many :variants,
+             resource: Spree.api.variant_serializer,
+             if: proc { params[:includes]&.include?('variants') }
+
+        one :default_variant,
+            resource: Spree.api.variant_serializer,
+            if: proc { params[:includes]&.include?('default_variant') }
+
+        one :master,
+            key: :master_variant,
+            resource: Spree.api.variant_serializer,
+            if: proc { params[:includes]&.include?('master_variant') }
+
+        many :option_types,
+             resource: Spree.api.option_type_serializer,
+             if: proc { params[:includes]&.include?('option_types') }
+
+        many :taxons,
+             proc { |taxons, params|
+               taxons.select { |t| t.taxonomy.store_id == params[:store].id }
+             },
+             resource: Spree.api.taxon_serializer,
+             if: proc { params[:includes]&.include?('taxons') },
+             params: { includes: [] }
+
+        many :public_metafields,
+             key: :metafields,
+             resource: Spree.api.metafield_serializer,
+             if: proc { params[:includes]&.include?('metafields') }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class PromotionSerializer < BaseSerializer
+        typelize name: :string, description: [:string, nullable: true],
+                 code: [:string, nullable: true], type: [:string, nullable: true],
+                 kind: [:string, nullable: true], path: [:string, nullable: true],
+                 match_policy: [:string, nullable: true], usage_limit: [:number, nullable: true],
+                 advertise: :boolean, multi_codes: :boolean,
+                 code_prefix: [:string, nullable: true], number_of_codes: [:number, nullable: true],
+                 starts_at: [:string, nullable: true], expires_at: [:string, nullable: true],
+                 promotion_category_id: [:string, nullable: true]
+
+        attributes :name, :description, :code, :type, :kind, :path,
+                   :match_policy, :usage_limit, :advertise, :multi_codes,
+                   :code_prefix, :number_of_codes,
+                   starts_at: :iso8601, expires_at: :iso8601,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :promotion_category_id do |promotion|
+          promotion.promotion_category&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class RefundSerializer < BaseSerializer
+        typelize amount: [:string, nullable: true], transaction_id: [:string, nullable: true],
+                 payment_id: [:string, nullable: true], refund_reason_id: [:string, nullable: true],
+                 reimbursement_id: [:string, nullable: true]
+
+        attributes :transaction_id, created_at: :iso8601, updated_at: :iso8601
+
+        attribute :amount do |refund|
+          refund.amount&.to_s
+        end
+
+        attribute :payment_id do |refund|
+          refund.payment&.prefixed_id
+        end
+
+        attribute :refund_reason_id do |refund|
+          refund.reason&.prefixed_id
+        end
+
+        attribute :reimbursement_id do |refund|
+          refund.reimbursement&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class ReimbursementSerializer < BaseSerializer
+        typelize number: :string, reimbursement_status: [:string, nullable: true],
+                 total: [:string, nullable: true],
+                 order_id: [:string, nullable: true], customer_return_id: [:string, nullable: true]
+
+        attributes :number, :reimbursement_status,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :total do |reimbursement|
+          reimbursement.total&.to_s
+        end
+
+        attribute :order_id do |reimbursement|
+          reimbursement.order&.prefixed_id
+        end
+
+        attribute :customer_return_id do |reimbursement|
+          reimbursement.customer_return&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class ReportSerializer < BaseSerializer
+        typelize type: [:string, nullable: true],
+                 user_id: [:string, nullable: true],
+                 currency: [:string, nullable: true],
+                 date_from: [:string, nullable: true], date_to: [:string, nullable: true]
+
+        attributes :type, :currency,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :user_id do |report|
+          report.user&.prefixed_id
+        end
+
+        attribute :date_from do |report|
+          report.date_from&.iso8601
+        end
+
+        attribute :date_to do |report|
+          report.date_to&.iso8601
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class ReturnAuthorizationSerializer < BaseSerializer
+        typelize number: :string, state: :string,
+                 order_id: [:string, nullable: true], stock_location_id: [:string, nullable: true],
+                 return_authorization_reason_id: [:string, nullable: true]
+
+        attributes :number, created_at: :iso8601, updated_at: :iso8601
+
+        attribute :state do |return_authorization|
+          return_authorization.state.to_s
+        end
+
+        attribute :order_id do |return_authorization|
+          return_authorization.order&.prefixed_id
+        end
+
+        attribute :stock_location_id do |return_authorization|
+          return_authorization.stock_location&.prefixed_id
+        end
+
+        attribute :return_authorization_reason_id do |return_authorization|
+          return_authorization.reason&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class ReturnItemSerializer < BaseSerializer
+        typelize reception_status: [:string, nullable: true], acceptance_status: [:string, nullable: true],
+                 pre_tax_amount: [:string, nullable: true],
+                 included_tax_total: [:string, nullable: true], additional_tax_total: [:string, nullable: true],
+                 inventory_unit_id: [:string, nullable: true],
+                 return_authorization_id: [:string, nullable: true],
+                 customer_return_id: [:string, nullable: true],
+                 reimbursement_id: [:string, nullable: true],
+                 exchange_variant_id: [:string, nullable: true]
+
+        attributes :reception_status, :acceptance_status,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :pre_tax_amount do |item|
+          item.pre_tax_amount&.to_s
+        end
+
+        attribute :included_tax_total do |item|
+          item.included_tax_total&.to_s
+        end
+
+        attribute :additional_tax_total do |item|
+          item.additional_tax_total&.to_s
+        end
+
+        attribute :inventory_unit_id do |item|
+          item.inventory_unit&.prefixed_id
+        end
+
+        attribute :return_authorization_id do |item|
+          item.return_authorization&.prefixed_id
+        end
+
+        attribute :customer_return_id do |item|
+          item.customer_return&.prefixed_id
+        end
+
+        attribute :reimbursement_id do |item|
+          item.reimbursement&.prefixed_id
+        end
+
+        attribute :exchange_variant_id do |item|
+          item.exchange_variant&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Spree
+  module Api
+    module V3
+      class ShipmentSerializer < BaseSerializer
+        typelize number: :string, state: :string, tracking: [:string, nullable: true],
+                 tracking_url: [:string, nullable: true], shipped_at: [:string, nullable: true],
+                 cost: :string, display_cost: :string
+
+        attributes :number, :state, :tracking, :tracking_url,
+                   :cost, :display_cost,
+                   shipped_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
+
+        one :shipping_method, resource: Spree.api.shipping_method_serializer
+        one :stock_location, resource: Spree.api.stock_location_serializer
+        many :shipping_rates, resource: Spree.api.shipping_rate_serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V3
+      class ShippingMethodSerializer < BaseSerializer
+        typelize name: :string, code: [:string, nullable: true]
+
+        attributes :name, :code
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Spree
+  module Api
+    module V3
+      class ShippingRateSerializer < BaseSerializer
+        typelize name: :string, selected: :boolean, shipping_method_id: :string,
+                 cost: :number, display_cost: :string
+
+        attribute :shipping_method_id do |shipping_rate|
+          shipping_rate.shipping_method&.prefixed_id
+        end
+
+        attributes :name, :selected
+
+        attribute :cost do |shipping_rate|
+          shipping_rate.cost.to_f
+        end
+
+        attribute :display_cost do |shipping_rate|
+          shipping_rate.display_cost.to_s
+        end
+
+        one :shipping_method, resource: Spree.api.shipping_method_serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Spree
+  module Api
+    module V3
+      class StateSerializer
+        include Alba::Resource
+        include Typelizer::DSL
+
+        typelize abbr: :string, name: :string
+
+        attributes :abbr, :name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class StockItemSerializer < BaseSerializer
+        typelize count_on_hand: :number, backorderable: :boolean,
+                 stock_location_id: [:string, nullable: true], variant_id: [:string, nullable: true]
+
+        attributes :count_on_hand, :backorderable,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :stock_location_id do |stock_item|
+          stock_item.stock_location&.prefixed_id
+        end
+
+        attribute :variant_id do |stock_item|
+          stock_item.variant&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Spree
+  module Api
+    module V3
+      class StockLocationSerializer < BaseSerializer
+        typelize name: :string, address1: [:string, nullable: true], city: [:string, nullable: true],
+                 zipcode: [:string, nullable: true], country_iso: [:string, nullable: true],
+                 country_name: [:string, nullable: true], state_abbr: [:string, nullable: true],
+                 state_text: [:string, nullable: true]
+
+        attribute :state_abbr do |stock_location|
+          stock_location.state&.abbr
+        end
+
+        attributes :name, :address1, :city, :zipcode, :country_iso, :country_name, :state_text
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class StockMovementSerializer < BaseSerializer
+        typelize quantity: :number, action: [:string, nullable: true],
+                 originator_type: [:string, nullable: true], originator_id: [:string, nullable: true],
+                 stock_item_id: [:string, nullable: true]
+
+        attributes :quantity, :action, :originator_type,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :originator_id do |movement|
+          movement.originator&.prefixed_id
+        end
+
+        attribute :stock_item_id do |movement|
+          movement.stock_item&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module V3
+      class StockTransferSerializer < BaseSerializer
+        typelize number: [:string, nullable: true], type: [:string, nullable: true],
+                 reference: [:string, nullable: true],
+                 source_location_id: [:string, nullable: true],
+                 destination_location_id: [:string, nullable: true]
+
+        attributes :number, :type, :reference,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :source_location_id do |transfer|
+          transfer.source_location&.prefixed_id
+        end
+
+        attribute :destination_location_id do |transfer|
+          transfer.destination_location&.prefixed_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module Spree
+  module Api
+    module V3
+      class StoreCreditSerializer < BaseSerializer
+        typelize amount: :string, amount_used: :string, amount_remaining: :string,
+                 display_amount: :string, display_amount_used: :string, display_amount_remaining: :string,
+                 currency: :string
+
+        attribute :amount do |store_credit|
+          store_credit.amount.to_s
+        end
+
+        attribute :amount_used do |store_credit|
+          store_credit.amount_used.to_s
+        end
+
+        attribute :amount_remaining do |store_credit|
+          store_credit.amount_remaining.to_s
+        end
+
+        attribute :display_amount do |store_credit|
+          store_credit.display_amount.to_s
+        end
+
+        attribute :display_amount_used do |store_credit|
+          store_credit.display_amount_used.to_s
+        end
+
+        attribute :display_amount_remaining do |store_credit|
+          store_credit.display_amount_remaining.to_s
+        end
+
+        attributes :currency
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Spree
+  module Api
+    module V3
+      class StoreSerializer < BaseSerializer
+        typelize name: :string, url: :string, meta_description: [:string, nullable: true],
+                 meta_keywords: [:string, nullable: true], seo_title: [:string, nullable: true],
+                 code: :string,
+                 facebook: [:string, nullable: true], twitter: [:string, nullable: true], instagram: [:string, nullable: true],
+                 customer_support_email: [:string, nullable: true],
+                 favicon_image_url: [:string, nullable: true],
+                 logo_image_url: [:string, nullable: true], social_image_url: [:string, nullable: true]
+
+        attributes :name, :url, :meta_description, :meta_keywords, :seo_title,
+                   :code, :facebook, :twitter,
+                   :instagram, :customer_support_email,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :favicon_image_url do |store|
+          image_url_for(store.favicon_image)
+        end
+
+        attribute :logo_image_url do |store|
+          image_url_for(store.logo)
+        end
+
+        attribute :social_image_url do |store|
+          image_url_for(store.social_image)
+        end
+
+        many :payment_methods,
+             proc { |payment_methods, _params|
+               payment_methods.select { |pm| pm.available_on_front_end? && pm.active? }
+             },
+             resource: Spree.api.payment_method_serializer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+module Spree
+  module Api
+    module V3
+      class TaxonSerializer < BaseSerializer
+        typelize name: :string, permalink: :string, position: :number, depth: :number,
+                 meta_title: [:string, nullable: true], meta_description: [:string, nullable: true], meta_keywords: [:string, nullable: true],
+                 parent_id: [:string, nullable: true], taxonomy_id: :string, children_count: :number,
+                 description: :string, description_html: :string,
+                 image_url: [:string, nullable: true], square_image_url: [:string, nullable: true],
+                 is_root: :boolean, is_child: :boolean, is_leaf: :boolean
+
+        attributes :name, :permalink, :position, :depth,
+                   :meta_title, :meta_description, :meta_keywords,
+                   :children_count,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :parent_id do |taxon|
+          taxon.parent&.prefixed_id
+        end
+
+        attribute :taxonomy_id do |taxon|
+          taxon.taxonomy&.prefixed_id
+        end
+
+        attribute :description do |taxon|
+          taxon.description&.to_plain_text.to_s
+        end
+
+        attribute :description_html do |taxon|
+          taxon.description&.body&.to_s.to_s
+        end
+
+        attribute :image_url do |taxon|
+          image_url_for(taxon.image)
+        end
+
+        attribute :square_image_url do |taxon|
+          image_url_for(taxon.square_image)
+        end
+
+        attribute :is_root do |taxon|
+          taxon.root?
+        end
+
+        attribute :is_child do |taxon|
+          taxon.child?
+        end
+
+        attribute :is_leaf do |taxon|
+          taxon.leaf?
+        end
+
+        # Conditional associations
+        # Note: We pass empty includes to nested taxons to prevent infinite recursion
+        # (e.g., ancestors trying to load their own ancestors)
+        one :parent,
+            resource: Spree.api.taxon_serializer,
+            if: proc { params[:includes]&.include?('parent') },
+            params: { includes: [] }
+
+        many :children,
+             resource: Spree.api.taxon_serializer,
+             if: proc { params[:includes]&.include?('children') },
+             params: { includes: [] }
+
+        many :ancestors,
+             resource: Spree.api.taxon_serializer,
+             if: proc { params[:includes]&.include?('ancestors') },
+             params: { includes: [] }
+
+        many :public_metafields,
+             key: :metafields,
+             resource: Spree.api.metafield_serializer,
+             if: proc { params[:includes]&.include?('metafields') }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Spree
+  module Api
+    module V3
+      class TaxonomySerializer < BaseSerializer
+        typelize name: :string, position: :number, root_id: [:string, nullable: true]
+
+        attributes :name, :position,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :root_id do |taxonomy|
+          taxonomy.root&.prefixed_id
+        end
+
+        # Conditional associations
+        # Note: We pass empty includes to nested taxons to prevent infinite recursion
+        one :root,
+            resource: Spree.api.taxon_serializer,
+            if: proc { params[:includes]&.include?('root') },
+            params: { includes: [] }
+
+        many :taxons,
+             resource: Spree.api.taxon_serializer,
+             if: proc { params[:includes]&.include?('taxons') },
+             params: { includes: [] }
+
+        many :public_metafields,
+             key: :metafields,
+             resource: Spree.api.metafield_serializer,
+             if: proc { params[:includes]&.include?('metafields') }
+      end
+    end
+  end
+end