Class: Spree::Order

Inherits:
Object
  • Object
show all
Extended by:
DisplayMoney
Includes:
MemoizedData, Metadata, Metafields, NumberIdentifier, AddressBook, Checkout, CurrencyUpdater, Digital, GiftCard, Payments, StoreCredit, Webhooks, Searchable, Security::Orders, SingleStoreResource, VendorConcern
Defined in:
app/models/spree/order.rb,
app/models/spree/order/digital.rb,
app/models/spree/order/checkout.rb,
app/models/spree/order/payments.rb,
app/models/spree/order/webhooks.rb,
app/models/spree/order/gift_card.rb,
app/models/spree/order/address_book.rb,
app/models/spree/order/store_credit.rb,
app/models/spree/order/currency_updater.rb

Defined Under Namespace

Modules: AddressBook, Checkout, CurrencyUpdater, Digital, GiftCard, Payments, StoreCredit, Webhooks

Constant Summary collapse

PAYMENT_STATES = 
%w(balance_due credit_owed failed paid void)
SHIPMENT_STATES = 
%w(backorder canceled partial pending ready shipped)
LINE_ITEM_REMOVABLE_STATES = 
%w(cart address delivery payment confirm resumed)
MEMOIZED_METHODS = 
%w(tax_zone)
MONEY_THRESHOLD = 
100_000_000
MONEY_VALIDATION = 
{
  presence: true,
  numericality: {
    greater_than: -MONEY_THRESHOLD,
    less_than: MONEY_THRESHOLD,
    allow_blank: true
  },
  format: { with: /\A-?\d+(?:\.\d{1,2})?\z/, allow_blank: true }
}.freeze
POSITIVE_MONEY_VALIDATION = 
MONEY_VALIDATION.deep_dup.tap do |validation|
  validation.fetch(:numericality)[:greater_than_or_equal_to] = 0
end.freeze
NEGATIVE_MONEY_VALIDATION = 
MONEY_VALIDATION.deep_dup.tap do |validation|
  validation.fetch(:numericality)[:less_than_or_equal_to] = 0
end.freeze
STATUSES = 
%w[draft placed canceled].freeze
ASSOCIATED_USER_ATTRIBUTES = 
[:user_id, :email, :bill_address_id, :ship_address_id]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DisplayMoney

money_methods

Methods included from Metadata

#metadata, #metadata=, #public_metadata=

Methods included from GiftCard

#apply_gift_card, #gift_card_total, #recalculate_gift_card, #redeem_gift_card, #remove_gift_card

Methods included from Webhooks

#send_order_canceled_webhook, #send_order_placed_webhook, #send_order_resumed_webhook

Methods included from AddressBook

#bill_address_attributes=, #bill_address_id=, #clone_billing_address, #clone_shipping_address, #ship_address_attributes=, #ship_address_id=

Methods included from StoreCredit

#add_store_credit_payments, #available_store_credits, #could_use_store_credit?, #covered_by_store_credit?, #display_order_total_after_store_credit, #display_store_credit_remaining_after_capture, #display_total_applicable_store_credit, #display_total_applied_store_credit, #display_total_available_store_credit, #display_total_minus_store_credits, #order_total_after_store_credit, #remove_store_credit_payments, #total_applicable_store_credit, #total_applied_store_credit, #total_available_store_credit, #total_minus_store_credits, #using_store_credit?

Methods included from Digital

#create_digital_links, #digital?, #digital_line_items, #digital_links, #some_digital?, #with_digital_assets?

Methods included from CurrencyUpdater

#price_from_line_item, #update_line_item_currencies!, #update_line_item_price!

Methods included from Checkout

included

Instance Attribute Details

#coupon_code ⇒ Object

Returns the value of attribute coupon_code.



122
123
124
 
# File 'app/models/spree/order.rb', line 122

def coupon_code
  @coupon_code
end

#notify_customer ⇒ Object

Set to false on admin-initiated flows to suppress customer-facing emails.



126
127
128
 
# File 'app/models/spree/order.rb', line 126

def notify_customer
  @notify_customer
end

#skip_market_resolution ⇒ Object

Returns the value of attribute skip_market_resolution.



235
236
237
 
# File 'app/models/spree/order.rb', line 235

def skip_market_resolution
  @skip_market_resolution
end

#temporary_address ⇒ Object

Returns the value of attribute temporary_address.



123
124
125
 
# File 'app/models/spree/order.rb', line 123

def temporary_address
  @temporary_address
end

#use_billing ⇒ Object

Returns the value of attribute use_billing.



235
236
237
 
# File 'app/models/spree/order.rb', line 235

def use_billing
  @use_billing
end

#use_shipping ⇒ Object

Returns the value of attribute use_shipping.



235
236
237
 
# File 'app/models/spree/order.rb', line 235

def use_shipping
  @use_shipping
end

Class Method Details

.find_by_param(param) ⇒ Spree::Order?

Find an order by prefixed ID first, falling back to number, then integer id for backwards compatibility

Parameters:

  • param (String) —

    the prefixed ID, number, or integer id to search for

Returns:



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'app/models/spree/order.rb', line 320

