spree_api 5.4.0.beta8 → 5.4.0.beta10

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.beta10
 platform: ruby
 authors:
 - Vendo Connect Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-16 00:00:00.000000000 Z
+date: 2026-03-19 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.beta10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0.beta8
+        version: 5.4.0.beta10
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -114,6 +114,7 @@ files:
 - app/controllers/concerns/spree/api/v3/rate_limit_headers.rb
 - app/controllers/concerns/spree/api/v3/resource_serializer.rb
 - app/controllers/concerns/spree/api/v3/security_headers.rb
+- app/controllers/concerns/spree/api/v3/store/search_provider_support.rb
 - app/controllers/spree/api/v3/admin/base_controller.rb
 - app/controllers/spree/api/v3/admin/resource_controller.rb
 - app/controllers/spree/api/v3/base_controller.rb
@@ -121,11 +122,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,13 +162,16 @@ 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/discount_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
 - app/serializers/spree/api/v3/admin/option_type_serializer.rb
 - app/serializers/spree/api/v3/admin/option_value_serializer.rb
-- app/serializers/spree/api/v3/admin/order_promotion_serializer.rb
 - app/serializers/spree/api/v3/admin/order_serializer.rb
 - app/serializers/spree/api/v3/admin/payment_method_serializer.rb
 - app/serializers/spree/api/v3/admin/payment_serializer.rb
@@ -177,10 +181,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
@@ -188,7 +189,6 @@ files:
 - app/serializers/spree/api/v3/admin/variant_serializer.rb
 - app/serializers/spree/api/v3/asset_serializer.rb
 - app/serializers/spree/api/v3/base_serializer.rb
-- app/serializers/spree/api/v3/cart_promotion_serializer.rb
 - app/serializers/spree/api/v3/cart_serializer.rb
 - app/serializers/spree/api/v3/category_serializer.rb
 - app/serializers/spree/api/v3/country_serializer.rb
@@ -196,9 +196,13 @@ 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/discount_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
@@ -212,7 +216,6 @@ files:
 - app/serializers/spree/api/v3/newsletter_subscriber_serializer.rb
 - app/serializers/spree/api/v3/option_type_serializer.rb
 - app/serializers/spree/api/v3/option_value_serializer.rb
-- app/serializers/spree/api/v3/order_promotion_serializer.rb
 - app/serializers/spree/api/v3/order_serializer.rb
 - app/serializers/spree/api/v3/payment_method_serializer.rb
 - app/serializers/spree/api/v3/payment_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
@@ -239,7 +239,7 @@ files:
 - app/serializers/spree/api/v3/store_credit_serializer.rb
 - app/serializers/spree/api/v3/tax_category_serializer.rb
 - app/serializers/spree/api/v3/variant_serializer.rb
-- app/serializers/spree/api/v3/wished_item_serializer.rb
+- app/serializers/spree/api/v3/wishlist_item_serializer.rb
 - app/serializers/spree/api/v3/wishlist_serializer.rb
 - app/services/spree/api/v3/filters_aggregator.rb
 - app/services/spree/webhooks/deliver_webhook.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.beta10
   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.beta10
 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/order_promotion_serializer.rb

@@ -1,16 +0,0 @@
-module Spree
-  module Api
-    module V3
-      class OrderPromotionSerializer < BaseSerializer
-        typelize name: :string, description: [:string, nullable: true], code: [:string, nullable: true],
-                 amount: :string, display_amount: :string, promotion_id: :string
-
-        attribute :promotion_id do |order_promotion|
-          order_promotion.promotion&.prefixed_id
-        end
-
-        attributes :name, :description, :code, :amount, :display_amount
-      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