Creating an address

post/addresses

Request

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

Request body

care_ofstring nullable

Additional care of field

citystring required

Name of the city

countrystring required

Country as uppercase ISO 3166-1 alpha-2 code

first_namestring nullable

A persons first name

statestring nullable

The state the address is in

streetstring required

Name of the street. Can hold the house number

street_nostring nullable

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

Response

An address was created

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.