def self.find_by_param(param)
  return nil if param.blank?

  # Try prefixed ID first (new format)
  if param.to_s.include?('_')
    decoded = decode_prefixed_id(param)
    order = find_by(id: decoded) if decoded
    return order if order
  end

  # Try number (legacy format)
  order = find_by(number: param)
  return order if order

  # Fall back to id (numeric legacy format) - only if param looks like an integer
  find_by(id: param) if param.to_s.match?(/\A\d+\z/)
end

.find_by_param!(param) ⇒ Spree::Order

Find an order by prefixed ID first, falling back to number, then integer id for backwards compatibility Raises ActiveRecord::RecordNotFound if not found

Parameters:

  • param (String) —

    the prefixed ID, number, or integer id to search for

Returns:

Raises:

  • (ActiveRecord::RecordNotFound) —

    if order not found



343
344
345
 
# File 'app/models/spree/order.rb', line 343

def self.find_by_param!(param)
  find_by_param(param) || raise(ActiveRecord::RecordNotFound.new("Couldn't find Order with param=#{param}"))
end

.multi_search(query) ⇒ Object

Backward compatibility alias — remove in Spree 6.0



315
 
# File 'app/models/spree/order.rb', line 315

def self.multi_search(query) = search(query)

.register_update_hook(hook) ⇒ Object

Use this method in other gems that wish to register their own custom logic that should be called after Order#update



349
350
351
 
# File 'app/models/spree/order.rb', line 349

def self.register_update_hook(hook)
  update_hooks.add(hook)
end

.search(query) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'app/models/spree/order.rb', line 292

def self.search(query)
  sanitized_query = sanitize_query_for_search(query)
  return none if query.blank?

  query_pattern = "%#{sanitized_query}%"

  conditions = []
  conditions << arel_table[:number].lower.matches(query_pattern)

  conditions << search_condition(Spree::Address, :firstname, sanitized_query)
  conditions << search_condition(Spree::Address, :lastname, sanitized_query)

  full_name = NameOfPerson::PersonName.full(sanitized_query)

  if full_name.first.present? && full_name.last.present?
    conditions << search_condition(Spree::Address, :firstname, full_name.first)
    conditions << search_condition(Spree::Address, :lastname, full_name.last)
  end

  left_joins(:bill_address).where(arel_table[:email].lower.eq(query.downcase)).or(where(conditions.reduce(:or)))
end

Instance Method Details

#all_inventory_units_returned? ⇒ Boolean

Returns:



549
550
551
 
# File 'app/models/spree/order.rb', line 549

def all_inventory_units_returned?
  inventory_units.all?(&:returned?)
end

#all_line_items ⇒ Object 



1067
1068
1069
 
# File 'app/models/spree/order.rb', line 1067

def all_line_items
  line_items
end

#all_line_items_invalid? ⇒ Boolean

Checks if all line items cannot be shipped

Returns:



854
855
856
 
# File 'app/models/spree/order.rb', line 854

def all_line_items_invalid?
  line_items_without_shipping_rates.size == line_items.count
end

#allow_cancel? ⇒ Boolean

Returns:



543
544
545
546
547
 
# File 'app/models/spree/order.rb', line 543

def allow_cancel?
  return false if !completed? || canceled?

  shipment_state.nil? || %w{ready backorder pending canceled}.include?(shipment_state)
end

#amount ⇒ Object

For compatibility with Calculator::PriceSack



354
355
356
 
# File 'app/models/spree/order.rb', line 354

def amount
  line_items.inject(0.0) { |sum, li| sum + li.amount }
end

#amount_due ⇒ Object 



61
62
63
 
# File 'app/models/spree/order.rb', line 61

def amount_due
  [outstanding_balance - total_applied_store_credit, 0].max
end

#analytics_subtotal ⇒ Float

Returns the subtotal used for analytics integrations It's a sum of the item total and the promo total

Returns:

  • (Float) 


381
382
383
 
# File 'app/models/spree/order.rb', line 381

def analytics_subtotal
  (item_total + line_items.sum(:promo_total)).to_f
end

#apply_free_shipping_promotions ⇒ Object 



858
859
860
861
862
863
 
# File 'app/models/spree/order.rb', line 858

def apply_free_shipping_promotions
  Spree::PromotionHandler::FreeShipping.new(self).activate
  shipments.each { |shipment| Spree::Adjustable::AdjustmentsUpdater.update(shipment) }
  create_shipment_tax_charge!
  update_with_updater!
end

#apply_unassigned_promotions ⇒ Object

Applies user promotions when login after filling the cart



866
867
868
 
# File 'app/models/spree/order.rb', line 866

def apply_unassigned_promotions
  ::Spree::PromotionHandler::Cart.new(self).activate
end

#approve! ⇒ Spree::ServiceModule::Result

Approves the order without recording an approver. Delegates to Spree::Orders::Approve service.

Returns:



978
979
980
 
# File 'app/models/spree/order.rb', line 978

def approve!
  Spree.order_approve_service.call(order: self)
end

#approved? ⇒ Boolean

Returns:



946
947
948
 
# File 'app/models/spree/order.rb', line 946

def approved?
  !!approved_at
end

#approved_by(user = nil) ⇒ Spree::ServiceModule::Result

Approves the order and records the approver. Delegates to Spree::Orders::Approve service.

