spree_api 5.4.0.rc1 → 5.4.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4378e0d0d201591ada81caa1958a92ca6aa55d8e2ff79d8b90b58016ff1b834b
-  data.tar.gz: 32fddc14b53ae38f7c80192be53a456e84b4862f58ddc3492a499ccbf2e67d53
+  metadata.gz: 78b4c09d45771aeb527cc5f623c07cca20e2920d2d083e7641573b8b95cadbf2
+  data.tar.gz: 2dc7b84ce1f3e9b59fa3a6bc8c874d4488d8480841839765a5af4a8d21dcf30f
 SHA512:
-  metadata.gz: 8f597f0fcb3d074cb90593a0feb619220642e13dbeefc994839b208f7639eabd0273e5b4a8223e8c4aa6ebbe9bd05add4559a9c6aac0de50cd837ee56060dcec
-  data.tar.gz: 03e32f252a79ec570e5d91fc5ed4113367b6892c384c7bc49eb0772b3f00c899d2007fc3be6424676cdbab7522b00f6db550425c9c68e932b761f582061bda14
+  metadata.gz: 412d63a74d08c348e9f76fd366552dc2af424ed3b42971896e3fdbe7e38c886592f5680207eb1805700f4e12c98a368428f50f4c389ee79953218729acd9c159
+  data.tar.gz: 4034da7fbd869926562e842632d12b2bc39eb3338987fc60904e6c08b1a4905d621735c713d0fe212a2319125fdcdb11616872479b0d18d8f5d280456f5cf9b1

data/app/controllers/spree/api/v3/store/carts/payments_controller.rb

@@ -3,9 +3,11 @@ module Spree
     module V3
       module Store
         module Carts
-          class PaymentsController < Store::ResourceController
+          class PaymentsController < Store::BaseController
             include Spree::Api::V3::CartResolvable
 
+            before_action :find_cart!
+
             # POST /api/v3/store/carts/:cart_id/payments
             # Creates a payment for non-session payment methods (e.g. Check, Cash on Delivery, Bank Transfer)
             def create
@@ -19,7 +21,7 @@ module Spree
                 )
               end
 
-              unless payment_method.available_for_order?(@parent)
+              unless payment_method.available_for_order?(@cart)
                 return render_error(
                   code: 'payment_method_unavailable',
                   message: Spree.t('api.v3.payments.method_unavailable'),
@@ -27,43 +29,20 @@ module Spree
                 )
               end
 
-              amount = params[:amount].presence || @parent.total_minus_store_credits
+              amount = params[:amount].presence || @cart.total_minus_store_credits
 
