While shipping method filters occur automatically, your store may require additional shipping method filtering.
Shipping methods are automatically filtered by zone. This means that once the customer provides a shipping address during checkout, the shipping methods that the customer can choose from are limited to the shipping methods available in their region.
For example, if your store does not have a zone that includes the United Kingdom, then a customer cannot complete the checkout process if their shipping address is within the United Kingdom.
available? method returns
true by default.
You can see the
shipping_methods being filtered out in the
Spree::Stock::Estimator class below:
class Spree::Stock::Estimator def shipping_methods(package) shipping_methods = package.shipping_methods shipping_methods.delete_if do |ship_method| !ship_method.calculator.available?(package.contents) end shipping_methods.delete_if do |ship_method| !ship_method.include?(order.ship_address) end shipping_methods.delete_if do |ship_method| !(ship_method.calculator.preferences[:currency].nil? || ship_method.calculator.preferences[:currency] == currency) end shipping_methods end end
Consider a custom "USPS Bogus First Class International" delivery service. This service is only available if the shipment weighs less than 10lbs.
We want to ensure that "USPS Bogus First Class International" shipping is not
available when orders weigh more than 10lbs. So, we want to set our shipping
available? method to return
false if the collective weight of
an order's line items are greater than 10lbs:
class Calculator::Usps::FirstClassMailParcels < Calculator::Usps::Base def self.description "USPS Bogus First Class International" end def available?(package) multiplier = 1.3 weight = order.line_items.inject(0) do |weight, line_item| line_item_weight = line_item.variant.weight weight + (line_item_weight ? (line_item.quantity * line_item_weight * multiplier) : 0) end # If weight in oz > 13, then "USPS Bogus First Class International" is not # available for the order weight > 13 ? false : true end end
Solidus is an open source platform supported by the community. We encourage everyone using Solidus to contribute back to the documentation and the code.
If you’re interested in contributing to the docs, get started with the contributing guidelines. If you see something that needs fixing and can’t do it yourself, please send us an email.