Parameters:

  • user (Spree.user_class, nil) (defaults to: nil) —

    the user who approved the order

Returns:



942
943
944
 
# File 'app/models/spree/order.rb', line 942

def approved_by(user = nil)
  Spree.order_approve_service.call(order: self, approver: user)
end

#associate_user!(user, override_email = true) ⇒ Spree::ServiceModule::Result

Associates the specified user with the order. Delegates to Cart::Associate service.

Parameters:

  • user (Spree.user_class) —

    the user to associate with the order

  • override_email (Boolean) (defaults to: true) —

    whether to override the order email with the user's email

Returns:



559
560
561
 
# File 'app/models/spree/order.rb', line 559

def associate_user!(user, override_email = true)
  Spree.cart_associate_service.call(guest_order: self, user: user, override_email: override_email)
end

#available_payment_methods(store = nil) ⇒ Object 



703
704
705
706
707
 
# File 'app/models/spree/order.rb', line 703

def available_payment_methods(store = nil)
  Spree::Deprecation.warn('`Order#available_payment_methods` is deprecated and will be removed in Spree 5.5. Use `collect_frontend_payment_methods` instead.')

  @available_payment_methods ||= collect_payment_methods(store)
end

#backordered? ⇒ Boolean

Returns:



462
463
464
 
# File 'app/models/spree/order.rb', line 462

def backordered?
  shipments.any?(&:backordered?)
end

#backordered_variants ⇒ Array<Spree::Variant>

Returns the backordered variants for the order

Returns:



646
647
648
649
650
651
 
# File 'app/models/spree/order.rb', line 646

def backordered_variants
  variants.
    where(track_inventory: true).
    joins(:stock_items, :product).
    where(Spree::StockItem.table_name => { count_on_hand: ..0, backorderable: true })
end

#can_add_coupon? ⇒ Boolean

Returns:



779
780
781
 
# File 'app/models/spree/order.rb', line 779

def can_add_coupon?
  Spree::Promotion.order_activatable?(self)
end

#can_approve? ⇒ Boolean

Returns:



950
951
952
 
# File 'app/models/spree/order.rb', line 950

def can_approve?
  !approved?
end

#can_be_deleted? ⇒ Boolean

Returns:



959
960
961
 
# File 'app/models/spree/order.rb', line 959

def can_be_deleted?
  !completed? && payments.completed.empty?
end

#can_be_destroyed? ⇒ Boolean

Returns:



954
955
956
957
 
# File 'app/models/spree/order.rb', line 954

def can_be_destroyed?
  Spree::Deprecation.warn('Spree::Order#can_be_destroyed? is deprecated and will be removed in the next major version. Use Spree::Order#can_be_deleted? instead.')
  can_be_deleted?
end

#can_ship? ⇒ Boolean

Returns:



653
654
655
 
# File 'app/models/spree/order.rb', line 653

def can_ship?
  complete? || resumed? || awaiting_return? || returned?
end

#canceled_by(user, canceled_at = nil) ⇒ Spree::ServiceModule::Result

Cancels the order and records the canceler. Delegates to Spree::Orders::Cancel service.

Parameters:

  • user (Spree.user_class, nil) —

    the user who canceled the order

  • canceled_at (Time, nil) (defaults to: nil) —

    the time of cancellation (defaults to current time)

Returns:



933
934
935
 
# File 'app/models/spree/order.rb', line 933

def canceled_by(user, canceled_at = nil)
  Spree.order_cancel_service.call(order: self, canceler: user, canceled_at: canceled_at)
end

#cart_promo_total ⇒ BigDecimal

Returns item and whole order discount amount for Order without Shipment discounts (eg. Free Shipping)

Returns:

  • (BigDecimal) 


1042
1043
1044
1045
1046
 
# File 'app/models/spree/order.rb', line 1042

def cart_promo_total
  all_adjustments.eligible.nonzero.promotion.
    where.not(adjustable_type: 'Spree::Shipment').
    sum(:amount)
end

#checkout_allowed? ⇒ Boolean

Indicates whether or not the user is allowed to proceed to checkout. Currently this is implemented as a check for whether or not there is at least one LineItem in the Order. Feel free to override this logic in your own application if you require additional steps before allowing a checkout.

Returns:



434
435
436
 
# File 'app/models/spree/order.rb', line 434

def checkout_allowed?
  line_items.exists?
end

#collect_backend_payment_methods ⇒ Object 



995
996
997
 
# File 'app/models/spree/order.rb', line 995

def collect_backend_payment_methods
  store.payment_methods.active.available_on_back_end.select { |pm| pm.available_for_order?(self) }
end

#collect_frontend_payment_methods ⇒ Object 



999
1000
1001
 
# File 'app/models/spree/order.rb', line 999

def collect_frontend_payment_methods
  store.payment_methods.active.available_on_front_end.select { |pm| pm.available_for_order?(self) }
end

#completed? ⇒ Boolean

Returns:



389
390
391
 
# File 'app/models/spree/order.rb', line 389

def completed?
  completed_at.present?
end

#confirmation_required? ⇒ Boolean

If true, causes the confirmation step to happen during the checkout process

Returns:



449
450
451
452
453
454
455
456
 
