VibeFox Omniva for WooCommerce — Help

Requirements

WordPress: 5.8 or later.

WooCommerce: 7.0 or later, installed and active. The plugin refuses to activate without it.

PHP: 8.0 or later.

Omniva: no API account is needed. Omniva has no public price API. The Omniva OMX API is available only to contract customers and is not used by this plugin, so you enter your own (contract) prices. Register the parcels in your Omniva business account.

Parcel machine list: the plugin downloads the open Omniva locations file from omniva.ee (no key or contract needed). Your server must be able to make outgoing HTTPS requests to www.omniva.ee.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

1. In WordPress go to Plugins > Add New > Upload Plugin, choose the plugin ZIP file and click Install Now. You can also upload the vfd_omniva folder to /wp-content/plugins/ by FTP.

2. Click Activate.

3. Open the settings: WooCommerce > Settings > Shipping > VibeFox Omniva, or click Settings under the plugin name on the Plugins page.

4. Enter your VibeFox license key in the license block at the top of the page and click Activate (see License key).

5. Check the prices by country and parcel size, the parcel sizes and the Parcel machine list status line.

6. Add VibeFox Omniva to your Estonia, Latvia and/or Lithuania zone in WooCommerce > Settings > Shipping > Shipping zones, or turn on Ignore shipping zones and choose countries.

Configuration

All settings are on one page: WooCommerce > Settings > Shipping > VibeFox Omniva. They apply to every shipping zone. When you add the method to a zone, the zone window has only one field:

Title (zone): the name customers see for this zone. Leave it empty to use the global Method title.

At the top of the page, notices show problems. A red notice appears when no price is set or when the parcel machine list could not be downloaded and there is no stored copy, because then the method is not shown at checkout. A yellow notice appears when the list could not be updated right now and the stored copy is used. Numbers that cannot be read are reported after saving and are not saved.

General

Enable/Disable: turns Omniva on or off in all zones at once.

Method title: the shipping method name shown to customers. The Title of a zone method overrides it. Default: Omniva parcel machine.

Tax status: Taxable adds WooCommerce tax to the shipping cost, None does not.

Prices (in your store currency; decimals may be written as 3.50 or 3,50)

Price by parcel size: one row each for Estonia, Latvia and Lithuania, with the columns S, M, L, XL and Free from. Enter the price of each Omniva parcel size for the destination country. An empty cell means this size is not offered for the country: the method is hidden when the parcel needs it. 0 means free. Free from is the cart total (after discounts, as displayed in the cart) from which delivery to this country is free; leave it empty for no free shipping. Until you save your own prices, the table starts with 3.50 for Estonia and 4.00 for Latvia and Lithuania. When WooCommerce taxes are on, a small -% button next to each price removes the VAT of your store country from the entered price (for prices you know including VAT).

Calculation: how the parcel size and the price are found.

Per order (all items packed in one parcel): the items are stacked on their smallest side and the smallest parcel size that fits the whole stack is charged once. This is the default.

Per item (each item unit is a separate parcel): every unit is priced by its own parcel size and the prices are added up.

Parcel sizes (cm): the maximum dimensions of each size, as Smallest side, Middle side and Largest side. Product dimensions are sorted the same way and compared side by side; values are sorted when saved. Product dimensions are converted from the store unit to cm. Products without dimensions fit size S. When nothing fits, the method is hidden. Defaults: S 9 x 38 x 64, M 19 x 38 x 64, L 38 x 39 x 64, XL 39 x 64 x 64. Check them against the current Omniva parcel sizes.

Availability

Minimum weight (kg): hide the method when the cart is lighter. Empty or 0 means no limit.

Maximum weight (kg): hide the method when the cart (or, with Per item, one item) is heavier. Omniva parcel machines accept parcels up to 30 kg. Default: 30. 0 means no limit. The store weight unit is converted to kg.

Minimum cart total: show the method only from this cart total. Leave empty to always show it.

Excluded shipping classes: hide the method when the cart contains products of these WooCommerce shipping classes.

Ignore shipping zones: offer Omniva for the countries below without adding it to a zone. When it is off, the countries are defined by the shipping zones where the method is added. This is recommended.

Countries (without zones): the destination countries for that mode. This field is used only when Ignore shipping zones is on. Leave it empty for all shipping countries. In any mode Omniva is offered only where it has parcel machines: Estonia, Latvia and Lithuania.

Parcel machines

Post offices: also offer Omniva post offices in the same list. Omniva lists post offices for Estonia. Off by default.

City order: show the largest cities first (Tallinn, Riga, Vilnius and others), then the rest alphabetically. On by default. When off, cities are sorted alphabetically.

Parcel machine list: a status line with the number of parcel machines per country (and post offices, if enabled) and the time of the last download from omniva.ee. Click Update the list now to download the list immediately; if omniva.ee does not answer, the stored copy is kept.

Advanced

Debug log: logs price calculation and parcel machine list details to WooCommerce > Status > Logs (source vfd-omniva). Errors, such as an unavailable parcel machine list, are always logged. No customer data is logged.

Remove data on uninstall: when on, deleting the plugin removes the settings, zone methods and the stored parcel machine list. Deactivating the plugin never deletes settings. The parcel machine saved in orders is kept.

How it works at checkout

