GET v3/customer/addresses

Return a list of the current customers stored address details

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of CustomerAddress
NameDescriptionTypeAdditional information
IsBilling

boolean

None.

IsDelivery

boolean

None.

Id

string

None.

Country

Country

None.

AdministrativeDivision

AdministrativeDivision

None.

Name

string

None.

Line1

string

None.

Line2

string

None.

Line3

string

None.

Line4

string

None.

Line5

string

None.

Postcode

string

None.

Town

string

None.

Response Formats

application/json

Sample:
[
  {
    "isBilling": false,
    "isDelivery": false,
    "id": null,
    "country": {
      "isoCode": "",
      "name": "",
      "postcodeRequired": false
    },
    "administrativeDivision": {
      "name": "",
      "isoCode": null
    },
    "name": "sample string 1",
    "line1": "sample string 2",
    "line2": "sample string 3",
    "line3": "sample string 4",
    "line4": "sample string 5",
    "line5": "sample string 6",
    "postcode": "sample string 7",
    "town": "sample string 8"
  },
  {
    "isBilling": false,
    "isDelivery": false,
    "id": null,
    "country": {
      "isoCode": "",
      "name": "",
      "postcodeRequired": false
    },
    "administrativeDivision": {
      "name": "",
      "isoCode": null
    },
    "name": "sample string 1",
    "line1": "sample string 2",
    "line2": "sample string 3",
    "line3": "sample string 4",
    "line4": "sample string 5",
    "line5": "sample string 6",
    "postcode": "sample string 7",
    "town": "sample string 8"
  }
]

text/xml

Sample:
<CustomerAddresses>
  <CustomerAddress>
    <IsBilling>false</IsBilling>
    <IsDelivery>false</IsDelivery>
    <Id nil="true" />
    <Country>
      <Country>
        <IsoCode />
        <Name />
        <PostcodeRequired>false</PostcodeRequired>
      </Country>
    </Country>
    <AdministrativeDivision>
      <AdministrativeDivision>
        <Name />
        <IsoCode nil="true" />
      </AdministrativeDivision>
    </AdministrativeDivision>
    <Name>sample string 1</Name>
    <Line1>sample string 2</Line1>
    <Line2>sample string 3</Line2>
    <Line3>sample string 4</Line3>
    <Line4>sample string 5</Line4>
    <Line5>sample string 6</Line5>
    <Postcode>sample string 7</Postcode>
    <Town>sample string 8</Town>
  </CustomerAddress>
  <CustomerAddress>
    <IsBilling>false</IsBilling>
    <IsDelivery>false</IsDelivery>
    <Id nil="true" />
    <Country>
      <Country>
        <IsoCode />
        <Name />
        <PostcodeRequired>false</PostcodeRequired>
      </Country>
    </Country>
    <AdministrativeDivision>
      <AdministrativeDivision>
        <Name />
        <IsoCode nil="true" />
      </AdministrativeDivision>
    </AdministrativeDivision>
    <Name>sample string 1</Name>
    <Line1>sample string 2</Line1>
    <Line2>sample string 3</Line2>
    <Line3>sample string 4</Line3>
    <Line4>sample string 5</Line4>
    <Line5>sample string 6</Line5>
    <Postcode>sample string 7</Postcode>
    <Town>sample string 8</Town>
  </CustomerAddress>
</CustomerAddresses>