# File 'app/models/spree/order.rb', line 449

def confirmation_required?
  Spree::Config[:always_include_confirm_step] ||
    payments.valid.map(&:payment_method).compact.any?(&:confirmation_required?) ||
    # Little hacky fix for #4117
    # If this wasn't here, order would transition to address state on confirm failure
    # because there would be no valid payments any more.
    confirm?
end

#consider_risk ⇒ Object 



963
964
965
 
# File 'app/models/spree/order.rb', line 963

def consider_risk
  considered_risky! if is_risky? && !approved?
end

#considered_risky! ⇒ Object 



967
968
969
970
971
972
 
# File 'app/models/spree/order.rb', line 967

def considered_risky!
  update_column(:considered_risky, true)

  # Manually publish update event since update_column bypasses callbacks
  publish_event('order.updated')
end

#create_proposed_shipments ⇒ Object 



791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'app/models/spree/order.rb', line 791

def create_proposed_shipments
  all_adjustments.shipping.delete_all

  shipment_ids = shipments.map(&:id)
  StateChange.where(stateful_type: 'Spree::Shipment', stateful_id: shipment_ids).delete_all
  ShippingRate.where(shipment_id: shipment_ids).delete_all

  shipments.delete_all

  # Inventory Units which are not associated to any shipment (unshippable)
  # and are not returned or shipped should be deleted
  inventory_units.on_hand_or_backordered.delete_all

  self.shipments = order_routing_strategy.for_allocation.map do |package|
    package.to_shipment.tap { |s| s.address_id = ship_address_id }
  end
end

#create_shipment_tax_charge! ⇒ Object 



588
589
590
 
# File 'app/models/spree/order.rb', line 588

def create_shipment_tax_charge!
  Spree::TaxRate.adjust(self, shipments) if shipments.any?
end

#create_tax_charge! ⇒ Object

Creates new tax charges if there are any applicable rates. If prices already include taxes then price adjustments are created instead.



583
584
585
586
 
# File 'app/models/spree/order.rb', line 583

def create_tax_charge!
  Spree::TaxRate.adjust(self, line_items)
  Spree::TaxRate.adjust(self, shipments) if shipments.any?
end

#delivery_required? ⇒ Boolean

Does this order require a delivery (physical or digital).

Returns:



439
440
441
 
# File 'app/models/spree/order.rb', line 439

def delivery_required?
  true # true for Spree, can be decorated
end

#disassociate_user! ⇒ Object 



563
564
565
566
567
 
# File 'app/models/spree/order.rb', line 563

def disassociate_user!
  nullified_attributes = ASSOCIATED_USER_ATTRIBUTES.index_with(nil)

  update!(nullified_attributes)
end

#draft? ⇒ Boolean

Returns:



400
401
402
 
# File 'app/models/spree/order.rb', line 400

def draft?
  status == 'draft'
end

#email_required? ⇒ Boolean

Returns:



458
459
460
 
# File 'app/models/spree/order.rb', line 458

def email_required?
  require_email
end

#empty! ⇒ Object 



736
737
738
739
740
741
 
# File 'app/models/spree/order.rb', line 736

def empty!
  raise Spree.t(:cannot_empty_completed_order) if completed?

  result = Spree.cart_empty_service.call(order: self)
  result.value
end

#ensure_channel_presence ⇒ Object 



520
521
522
523
524
 
# File 'app/models/spree/order.rb', line 520

def ensure_channel_presence
  return if channel_id.present?

  self.channel = store&.default_channel
end

#ensure_line_item_variants_are_not_discontinued ⇒ Object

Check to see if any line item variants are discontinued. If so add error and restart checkout.



716
717
718
719
720
721
722
723
724
 
# File 'app/models/spree/order.rb', line 716

def ensure_line_item_variants_are_not_discontinued
  if line_items.any? { |li| !li.variant || li.variant.discontinued? }
    restart_checkout_flow
    errors.add(:base, Spree.t(:discontinued_variants_present))
    false
  else
    true
  end
end

#ensure_line_items_are_in_stock ⇒ Object 



726
727
728
729
730
731
732
733
734
 
# File 'app/models/spree/order.rb', line 726

def ensure_line_items_are_in_stock
  if insufficient_stock_lines.present?
    restart_checkout_flow
    errors.add(:base, Spree.t(:insufficient_stock_lines_present))
    false
  else
    true
  end
end

#ensure_market_presence ⇒ Object 



516
517
518
 
# File 'app/models/spree/order.rb', line 516

def ensure_market_presence
  self.market ||= Spree::Current.market || store&.default_market
end

#ensure_store_presence ⇒ Object 



511
512
513
514
 
# File 'app/models/spree/order.rb', line 511

def ensure_store_presence
  Spree::Deprecation.warn('Spree::Order#ensure_store_presence is deprecated and will be removed in Spree 6.0. ensure_store instead.')
  ensure_store
end

#ensure_updated_shipments ⇒ Object

Clean shipments and make order back to address state

At some point the might need to force the order to transition from address to delivery again so that proper updated shipments are created. e.g. customer goes back from payment step and changes order items



875
876
877
878
879
880
881
882
883
884
885
 
# File 'app/models/spree/order.rb', line 875

