1 Table of Contents
2 Overview
Address elements are used for shipping, billing or general customer information.
2.1 Elements
| Name | Type | Datatype | Example | Default | Description |
|---|
| Salutation
| required
| string
| Male
| Neuter; Male; Female
| Type of salutation.
|
| | Neuter: Neutral salutation type. Used for companies.
|
| | Male: Male salutation type i.e. Mr.
|
| | Female: Female salutation type i.e. Mrs.
|
| Company
| optional
| string
| -
| -
| Addressee's company name.
|
| Forename
| required
| string
| -
| -
| First name of the addressee.
|
| Surname
| required
| string
| -
| -
| Last name of the addressee.
|
| Street
| required
| string
| -
| -
| Street.
|
| Addition
| optional
| string
| -
| -
| Second address line for additional information.
|
| City
| required
| string
| -
| -
| City of the addressee.
|
| State
| req./opt.
| string
| AL
| -
| Three/two letter ISO 3166-2 state/province code of the addressee. For details see here. Required in some countries. Shipment to the US requires this element.
|
| ZipCode
| required
| string
| -
| -
| Zip code of the addressee.
|
| Country
| required
| string
| US
| -
| Two letter ISO 3166-1 country code of the addressee. For a list see here.
|
| Phone
| req./opt.
| string
| -
| -
| Phone number of the addressee.
|
| Email
| req./opt.
| string
| -
| -
| E-Mail number of the addressee.
|
| Note
| optional
| string
| -
| -
| Additional note.
|
2.2 Example
XML:
<Shipping>
<Salutation>Male</Salutation>
<Forename>Ingmar</Forename>
<Surname>Bergman</Surname>
<Street>Strawberry road 12</Address1>
<Addition />
<City>Stockholm</City>
<State />
<ZipCode>57264</ZipCode>
<Country>SE</Country>
<Phone>123456789</Phone>
<Email>ingmar@bergman.se</Email>
<Note>Beware of the dog!</Note>
</Shipping>
JSON:
"Shipping": {
"Salutation": "Male",
"Forename": "Ingmar",
"Surname": "Bergman",
"Street": "Strawberry road 12",
"Addition": "",
"City": "Stockholm",
"State": "",
"ZipCode": "57264",
"Country": "SE",
"Phone": "123456789",
"Email": "ingmar@bergman.se",
"Note": "Beware of the dog!"
}