spree_api 5.4.0.beta8 → 5.4.0.beta9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d59f56e428252697b4360183c26b92d20fe7607630b84589a5203ad766d6a467
-  data.tar.gz: 2807c39fa35138ae1db42e5fb184998dfc8e9c25d7309f11b43edc0af1751877
+  metadata.gz: 7630000b76a8d6596d6a94e2e5ef3b928ad55035995a777d79a855da0b83e707
+  data.tar.gz: 5621ebbdb257e9c69518e3ad71a9368954c0fbf7db6ad7a3b4adb237b00cb83b
 SHA512:
-  metadata.gz: ed23df8b1714945bb9b4718f0c81443fb140fb3ddbaf48e72fbc4de1f9b6b0f9b41373587cf57f69fcc4e928aa75fc1636c7dc57b700e24c9958a3bd70c42bc0
-  data.tar.gz: bc499f9d970dc0fc0d24de5c711070b267e103d60c82704e5de1f48c7bcd635183cf024e1cfef4b0f9d0841f5e2ea150e74618f7ec3283dd59ee73f20059682f
+  metadata.gz: ecdbc7f8b2e6792a1e8641ebaabfcc69423705f032435bb960ff3f2ae36eb19c89dc224b8af79278b3e74536ca95112442139278e847cca9710f437300d9395e
+  data.tar.gz: 8264257bdf243e8bc504880ceed1f99233baaf09bf6e7264714ab9395b59429e0c9c553269012015d9e870dd3dc797b19224d204b7a33518681878533200e71e

data/app/controllers/concerns/spree/api/v3/error_handler.rb

@@ -12,6 +12,7 @@ module Spree
           access_denied: 'access_denied',
           invalid_token: 'invalid_token',
           invalid_provider: 'invalid_provider',
+          invalid_refresh_token: 'invalid_refresh_token',
           current_password_invalid: 'current_password_invalid',
           password_reset_token_invalid: 'password_reset_token_invalid',
           redirect_url_not_allowed: 'redirect_url_not_allowed',

data/app/controllers/spree/api/v3/store/auth_controller.rb

@@ -7,9 +7,9 @@ module Spree
           rate_limit to: Spree::Api::Config[:rate_limit_login], within: Spree::Api::Config[:rate_limit_window].seconds, store: Rails.cache, only: :create, with: RATE_LIMIT_RESPONSE
           rate_limit to: Spree::Api::Config[:rate_limit_refresh], within: Spree::Api::Config[:rate_limit_window].seconds, store: Rails.cache, only: :refresh, with: RATE_LIMIT_RESPONSE
           rate_limit to: Spree::Api::Config[:rate_limit_oauth], within: Spree::Api::Config[:rate_limit_window].seconds, store: Rails.cache, only: :oauth_callback, with: RATE_LIMIT_RESPONSE
+          rate_limit to: Spree::Api::Config[:rate_limit_refresh], within: Spree::Api::Config[:rate_limit_window].seconds, store: Rails.cache, only: :logout, with: RATE_LIMIT_RESPONSE
 
-          skip_before_action :authenticate_user, only: [:create, :oauth_callback]
-          prepend_before_action :require_authentication!, only: [:refresh]
+          skip_before_action :authenticate_user, only: [:create, :refresh, :oauth_callback]
 
           # POST  /api/v3/store/auth/login
           # Supports multiple authentication providers via :provider param
@@ -23,11 +23,7 @@ module Spree
 
             if result.success?
               user = result.value