def ensure_updated_shipments
  if shipments.any? && !completed?
    shipments.destroy_all
    update_column(:shipment_total, 0)

    # Manually publish update event since update_column bypasses callbacks
    publish_event('order.updated')

    restart_checkout_flow
  end
end

#finalize! ⇒ Object

Finalizes an in progress order after checkout is complete. Called after transition to complete state when payments will have been processed



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'app/models/spree/order.rb', line 663

def finalize!
  # lock all adjustments (coupon promotions, etc.)
  all_adjustments.each(&:close)

  # update payment and shipment(s) states, and save
  updater.update_payment_state
  shipments.each do |shipment|
    shipment.update!(self)
    shipment.finalize!
  end

  updater.update_shipment_state
  self.status = 'placed'
  save!
  updater.run_hooks

  touch :completed_at

  send_order_placed_webhook

  consider_risk

  publish_order_completed_event
end

#find_line_item_by_variant(variant, options = {}) ⇒ Object 



574
575
576
577
578
579
 
# File 'app/models/spree/order.rb', line 574

def find_line_item_by_variant(variant, options = {})
  line_items.detect do |line_item|
    line_item.variant_id == variant.id &&
      Spree.cart_compare_line_items_service.new.call(order: self, line_item: line_item, options: options).value
  end
end

#fulfill! ⇒ Object 



688
689
690
691
692
 
# File 'app/models/spree/order.rb', line 688

def fulfill!
  shipments.each { |shipment| shipment.update!(self) if shipment.persisted? }
  updater.update_shipment_state
  save!
end

#full_name ⇒ Object 



621
622
623
624
625
626
627
 
# File 'app/models/spree/order.rb', line 621

def full_name
  @full_name ||= if user.present? && user.name.present?
                   user.full_name
                 else
                   billing_address&.full_name || email
                 end
end

#fully_discounted? ⇒ Boolean Also known as: fully_discounted

determines whether the inventory is fully discounted

Returns

  • true if inventory amount is the exact negative of inventory related adjustments
  • false otherwise

Returns:



1008
1009
1010
 
# File 'app/models/spree/order.rb', line 1008

def fully_discounted?
  adjustment_total + line_items.map(&:final_amount).sum == 0.0
end

#fully_shipped? ⇒ Boolean

Returns:



787
788
789
 
# File 'app/models/spree/order.rb', line 787

def fully_shipped?
  shipments.shipped.size == shipments.size
end

#guest_checkout_disallowed? ⇒ Boolean

Returns true when this order has no registered user and its channel forbids guest checkout (see Spree::Channel::Gating). Enforced by the checkout completion service and the v3 Store API so every completion path (controller, payment webhook) is covered.

A prices_hidden channel also disallows guest completion regardless of the guest_checkout flag — prices are withheld from guests, and a buyer who cannot see prices cannot meaningfully place an order. This dissolves the otherwise contradictory "prices hidden but guests may buy" config.

Returns:

  • (Boolean) —

    true when this order has no registered user and its channel forbids guest checkout (see Spree::Channel::Gating). Enforced by the checkout completion service and the v3 Store API so every completion path (controller, payment webhook) is covered.

    A prices_hidden channel also disallows guest completion regardless of the guest_checkout flag — prices are withheld from guests, and a buyer who cannot see prices cannot meaningfully place an order. This dissolves the otherwise contradictory "prices hidden but guests may buy" config.



535
536
537
538
539
540
541
 
# File 'app/models/spree/order.rb', line 535

def guest_checkout_disallowed?
  return false if user_id.present?
  return false if channel.blank?
  return true if channel.storefront_prices_hidden?

  !channel.resolved_guest_checkout
end

#has_free_shipping? ⇒ Boolean

Returns:



1048
1049
1050
1051
1052
1053
 
# File 'app/models/spree/order.rb', line 1048

def has_free_shipping?
  shipment_adjustments.
    joins(:promotion_action).
    where(spree_adjustments: { eligible: true, source_type: 'Spree::PromotionAction' },
          spree_promotion_actions: { type: 'Spree::Promotion::Actions::FreeShipping' }).exists?
end

#has_non_reimbursement_related_refunds? ⇒ Boolean

Returns:



990
991
992
993
 
# File 'app/models/spree/order.rb', line 990

def has_non_reimbursement_related_refunds?
  refunds.non_reimbursement.exists? ||
    payments.offset_payment.exists? # how old versions of spree stored refunds
end

#has_step?(step) ⇒ Boolean

Returns:



747
748
749
 
# File 'app/models/spree/order.rb', line 747

def has_step?(step)
  checkout_steps.include?(step)
end

#in_checkout? ⇒ Boolean

True when the order is mid-checkout: past the cart state but not yet completed or canceled. Used by stock reservation hooks and any flow that should only run during the active checkout phase.

Returns:



396
397
398
 
# File 'app/models/spree/order.rb', line 396

def in_checkout?
  !cart? && !complete? && !canceled?
end

#inferred_preferred_stock_location_id ⇒ Integer?

Cascade for the preferred_location rule kind. Channel and B2B sources are layered in by their respective plans.

Returns:

  • (Integer, nil) 


829
830
831
832
 
# File 'app/models/spree/order.rb', line 829

