Add Address

Endpoint to create an Address.

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Required scopes:
  • address_write
Fingerprint order:
  • addressee_name,addressee_surname,line1,line2,line3,country,county,city,post_code,default_shipping,resource_type,employee_id,token
Body Params
string

The name of the addressee.

string

The surname of the addressee.

string
required

The city name.

string
required

The country code in ISO 3166-1 alpha-3 standard.

string

The county code.

boolean

It is true if it's the default shipping address (for COMPANY addresses only).

string

The ID of the User owner of the Address, required only when resource_type is USER.

string
required

The actual name of the Address.

string

The primary street of the Address.

string

The optional secondary street.

string
required

The post code of the city.

string
required

The type of the Address.

Headers
string
required
Defaults to {{fingerprint}}

Advanced authentication: SHA512SUM of the Fingerprint order values.

string
required
Defaults to {{fingerprint_signature}}

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Responses

Address created.

Response body
object
string

The category of the Address.

string

The type of the Address.

string

The name of the addressee.

string

The surname of the addressee.

string

The city of the Address.

string

The country of the Address.

string

The county of the Address.

string

The date and time when the Address was created.

boolean

True if the Address is the default shipping address.

string

The User ID, only if address_category is USER.

string

The date and time when the Address was last updated.

string

The actual name of the Address.

string

The Address street.

string

An optional other street.

string

The postal code of the Address.

string

The Address ID.

400

Your request has missing arguments or is malformed.

Language
Credentials
OAuth2
URL