VibeFox Packeta for OpenCart — Help

Requirements

OpenCart: 3.0.x (tested on 3.0.5.0) or 4.0.2 and later (tested on 4.1.0.3), with the default checkout of the default theme.

PHP: 8.0 or later.

Packeta API key: you find it in the Packeta client section (client.packeta.com) under Client support. It has 16 letters and digits. The widget needs it to open at checkout, so the method is shown to customers only after the API key is entered.

Countries: the Czech Republic, Slovakia, Hungary or Romania must be enabled countries of your store. They are in the standard OpenCart data. Hungary has no regions in OpenCart, so the region field of the address stays empty; this does not matter.

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

Installation

The download is one zip file with the packages for both OpenCart versions. Unpack it on your computer. It contains README.txt, the OpenCart 3 package vfd_packeta-oc3-(version).ocmod.zip and the OpenCart 4 package vfd_packeta.ocmod.zip. Install only the package for your OpenCart version. The license key is the same for both versions.

OpenCart 3

1. In the admin go to Extensions > Installer, click Upload and choose the file vfd_packeta-oc3-(version).ocmod.zip. The extension adds no OCMOD modifications, so you do not need to refresh Extensions > Modifications. Instead of the Installer, you can copy the contents of the upload folder of this package into the root folder of your store.

2. Go to Extensions > Extensions and choose the extension type Shipping. Find VibeFox Packeta and click Install (the green + button).

3. Click Edit (the pencil button) to open the settings page.

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

5. Enter your Packeta API key and your prices: at least one Country prices row (for example * Default) or a Fallback cost. Turn on Enable/Disable and click Save. The page shows whether Packeta accepted the key.

OpenCart 4

1. In the admin go to Extensions > Installer, click Upload and choose the file vfd_packeta.ocmod.zip. Do not rename the file: OpenCart 4 takes the extension code from the file name, and a renamed package does not work.

2. The package appears in the list of installed extensions on the same page. Click Install (the green + button) next to it.

3. Go to Extensions > Extensions and choose the extension type Shipping. Find VibeFox Packeta, click Install (the green + button), then Edit (the pencil button).

4. Enter the license key, the API key and the prices as in steps 4 and 5 for OpenCart 3. The settings page and its fields are the same in both versions.

After install the method is off until you turn on Enable/Disable and save. If you install the extension again after an uninstall, the Packeta settings you kept are used again.

Configuration

All settings are on the extension page: Extensions > Extensions > Shipping > VibeFox Packeta > Edit. The sections are listed on the left. One Save button at the bottom saves the whole page without reloading it. Only admin users with the modify permission for this extension can save the settings.

The method is offered only for the countries of the Packeta own pickup-point network: CZ, SK, HU and RO. Above the settings the page shows the result of the API key check and warnings about problems: no API key, no price, selected countries outside the Packeta network, or a store weight unit the extension does not know. The warnings are updated after every save.

All prices and limits accept a comma or a point as the decimal separator (4,99 or 4.99). An invalid or negative number is refused with a message, and the previous value of that field is kept; the other fields are saved.

General

Enable/Disable: turns Packeta at checkout on or off. Default: off.

Name: the shipping method name shown to the customer. Default: Packeta pickup point. Required, at most 64 characters.

API key: your Packeta API key from client.packeta.com > Client support. You may also paste the 32-character API password: only its first 16 characters, which are the API key, are saved. The API key is public: it is sent to the customer's browser to open the widget. When you save a new key, it is checked against the Packeta carrier feed, and the page shows Packeta API key verified or that Packeta rejected it. If the check cannot run, the key is saved and checked again the next time you save.

Widget language: the language of the pickup-point widget. Store / visitor language (default) follows the language of the page. You can also fix it to Czech, Slovak, Hungarian, Romanian, English, German, Polish or Ukrainian.

Pickup point types: which Packeta points the widget offers.

Tax status: the OpenCart tax class applied to the shipping price, or None (no tax on shipping) (default).

Sort order: the position of Packeta among the shipping methods at checkout. A whole number.

Prices

Packeta has no public rate API. Prices come from this table and are entered in your store default currency, tax excluded. Customers paying in another currency see the converted price.

Calculation type: Per order (default) charges the price once. Per item (price x quantity) multiplies it by the quantity of products that require shipping.

Country prices: a price per destination country and parcel weight. Click Add country to add a row and the × button to remove one. Each row has a Price and weight columns: XS up to 1 kg, S 1–2 kg, M 2–3 kg, L 3–5 kg and XL over 5 kg. A weight column left at 0 uses the Price column. The * Default row is used for countries without their own row. A new row starts as * Default with all prices at 0, which means free shipping. Choose the country and enter the prices before you save, or remove the row. If the same country (or * Default) is in two rows, only the first one is kept when you save. If a value in the table is not a number of 0 or more, the table is not saved and the page lists the wrong values.