def inferred_preferred_stock_location_id
  preferred_stock_location_id.presence ||
    created_by&.try(:preferred_stock_location_id)
end

#insufficient_stock_lines ⇒ Object 



709
710
711
 
# File 'app/models/spree/order.rb', line 709

def insufficient_stock_lines
  line_items.select(&:insufficient_stock?)
end

#is_risky? ⇒ Boolean

Returns:



923
924
925
 
# File 'app/models/spree/order.rb', line 923

def is_risky?
  !payments.risky.empty?
end

#line_items_without_shipping_rates ⇒ Array<Spree::LineItem>

Returns line items that have no shipping rates

Returns:



845
846
847
848
849
 
# File 'app/models/spree/order.rb', line 845

def line_items_without_shipping_rates
  @line_items_without_shipping_rates ||= shipments.map do |shipment|
    shipment.manifest.map(&:line_item) if shipment.shipping_rates.blank?
  end.flatten.compact
end

#log_state_changes(state_name:, old_state:, new_state:) ⇒ Object 



762
763
764
765
766
767
768
769
 
# File 'app/models/spree/order.rb', line 762

def log_state_changes(state_name:, old_state:, new_state:)
  state_changes.create(
    previous_state: old_state,
    next_state: new_state,
    name: state_name,
    user_id: user_id
  )
end

#merger ⇒ Object 



507
508
509
 
# File 'app/models/spree/order.rb', line 507

def merger
  @merger ||= Spree::OrderMerger.new(self)
end

#name ⇒ Object 



615
616
617
618
619
 
# File 'app/models/spree/order.rb', line 615

def name
  if (address = bill_address || ship_address)
    address.full_name
  end
end

#order_level_promo_total ⇒ BigDecimal

Sum of the eligible promotion adjustments applied to the order itself (whole-order discounts created by Promotion::Actions::CreateAdjustment), as opposed to promotions applied to individual line items or shipments. Zero or negative.

Returns:

  • (BigDecimal) 


369
370
371
 
# File 'app/models/spree/order.rb', line 369

def order_level_promo_total
  adjustments.promotion.eligible.sum(:amount)
end

#order_refunded? ⇒ Boolean

Checks if the order is fully refunded

Returns:



410
411
412
413
414
415
 
# File 'app/models/spree/order.rb', line 410

def order_refunded?
  return false if item_count.zero?
  return false if refunds_total.zero?

  payment_state.in?(%w[void failed]) || refunds_total == total_minus_store_credits - additional_tax_total.abs
end

#order_routing_strategy ⇒ Spree::OrderRouting::Strategy::Base

