Getting a list of addresses

get/addresses

Request

  • Base URL: https://api.shipcloud.io/v1
  • URL: https://api.shipcloud.io/v1/addresses
  • Auth: HTTP basic

Query parameters

care_ofstring

Filter addresses by care_of

citystring

Filter addresses by city

companystring

Filter addresses by company name

countrystring

Filter addresses by country code

first_namestring

Filter addresses by first name

last_namestring

Filter addresses by last name

pageinteger

Number of page that should be returned

per_pageinteger

Number of items that should be shown on a page (default value is 100)

phonestring

Filter addresses by phone number

streetstring

Filter addresses by street name

street_nostring

Filter addresses by house number

zip_codestring

Filter addresses by zip code

Response

List of addresses

care_ofstring nullable required

Additional care of field

citystring required

Name of the city

countrystring required

Country as uppercase ISO 3166-1 alpha-2 code

first_namestring nullable required

A persons first name

statestring nullable required

The state the address is in

streetstring required

Name of the street. Can hold the house number

street_nostring nullable required

House number of the address (when a carrier requires it separately)

zip_codestring required

Zipcode of the address

phonestring

Telephone number (mandatory when using UPS and the following terms apply: service is one_day or one_day_early or ship to country is different than ship from country)

emailstring

Email address for this person. Some carrier are using the email address to send notifications

idstring required

identifier of a previously created address

Changes

No recorded changes to this operation across all 1 revision of this API.