-              token = generate_jwt(user)
-              render json: {
-                token: token,
-                user: user_serializer.new(user, params: serializer_params).to_h
-              }
+              render json: auth_response(user)
             else
               render_error(
                 code: ERROR_CODES[:authentication_failed],
@@ -38,21 +34,55 @@ module Spree
           end
 
           # POST  /api/v3/store/auth/refresh
+          # Accepts: { "refresh_token": "rt_xxx" }
+          # Returns new access JWT + rotated refresh token
           def refresh
-            token = generate_jwt(current_user)
+            refresh_token_value = params[:refresh_token]
+
+            if refresh_token_value.blank?
+              return render_error(
+                code: ERROR_CODES[:invalid_refresh_token],
+                message: 'refresh_token is required',
+                status: :unauthorized
+              )
+            end
+
+            refresh_token = Spree::RefreshToken.active.find_by(token: refresh_token_value)
+
+            if refresh_token.nil?
+              return render_error(
+                code: ERROR_CODES[:invalid_refresh_token],
+                message: 'Invalid or expired refresh token',
+                status: :unauthorized
+              )
+            end
+
+            user = refresh_token.user
+            new_refresh_token = refresh_token.rotate!(request_env: request_env_for_token)
+
             render json: {
-              token: token,
-              user: user_serializer.new(current_user, params: serializer_params).to_h
+              token: generate_jwt(user),
+              refresh_token: new_refresh_token.token,
+              user: user_serializer.new(user, params: serializer_params).to_h
             }
           end
 
+          # POST  /api/v3/store/auth/logout
+          # Accepts: { "refresh_token": "rt_xxx" }
+          # Revokes the refresh token
+          def logout
+            refresh_token_value = params[:refresh_token]
+
+            if refresh_token_value.present?
+              Spree::RefreshToken.find_by(token: refresh_token_value)&.destroy
+            end
+
+            head :no_content
+          end
+
           # POST  /api/v3/store/auth/oauth/callback
           # OAuth callback endpoint for server-side OAuth flows
           def oauth_callback
-            # This endpoint is designed for OAuth flows where the server
-            # exchanges the authorization code for an access token
-            # For client-side flows, use the regular /login endpoint with id_token
-
             strategy = authentication_strategy
             return unless strategy # Error already rendered by determine_strategy
 
@@ -60,11 +90,7 @@ module Spree
 
             if result.success?
               user = result.value
-              token = generate_jwt(user)
-              render json: {
-                token: token,
-                user: user_serializer.new(user, params: serializer_params).to_h
-              }
+              render json: auth_response(user)
             else
               render_error(
                 code: ERROR_CODES[:authentication_failed],
@@ -88,6 +114,23 @@ module Spree
 
           private
 
+          def auth_response(user)
+            refresh_token = Spree::RefreshToken.create_for(user, request_env: request_env_for_token)
+
+            {
+              token: generate_jwt(user),
+              refresh_token: refresh_token.token,
+              user: user_serializer.new(user, params: serializer_params).to_h
+            }
+          end
+
+          def request_env_for_token
+            {
+              ip_address: request.remote_ip,
+              user_agent: request.user_agent&.truncate(255)
+            }
+          end
+
           def authentication_strategy
             strategy_class = determine_strategy
             strategy_class.new(

data/app/controllers/spree/api/v3/store/carts/{shipments_controller.rb → fulfillments_controller.rb}

@@ -3,31 +3,31 @@ module Spree
     module V3
       module Store
         module Carts
-          class ShipmentsController < Store::BaseController
+          class FulfillmentsController < Store::BaseController
             include Spree::Api::V3::CartResolvable
             include Spree::Api::V3::OrderLock
 
             before_action :find_cart!
 
-            # GET /api/v3/store/carts/:cart_id/shipments
+            # GET /api/v3/store/carts/:cart_id/fulfillments
             def index
-              shipments = @cart.shipments.includes(shipping_rates: :shipping_method)
+              fulfillments = @cart.shipments.includes(shipping_rates: :shipping_method)
               render json: {
-                data: shipments.map { |s| Spree.api.shipment_serializer.new(s, params: serializer_params).to_h },
-                meta: { count: shipments.size }
+                data: fulfillments.map { |s| Spree.api.fulfillment_serializer.new(s, params: serializer_params).to_h },
+                meta: { count: fulfillments.size }
               }
             end
 
-            # PATCH /api/v3/store/carts/:cart_id/shipments/:id
-            # Select a shipping rate for a specific shipment
+            # PATCH /api/v3/store/carts/:cart_id/fulfillments/:id
+            # Select a delivery rate for a specific fulfillment
             def update
               with_order_lock do
-                shipment = @cart.shipments.find_by_prefix_id!(params[:id])
+                fulfillment = @cart.shipments.find_by_prefix_id!(params[:id])
 
-                if permitted_params[:selected_shipping_rate_id].present?
-                  shipping_rate = shipment.shipping_rates.find_by_prefix_id!(permitted_params[:selected_shipping_rate_id])
-                  shipment.selected_shipping_rate_id = shipping_rate.id
-                  shipment.save!
+                if permitted_params[:selected_delivery_rate_id].present?
+                  delivery_rate = fulfillment.shipping_rates.find_by_prefix_id!(permitted_params[:selected_delivery_rate_id])
+                  fulfillment.selected_shipping_rate_id = delivery_rate.id
+                  fulfillment.save!
                 end
 
                 # Auto-advance (e.g. delivery → payment) after rate selection.
@@ -41,7 +41,7 @@ module Spree
             private
 
             def permitted_params
-              params.permit(:selected_shipping_rate_id)
+              params.permit(:selected_delivery_rate_id)
             end
 
             # Temporary — Spree 6 removes the checkout state machine.

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

@@ -55,10 +55,12 @@ module Spree
 
               if user.update(password: params[:password], password_confirmation: params[:password_confirmation])
                 jwt = generate_jwt(user)
+                refresh_token = Spree::RefreshToken.create_for(user, request_env: { ip_address: request.remote_ip, user_agent: request.user_agent&.truncate(255) })
                 user.publish_event('customer.password_reset')
 
                 render json: {
                   token: jwt,
+                  refresh_token: refresh_token.token,
                   user: serializer_class.new(user, params: serializer_params).to_h
                 }
               else

data/app/controllers/spree/api/v3/store/customers_controller.rb

@@ -13,9 +13,13 @@ module Spree
             user = Spree.user_class.new(create_params)
 
             if user.save
-              token = generate_jwt(user)
+              refresh_token = Spree::RefreshToken.create_for(user, request_env: {
+                ip_address: request.remote_ip,
+                user_agent: request.user_agent&.truncate(255)
+              })
               render json: {
-                token: token,
+                token: generate_jwt(user),
+                refresh_token: refresh_token.token,
                 user: user_serializer.new(user, params: serializer_params).to_h
               }, status: :created
             else

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

@@ -4,13 +4,13 @@ module Spree
       module Admin
         class AddressSerializer < V3::AddressSerializer
           typelize label: [:string, nullable: true],
-                   user_id: [:string, nullable: true],
+                   customer_id: [:string, nullable: true],
                    metadata: 'Record<string, unknown> | null'
 
           attributes :label,
                      created_at: :iso8601, updated_at: :iso8601
 
-          attribute :user_id do |address|
+          attribute :customer_id do |address|
             address.user&.prefixed_id
           end
 

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

@@ -3,10 +3,10 @@ module Spree
     module V3
       module Admin
         class CreditCardSerializer < V3::CreditCardSerializer
-          typelize user_id: [:string, nullable: true],
+          typelize customer_id: [:string, nullable: true],
                    payment_method_id: [:string, nullable: true]
 
-          attribute :user_id do |credit_card|
+          attribute :customer_id do |credit_card|
             credit_card.user&.prefixed_id
           end
 

data/app/serializers/spree/api/v3/admin/{shipping_method_serializer.rb → delivery_method_serializer.rb}

@@ -2,7 +2,7 @@ module Spree
   module Api
     module V3
       module Admin
-        class ShippingMethodSerializer < V3::ShippingMethodSerializer
+        class DeliveryMethodSerializer < V3::DeliveryMethodSerializer
           attributes created_at: :iso8601, updated_at: :iso8601
         end
       end

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

@@ -0,0 +1,11 @@
+module Spree
+  module Api
+    module V3
+      module Admin
+        class DeliveryRateSerializer < V3::DeliveryRateSerializer
+          one :shipping_method, key: :delivery_method, resource: Spree.api.admin_delivery_method_serializer, if: proc { expand?('delivery_method') }
+        end
+      end
+    end
+  end
+end

data/app/serializers/spree/api/v3/admin/{shipment_serializer.rb → fulfillment_serializer.rb}

@@ -2,7 +2,7 @@ module Spree
   module Api
     module V3
       module Admin
-        class ShipmentSerializer < V3::ShipmentSerializer
+        class FulfillmentSerializer < V3::FulfillmentSerializer
           typelize metadata: 'Record<string, unknown> | null',
                    order_id: [:string, nullable: true],
                    stock_location_id: [:string, nullable: true],
@@ -26,9 +26,9 @@ module Spree
           end
 
           # Override inherited associations to use admin serializers
-          one :shipping_method, resource: Spree.api.admin_shipping_method_serializer, if: proc { expand?('shipping_method') }
+          one :shipping_method, key: :delivery_method, resource: Spree.api.admin_delivery_method_serializer, if: proc { expand?('delivery_method') }
           one :stock_location, resource: Spree.api.admin_stock_location_serializer, if: proc { expand?('stock_location') }
-          many :shipping_rates, resource: Spree.api.admin_shipping_rate_serializer, if: proc { expand?('shipping_rates') }
+          many :shipping_rates, key: :delivery_rates, resource: Spree.api.admin_delivery_rate_serializer, if: proc { expand?('delivery_rates') }
 
           one :order,
               resource: Spree.api.admin_order_serializer,

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

@@ -11,7 +11,7 @@ module Spree
                    store_owner_notification_delivered: :boolean,
                    internal_note: [:string, nullable: true], approver_id: [:string, nullable: true],
                    canceler_id: [:string, nullable: true], created_by_id: [:string, nullable: true],
-                   user_id: [:string, nullable: true],
+                   customer_id: [:string, nullable: true],
                    canceled_at: [:string, nullable: true], approved_at: [:string, nullable: true],
                    payment_total: :string, display_payment_total: :string,
                    metadata: 'Record<string, unknown> | null'
@@ -38,14 +38,14 @@ module Spree
             order.created_by&.prefixed_id
           end
 
-          attribute :user_id do |order|
+          attribute :customer_id do |order|
             order.user&.prefixed_id
           end
 
           # Override inherited associations to use admin serializers
           many :order_promotions, key: :promotions, resource: Spree.api.admin_order_promotion_serializer, if: proc { expand?('promotions') }
           many :line_items, key: :items, resource: Spree.api.admin_line_item_serializer, if: proc { expand?('items') }
-          many :shipments, resource: Spree.api.admin_shipment_serializer, if: proc { expand?('shipments') }
+          many :shipments, key: :fulfillments, resource: Spree.api.admin_fulfillment_serializer, if: proc { expand?('fulfillments') }
           many :payments, resource: Spree.api.admin_payment_serializer, if: proc { expand?('payments') }
 
           one :bill_address, resource: Spree.api.admin_address_serializer, if: proc { expand?('bill_address') }
@@ -54,8 +54,9 @@ module Spree
           many :payment_methods, resource: Spree.api.admin_payment_method_serializer, if: proc { expand?('payment_methods') }
 
           one :user,
+              key: :customer,
               resource: Spree.api.admin_customer_serializer,
-              if: proc { expand?('user') }
+              if: proc { expand?('customer') }
 
           one :approver,
               resource: Spree.api.admin_customer_serializer,

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

@@ -32,11 +32,6 @@ module Spree
               resource: Spree.api.admin_variant_serializer,
               if: proc { expand?('default_variant') }
 
-          one :master,
-              key: :master_variant,
-              resource: Spree.api.admin_variant_serializer,
-              if: proc { expand?('master_variant') }
-
           one :primary_media,
               resource: Spree.api.admin_media_serializer,
               if: proc { expand?('primary_media') }

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

@@ -3,11 +3,11 @@ module Spree
     module V3
       module Admin
         class StoreCreditSerializer < V3::StoreCreditSerializer
-          typelize user_id: [:string, nullable: true],
+          typelize customer_id: [:string, nullable: true],
                    created_by_id: [:string, nullable: true],
                    metadata: 'Record<string, unknown> | null'
 
-          attribute :user_id do |store_credit|
+          attribute :customer_id do |store_credit|
             store_credit.user&.prefixed_id
           end
 

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

@@ -8,7 +8,7 @@ module Spree
                  special_instructions: [:string, nullable: true], currency: :string, locale: [:string, nullable: true], item_count: :number,
                  requirements: 'Array<{step: string, field: string, message: string}>',
                  item_total: :string, display_item_total: :string,
-                 ship_total: :string, display_ship_total: :string,
+                 delivery_total: :string, display_delivery_total: :string,
                  adjustment_total: :string, display_adjustment_total: :string,
                  promo_total: :string, display_promo_total: :string,
                  tax_total: :string, display_tax_total: :string,
@@ -24,12 +24,20 @@ module Spree
 
         attributes :number, :token, :email, :special_instructions,
                    :currency, :locale, :item_count,
-                   :item_total, :display_item_total, :ship_total, :display_ship_total,
+                   :item_total, :display_item_total,
                    :adjustment_total, :display_adjustment_total, :promo_total, :display_promo_total,
                    :tax_total, :display_tax_total, :included_tax_total, :display_included_tax_total,
                    :additional_tax_total, :display_additional_tax_total, :total, :display_total,
                    created_at: :iso8601, updated_at: :iso8601
 
+        attribute :delivery_total do |order|
+          order.ship_total
+        end
+
+        attribute :display_delivery_total do |order|
+          order.display_ship_total.to_s
+        end
+
         attribute :current_step do |order|
           order.current_checkout_step
         end
@@ -44,7 +52,7 @@ module Spree
 
         many :cart_promotions, key: :promotions, resource: Spree.api.cart_promotion_serializer
         many :line_items, key: :items, resource: Spree.api.line_item_serializer
-        many :shipments, resource: Spree.api.shipment_serializer
+        many :shipments, key: :fulfillments, resource: Spree.api.fulfillment_serializer
         many :payments, resource: Spree.api.payment_serializer
         one :bill_address, resource: Spree.api.address_serializer
         one :ship_address, resource: Spree.api.address_serializer

data/app/serializers/spree/api/v3/{shipping_method_serializer.rb → delivery_method_serializer.rb}

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

data/app/serializers/spree/api/v3/{shipping_rate_serializer.rb → delivery_rate_serializer.rb}

@@ -1,11 +1,11 @@
 module Spree
   module Api
     module V3
-      class ShippingRateSerializer < BaseSerializer
-        typelize name: :string, selected: :boolean, shipping_method_id: :string,
+      class DeliveryRateSerializer < BaseSerializer
+        typelize name: :string, selected: :boolean, delivery_method_id: :string,
                  cost: :string, display_cost: :string
 
-        attribute :shipping_method_id do |shipping_rate|
+        attribute :delivery_method_id do |shipping_rate|
           shipping_rate.shipping_method&.prefixed_id
         end
 
@@ -15,7 +15,7 @@ module Spree
           shipping_rate.display_cost.to_s
         end
 
-        one :shipping_method, resource: Spree.api.shipping_method_serializer
+        one :shipping_method, key: :delivery_method, resource: Spree.api.delivery_method_serializer
       end
     end
   end

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

@@ -0,0 +1,45 @@
+module Spree
+  module Api
+    module V3
+      class FulfillmentSerializer < BaseSerializer
+        typelize number: :string, status: :string, fulfillment_type: :string,
+                 tracking: [:string, nullable: true],
+                 tracking_url: [:string, nullable: true], fulfilled_at: [:string, nullable: true],
+                 cost: :string, display_cost: :string,
+                 items: 'Array<{ item_id: string; variant_id: string; quantity: number }>'
+
+        attributes :number, :tracking, :tracking_url,
+                   :cost, :display_cost,
+                   created_at: :iso8601, updated_at: :iso8601
+
+        attribute :status do |shipment|
+          shipment.state
+        end
+
+        attribute :fulfillment_type do |shipment|
+          shipment.digital? ? 'digital' : 'shipping'
+        end
+
+        attribute :fulfilled_at do |shipment|
+          shipment.shipped_at&.iso8601
+        end
+
+        # Which items (and how many) are in this fulfillment.
+        # A line item can be split across fulfillments with different quantities.
+        attribute :items do |shipment|
+          shipment.manifest.map do |item|
+            {
+              item_id: item.line_item.prefixed_id,
+              variant_id: item.variant.prefixed_id,
+              quantity: item.quantity
+            }
+          end
+        end
+
+        one :shipping_method, key: :delivery_method, resource: Spree.api.delivery_method_serializer
+        one :stock_location, resource: Spree.api.stock_location_serializer
+        many :shipping_rates, key: :delivery_rates, resource: Spree.api.delivery_rate_serializer
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module Spree
     module V3
       class GiftCardSerializer < BaseSerializer
         typelize code: :string,
-                 state: :string,
+                 status: :string,
                  amount: :string,
                  amount_used: :string,
                  amount_authorized: :string,
@@ -21,7 +21,7 @@ module Spree
           gift_card.display_code
         end
 
-        attribute :state do |gift_card|
+        attribute :status do |gift_card|
           gift_card.display_state
         end
 

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

@@ -6,7 +6,7 @@ module Spree
       class NewsletterSubscriberSerializer < BaseSerializer
         typelize email: :string, verified: :boolean,
                  verified_at: [:string, nullable: true],
-                 user_id: [:string, nullable: true]
+                 customer_id: [:string, nullable: true]
 
         attributes :email, created_at: :iso8601, updated_at: :iso8601
 
@@ -18,7 +18,7 @@ module Spree
           subscriber.verified_at&.iso8601
         end
 
-        attribute :user_id do |subscriber|
+        attribute :customer_id do |subscriber|
           subscriber.user&.prefixed_id
         end
       end

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

@@ -6,9 +6,9 @@ module Spree
       class OrderSerializer < BaseSerializer
         typelize number: :string, email: :string,
                  special_instructions: [:string, nullable: true], currency: :string, locale: [:string, nullable: true], item_count: :number,
-                 shipment_state: [:string, nullable: true], payment_state: [:string, nullable: true],
+                 fulfillment_status: [:string, nullable: true], payment_status: [:string, nullable: true],
                  item_total: :string, display_item_total: :string,
-                 ship_total: :string, display_ship_total: :string,
+                 delivery_total: :string, display_delivery_total: :string,
                  adjustment_total: :string, display_adjustment_total: :string,
                  promo_total: :string, display_promo_total: :string,
                  tax_total: :string, display_tax_total: :string,
@@ -18,16 +18,32 @@ module Spree
                  bill_address: { nullable: true }, ship_address: { nullable: true }
 
         attributes :number, :email, :special_instructions,
-                   :currency, :locale, :item_count, :shipment_state, :payment_state,
-                   :item_total, :display_item_total, :ship_total, :display_ship_total,
+                   :currency, :locale, :item_count,
+                   :item_total, :display_item_total,
                    :adjustment_total, :display_adjustment_total, :promo_total, :display_promo_total,
                    :tax_total, :display_tax_total, :included_tax_total, :display_included_tax_total,
                    :additional_tax_total, :display_additional_tax_total, :total, :display_total,
                    completed_at: :iso8601, created_at: :iso8601, updated_at: :iso8601
 
+        attribute :fulfillment_status do |order|
+          order.shipment_state
+        end
+
+        attribute :payment_status do |order|
+          order.payment_state
+        end
+
+        attribute :delivery_total do |order|
+          order.ship_total
+        end
+
+        attribute :display_delivery_total do |order|
+          order.display_ship_total.to_s
+        end
+
         many :order_promotions, key: :promotions, resource: Spree.api.order_promotion_serializer
         many :line_items, key: :items, resource: Spree.api.line_item_serializer
-        many :shipments, resource: Spree.api.shipment_serializer
+        many :shipments, key: :fulfillments, resource: Spree.api.fulfillment_serializer
         many :payments, resource: Spree.api.payment_serializer
         one :bill_address, resource: Spree.api.address_serializer
         one :ship_address, resource: Spree.api.address_serializer

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

@@ -2,7 +2,7 @@ module Spree
   module Api
     module V3
       class PaymentSerializer < BaseSerializer
-        typelize state: :string, payment_method_id: :string, response_code: [:string, nullable: true],
+        typelize status: :string, payment_method_id: :string, response_code: [:string, nullable: true],
                  number: :string, amount: :string, display_amount: :string,
                  source_type: [:string, nullable: true, enum: %w[credit_card store_credit payment_source]],
                  source_id: [:string, nullable: true],
@@ -12,9 +12,13 @@ module Spree
           payment.payment_method&.prefixed_id
         end
 
-        attributes :state, :response_code, :number, :amount, :display_amount,
+        attributes :response_code, :number, :amount, :display_amount,
                    created_at: :iso8601, updated_at: :iso8601
 
+        attribute :status do |payment|
+          payment.state
+        end
+
         attribute :source_type do |payment|
           case payment.source_type
           when 'Spree::CreditCard'

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

@@ -85,11 +85,6 @@ module Spree
             resource: Spree.api.variant_serializer,
             if: proc { expand?('default_variant') }
 
-        one :master,
-            key: :master_variant,
-            resource: Spree.api.variant_serializer,
-            if: proc { expand?('master_variant') }
-
         many :option_types,
              resource: Spree.api.option_type_serializer,
              if: proc { expand?('option_types') }

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

@@ -5,7 +5,7 @@ module Spree
       # Customer-facing variant data with limited fields
       class VariantSerializer < BaseSerializer
         typelize product_id: :string, sku: [:string, nullable: true],
-                 is_master: :boolean, options_text: :string, track_inventory: :boolean, media_count: :number,
+                 options_text: :string, track_inventory: :boolean, media_count: :number,
                  thumbnail_url: [:string, nullable: true],
                  purchasable: :boolean, in_stock: :boolean, backorderable: :boolean,
                  weight: [:number, nullable: true], height: [:number, nullable: true], width: [:number, nullable: true], depth: [:number, nullable: true],
@@ -16,7 +16,7 @@ module Spree
           variant.product&.prefixed_id
         end
 
-        attributes :sku, :is_master, :options_text, :track_inventory, :media_count,
+        attributes :sku, :options_text, :track_inventory, :media_count,
                    created_at: :iso8601, updated_at: :iso8601
 
         # Main variant image URL for listings (cached primary_media)

data/config/routes.rb

@@ -5,6 +5,7 @@ Spree::Core::Engine.add_routes do
         # Authentication
         post 'auth/login', to: 'auth#create'
         post 'auth/refresh', to: 'auth#refresh'
+        post 'auth/logout', to: 'auth#logout'
         post 'auth/oauth/callback', to: 'auth#oauth_callback'
 
         # Markets
@@ -38,7 +39,7 @@ 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 :shipments, only: [:index, :update], controller: 'carts/shipments'
+          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 :payment_sessions, only: [:create, :show, :update], controller: 'carts/payment_sessions' do

data/lib/spree/api/configuration.rb

@@ -11,6 +11,7 @@ module Spree
 
       preference :jwt_expiration, :integer, default: 3600 # 1 hour in seconds
       preference :jwt_secret_key, :string, default: nil
+      preference :refresh_token_expiry, :integer, default: 2_592_000 # 30 days in seconds
 
       # Rate limiting
       preference :rate_limit_per_key, :integer, default: 300 # per publishable API key

data/lib/spree/api/dependencies.rb

@@ -107,7 +107,8 @@ module Spree
         payment_setup_session_serializer: 'Spree::Api::V3::PaymentSetupSessionSerializer',
         payment_source_serializer: 'Spree::Api::V3::PaymentSourceSerializer',
         store_credit_serializer: 'Spree::Api::V3::StoreCreditSerializer',
-        shipment_serializer: 'Spree::Api::V3::ShipmentSerializer',
+        shipment_serializer: 'Spree::Api::V3::FulfillmentSerializer',
+        fulfillment_serializer: 'Spree::Api::V3::FulfillmentSerializer',
         address_serializer: 'Spree::Api::V3::AddressSerializer',
         customer_serializer: 'Spree::Api::V3::CustomerSerializer',
         country_serializer: 'Spree::Api::V3::CountrySerializer',
@@ -116,8 +117,10 @@ module Spree
         wishlist_serializer: 'Spree::Api::V3::WishlistSerializer',
         wished_item_serializer: 'Spree::Api::V3::WishedItemSerializer',
         payment_method_serializer: 'Spree::Api::V3::PaymentMethodSerializer',
-        shipping_method_serializer: 'Spree::Api::V3::ShippingMethodSerializer',
-        shipping_rate_serializer: 'Spree::Api::V3::ShippingRateSerializer',
+        shipping_method_serializer: 'Spree::Api::V3::DeliveryMethodSerializer',
+        shipping_rate_serializer: 'Spree::Api::V3::DeliveryRateSerializer',
+        delivery_method_serializer: 'Spree::Api::V3::DeliveryMethodSerializer',
+        delivery_rate_serializer: 'Spree::Api::V3::DeliveryRateSerializer',
         stock_location_serializer: 'Spree::Api::V3::StockLocationSerializer',
         category_serializer: 'Spree::Api::V3::CategorySerializer',
         cart_promotion_serializer: 'Spree::Api::V3::CartPromotionSerializer',
@@ -164,7 +167,8 @@ module Spree
         admin_media_serializer: 'Spree::Api::V3::Admin::MediaSerializer',
         admin_asset_serializer: 'Spree::Api::V3::Admin::AssetSerializer',
         admin_stock_item_serializer: 'Spree::Api::V3::Admin::StockItemSerializer',
-        admin_shipment_serializer: 'Spree::Api::V3::Admin::ShipmentSerializer',
+        admin_shipment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
+        admin_fulfillment_serializer: 'Spree::Api::V3::Admin::FulfillmentSerializer',
         admin_payment_serializer: 'Spree::Api::V3::Admin::PaymentSerializer',
         admin_refund_serializer: 'Spree::Api::V3::Admin::RefundSerializer',
         admin_adjustment_serializer: 'Spree::Api::V3::Admin::AdjustmentSerializer',
@@ -174,9 +178,11 @@ module Spree
         admin_reimbursement_serializer: 'Spree::Api::V3::Admin::ReimbursementSerializer',
         admin_admin_user_serializer: 'Spree::Api::V3::Admin::AdminUserSerializer',
         admin_address_serializer: 'Spree::Api::V3::Admin::AddressSerializer',
-        admin_shipping_method_serializer: 'Spree::Api::V3::Admin::ShippingMethodSerializer',
+        admin_shipping_method_serializer: 'Spree::Api::V3::Admin::DeliveryMethodSerializer',
+        admin_delivery_method_serializer: 'Spree::Api::V3::Admin::DeliveryMethodSerializer',
         admin_stock_location_serializer: 'Spree::Api::V3::Admin::StockLocationSerializer',
-        admin_shipping_rate_serializer: 'Spree::Api::V3::Admin::ShippingRateSerializer',
+        admin_shipping_rate_serializer: 'Spree::Api::V3::Admin::DeliveryRateSerializer',
+        admin_delivery_rate_serializer: 'Spree::Api::V3::Admin::DeliveryRateSerializer',
         admin_order_promotion_serializer: 'Spree::Api::V3::Admin::OrderPromotionSerializer',
         admin_payment_method_serializer: 'Spree::Api::V3::Admin::PaymentMethodSerializer',
         admin_credit_card_serializer: 'Spree::Api::V3::Admin::CreditCardSerializer',

data/lib/spree/api/openapi/schema_helper.rb

@@ -81,9 +81,10 @@ module Spree
               type: :object,
               properties: {
                 token: { type: :string, description: 'JWT access token' },
+                refresh_token: { type: :string, description: 'Refresh token for obtaining new access tokens' },
                 user: { '$ref' => '#/components/schemas/Customer' }
               },
-              required: %w[token user]
+              required: %w[token refresh_token user]
             },
             CheckoutRequirement: {
               type: :object,
@@ -93,6 +94,16 @@ module Spree
                 message: { type: :string, description: 'Human-readable requirement message', example: 'Add a payment method' }
               },
               required: %w[step field message]
+            },
+            FulfillmentManifestItem: {
+              type: :object,
+              description: 'An item within a fulfillment — which line item and how many units are in this fulfillment',
+              properties: {
+                item_id: { type: :string, description: 'Line item prefixed ID', example: 'li_abc123' },
+                variant_id: { type: :string, description: 'Variant prefixed ID', example: 'variant_abc123' },
+                quantity: { type: :integer, description: 'Quantity in this fulfillment', example: 2 }
+              },
+              required: %w[item_id variant_id quantity]
             }
           }
         end
