Sign in

v1

latestOpenAPI 3.1.02026-07-24416405768.8 KB
d) Customer Management

Add a new address for the customer

Creates a new address linked to the customer. You can give a customer multiple addresses.

post/eclipse-conductor/rest/v1/tenants/{tenantId}/customers/{customerId}/addresses

Path parameters

tenantIdinteger required
customerIdinteger required

Request body

addressType'BRANCH' | 'HEADQUARTERS' | 'OPERATING' | 'PHYSICAL' | 'POSTAL' | 'PRIMARY' | 'REGISTERED' required
citystring required
codestring
countrystring required
gpsLatitudenumber

GPS latitude of the address in decimal degrees

gpsLongitudenumber

GPS longitude of the address in decimal degrees

line1string required
line2string
line3string
statestring required

Response

OK

addressIdinteger

Unique system generated identifier for an address

addressType'BRANCH' | 'HEADQUARTERS' | 'OPERATING' | 'PHYSICAL' | 'POSTAL' | 'PRIMARY' | 'REGISTERED' required
citystring required
codestring
countrystring required
customerIdinteger

The customer the address is for

gpsLatitudenumber

GPS latitude of the address in decimal degrees

gpsLongitudenumber

GPS longitude of the address in decimal degrees

line1string required
line2string
line3string
organisationIdinteger

The organisation the address is for

statestring required
tenantIdinteger
versioninteger required

A number indicating the version of the record. Updates will only be accepted if the passed in version is the same as the current version on record. This is in order to prevent concurrent modifications by multiple users.