Free Shipping Script

Shopify Plus Only

This is an advanced guide meant for developers that not is supported by the Inveterate team. You should ensure you have the appropriate development resources to implement before proceeding.

Only one shipping script can be active at a time. If you already have a shipping script running and you want to run this script in tandem, this will not work. You'll need to customize the scripts to work together.

Shipping scripts are incompatible with split shipping in Shopify Checkout. If you use Shipping scripts and activate split shipping, then split shipments aren't displayed to your customers at checkout.

Where "Buy with Prime" requires split shipping to be activated, the Free Shipping script causes the "Buy with Prime" button to be removed from checkout.

This guide requires the Shopify Script Editor app.

By default we utilize discount codes to provide free shipping to subscribers. Due to Shopify's limitation, only allowing 1 discount code to be used at checkout, this is not always the most desirable solution. A more robust solution is to utilize the Shopify Script Editor app to create a free shipping script. This will allow your customers to utilize any current discount codes your providing as well as take advantage of their free shipping benefit at the same time.

Editable Values

• MESSAGE - {string} The message that will be displayed next to discounted shipping items.

• MINIMUM_PURCHASE_AMOUNT - {number | nil} The amount a customer must purchase before this discount is applied. Measured in dollars. Set to nil to remove this check.

• MINIMUM_QUANTITY_ITEMS - {number | nil} The amount of items that must be in cart before this discount is applied. Set to nil to remove this check.

• MAXIMUM_SHIPPING_PRICE - {number | nil} The maximum amount a shipping item can cost to allow this discount to apply. Set to nil to remove this check.

• PRODUCT_ID_LIST - {array[number]} An array of product IDs that must be in cart to get the discount. All items in cart must be represented in the array for the discount to apply. If left empty, discount will apply to all products.

• COUNTRY_CODE_LIST - {array[string]} An array of ISO 3166-1 alpha-2 country code designators that the shipping address must match to receive the discount. If left empty, discount will apply to all countries.

Script

# Editable Values
MESSAGE = "Free shipping for members!"
MINIMUM_PURCHASE_AMOUNT = nil
MINIMUM_QUANTITY_ITEMS = nil
MAXIMUM_SHIPPING_PRICE = nil
PRODUCT_ID_LIST = []
COUNTRY_CODE_LIST = []

########
# DO NOT EDIT PAST THIS POINT
########

class InveterateFreeShipping 
  def initialize()
    @percent_off = 100 * 0.01
    @message = MESSAGE
    @minimum_purchase_amount = MINIMUM_PURCHASE_AMOUNT
    @minimum_quantity_items = MINIMUM_QUANTITY_ITEMS
    @maximum_shipping_price = MAXIMUM_SHIPPING_PRICE
    @product_id_list = PRODUCT_ID_LIST
    @country_code_list = COUNTRY_CODE_LIST
  end

  def run(shipping_rates, cart)
    @shipping_rates = shipping_rates
    @cart = cart
    start
  end

  private

  def check_purchase_amount
    return true unless @minimum_purchase_amount
    min_price = Money.derived_from_presentment(customer_cents:@minimum_purchase_amount)
    return @cart.subtotal_price > min_price
  end

  def check_item_quantity
    return true unless @minimum_quantity_items
    return @cart.line_items.size >= @minimum_quantity_items
  end

  def check_max_shipping_price(shipping_rate)
    return true unless @maximum_shipping_price
    max_shipping_price = Money.derived_from_presentment(customer_cents: @maximum_shipping_price)
    return shipping_rate.price <= max_shipping_price
  end

  def check_product_ids
    return true unless @product_id_list.size > 0
    line_item_ids = @cart.line_items.map do |line_item|
      line_item.variant.product.id
    end
    reduced_array = line_item_ids - @product_id_list
    return true unless reduced_array.size > 0
  end

  def check_countries
    return true unless @country_code_list.size > 0
    return @country_code_list.include? @cart.shipping_address.country_code
  end
  
  def start
    return unless @cart.customer
    return unless @cart.customer.tags.include? "inveterate-subscriber"
    return unless check_purchase_amount
    return unless check_item_quantity
    return unless check_product_ids
    return unless check_countries
    
    @shipping_rates.each do |shipping_rate|
      return unless check_max_shipping_price(shipping_rate)

      shipping_rate.apply_discount(
        shipping_rate.price * @percent_off,
        message: @message
      )
    end
  end
end

CAMPAIGNS = [
  InveterateFreeShipping.new()
]

CAMPAIGNS.each do |campaign|
  campaign.run(Input.shipping_rates, Input.cart)
end

Output.shipping_rates = Input.shipping_rates