Address

Use the Address object to add or update address information.

The XML API also uses the Address object as a substructure to pass address and other contact information when reading, adding or updating any type of records including such information. See Address Fields.

XML

SOAP

REST

Database table

Object

Address

oaAddress

address

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

The Address object has the following standard properties:

XML

SOAP

Database

Description

addr1

addr1

address1

Address line 1

addr2

addr2

address2

Address line 2

addr3

addr3

address3

Address line 3

addr4

addr4

address4

Address line 4

city

city

city

City

contact_id

contact_id

contact_id

The internal ID of the associated contact

country

country

country

Country

customer_only

Used for backward compatibility when modifying a customer record.

Set to yes to update only the customer's billing address [billingaddr] of the customer, and not its associated contact. See Customer.

email

email

email

Email address

fax

fax

Fax number

first

first

First name

id

id

id

Unique ID. Automatically assigned by OpenAir.

last

last

Last name

middle

middle

Middle name

mobile

mobile

Mobile phone number

phone

phone

Phone number

salutation

salutation

Contact's salutation

state

state

state

State

zip

zip

zip

Zip code