API Reference
Addresses
API reference for managing saved addresses.
List Addresses
GET /api/v1/addresses
Return saved addresses for the API key's organization.
Query Parameters
| Param | Type | Description |
|---|---|---|
limit | number | Max results (1-100, default 10) |
starting_after | string | Cursor for forward pagination |
Create Address
POST /api/v1/addresses
Save a reusable shipper, consignee, or billing address.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Saved-address label |
company | string | Yes | Company name |
address | string | Yes | Street address |
city | string | Yes | City |
state | string | Yes | 2-letter state code |
zip | string | Yes | ZIP code |
phone | string | No | Phone number |
email | string | No | Email address |
contact_name | string | No | Contact name |
Retrieve Address
GET /api/v1/addresses/:id
Return one saved address by ID.
Update Address
PATCH /api/v1/addresses/:id
Update fields on one saved address.
Delete Address
DELETE /api/v1/addresses/:id
Delete one saved address.
Validate Address
POST /api/v1/addresses/validate
Validate a street address with USPS, then fall back to UPS if USPS cannot return a valid result.
| Field | Type | Required | Description |
|---|---|---|---|
street | string | Yes | Street address |
city | string | No | City |
state | string | Yes | 2-letter state code |
zip | string | No | ZIP code |
Errors
| Status | When |
|---|---|
400 | Address fields are invalid or incomplete |
404 | The address ID does not exist in the API key's organization |
See Handle API Errors for the common error envelope and retry guidance.