Installation

Overview · Configuration · Usage · FAQ · Developer notes

Requirements

CS-Cart or Multi-Vendor 4.17.2 to 4.21.x, PHP 7.4 to 8.3 with the curl extension.
An account with 17TRACK (Tracking API) or AfterShip (Tracking API). Both have plans by number of tracked parcels; check the service’s prices. The add-on does not include tracking quota.
HTTPS on the storefront is recommended: the service calls the webhook URL of your store.
A cron job (recommended): fallback when a webhook is missed, and for shipments made through the API or imports.

Install

Add-ons > Manage > upload kv_parcel_status-1.0.0.zip and install it.
Enter the license key on the add-on page (License tab or the card at the top).
Tracking service tab: choose 17TRACK or AfterShip and paste the API key. Save, then press Test connection.
Copy the Webhook URL shown on the same tab into the service:
- 17TRACK: API console > Settings > Webhook. 17TRACK signs each call with your API key; nothing else to enter.
- AfterShip: Notifications > Webhooks > add the URL, then copy the webhook secret into Webhook secret (AfterShip) and save.
Order status rules tab: choose what happens to the order for each parcel status. By default only “Delivered” sets the order to Complete.
Shipments created from now on are tracked. For earlier shipments use Orders > Parcel tracking > Import earlier shipments (last 7, 30 or 90 days).

Cron job

Run every hour:

php /path/to/store/admin.php --dispatch=kv_parcel_status.cron

Over HTTP: https://your-store/admin.php?dispatch=kv_parcel_status.cron&cron_password=... with the cron password of Settings > Security. Each run picks up shipments without a parcel, registers parcels that are not registered yet (up to 5 tries), checks parcels without an update for the set number of hours and stops tracking parcels older than the set number of days. Run now on the dashboard does the same by hand.

Upgrade

Upload the new zip over the old files (Add-ons > Manage > upload). The add-on applies new tables and settings itself on the next admin page view. Parcels, events and settings are kept.

Uninstall

Uninstalling removes the add-on’s three tables (parcels, events, log) and its settings. Shipments, tracking numbers and order statuses of CS-Cart are not touched. Remove the webhook URL from the service afterwards.