@@ -120,6 +131,7 @@ module Spree
               strip_null_from_enums(s)
             end
             patch_cart_schema(schemas)
+            patch_fulfillment_schema(schemas)
             schemas
           end
         end
@@ -142,6 +154,24 @@ module Spree
           end
         end
 
+        # Typelizer cannot represent Array<{...}> inline object types in OpenAPI,
+        # so we patch Fulfillment#items to reference the FulfillmentManifestItem component schema.
+        def patch_fulfillment_schema(schemas)
+          fulfillment = schemas['Fulfillment'] || schemas[:Fulfillment]
+          return unless fulfillment
+
+          props = fulfillment[:properties]
+          return unless props
+
+          items_key = props.key?('items') ? 'items' : :items
+          if props[items_key]
+            props[items_key] = {
+              type: :array,
+              items: { '$ref' => '#/components/schemas/FulfillmentManifestItem' }
+            }
+          end
+        end
+
         # Typelizer adds nil to enum arrays for nullable fields.
         # OpenAPI 3.0 handles nullability via `nullable: true`, so the nil entry is redundant
         # and causes issues with code generators.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 5.4.0.beta8
+  version: 5.4.0.beta9
 platform: ruby
 authors:
 - Vendo Connect Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-16 00:00:00.000000000 Z
