Usage

Daily use

1. Offer UPS in shipping methods (one method per service); the customer sees the live rate and the delivery date at checkout.
2. Open the order and the UPS label and tracking tab. The form is pre-filled from the order: the service of the chosen shipping method, one package with the weight of the products (split automatically above the UPS limit), the customer’s address, customs lines for international orders.
3. For a US address click Validate address to let UPS resolve it and classify it as residential or commercial; the label then uses that classification.
4. Click Create label. Each package gets its own label (GIF or ZPL); international shipments also get the commercial invoice. Preview and download from the tab or the shipment list.
5. Tracking is refreshed by the queue every 30 minutes; Refresh tracking checks at once. Scan events are shown on the order. The tracking number is also saved as a CS-Cart shipment, so the customer’s order page links to UPS tracking.

Or let the add-on create the label by itself when the order reaches the status chosen in the settings.

Several packages

Add one row per package (weight, size, value); leave spare rows empty. UPS returns one shipment identification number (the tracking number of the first package) and a label per package.

International shipments

Review the customs lines (description, quantity, unit value, part number, HS code, origin). The unit value is the price of the item without a tax that is already included in it. Duties and taxes paid by is pre-selected from the Connection page and can be changed per label: Recipient (DAP, UPS bills the receiver, the default), Sender (DDP, UPS invoices the destination duties and taxes to your account) or Third party (another UPS account). The commercial invoice is requested with reason “Sale” and the matching terms of shipment, and UPS returns a copy with every label. A label is refused before it is sent when a customs line or a phone number is missing.

No label is bought for an order that is cancelled, declined, failed, backordered or incomplete (return labels stay possible for cancelled and backordered orders).

Return labels

Create return label (tested for domestic lanes; cross-border returns send no customs forms and UPS may refuse them) buys a UPS Print Return Label: the customer is the ship-from party and your ship-from address is the recipient. The outbound label stays as it is. UPS does not offer returns for a few services (for example Next Day Air Saver and 2nd Day Air A.M.); the add-on tells you before it calls UPS.

Void

Void at UPS voids all packages of a shipment that UPS has not yet picked up. A voided order can get a new label.

If UPS does not answer while a label is bought

The add-on never repeats a purchase whose outcome it cannot know. It writes the attempt with its own reference (kv-<order>-<n>) first; if the connection breaks or UPS answers with a server error after receiving the request, the attempt is kept as Unresolved and no new label can be bought for the order. The add-on immediately searches UPS tracking (Tracking API, search by reference number) for the reference and, when it finds a tracking number of your account, recovers the label (Label Recovery by tracking number) and adopts it. UPS does not guarantee that this search finds a shipment that is only minutes old, so an empty answer is not proof that UPS holds no label. Press Check with UPS again later, and search your UPS shipping history (Ship Manager) for the reference: if you find a shipment, paste its tracking number into UPS tracking number found in your UPS account and press Adopt this tracking number. Press Discard this attempt and create the label again only when you are sure UPS holds no shipment for it, otherwise UPS bills a second label (void the surplus one). Errors that UPS reports before processing (validation errors, HTTP 503, rate limit) are safe: the attempt is removed and a retry works.

Pickups

On Orders > UPS shipments, choose the service, the date, the ready and closing time, the number of packages and optional remarks, then Book pickup. It books a UPS on-call pickup at your ship-from address that is paid with your UPS account. The same request is booked once. Cancel pickup cancels it at UPS by its pickup request number (UPS cannot change a booked pickup). Times are the local time of the pickup address.

Jobs, log and connection

• Jobs: counts per state, the list with the last error, Retry, Remove and Run the queue now.
• Log: filter and export what happened and when.
• Connection: test and live credentials, Test connection.

Multi-Vendor

Vendors see their own shipments and pickups. They create labels with their own UPS account (owner mode off) or, if the marketplace owner allows it, with the owner’s account for their own orders.