> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# UPS API

> Create UPS shipping and return labels, track parcels, check addresses and rates, and book pickups

The common use is hardware on a ticket: an agent creates the label to send a laptop to a user, or the return label to get it back from a user who leaves, notes the tracking number on the ticket, and follows the parcel until it arrives.

> [!NOTE]
>
> Automatically enabled when you configure UPS permissions in your agent workflow, or on a dashboard.

## What It Does

* Create shipments with their labels, as a print link for the technician
* Create return labels that UPS emails to the user, or that the technician prints
* Void a label, and recover a lost one
* Track parcels by tracking number, shipment or reference, with delivery date and proof of delivery
* Validate US addresses, compare rates and transit times per service, and find UPS Access Points
* Book, list and cancel pickups, and read or change the account's pickup settings
* Redirect, hold, return or reschedule a parcel on its way, after reading its fee
* Quote landed costs and duties, check export rules and customs requirements, and file dangerous goods notices
* Work with UPS Forwarding, TradeDirect, WorldEase and UPS Supply Chain Solutions, for accounts enrolled in them

## Permission Groups

| Group | Covers |
| - | - |
| Shipments & Labels | Create shipments with their labels, return labels emailed to the user or as a print link, void a shipment, recover a lost label, and upload trade documents for a shipment |
| Tracking | Where a parcel is, its events, delivery date and proof of delivery, by tracking or reference number; Quantum View events for the account. Subscribe tracking numbers to UPS Track Alert |
| Rates, Transit Times & Addresses | Rates and transit times per service, address validation, UPS Access Point and store locations, and address risk scores. Read only |
| Pickups | Pickup rates, pending pickups, service centres and the account's pickup settings. Book and cancel a pickup and change the pickup settings |
| Delivery Changes | Which changes a parcel on its way allows and their fee. Redirect it, hold it for collection, return it to the sender, reschedule it or cancel such a change |
| Customs & Trade | Landed cost and guaranteed duty quotes, customs requirements and dangerous goods checks. Export guidance and product descriptions with tariff codes, which UPS bills, and customs details and dangerous goods pre-notifications need Read / Write |
| Freight & Supply Chain | UPS Forwarding air and ocean freight, TradeDirect and WorldEase consolidated shipments, UPS Supply Chain Solutions data ingestion and pickup points |

## Access Profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Every read | No write is allowed |
| **Helpdesk** | Every read | Labels, voids, pickups and tracking alerts; no other write is allowed |
| **IT Admin** | Every read | Every write, in every group: each spends money or changes your UPS account |
| **Full Automation** | Every read and write | Nothing |

## Safety Controls

| Control | Behavior |
| - | - |
| **Your saved account number** | Neo writes the UPS account number saved on the tile into every account-number field (`ShipperNumber`, `AccountNumber` and the like) and refuses any other value there. UPS Forwarding names each party's account in its own field, which the agent fills; Forwarding writes ask a technician in IT Admin |
| **No sign-in tokens or delivery PINs** | Neo never sends UPS's sign-in calls or the calls that return a package release PIN |
| **Operations from the API reference only** | Neo sends only the operations in UPS's API files; any other call is refused before it reaches UPS |
| **Labels stay out of the conversation** | A label image is left out of what the agent reads; the agent gives people UPS's print link |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.