Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Customer Address

Get a specific customer address

get/api/customers/{customerId}/addresses/{customerAddressId}

Path parameters

customerIdstring required
customerAddressIdstring required

Response

The customer address for the given id

namestring nullable

Name of the address (Bob's Shipping, Primary, Reno Warehouse, etc).

address1string required

Primary address line.

address2string nullable

Second address line.

address3string nullable

Third address line.

citystring required

Address city

stateProvincestring nullable

Address state/province.

postalCodestring required

Postal/zip code.

countrystring nullable

Country identifier.

shippingLeadTimeinteger nullable

Lead time for shipping contents.

primaryBillingboolean

Signifies if this is a primary billing address.

primaryShippingboolean

Signifies if this is a primary billing address.

idstring required

Unique id associated to this entity.

emailstring email nullable

Email address

phonestring nullable

Associated phone number

faxstring nullable

Associated fax number

notesstring nullable

General notes associated to this customer address