Skip to content
WooCommerce & WordPress Plugin Docs

Getting started

Shiplume ships enabled, with the threshold set to read from WooCommerce automatically. For most shops the only setup is confirming where the bar appears.

Before you start

Section titled “Before you start”
  • WordPress 6.5 or newer
  • WooCommerce 8.0 or newer (HPOS compatible; the bar shows on the classic cart and checkout, not on the Cart/Checkout blocks)
  • PHP 8.1 or newer

A configured free-shipping method helps Automatic mode but is not required, Shiplume falls back to a manual amount when it finds none.

Install

Section titled “Install”
  1. Install WooCommerce and make sure it is active. Shiplume shows an admin notice and stays inactive while WooCommerce is missing.
  2. Install Shiplume from the WordPress.org plugin directory (Plugins > Add New, search “Shiplume”) or upload the shiplume folder to /wp-content/plugins/.
  3. Activate the plugin.

There is no wizard. Shiplume does not create any database table on activation, it stores its configuration in two options (nudge_settings and nudge_db_version).

First configuration

Section titled “First configuration”

Open WooCommerce > Shiplume in wp-admin. The screen has three sections:

  • General, Enable Shiplume (the master switch), plus Cart page and Checkout page toggles for where the bar shows. All three are on by default.
  • Free-shipping threshold, Threshold source (Automatic or Manual) and a Manual amount (default 50) used when the source is Manual or as the fallback for Automatic.
  • Messages, the Progress message (with the {amount} token) and the Success message. A live preview under each field shows the wording with a sample amount.

Changes save with the standard Save Changes button. No cache clearing is needed.

Verify on the storefront

Section titled “Verify on the storefront”
  1. Add a product and open the Cart, the bar should show the remaining amount to free shipping above the totals.
  2. Add or remove items, after WooCommerce recalculates, the bar should re-render with a new width and animate toward the goal.
  3. Cross the threshold, the bar fills completely and switches to the success message.
  4. Empty the cart, or have no free-shipping goal configured, the bar should disappear entirely rather than show a broken or always-complete state.

If the bar does not appear

Section titled “If the bar does not appear”
  • Confirm Enable Shiplume is on and the relevant page toggle (Cart or Checkout) is ticked. When the bar is disabled, no Shiplume styles or scripts load on the front end at all.
  • In Automatic mode, confirm you have an enabled free-shipping method whose requirement is A minimum order amount (or …or a coupon / …and a coupon) with a non-zero amount. A coupon-only requirement exposes no amount to count down to, so it is ignored.
  • If you have no such method, set the source to Manual and enter an amount.

Free vs Pro

Section titled “Free vs Pro”

The free edition covers everything documented here: automatic or manual threshold, cart and checkout placement, editable messages and themeable colours.

Shiplume Pro adds a floating mini-cart bar, per-zone thresholds, tiered rewards and conversion analytics while keeping the free progress bar intact.

Need help?

Section titled “Need help?”