Resolves the routing strategy from the channel override first, then the store default. Only a registered Spree::OrderRouting::Strategy::Base subclass is used; any other value (an unregistered/typo'd class, or a strategy that was unregistered after being persisted) is logged and skipped rather than raised, falling back to the default Rules strategy so a misconfiguration can't take down cart display or checkout.

Returns:



817
818
819
820
821
822
823
 
# File 'app/models/spree/order.rb', line 817

def order_routing_strategy
  klass = valid_order_routing_strategy_class(channel&.preferred_order_routing_strategy) ||
          valid_order_routing_strategy_class(store.preferred_order_routing_strategy) ||
          Spree::OrderRouting::Strategy::Rules

  klass.new(order: self)
end

#outstanding_balance ⇒ Object 



599
600
601
602
603
604
605
 
# File 'app/models/spree/order.rb', line 599

def outstanding_balance
  if canceled?
    -1 * payment_total
  else
    total - (payment_total + reimbursement_paid_total)
  end
end

#outstanding_balance? ⇒ Boolean

Returns:



611
612
613
 
# File 'app/models/spree/order.rb', line 611

def outstanding_balance?
  outstanding_balance != 0
end

#paid? ⇒ Boolean

Helper methods for checkout steps

Returns:



695
696
697
 
# File 'app/models/spree/order.rb', line 695

def paid?
  payments.valid.completed.size == payments.valid.size && payments.valid.sum(:amount) >= total
end

#partially_refunded? ⇒ Boolean

Checks if the order is partially refunded

Returns:



423
424
425
426
427
428
 
# File 'app/models/spree/order.rb', line 423

def partially_refunded?
  return false if item_count.zero?
  return false if payment_state.in?(%w[void failed]) || refunds.empty?

  refunds_total < total_minus_store_credits - additional_tax_total.abs
end

#payment_method ⇒ Spree::PaymentMethod

Returns the payment method for the order

Returns:



632
633
634
 
# File 'app/models/spree/order.rb', line 632

def payment_method
  payments.valid.not_store_credits.first&.payment_method
end

#payment_methods ⇒ Object 



699
700
701
 
# File 'app/models/spree/order.rb', line 699

def payment_methods
  @payment_methods ||= store.payment_methods.active.available_on_front_end.select { |pm| pm.available_for_order?(self) }
end

#payment_required? ⇒ Boolean

Is this a free order in which case the payment step should be skipped

Returns:



444
445
446
 
# File 'app/models/spree/order.rb', line 444

def payment_required?
  total.to_f > 0.0
end

#payment_source ⇒ Spree::PaymentSource

Returns the payment source for the order

Returns:



639
640
641
 
# File 'app/models/spree/order.rb', line 639

def payment_source
  payments.valid.not_store_credits.first&.source
end

#placed? ⇒ Boolean

Returns:



404
405
406
 
# File 'app/models/spree/order.rb', line 404

def placed?
  status == 'placed'
end

#pre_tax_item_amount ⇒ Object

Sum of all line item amounts pre-tax



359
360
361
 
# File 'app/models/spree/order.rb', line 359

def pre_tax_item_amount
  line_items.sum(:pre_tax_amount)
end

#pre_tax_total ⇒ Object

Sum of all line item and shipment pre-tax



374
375
376
 
# File 'app/models/spree/order.rb', line 374

def pre_tax_total
  pre_tax_item_amount + shipments.sum(:pre_tax_amount)
end

#promo_code ⇒ Object 



1013
1014
1015
 
# File 'app/models/spree/order.rb', line 1013

def promo_code
  Spree::CouponCode.find_by(order: self, promotion: promotions).try(:code) || promotions.pluck(:code).compact.first
end

#quantity ⇒ Object 



986
987
988
 
# File 'app/models/spree/order.rb', line 986

def quantity
  line_items.sum(:quantity)
end

#quantity_of(variant, options = {}) ⇒ Object 



569
570
571
572
 
# File 'app/models/spree/order.rb', line 569

def quantity_of(variant, options = {})
  line_item = find_line_item_by_variant(variant, options)
  line_item ? line_item.quantity : 0
end

#quick_checkout? ⇒ Boolean

Check if the shipping address is a quick checkout address quick checkout addresses are incomplete as wallet providers like Apple Pay and Google Pay do not provide all the address fields until the checkout is completed (confirmed) on their side

Returns:



470
471
472
 
# File 'app/models/spree/order.rb', line 470

def quick_checkout?
  shipping_address.present? && shipping_address.quick_checkout?
end

#quick_checkout_available? ⇒ Boolean

Check if quick checkout is available for this order Either fully digital or not digital at all

Returns:



477
478
479
 
# File 'app/models/spree/order.rb', line 477

def quick_checkout_available?
  payment_required? && shipments.count <= 1 && (digital? || !some_digital? || !delivery_required?)
end

#quick_checkout_require_address? ⇒ Boolean

Check if quick checkout requires an address collection If the order is digital or not delivery required, then we don't need to collect an address

Returns:



484
485
486
 
# File 'app/models/spree/order.rb', line 484

def quick_checkout_require_address?
  !digital? && delivery_required?
end

#refresh_shipment_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END) ⇒ Object 



899
900
901
 
# File 'app/models/spree/order.rb', line 899

def refresh_shipment_rates(shipping_method_filter = ShippingMethod::DISPLAY_ON_FRONT_END)
  shipments.map { |s| s.refresh_rates(shipping_method_filter) }
end

#refunds_total ⇒ Object 



417
418
419
 
# File 'app/models/spree/order.rb', line 417

def refunds_total
  refunds.loaded? ? refunds.sum(&:amount) : refunds.sum(:amount)
end

#reimbursement_paid_total ⇒ Object 



607
608
609
 
# File 'app/models/spree/order.rb', line 607

def reimbursement_paid_total
  reimbursements.sum(&:paid_amount)
end

#remove_out_of_stock_items! ⇒ Object

Removes out-of-stock/discontinued items and populates warnings. Returns self (reloaded if items were removed) with warnings set. Captured before the call because removing items reloads the order, which would drop warnings already recorded upstream.



72
73
74
75
76
77
78
79
80
 
# File 'app/models/spree/order.rb', line 72

def remove_out_of_stock_items!
  existing_warnings = warnings
  result = Spree::Cart::RemoveOutOfStockItems.call(order: self)
  return self unless result.success?

  order, _messages, new_warnings = result.value
  order.warnings = existing_warnings | (new_warnings || [])
  order
end

#requires_ship_address? ⇒ Boolean

Returns:



1071
1072
1073
 
# File 'app/models/spree/order.rb', line 1071

def requires_ship_address?
  !digital?
end

#restart_checkout_flow ⇒ Object 



887
888
889
890
891
892
893
894
895
896
897
 
# File 'app/models/spree/order.rb', line 887

def restart_checkout_flow
  update_columns(
    state: 'cart',
    updated_at: Time.current
  )

  # Manually publish update event since update_columns bypasses callbacks
  publish_event('order.updated')

  next! unless line_items.empty?
end

#set_shipments_cost ⇒ Object 



907
908
909
910
911
912
 
# File 'app/models/spree/order.rb', line 907

def set_shipments_cost
  shipments.each(&:update_amounts)
  updater.update_shipment_total
  updater.update_adjustment_total
  persist_totals
end

#shipped? ⇒ Boolean

Returns:



783
784
785
 
# File 'app/models/spree/order.rb', line 783

def shipped?
  %w(partial shipped).include?(shipment_state)
end

#shipping_discount ⇒ Object 



385
386
387
 
# File 'app/models/spree/order.rb', line 385

def shipping_discount
  shipment_adjustments.non_tax.eligible.sum(:amount) * - 1
end

#shipping_eq_billing_address? ⇒ Boolean

Returns:



903
904
905
 
# File 'app/models/spree/order.rb', line 903

def shipping_eq_billing_address?
  bill_address == ship_address
end

#shipping_method ⇒ Object 



914
915
916
917
918
919
920
921
 
# File 'app/models/spree/order.rb', line 914

def shipping_method
  # This query will select the first available shipping method from the shipments.
  # It will use subquery to first select the shipping method id from the shipments' selected_shipping_rate.
  Spree::ShippingMethod.
    where(id: shipments.with_selected_shipping_method.limit(1).pluck(:shipping_method_id)).
    limit(1).
    first
end

#state_changed(name) ⇒ Object 



751
752
753
754
755
756
757
758
759
760
 
# File 'app/models/spree/order.rb', line 751

def state_changed(name)
  state = "#{name}_state"
  if persisted?
    old_state = send("#{state}_was")
    new_state = send(state)
    unless old_state == new_state
      log_state_changes(state_name: name, old_state: old_state, new_state: new_state)
    end
  end
end

#tags=(tags) ⇒ Object 



142
143
144
 
# File 'app/models/spree/order.rb', line 142

def tags=(tags)
  self.tag_list = tags
end

#tax_address ⇒ Object

Returns the address for taxation based on configuration



495
496
497
 
# File 'app/models/spree/order.rb', line 495

def tax_address
  Spree::Config[:tax_using_ship_address] ? ship_address : bill_address
end

#tax_total ⇒ Object 



982
983
984
 
# File 'app/models/spree/order.rb', line 982

def tax_total
  included_tax_total + additional_tax_total
end

#tax_zone ⇒ Object

Returns the relevant zone (if any) to be used for taxation purposes. Uses default tax zone unless there is a specific match



490
491
492
 
# File 'app/models/spree/order.rb', line 490

def tax_zone
  @tax_zone ||= Zone.match(tax_address) || Zone.default_tax
end

#to_csv(_store = nil) ⇒ Object 



1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
 
# File 'app/models/spree/order.rb', line 1055

def to_csv(_store = nil)
  metafields_for_csv ||= Spree::MetafieldDefinition.for_resource_type('Spree::Order').order(:namespace, :key).map do |mf_def|
    metafields.find { |mf| mf.metafield_definition_id == mf_def.id }&.csv_value
  end

  csv_lines = []
  all_line_items.each_with_index do |line_item, index|
    csv_lines << Spree::CSV::OrderLineItemPresenter.new(self, line_item, index, metafields_for_csv).call
  end
  csv_lines
end

#total_weight ⇒ BigDecimal

Returns the total weight of the inventory units in the order This is used to calculate the shipping rates for the order

Returns:

  • (BigDecimal) —

    the total weight of the inventory units in the order



838
839
840
 
# File 'app/models/spree/order.rb', line 838

def total_weight
  @total_weight ||= line_items.joins(:variant).includes(:variant).map(&:item_weight).sum
end

#uneditable? ⇒ Boolean

Returns:



657
658
659
 
# File 'app/models/spree/order.rb', line 657

def uneditable?
  complete? || canceled? || returned?
end

#update_line_item_prices! ⇒ Object 



592
593
594
595
596
597
 
# File 'app/models/spree/order.rb', line 592

def update_line_item_prices!
  transaction do
    line_items.reload.each(&:update_price)
    save!
  end
end

#update_with_updater! ⇒ Object 



503
504
505
 
# File 'app/models/spree/order.rb', line 503

def update_with_updater!
  updater.update
end

#updater ⇒ Object 



499
500
501
 
# File 'app/models/spree/order.rb', line 499

def updater
  @updater ||= Spree.order_updater.new(self)
end

#use_all_coupon_codes ⇒ Object 



743
744
745
 
# File 'app/models/spree/order.rb', line 743

def use_all_coupon_codes
  Spree::CouponCodes::CouponCodesHandler.new(order: self).use_all_codes
end

#valid_coupon_promotions ⇒ Array<Spree::Promotion>

Returns the valid coupon promotions for the order

Returns:



1033
1034
1035
1036
1037
 
# File 'app/models/spree/order.rb', line 1033

def valid_coupon_promotions
  promotions.
    where(id: valid_promotion_ids).
    coupons
end

#valid_promotion_ids ⇒ Array<Integer>

Returns the IDs of the valid promotions for the order

Returns:

  • (Array<Integer>) 


1025
1026
1027
1028
1029
 
# File 'app/models/spree/order.rb', line 1025

def valid_promotion_ids
  all_adjustments.eligible.nonzero.promotion.promotion.eligible.nonzero.promotion.
    joins("INNER JOIN #{Spree::PromotionAction.table_name} ON #{Spree::PromotionAction.table_name}.id = #{Spree::Adjustment.table_name}.source_id").
    pluck("#{Spree::PromotionAction.table_name}.promotion_id").compact.uniq
end

#valid_promotions ⇒ Array<Spree::OrderPromotion>

Returns the valid promotions for the order

Returns:



1019
1020
1021
 
# File 'app/models/spree/order.rb', line 1019

def valid_promotions
  order_promotions.includes(:promotion).where(promotion_id: valid_promotion_ids).uniq(&:promotion_id)
end