-              @payment = @parent.payments.build(
+              @payment = @cart.payments.build(
                 payment_method: payment_method,
                 amount: amount,
                 metadata: params[:metadata].present? ? params[:metadata].to_unsafe_h : {}
               )
 
               if @payment.save
-                render json: serialize_resource(@payment), status: :created
+                render json: Spree.api.payment_serializer.new(@payment, params: serializer_params).to_h, status: :created
               else
                 render_errors(@payment.errors)
               end
             end
-
-            protected
-
-            def set_parent
-              find_cart!
-              @parent = @cart
-            end
-
-            def parent_association
-              :payments
-            end
-
-            def model_class
-              Spree::Payment
-            end
-
-            def serializer_class
-              Spree.api.payment_serializer
-            end
-
-            # Authorization is handled by find_cart! in set_parent
-            def authorize_resource!(*)
-            end
           end
         end
       end

data/app/controllers/spree/api/v3/store/customer/addresses_controller.rb

@@ -5,9 +5,9 @@ module Spree
         module Customer
           class AddressesController < ResourceController
             prepend_before_action :require_authentication!
-            before_action :set_resource, only: [:show, :update, :destroy, :mark_as_default]
+            before_action :set_resource, only: [:show, :update, :destroy]
 
-            # POST /api/v3/store/customer/addresses
+            # POST /api/v3/store/customers/me/addresses
             def create
               result = Spree.address_create_service.call(
                 address_params: permitted_params,
@@ -21,25 +21,7 @@ module Spree
               end
             end
 
-            # PATCH /api/v3/store/customer/addresses/:id/mark_as_default
-            def mark_as_default
-              kind = params[:kind].to_s
-
-              unless %w[billing shipping].include?(kind)
-                return render_error(
-                  code: ERROR_CODES[:invalid_request],
-                  message: 'kind must be billing or shipping',
-                  status: :unprocessable_content
-                )
-              end
-
-              attribute = kind == 'billing' ? :bill_address_id : :ship_address_id
-              current_user.update!(attribute => @resource.id)
-
-              render json: serialize_resource(@resource.reload)
-            end
-
-            # PATCH /api/v3/store/customer/addresses/:id
+            # PATCH /api/v3/store/customers/me/addresses/:id
             def update
               result = Spree.address_update_service.call(
                 address: @resource,
@@ -74,7 +56,8 @@ module Spree
             def permitted_params
               params.permit(
                 :first_name, :last_name, :address1, :address2, :city,
-                :postal_code, :phone, :company, :country_iso, :state_abbr, :state_name
+                :postal_code, :phone, :company, :country_iso, :state_abbr, :state_name,
+                :is_default_billing, :is_default_shipping
               )
             end
           end

data/app/controllers/spree/api/v3/store/customer/store_credits_controller.rb

@@ -0,0 +1,39 @@
+module Spree
+  module Api
+    module V3
+      module Store
+        module Customer
+          class StoreCreditsController < ResourceController
+            prepend_before_action :require_authentication!
+
+            protected
+
+            def set_parent
+              @parent = current_user
+            end
+
+            def parent_association
+              :store_credits
+            end
+
+            def scope
+              super.for_store(current_store).where(currency: current_currency)
+            end
+
+            def model_class
+              Spree::StoreCredit
+            end
+
+            def serializer_class
+              Spree.api.store_credit_serializer
+            end
+
+            # Authorization is handled by set_parent scoping to current_user
+            def authorize_resource!(*)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,11 +7,11 @@ module Spree
                  city: [:string, nullable: true], postal_code: [:string, nullable: true], phone: [:string, nullable: true],
                  company: [:string, nullable: true], state_abbr: [:string, nullable: true], state_name: [:string, nullable: true],
                  state_text: [:string, nullable: true], country_iso: :string, country_name: :string,
-                 quick_checkout: :boolean
+                 quick_checkout: :boolean, is_default_billing: :boolean, is_default_shipping: :boolean
 
         attributes :first_name, :last_name, :full_name, :address1, :address2, :postal_code,
                    :city, :phone, :company, :country_name, :country_iso, :state_text,
-                   :state_abbr, :quick_checkout
+                   :state_abbr, :quick_checkout, :is_default_billing, :is_default_shipping
 
         # State name - used for countries without predefined states
         attribute :state_name do |address|

data/app/serializers/spree/api/v3/admin/gift_card_serializer.rb

@@ -0,0 +1,17 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class GiftCardSerializer < V3::GiftCardSerializer
+          typelize metadata: 'Record<string, unknown> | null'
+
+          attribute :metadata do |gift_card|
+            gift_card.metadata.presence
+          end
+
+          attributes created_at: :iso8601, updated_at: :iso8601
+        end
+      end
+    end
+  end
+end

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

@@ -50,6 +50,7 @@ module Spree
 
           one :billing_address, resource: Spree.api.admin_address_serializer, if: proc { expand?('billing_address') }
           one :shipping_address, resource: Spree.api.admin_address_serializer, if: proc { expand?('shipping_address') }
+          one :gift_card, resource: Spree.api.admin_gift_card_serializer
 
           many :payment_methods, resource: Spree.api.admin_payment_method_serializer, if: proc { expand?('payment_methods') }
 

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

@@ -14,9 +14,13 @@ module Spree
                  tax_total: :string, display_tax_total: :string,
                  included_tax_total: :string, display_included_tax_total: :string,
                  additional_tax_total: :string, display_additional_tax_total: :string,
+                 store_credit_total: :string, display_store_credit_total: :string,
+                 gift_card_total: :string, display_gift_card_total: :string,
+                 covered_by_store_credit: :boolean,
                  total: :string, display_total: :string,
                  shipping_eq_billing_address: :boolean,
-                 billing_address: { nullable: true }, shipping_address: { nullable: true }
+                 billing_address: { nullable: true }, shipping_address: { nullable: true },
+                 gift_card: { nullable: true }
 
         # Override ID to use cart_ prefix
         attribute :id do |order|
@@ -33,6 +37,20 @@ module Spree
                    :delivery_total, :display_delivery_total,
                    created_at: :iso8601, updated_at: :iso8601
 
+        attribute :store_credit_total do |order|
+          order.total_applied_store_credit.to_s
+        end
+
+        attribute :display_store_credit_total do |order|
+          order.display_total_applied_store_credit.to_s
+        end
+
+        attributes :gift_card_total, :display_gift_card_total
+
+        attribute :covered_by_store_credit do |order|
+          order.covered_by_store_credit?
+        end
+
         attribute :current_step do |order|
           order.current_checkout_step
         end
@@ -57,6 +75,7 @@ module Spree
         one :shipping_address, resource: Spree.api.address_serializer
 
         many :payment_methods, resource: Spree.api.payment_method_serializer
+        one :gift_card, resource: Spree.api.gift_card_serializer
       end
     end
   end

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

@@ -6,11 +6,24 @@ module Spree
       class CustomerSerializer < BaseSerializer
         typelize email: :string, first_name: [:string, nullable: true], last_name: [:string, nullable: true],
                  phone: [:string, nullable: true], accepts_email_marketing: :boolean,
+                 available_store_credit_total: :string, display_available_store_credit_total: :string,
                  default_billing_address: { nullable: true }, default_shipping_address: { nullable: true }
 
         attributes :email, :first_name, :last_name, :phone, :accepts_email_marketing,
                    created_at: :iso8601, updated_at: :iso8601
 
+        attribute :available_store_credit_total do |user, params|
+          store = params&.dig(:store) || Spree::Current.store
+          currency = params&.dig(:currency) || Spree::Current.currency || store&.default_currency
+          user.total_available_store_credit(currency, store).to_s
+        end
+
+        attribute :display_available_store_credit_total do |user, params|
+          store = params&.dig(:store) || Spree::Current.store
+          currency = params&.dig(:currency) || Spree::Current.currency || store&.default_currency
+          Spree::Money.new(user.total_available_store_credit(currency, store), currency: currency).to_s
+        end
+
         many :addresses, resource: Spree.api.address_serializer
         one :bill_address, key: :default_billing_address, resource: Spree.api.address_serializer
         one :ship_address, key: :default_shipping_address, resource: Spree.api.address_serializer

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

@@ -14,8 +14,12 @@ module Spree
                  tax_total: :string, display_tax_total: :string,
                  included_tax_total: :string, display_included_tax_total: :string,
                  additional_tax_total: :string, display_additional_tax_total: :string,
+                 store_credit_total: :string, display_store_credit_total: :string,
+                 gift_card_total: :string, display_gift_card_total: :string,
+                 covered_by_store_credit: :boolean,
                  total: :string, display_total: :string, completed_at: [:string, nullable: true],
-                 billing_address: { nullable: true }, shipping_address: { nullable: true }
+                 billing_address: { nullable: true }, shipping_address: { nullable: true },
+                 gift_card: { nullable: true }
 
         attributes :number, :email, :customer_note,
                    :currency, :locale, :total_quantity,
@@ -27,12 +31,27 @@ module Spree
                    :delivery_total, :display_delivery_total, :fulfillment_status, :payment_status,
                    completed_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
 
+        attribute :store_credit_total do |order|
+          order.total_applied_store_credit.to_s
+        end
+
+        attribute :display_store_credit_total do |order|
+          order.display_total_applied_store_credit.to_s
+        end
+
+        attributes :gift_card_total, :display_gift_card_total
+
+        attribute :covered_by_store_credit do |order|
+          order.covered_by_store_credit?
+        end
+
         many :discounts, resource: Spree.api.discount_serializer
         many :line_items, key: :items, resource: Spree.api.line_item_serializer
         many :fulfillments, resource: Spree.api.fulfillment_serializer
         many :payments, resource: Spree.api.payment_serializer
         one :billing_address, resource: Spree.api.address_serializer
         one :shipping_address, resource: Spree.api.address_serializer
+        one :gift_card, resource: Spree.api.gift_card_serializer
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Spree
       # Store API Product Serializer
       # Customer-facing product data with limited fields
       class ProductSerializer < BaseSerializer
-        typelize name: :string, description: [:string, nullable: true], slug: :string,
+        typelize name: :string, description: [:string, nullable: true], description_html: [:string, nullable: true], slug: :string,
                  meta_description: [:string, nullable: true], meta_keywords: [:string, nullable: true],
                  variant_count: :number,
                  default_variant_id: :string,
@@ -15,7 +15,7 @@ module Spree
                  original_price: ['Price', nullable: true],
                  tags: [:string, multi: true]
 
-        attributes :name, :description, :slug,
+        attributes :name, :slug,
                    :meta_description, :meta_keywords,
                    :variant_count,
                    available_on: :iso8601, created_at: :iso8601, updated_at: :iso8601
@@ -36,6 +36,16 @@ module Spree
           product.available?
         end
 
+        attribute :description do |product|
+          next if product.description.blank?
+
+          Nokogiri::HTML.fragment(product.description).text.squish
+        end
+
+        attribute :description_html do |product|
+          product.description
+        end
+
         attribute :default_variant_id do |product|
           product.default_variant&.prefixed_id
         end

data/config/routes.rb

@@ -39,9 +39,8 @@ Spree::Core::Engine.add_routes do
           end
           resources :items, only: [:create, :update, :destroy], controller: 'carts/items'
           resources :coupon_codes, only: [:create, :destroy], controller: 'carts/coupon_codes'
-          resources :fulfillments, only: [:index, :update], controller: 'carts/fulfillments'
-          resources :payment_methods, only: [:index], controller: 'carts/payment_methods'
-          resources :payments, only: [:index, :show, :create], controller: 'carts/payments'
+          resources :fulfillments, only: [:update], controller: 'carts/fulfillments'
+          resources :payments, only: [:create], controller: 'carts/payments'
           resources :payment_sessions, only: [:create, :show, :update], controller: 'carts/payment_sessions' do
             member do
               patch :complete
@@ -53,23 +52,21 @@ Spree::Core::Engine.add_routes do
         # Orders (single order lookup, guest-accessible via order token)
         resources :orders, only: [:show]
 
-        # Customer (current user profile)
+        # Customers
         resources :customers, only: [:create]
-        get 'customer', to: 'customers#show'
-        patch 'customer', to: 'customers#update'
 
-        # Customer nested resources
-        namespace :customer, path: 'customer' do
+        # Current customer profile and nested resources (/customers/me/...)
+        namespace :customer, path: 'customers/me' do
+          get '/', action: :show, controller: '/spree/api/v3/store/customers'
+          patch '/', action: :update, controller: '/spree/api/v3/store/customers'
+
           resources :password_resets, only: [:create, :update]
 
           resources :orders, only: [:index, :show]
-          resources :addresses, only: [:index, :show, :create, :update, :destroy] do
-            member do
-              patch :mark_as_default
-            end
-          end
+          resources :addresses, only: [:index, :show, :create, :update, :destroy]
           resources :credit_cards, only: [:index, :show, :destroy]
           resources :gift_cards, only: [:index, :show]
+          resources :store_credits, only: [:index, :show]
           resources :payment_setup_sessions, only: [:create, :show] do
             member do
               patch :complete

data/lib/spree/api/dependencies.rb

@@ -170,6 +170,7 @@ module Spree
         admin_stock_item_serializer: 'Spree::Api::V3::Admin::StockItemSerializer',
         admin_shipment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
         admin_fulfillment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
+        admin_gift_card_serializer: 'Spree::Api::V3::Admin::GiftCardSerializer',
         admin_payment_serializer: 'Spree::Api::V3::Admin::PaymentSerializer',
         admin_refund_serializer: 'Spree::Api::V3::Admin::RefundSerializer',
         admin_adjustment_serializer: 'Spree::Api::V3::Admin::AdjustmentSerializer',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 5.4.0.rc1
+  version: 5.4.0.rc2
 platform: ruby
 authors:
 - Vendo Connect Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-20 00:00:00.000000000 Z
+date: 2026-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rswag-specs
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0.rc1
+        version: 5.4.0.rc2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0.rc1
+        version: 5.4.0.rc2
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -124,7 +124,6 @@ files:
 - app/controllers/spree/api/v3/store/carts/coupon_codes_controller.rb
 - app/controllers/spree/api/v3/store/carts/fulfillments_controller.rb
 - app/controllers/spree/api/v3/store/carts/items_controller.rb
-- app/controllers/spree/api/v3/store/carts/payment_methods_controller.rb
 - app/controllers/spree/api/v3/store/carts/payment_sessions_controller.rb
 - app/controllers/spree/api/v3/store/carts/payments_controller.rb
 - app/controllers/spree/api/v3/store/carts/store_credits_controller.rb
@@ -139,6 +138,7 @@ files:
 - app/controllers/spree/api/v3/store/customer/orders_controller.rb
 - app/controllers/spree/api/v3/store/customer/password_resets_controller.rb
 - app/controllers/spree/api/v3/store/customer/payment_setup_sessions_controller.rb
+- app/controllers/spree/api/v3/store/customer/store_credits_controller.rb
 - app/controllers/spree/api/v3/store/customers_controller.rb
 - app/controllers/spree/api/v3/store/digitals_controller.rb
 - app/controllers/spree/api/v3/store/locales_controller.rb
@@ -167,6 +167,7 @@ files:
 - app/serializers/spree/api/v3/admin/digital_link_serializer.rb
 - app/serializers/spree/api/v3/admin/discount_serializer.rb
 - app/serializers/spree/api/v3/admin/fulfillment_serializer.rb
+- app/serializers/spree/api/v3/admin/gift_card_serializer.rb
 - app/serializers/spree/api/v3/admin/line_item_serializer.rb
 - app/serializers/spree/api/v3/admin/media_serializer.rb
 - app/serializers/spree/api/v3/admin/metafield_serializer.rb
@@ -268,9 +269,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.4.0.rc1
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.4.0.rc2
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.4.0.rc1
+  source_code_uri: https://github.com/spree/spree/tree/v5.4.0.rc2
 post_install_message:
 rdoc_options: []
 require_paths:

data/app/controllers/spree/api/v3/store/carts/payment_methods_controller.rb

@@ -1,24 +0,0 @@
-module Spree
-  module Api
-    module V3
-      module Store
-        module Carts
-          class PaymentMethodsController < Store::BaseController
-            include Spree::Api::V3::CartResolvable
-
-            before_action :find_cart!
-
-            # GET /api/v3/store/carts/:cart_id/payment_methods
-            def index
-              methods = @cart.collect_frontend_payment_methods
-              render json: {
-                data: methods.map { |m| Spree.api.payment_method_serializer.new(m, params: serializer_params).to_h },
-                meta: { count: methods.size }
-              }
-            end
-          end
-        end
-      end
-    end
-  end
-end