FreightCake
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

ParamTypeDescription
limitnumberMax results (1-100, default 10)
starting_afterstringCursor for forward pagination

Create Address

POST /api/v1/addresses

Save a reusable shipper, consignee, or billing address.

Request Body

FieldTypeRequiredDescription
namestringYesSaved-address label
companystringYesCompany name
addressstringYesStreet address
citystringYesCity
statestringYes2-letter state code
zipstringYesZIP code
phonestringNoPhone number
emailstringNoEmail address
contact_namestringNoContact 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.

FieldTypeRequiredDescription
streetstringYesStreet address
citystringNoCity
statestringYes2-letter state code
zipstringNoZIP code

Errors

StatusWhen
400Address fields are invalid or incomplete
404The address ID does not exist in the API key's organization

See Handle API Errors for the common error envelope and retry guidance.

On this page