Shipping API
Get real-time shipping quotes, generate labels, and track shipments across multiple carriers.
Base URL:
https://gateway.regentherapy.com/api/v1/shippingSupported Carriers
UPS
Ground, 2-Day, Next Day
FedEx
Ground, Express, Priority
USPS
Priority, First Class
DHL
International Express
Endpoints
POST
/quoteGet shipping rate quotes for a package
Request Body
{
"origin": {
"street": "123 Warehouse St",
"city": "Los Angeles",
"state": "CA",
"zip": "90210",
"country": "US"
},
"destination": {
"street": "456 Customer Ave",
"city": "New York",
"state": "NY",
"zip": "10001",
"country": "US"
},
"packages": [
{
"weight": 2.5,
"weightUnit": "lb",
"length": 12,
"width": 8,
"height": 6,
"dimensionUnit": "in"
}
],
"carriers": ["UPS", "FEDEX", "USPS"] // Optional, defaults to all
}Response
{
"quotes": [
{
"carrier": "UPS",
"service": "Ground",
"serviceCode": "03",
"rate": 12.99,
"currency": "USD",
"estimatedDays": 5,
"deliveryDate": "2024-01-20",
"guaranteed": false
},
{
"carrier": "UPS",
"service": "2nd Day Air",
"serviceCode": "02",
"rate": 24.99,
"currency": "USD",
"estimatedDays": 2,
"deliveryDate": "2024-01-17",
"guaranteed": true
}
],
"cheapest": { "carrier": "USPS", "service": "Priority", "rate": 8.99 },
"fastest": { "carrier": "UPS", "service": "Next Day Air", "rate": 45.99 }
}Address Object
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Recipient/shipper name |
| company | string | No | Company name |
| street | string | Yes | Street address line 1 |
| street2 | string | No | Street address line 2 |
| city | string | Yes | City name |
| state | string | Yes | State/province code (e.g., CA, NY) |
| zip | string | Yes | ZIP/postal code |
| country | string | Yes | ISO 2-letter country code |
| phone | string | No | Phone number |
Best Practices
- • Always validate addresses before creating labels
- • Cache rate quotes for 15-30 minutes to reduce API calls
- • Use webhooks for tracking updates instead of polling
- • Store tracking numbers for customer communication