Fallback cost: used when the country table has no row for the destination and no * Default row. Leave it empty to not offer the method there.

Free shipping from: the cart subtotal (after the coupon, without tax) from which Packeta delivery is free. It is checked before the price table: from this amount delivery is free in every Packeta country where the method is offered, even one without a country row or fallback cost. Leave it empty to never offer free shipping.

Availability

Minimum weight (kg): hide the method when the cart weighs less. Product weights are converted from their OpenCart weight classes. Empty or 0 means no limit.

Maximum weight (kg): hide the method when the cart weighs more. Default: 15. Packeta pickup points and Z-BOXes usually accept parcels up to 15 kg; check your Packeta contract. Empty or 0 means no limit. A minimum weight greater than the maximum is refused when you save, and both previous values are kept.

Minimum cart subtotal: offer the method only when the cart subtotal (after the coupon, without tax) reaches this amount.

Geo zone: offer Packeta only for addresses in this geo zone. All zones (default) means no limit. It is not checked when Ignore shipping zones is on. Geo zones are managed in System > Localisation > Geo Zones.

Ignore shipping zones: when on, the geo zone is not checked and the method is offered for the countries selected below. When off (default), it is offered only in the geo zone above.

Countries (ignore zones mode): the destination countries for that mode. Leave it empty to use all Packeta countries. Countries outside the Packeta pickup-point network are skipped. This field is used only when Ignore shipping zones is on.

Advanced

Debug log: writes rate calculations and pickup point choices to storage/logs/vfd_pckt_debug.log.php. The file cannot be read from the web. No customer personal data and no API key are logged. Errors and failed API key checks are always logged. Turn the log off when you are done. When the file reaches 5 MB, it is moved to vfd_pckt_debug.old.log.php and a new log is started.

Log (last lines): shows the size and the latest entries of the debug log. Click Clear log to empty it.

Remove data on uninstall: when on, uninstalling the extension deletes the settings and the log. When off (default), the settings are kept for a re-install. The pickup point saved in orders is always kept.

Import / Export

Export: click Download JSON to save the settings as a JSON file, including the API key, which is public.

Import: paste previously exported JSON and click Import to restore the settings, for example on another store. The values are checked like a normal save.

How it works at checkout

When OpenCart shows the shipping methods, it asks the extension for the Packeta price. If a Geo zone is set (and Ignore shipping zones is off) and the address is outside it, Packeta is not offered. Only products with Requires Shipping set to Yes count: other products add no weight and are not included in the subtotal. The extension checks the conditions: delivery country in the Packeta network, API key, the country list in ignore zones mode, cart weight and minimum cart subtotal. The subtotal is the price of the products that need shipping, after the coupon discount and without tax. Gift certificates, reward points and store credit are not taken into account. If free shipping applies, the price is 0. Otherwise the price comes from the country table, then from the fallback cost. If there is no price, the method is hidden. The price is shown to the customer in their currency with the tax of the selected Tax status.

Under the Packeta option of the delivery method step there is a Choose pickup point button. It opens the official Packeta widget in the customer's browser with the destination country, the cart weight, the chosen point types and the widget language. After the customer picks a point, its name and address are shown under the method, and the button changes to Change pickup point. The point is saved for the checkout session and kept when the page reloads. A point chosen for another country is not used when the delivery address changes to another country.

Nothing is requested from Packeta by your server at checkout. The widget script is loaded from widget.packeta.com, only on the checkout page. If it is blocked (an ad or privacy blocker, a content security policy, a Packeta outage), the customer sees "The Packeta pickup point widget could not be loaded. Please reload the page or choose another shipping method."

Packeta prices are not requested live; they come from your table. The extension does not create Packeta shipments, print labels or track parcels, and it does not offer home delivery or partner-carrier pickup points out of the box. Hand the pickup point ID from the order to Packeta in your usual way, for example by import in client.packeta.com. The pickup point button works with the standard OpenCart checkout of the default theme.

On OpenCart 4 the customer clicks Choose in the shipping method block of the checkout page and picks Packeta in the window Shipping method options. The Choose pickup point button and the chosen point appear in that window, under the Packeta option, and the Packeta widget opens on top of it. The prices are the same as on OpenCart 3.

Pickup points

The pickup point is required. If the customer clicks Continue at the delivery method step without choosing one, the step is not completed and the customer sees "Please choose a Packeta pickup point." If the chosen point is in another country than the delivery address, the customer sees "The selected Packeta pickup point is not in your shipping country. Please choose a pickup point again." The extension does not verify the point ID with Packeta; it checks that a point was chosen and that its country matches.

The point is attached to the order when the order is created:

