Create a send-from address
Creates a new send-from address (warehouse, fulfillment center).
Used as `from_address` when purchasing labels.
Parameters
Request Body
address_code
string
Unique identifier code for this warehouse/location.
Used for quick reference in batch operations.
name
string
Location name (e.g., warehouse name)
company
string
Company name shown on shipping labels
contact_person
string
Contact person at this location
street1
string
Required
Primary street address
street2
string
Secondary address (suite, unit, dock number)
city
string
Required
state
string
Required
State or province. The two-letter form is what carriers expect for US, CA and AU, but only a non-empty string is enforced here.
zip
string
Required
ZIP code
country
string
ISO 2-letter country code
phone
string
Contact phone (required for some carriers)
email
string
Contact email for notifications
timezone
string
IANA timezone for this location. Any string is accepted — the values above are the ones that behave correctly, but nothing validates them.
Used for business hours and pickup scheduling.
business_hours
string
Weekly business hours for pickup scheduling, as a string (e.g.
"Mon-Fri 09:00-17:00"). An object is rejected with 400.
Carriers will schedule pickups within these hours.
is_default
boolean
Set as the default origin address.
Only one address can be default at a time.
is_pickup
boolean
Allow carrier pickups at this location.
Requires business_hours to be set.
is_return
boolean
Offer this address as the return address on return labels.
The dashboard pre-fills the address that has both is_return and is_default.
residential
boolean
Explicit residential/commercial override. Omit it (the default) to let rate
engines auto-classify the address; sending true or false overrides that
classification, which changes the rate you are quoted.
Returns
201
Address created
400
Invalid request data.
ADDRESS_BOOK_MANAGED — this organization's address book is managed centrally; addresses cannot be created through the API.
401
Authentication required
Related
Addresses
POST/api/v1/addresses