+date: 2026-03-17 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.beta8
+        version: 5.4.0.beta9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0.beta8
+        version: 5.4.0.beta9
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -121,11 +121,11 @@ files:
 - app/controllers/spree/api/v3/store/auth_controller.rb
 - app/controllers/spree/api/v3/store/base_controller.rb
 - 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/shipments_controller.rb
 - app/controllers/spree/api/v3/store/carts/store_credits_controller.rb
 - app/controllers/spree/api/v3/store/carts_controller.rb
 - app/controllers/spree/api/v3/store/categories/products_controller.rb
@@ -161,7 +161,10 @@ files:
 - app/serializers/spree/api/v3/admin/category_serializer.rb
 - app/serializers/spree/api/v3/admin/credit_card_serializer.rb
 - app/serializers/spree/api/v3/admin/customer_serializer.rb
+- app/serializers/spree/api/v3/admin/delivery_method_serializer.rb
+- app/serializers/spree/api/v3/admin/delivery_rate_serializer.rb
 - app/serializers/spree/api/v3/admin/digital_link_serializer.rb
+- app/serializers/spree/api/v3/admin/fulfillment_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
@@ -177,10 +180,7 @@ files:
 - app/serializers/spree/api/v3/admin/refund_serializer.rb
 - app/serializers/spree/api/v3/admin/reimbursement_serializer.rb
 - app/serializers/spree/api/v3/admin/return_authorization_serializer.rb
