Settings
Open Add-ons > Manage add-ons > UPS REST Rates & Labels > Settings.
General
Section titled “General”| Setting | Default | Description |
|---|---|---|
| Enable | On | When off, no new work is started. Jobs of work that is already under way are still processed. |
| Marketplace owner mode | On | Multi-Vendor. On: every order is processed with the marketplace owner’s account and vendors have no connection page. Off: each vendor connects their own account. |
| Vendors may create labels | Off | Multi-Vendor, owner mode only. Lets vendors buy labels and book pickups for their own orders with the owner’s UPS account (the owner is billed). |
| Debug log | Off | Also stores every HTTP call with masked request and response. Secrets are never stored. |
| Log retention (days) | 90 | Older log entries are removed by the cron run. |
| Create the label when the order status becomes | empty | Empty = create labels by hand on the order page. |
| Set the order status when UPS delivers | empty | Order status to set when tracking reports “delivered”. |
| Show UPS delivery estimates | On | Asks UPS for the time in transit with every rate request (Rating option Shoptimeintransit) and shows the delivery date at checkout. If UPS refuses it, the prices are fetched without it. |
| Also create a CS-Cart shipment | On | Records the tracking number as a regular shipment so the customer’s order page and notifications show it. |
| Fallback shipping rate | empty | Offered for every UPS method when UPS does not answer or has no rate. Empty = hide the method. A method can have its own fallback. |
Connection
Section titled “Connection”Credentials are not ordinary settings: they are entered on the Connection page and stored encrypted (AES-256-GCM, key derived from your store’s own secret). They are never shown again; leave a secret field empty to keep the saved value.
| Field | Description |
|---|---|
| Mode | Test uses the UPS Customer Integration Environment (wwwcie.ups.com) and the test credentials; Live uses production (onlinetools.ups.com) and the live credentials. |
| Client ID / Client secret | The credentials of your UPS Developer Portal app, one pair for test and one for live. |
| UPS account number | The six character shipper number billed for labels and used for negotiated rates. Required for rating, shipping and pickups. |
| Ship-from address | Name, company, street, city, state, ZIP, country (ISO), phone, e-mail. Empty fields use the company details of the store (or of the vendor). |
| Prices at checkout | Your account (negotiated) rates or the UPS published rates. |
| Pickup type for rates | Daily pickup (01), customer counter (03), one time pickup (06), letter center (19) or air service center (20). Affects the rate type UPS uses. |
| Customer classification (US) | Only for shipments from the United States: automatic, rates associated with the shipper number (00), daily (01), retail (04) or regional (05). |
| Packaging type | Customer supplied package (default), UPS Letter, Pak, Tube, Express Box, 25 kg or 10 kg box. |
| Deliveries are residential | Used for rates until the address has been validated; a validated address uses the UPS classification. |
| Label file type / Thermal label size | GIF (prints on any printer, 4 x 6 in) or ZPL; ZPL labels can be 4 x 6 or 4 x 8 in. UPS does not deliver labels as PDF. |
| Default package length, width, height | In inches (US) or centimetres, used when a product has no box size. |
| Default package weight | Used when the products of an order have no weight. |
| Heaviest package | Orders heavier than this are pre-split into several packages (UPS accepts 150 lb / 70 kg; the split uses 68 kg). |
| Country of manufacture, default HS code | Pre-filled on customs lines of international shipments. |
| Duties and taxes paid by | Who UPS bills the destination duties and taxes to on international labels: the recipient (default, DAP: UPS bills the receiver), your account (DDP) or a third-party account (enter its number, postal code and country). Changeable per label. |
Shipping method (Configure tab)
Section titled “Shipping method (Configure tab)”Markup (percent plus fixed amount), round up, free shipping from a package value, fallback rate, show the delivery date, signature on delivery (delivery confirmation with signature), declare the value of the package (the currency must be the currency of the ship-from country).
The queue runs from cron. Use either the command line or the secret web address shown in the Cron section of the settings:
php /path/to/store/admin.php --dispatch=kv_ups_rest.cronhttps://your-store.example/index.php?dispatch=kv_ups_rest.cron&key=<secret>
The queue creates labels at the chosen order status, refreshes the tracking of open shipments every 30 minutes and checks each connection once a day.
Log and jobs
Section titled “Log and jobs”- Log lists every call and job with filters (level, action, text, dates) and a CSV export.
- Jobs lists the queue. A job that fails is retried after 5 minutes, 15 minutes, 1 hour, 3 hours and 12 hours, then marked “Gave up”; use Retry to queue it again.
Multi-Vendor
Section titled “Multi-Vendor”In the vendor panel a vendor sees only their own records. With the marketplace owner mode off the vendor also gets the Connection tab for their own account. Running the queue, retrying or removing jobs is for the marketplace owner only.