Shipping method of the order: the point name and address are added to the method name, for example Packeta pickup point: <point> (up to 128 characters). The customer sees it in the order history and in the order e-mail, and it is printed on the invoice. OpenCart's order success page does not show the shipping method.

Admin order page: open the order in Sales > Orders. A Packeta pickup point panel shows the name and address, the Pickup point ID and the country. If a Packeta order has no point, the panel says "No pickup point was selected for this order."

On OpenCart 4 the Continue button of the window Shipping method options does not go on without a point, with the same messages. OpenCart 4 keeps one order for the checkout and updates it each time the customer confirms again, and the pickup point of the order is updated with it. The Packeta pickup point panel of the admin order page is shown above the History section.

The point is stored in the extension's own table vfd_pckt_point (checkout session, order, point ID, name and address, country).

License key

The extension works with a VibeFox license key from vibefox.net. The license block License — VibeFox Packeta is the first block on Extensions > Extensions > Shipping > VibeFox Packeta > Edit, above the settings. Paste the key into License key and click Activate. After that the block shows the key masked, the status (for example the date the license is active until and your domain) and the buttons Check now to check the status again, Change key to enter another key and Remove key to remove the key from this store. Below them are the line Product: opencart-shipping-packeta and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only admin users with the Modify permission for the extension can change the key. The texts of the block follow the admin language (English and Russian are included).

If the key is not accepted, the block says why, for example Key not found, This key belongs to another product, Domain limit reached or License expired on a date. After the store address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the extension keeps working on the last known status.

One key works on one domain: the store address from the OpenCart configuration. Removing the key from the store does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, Packeta is not shown to customers at checkout and no rate is calculated. An admin user who is logged in to the admin in the same browser still sees the method in the store, marked (unlicensed — visible to admins only), so you can set up and test the extension before you buy a key. On OpenCart 4 this preview is not available: the store does not see the admin login, so without an active key the method is hidden for everybody. After you have opened the Edit page once, a reminder appears on the admin Dashboard. Close it with × to hide it for 7 days. Existing orders are not affected.

When a license expires, the extension keeps working, but updates and support need a renewal. The status is checked again automatically when you open the admin Dashboard or the Edit page: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling the extension always removes the license key and license status.

Troubleshooting

Packeta does not appear at checkout: check that the license is active, Enable/Disable is on, the API key is entered and the delivery country is CZ, SK, HU or RO. Check that a price is set for the country (country row, * Default row or Fallback cost), the weight and subtotal limits, and Geo zone (or Ignore shipping zones and its countries). Check that the products have Requires Shipping set to Yes. The settings page lists configuration problems at the top. Turn on Debug log to see the reason in Log (last lines).

Packeta rejected the API key: copy the API key again from client.packeta.com > Client support and save. Until then the widget cannot open at checkout.

The widget does not open: the Packeta script is blocked by an ad or privacy blocker, a content security policy or a Packeta outage. Allow widget.packeta.com in your content security policy.

Shipping is free by mistake: check Country prices for rows with a Price of 0, especially a * Default row added with Add country and left unfilled, and check Free shipping from.

Weight limits or weight columns look wrong: if the page warns about the store weight unit, use weight classes with the unit kg, g, lb or oz and set the default weight class in System > Settings, tab Local. Other units are read as kilograms.

The page says "Warning: You do not have permission to modify VibeFox Packeta!": your admin user group may only view the settings. Give the group the modify permission for extension/shipping/vfd_packeta (OpenCart 3) or extension/vfd_packeta/shipping/vfd_packeta (OpenCart 4) in System > Users > User Groups.

For developers: other extensions can add countries, pass options such as carrier IDs to the widget, change the widget script URL or its language with the OpenCart events vfd_packeta/countries, vfd_packeta/widget_options, vfd_packeta/widget_url and vfd_packeta/widget_language (triggers with the catalog/ prefix, for example catalog/vfd_packeta/widget_options).

Uninstall

Go to Extensions > Extensions, choose the type Shipping and click Uninstall (the red − button) next to VibeFox Packeta. The license key and license status of this extension are always removed. OpenCart always resets Enable/Disable, Sort order, Tax status and Geo zone. The stored API key check is always removed, and the pickup point button and the order panel are no longer shown. If Remove data on uninstall is on, the settings, the log and the pickup points of checkouts that never became orders are deleted. If it is off, the other settings are kept and are used again when you install the extension again. Existing orders always keep the saved pickup point and the point in their shipping method.

On OpenCart 4, to remove the files of the extension as well, go to Extensions > Installer after the uninstall and click Uninstall (the orange − button) next to VibeFox Packeta in the list of installed extensions, then Delete (the red bin button) to remove the uploaded package.

Packeta is a trademark of its respective owner. This extension is not affiliated with or endorsed by Packeta.