-- app/serializers/spree/api/v3/admin/shipment_serializer.rb
 - app/serializers/spree/api/v3/admin/shipping_category_serializer.rb
-- app/serializers/spree/api/v3/admin/shipping_method_serializer.rb
-- app/serializers/spree/api/v3/admin/shipping_rate_serializer.rb
 - app/serializers/spree/api/v3/admin/stock_item_serializer.rb
 - app/serializers/spree/api/v3/admin/stock_location_serializer.rb
 - app/serializers/spree/api/v3/admin/store_credit_serializer.rb
@@ -196,9 +196,12 @@ files:
 - app/serializers/spree/api/v3/currency_serializer.rb
 - app/serializers/spree/api/v3/customer_return_serializer.rb
 - app/serializers/spree/api/v3/customer_serializer.rb
+- app/serializers/spree/api/v3/delivery_method_serializer.rb
+- app/serializers/spree/api/v3/delivery_rate_serializer.rb
 - app/serializers/spree/api/v3/digital_link_serializer.rb
 - app/serializers/spree/api/v3/digital_serializer.rb
 - app/serializers/spree/api/v3/export_serializer.rb
+- app/serializers/spree/api/v3/fulfillment_serializer.rb
 - app/serializers/spree/api/v3/gift_card_batch_serializer.rb
 - app/serializers/spree/api/v3/gift_card_serializer.rb
 - app/serializers/spree/api/v3/import_row_serializer.rb
