Configuration
Overview · Installation · Usage · FAQ · Developer notes
Add-ons > Manage > Parcel Status Updates. All settings are for the whole installation (on CS-Cart Ultimate they apply to every storefront).
Tracking service
Section titled “Tracking service”| Setting | What it does |
|---|---|
| Enable | Switches tracking on or off. Off: no registration, webhooks are answered but ignored, the customer tab is hidden. |
| Tracking service | 17TRACK (API v2.2) or AfterShip (Tracking API 2024-04). |
| API key | 17TRACK: the Security key of the API console. AfterShip: an API key from Settings > API keys. |
| Webhook secret (AfterShip) | When set, AfterShip calls without a valid aftership-hmac-sha256 signature are refused. |
| Webhook and cron | Shows the webhook URL (with its secret token), the cron command and the Test connection button. |
| Register new shipments automatically | On: a shipment with a tracking number is registered as soon as it is saved. Off: only with the Register button or by the cron job. |
| Check parcels by cron every (hours) | Fallback polling interval for parcels without a webhook update. 6 hours by default. |
| Parcels per request | Batch size for registration and polling (17TRACK accepts 40 numbers per request). |
| Stop tracking after (days) | Parcels not delivered after this many days are no longer checked. Delivered and expired parcels stop at once. |
| Carrier codes | Optional, one per line: CS-Cart carrier code = service carrier code. Built in: usps, ups, fedex and dhl for both services; aup, can and swisspost for AfterShip. Without a code the service detects the carrier from the number. |
Order status rules
Section titled “Order status rules”| Setting | What it does |
|---|---|
| When a parcel is in transit, out for delivery, ready for pickup, after a failed attempt, when the carrier reports a problem, when it is delivered: set the order to | One order status per parcel status, or “Do not change”. Default: only Delivered sets Complete. |
| Rules may change orders in these statuses | Orders in other statuses are never changed. Default: Open and Paid (status codes O and P). Canceled or declined orders stay as they are. |
| Delivered rule waits for every parcel of the order | On: with several shipments, the order gets the Delivered status only when all of its parcels are delivered. |
| Notify the customer, orders department, vendor | Passed to the CS-Cart status change, so the usual status e-mails go out. |
Customer order page
Section titled “Customer order page”| Setting | What it does |
|---|---|
| Show the delivery status tab | Adds the Delivery status tab with progress, expected date and carrier events. |
| Show the status link above the order | A small link such as “Delivery: In transit” next to the order actions. It opens the tab. |
| Carrier events shown per parcel | How many events the customer sees (newest first). |
License
Section titled “License”The License tab holds the license key and its status. Without a valid license no parcels are registered or updated, webhooks are ignored and the delivery tab is hidden; parcels and their history are kept.