Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Introduce Storefront API Order Serializer (#11590)
Damian Legawiec981b5dff9284
diff --git a/api/app/serializers/spree/v2/storefront/order_serializer.rb b/api/app/serializers/spree/v2/storefront/order_serializer.rbnew file mode 100644index 0000000000..22468b4d69--- /dev/null+++ b/api/app/serializers/spree/v2/storefront/order_serializer.rb@@ -0,0 +1,9 @@+module Spree+ module V2+ module Storefront+ class OrderSerializer < CartSerializer+ set_type :order+ end+ end+ end+enddiff --git a/api/lib/spree/api/dependencies.rb b/api/lib/spree/api/dependencies.rbindex 8fe15edea3..6ead668b50 100644--- a/api/lib/spree/api/dependencies.rb+++ b/api/lib/spree/api/dependencies.rb@@ -102,7 +102,7 @@ module Spree@storefront_product_serializer = 'Spree::V2::Storefront::ProductSerializer'@storefront_estimated_shipment_serializer = 'Spree::V2::Storefront::EstimatedShippingRateSerializer'@storefront_store_serializer = 'Spree::V2::Storefront::StoreSerializer'- @storefront_order_serializer = 'Spree::V2::Storefront::CartSerializer'+ @storefront_order_serializer = 'Spree::V2::Storefront::OrderSerializer'# sorters@storefront_collection_sorter = Spree::Dependencies.collection_sorterdiff --git a/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb b/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rbindex e504ea90ea..876b2b3324 100644--- a/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb+++ b/api/spec/requests/spree/api/v2/storefront/account/orders_spec.rb@@ -9,6 +9,37 @@ describe 'Storefront API v2 Orders spec', type: :request doinclude_context 'API v2 tokens'+ def expect_order_json(json)+ expect(json).to be_present+ expect(json).to have_id(order.id.to_s)+ expect(json).to have_type('order')+ expect(json).to have_attribute(:number).with_value(order.number)+ expect(json).to have_attribute(:state).with_value(order.state)+ expect(json).to have_attribute(:token).with_value(order.token)+ expect(json).to have_attribute(:total).with_value(order.total.to_s)+ expect(json).to have_attribute(:item_total).with_value(order.item_total.to_s)+ expect(json).to have_attribute(:ship_total).with_value(order.ship_total.to_s)+ expect(json).to have_attribute(:adjustment_total).with_value(order.adjustment_total.to_s)+ expect(json).to have_attribute(:included_tax_total).with_value(order.included_tax_total.to_s)+ expect(json).to have_attribute(:additional_tax_total).with_value(order.additional_tax_total.to_s)+ expect(json).to have_attribute(:display_additional_tax_total).with_value(order.display_additional_tax_total.to_s)+ expect(json).to have_attribute(:display_included_tax_total).with_value(order.display_included_tax_total.to_s)+ expect(json).to have_attribute(:tax_total).with_value(order.tax_total.to_s)+ expect(json).to have_attribute(:currency).with_value(order.currency.to_s)+ expect(json).to have_attribute(:email).with_value(order.email)+ expect(json).to have_attribute(:display_item_total).with_value(order.display_item_total.to_s)+ expect(json).to have_attribute(:display_ship_total).with_value(order.display_ship_total.to_s)+ expect(json).to have_attribute(:display_adjustment_total).with_value(order.display_adjustment_total.to_s)+ expect(json).to have_attribute(:display_tax_total).with_value(order.display_tax_total.to_s)+ expect(json).to have_attribute(:item_count).with_value(order.item_count)+ expect(json).to have_attribute(:special_instructions).with_value(order.special_instructions)+ expect(json).to have_attribute(:promo_total).with_value(order.promo_total.to_s)+ expect(json).to have_attribute(:display_promo_total).with_value(order.display_promo_total.to_s)+ expect(json).to have_attribute(:display_total).with_value(order.display_total.to_s)+ expect(json).to have_attribute(:public_metadata).with_value(order.public_metadata)+ expect(json).to have_relationships(:user, :line_items, :variants, :billing_address, :shipping_address, :payments, :shipments, :promotions)+ end+describe 'orders#index' docontext 'with option: include' dobefore { get '/api/v2/storefront/account/orders?include=billing_address', headers: headers_bearer }@@ -17,34 +48,7 @@ describe 'Storefront API v2 Orders spec', type: :request doexpect(json_response['data'].size).to eq 1expect(json_response['data']).to be_kind_of(Array)- expect(json_response['data'][0]).to be_present- expect(json_response['data'][0]).to have_id(order.id.to_s)- expect(json_response['data'][0]).to have_type('cart')- expect(json_response['data'][0]).to have_attribute(:number).with_value(order.number)- expect(json_response['data'][0]).to have_attribute(:state).with_value(order.state)- expect(json_response['data'][0]).to have_attribute(:token).with_value(order.token)- expect(json_response['data'][0]).to have_attribute(:total).with_value(order.total.to_s)- expect(json_response['data'][0]).to have_attribute(:item_total).with_value(order.item_total.to_s)- expect(json_response['data'][0]).to have_attribute(:ship_total).with_value(order.ship_total.to_s)- expect(json_response['data'][0]).to have_attribute(:adjustment_total).with_value(order.adjustment_total.to_s)- expect(json_response['data'][0]).to have_attribute(:included_tax_total).with_value(order.included_tax_total.to_s)- expect(json_response['data'][0]).to have_attribute(:additional_tax_total).with_value(order.additional_tax_total.to_s)- expect(json_response['data'][0]).to have_attribute(:display_additional_tax_total).with_value(order.display_additional_tax_total.to_s)- expect(json_response['data'][0]).to have_attribute(:display_included_tax_total).with_value(order.display_included_tax_total.to_s)- expect(json_response['data'][0]).to have_attribute(:tax_total).with_value(order.tax_total.to_s)- expect(json_response['data'][0]).to have_attribute(:currency).with_value(order.currency.to_s)- expect(json_response['data'][0]).to have_attribute(:email).with_value(order.email)- expect(json_response['data'][0]).to have_attribute(:display_item_total).with_value(order.display_item_total.to_s)- expect(json_response['data'][0]).to have_attribute(:display_ship_total).with_value(order.display_ship_total.to_s)- expect(json_response['data'][0]).to have_attribute(:display_adjustment_total).with_value(order.display_adjustment_total.to_s)- expect(json_response['data'][0]).to have_attribute(:display_tax_total).with_value(order.display_tax_total.to_s)- expect(json_response['data'][0]).to have_attribute(:item_count).with_value(order.item_count)- expect(json_response['data'][0]).to have_attribute(:special_instructions).with_value(order.special_instructions)- expect(json_response['data'][0]).to have_attribute(:promo_total).with_value(order.promo_total.to_s)- expect(json_response['data'][0]).to have_attribute(:display_promo_total).with_value(order.display_promo_total.to_s)- expect(json_response['data'][0]).to have_attribute(:display_total).with_value(order.display_total.to_s)- expect(json_response['data'][0]).to have_attribute(:public_metadata).with_value(order.public_metadata)- expect(json_response['data'][0]).to have_relationships(:user, :line_items, :variants, :billing_address, :shipping_address, :payments, :shipments, :promotions)+ expect_order_json(json_response['data'].first)endit 'returns included resource' do@@ -184,13 +188,17 @@ describe 'Storefront API v2 Orders spec', type: :request docontext 'without option: include' dobefore { get "/api/v2/storefront/account/orders/#{order.number}", headers: headers_bearer }- it_behaves_like 'returns valid cart JSON'+ it 'returns valid order JSON' do+ expect_order_json(json_response['data'])+ endendcontext 'with option: include' dobefore { get "/api/v2/storefront/account/orders/#{order.number}?include=billing_address", headers: headers_bearer }- it_behaves_like 'returns valid cart JSON'+ it 'returns valid order JSON' do+ expect_order_json(json_response['data'])+ endit 'return hash with included' doexpect(json_response['included']).to be_present