@@ -227,10 +230,7 @@ files:
 - app/serializers/spree/api/v3/report_serializer.rb
 - app/serializers/spree/api/v3/return_authorization_serializer.rb
 - app/serializers/spree/api/v3/return_item_serializer.rb
-- app/serializers/spree/api/v3/shipment_serializer.rb
 - app/serializers/spree/api/v3/shipping_category_serializer.rb
-- app/serializers/spree/api/v3/shipping_method_serializer.rb
-- app/serializers/spree/api/v3/shipping_rate_serializer.rb
 - app/serializers/spree/api/v3/state_serializer.rb
 - app/serializers/spree/api/v3/stock_item_serializer.rb
 - app/serializers/spree/api/v3/stock_location_serializer.rb
@@ -268,9 +268,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.beta8
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.4.0.beta9
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.4.0.beta8
+  source_code_uri: https://github.com/spree/spree/tree/v5.4.0.beta9
 post_install_message:
 rdoc_options: []
 require_paths:

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

@@ -1,11 +0,0 @@
-module Spree
-  module Api
-    module V3
-      module Admin
-        class ShippingRateSerializer < V3::ShippingRateSerializer
-          one :shipping_method, resource: Spree.api.admin_shipping_method_serializer, if: proc { expand?('shipping_method') }
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-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