POST v1/Generic/GetCustomerAddressDetail

Get Address based on input parameters

Request Information

URI Parameters

None.

Body Parameters

Use this parameter to get the Customer's Address

CustomerAddressRequestData
NameDescriptionTypeAdditional information
CustomerId

Requested CustomerId

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerId": "sample string 1"
}

application/xml, text/xml

Sample: 
<CustomerAddressRequestData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerId>sample string 1</CustomerId>
</CustomerAddressRequestData>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomerAddressRequestData'.

Response Information

Resource Description

Collection of CustomerAddressResponse
NameDescriptionTypeAdditional information
AddressType

Returns AddressType

 string

None.
Attn

Returns Attention

 string

None.
Address1

Returns Address1

 string

None.
Address2

Returns Address2

 string

None.
Address3

Returns Address3

 string

None.
City

Returns City

 string

None.
State

Returns State

 string

None.
Zip

Returns Zip

 string

None.
Country

Returns Country

 string

None.
Phone1

Returns Phone1 either Bus. Phone or Pers. Phone

 string

None.
ExtPhone1

Returns Phone1 Extention either Bus. Phone or Pers. Phone

 string

None.
Phone2

Returns Phone2 either Other Phone or Mobile Phone

 string

None.
ExtPhone2

Returns Phone2 Extention either Other Phone or Mobile Phone

 string

None.
Email

Returns Email Address

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "AddressType": "sample string 1",
    "Attn": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Address3": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "Country": "sample string 9",
    "Phone1": "sample string 10",
    "ExtPhone1": "sample string 11",
    "Phone2": "sample string 12",
    "ExtPhone2": "sample string 13",
    "Email": "sample string 14"
  },
  {
    "AddressType": "sample string 1",
    "Attn": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "Address3": "sample string 5",
    "City": "sample string 6",
    "State": "sample string 7",
    "Zip": "sample string 8",
    "Country": "sample string 9",
    "Phone1": "sample string 10",
    "ExtPhone1": "sample string 11",
    "Phone2": "sample string 12",
    "ExtPhone2": "sample string 13",
    "Email": "sample string 14"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCustomerAddressResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerAddressResponse>
    <AddressType>sample string 1</AddressType>
    <Attn>sample string 2</Attn>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <Address3>sample string 5</Address3>
    <City>sample string 6</City>
    <State>sample string 7</State>
    <Zip>sample string 8</Zip>
    <Country>sample string 9</Country>
    <Phone1>sample string 10</Phone1>
    <ExtPhone1>sample string 11</ExtPhone1>
    <Phone2>sample string 12</Phone2>
    <ExtPhone2>sample string 13</ExtPhone2>
    <Email>sample string 14</Email>
  </CustomerAddressResponse>
  <CustomerAddressResponse>
    <AddressType>sample string 1</AddressType>
    <Attn>sample string 2</Attn>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <Address3>sample string 5</Address3>
    <City>sample string 6</City>
    <State>sample string 7</State>
    <Zip>sample string 8</Zip>
    <Country>sample string 9</Country>
    <Phone1>sample string 10</Phone1>
    <ExtPhone1>sample string 11</ExtPhone1>
    <Phone2>sample string 12</Phone2>
    <ExtPhone2>sample string 13</ExtPhone2>
    <Email>sample string 14</Email>
  </CustomerAddressResponse>
</ArrayOfCustomerAddressResponse>