When the customer enters a delivery address in Estonia, Latvia or Lithuania, WooCommerce asks the plugin for a rate. The plugin checks the cart weight, the minimum cart total and the excluded shipping classes, then finds the parcel size from the product dimensions. If the parcel fits no size, or the size has no price for the country, or no parcel machine is available, the method is hidden, so the customer never sees a checkout that cannot be completed. If the cart total reaches Free from of the country, the price is 0. The parcel size is saved on the shipping line of the order as Omniva parcel size.

The parcel machine list is downloaded from omniva.ee once a day and stored in the WordPress database, not in the plugin folder. If the download fails, the stored copy keeps working and the next attempt is made after 15 minutes, so the checkout does not wait for omniva.ee on every refresh. The download timeout is 15 seconds.

The method works on the classic checkout and on the Cart and Checkout blocks. It is compatible with WooCommerce High-Performance Order Storage (HPOS). Prices are in your store currency. The plugin does not convert currencies.

The plugin does not request Omniva prices, register shipments, print labels, call a courier or track parcels. Register the parcels in your Omniva business account. Courier (door-to-door) delivery is not part of this method.

Pickup points

When the customer selects Omniva, two lists appear under the method: -- Select city -- and -- Select parcel machine --. Only cities and parcel machines of the delivery country are shown; when the customer changes the country, the lists change too. In Estonia the cities are counties, with Tallinn, Tartu and Pärnu listed separately; in Latvia and Lithuania they are cities and municipalities. The city of the shipping address is pre-selected when it matches a city in the list. Each parcel machine is shown with its name and address. The choice is remembered during the checkout, so it is not lost when the checkout refreshes.

A parcel machine is required. In the classic checkout the customer sees Please select an Omniva parcel machine. In the block checkout Place order is blocked until a parcel machine is chosen. In both checkouts the server checks the parcel machine against the list again, so a forged ID or a parcel machine of another country is refused.

The parcel machine ID, name, city and country are saved in the order. They are shown on the order screen under the shipping address (with the parcel machine ID), on the order received page, in My account > Orders and in the order e-mails (HTML and plain text) as Omniva parcel machine.

To change the parcel machine of an order, open the order in WooCommerce > Orders, click Change next to the parcel machine, choose a city and a parcel machine of the order's delivery country and click Save parcel machine. An order note records the old and the new parcel machine.

License key

The plugin works with a VibeFox license key from vibefox.net. The license block is at the top of WooCommerce > Settings > Shipping > VibeFox Omniva. Paste the key into License key and click Activate. The block shows the status, for example the date the license is active until and your domain. Use Check now to check the status again, Change key to enter another key and Remove key to remove it from this site. The link Manage licenses and domains in your account opens your vibefox.net account.

One key works on one domain. Removing the key from a site does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, Omniva is not shown to customers at checkout. Logged-in store managers still see it, marked (unlicensed — visible to admins only), so you can set up and test the plugin before you buy a key. A reminder appears on the Plugins page and on WooCommerce pages. Existing orders are not affected.

When a license expires, the plugin keeps working, but updates and support need a renewal. The status is checked again automatically in the background.

Troubleshooting

Omniva does not appear at checkout: check that the license is active, Enable/Disable is on, the delivery country is Estonia, Latvia or Lithuania, and the method is added to the zone of the customer's country (or Ignore shipping zones is on and the country is allowed). Open the settings page: a red notice explains if no price is set or no parcel machine list is available. Also check the product dimensions (a parcel larger than the XL size, or a size with an empty price cell, hides the method), the weight limits, Minimum cart total and Excluded shipping classes. With Debug log on, WooCommerce > Status > Logs (source vfd-omniva) shows why the method was hidden.

No parcel machines: the list could not be downloaded from omniva.ee and there is no stored copy. The plugin retries every 15 minutes. Click Update the list now; if it fails, check that your server can reach www.omniva.ee and see the error in WooCommerce > Status > Logs.

A new parcel machine is missing: the list is updated once a day. Click Update the list now to download it immediately.

The wrong price is charged: the price depends on the parcel size found from the product dimensions. Check the dimensions of the products, Calculation and Parcel sizes (cm). With Debug log on, the log shows the chosen size and price.

The customer cannot place the order: a parcel machine must be chosen. If the customer sees "The Omniva parcel machine list is temporarily unavailable", no parcel machines are available right now; see No parcel machines.

In which currency are the prices: in your store currency. The plugin does not convert currencies.

For developers: the filter vfd_omniva_locations_url changes the address of the locations file (CSV in the Omniva format), and vfd_omniva_countries changes the list of destination countries (default EE, LV, LT).

The license block shows an error: follow the message in the block. For example, if the key is already used on another domain, free a slot in your vibefox.net account and click Check now. If the site address changed, click Check now to activate the key for the new domain. If the license server cannot be reached, the plugin keeps working on the last known status.

Uninstall

Deactivating the plugin keeps all settings and the stored parcel machine list. To remove it, deactivate and delete it on the Plugins page. The license key and license status of this plugin and the caches are always removed. Settings, zone methods and the stored parcel machine list are removed only if Remove data on uninstall was on. Otherwise they stay for a later re-install. The parcel machine saved in orders is never deleted, and existing orders keep their shipping lines.

Omniva is a trademark of its respective owner. This plugin is not affiliated with or endorsed by Omniva.