GET address/search/{collectionKey}?page={page}&pageSize={pageSize}&name={name}&stateProvince={stateProvince}&postalCode={postalCode}&countryCode={countryCode}&searchText={searchText}&useAndOperator={useAndOperator}

Search for addresses in collection

Request Information

URI Parameters

NameDescriptionTypeAdditional information
collectionKey

Address collection key

string

Required

page

Page number

integer

Default value is 1

pageSize

Number of results per page

integer

Default value is 100

name

Optional search by address name

string

None.

stateProvince

Optional search by state/province

string

None.

postalCode

Optional search by postal code

string

None.

countryCode

Optional search by country code

string

None.

searchText

Full text search against all address fields - overrides other search parameters

string

None.

useAndOperator

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of AddressResponseModel
NameDescriptionTypeAdditional information
Id

Unique Identifier

integer

None.

Created

Created DateTime stamp

date

None.

Updated

Updated DateTime stamp

date

None.

AddressType

Specifies Type of address (SoldTo, BillTo, Payer, ShipTo, EndUser)
0 – SoldTo
1 – BillTo
2 – Payer
3 – ShipTo
4 – EndUser

AddressType

None.

Name

Recipient’s name

string

Max length: 100

Attention

Attention line

string

Max length: 100

Phone

Contact phone #

string

Max length: 20

Street1

Street address line one

string

Max length: 100

Street2

Street address line two

string

Max length: 100

City

City

string

Max length: 100

StateProvince

State / Province code Valid 2 character State or Province code. See ISO-3166

string

Max length: 100

PostalCode

Postal code

string

Max length: 20

CountryCode

Country Code Standard ISO-3166 2-Character country code

string

Max length: 2

ExtendedData

Client defined data

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Created": "2021-05-13T16:59:18.5197249-04:00",
    "Updated": "2021-05-13T16:59:18.5197249-04:00",
    "AddressType": 0,
    "Name": "sample string 4",
    "Attention": "sample string 5",
    "Phone": "sample string 6",
    "Street1": "sample string 7",
    "Street2": "sample string 8",
    "City": "sample string 9",
    "StateProvince": "sample string 10",
    "PostalCode": "sample string 11",
    "CountryCode": "sample string 12",
    "ExtendedData": "sample string 13"
  },
  {
    "Id": 1,
    "Created": "2021-05-13T16:59:18.5197249-04:00",
    "Updated": "2021-05-13T16:59:18.5197249-04:00",
    "AddressType": 0,
    "Name": "sample string 4",
    "Attention": "sample string 5",
    "Phone": "sample string 6",
    "Street1": "sample string 7",
    "Street2": "sample string 8",
    "City": "sample string 9",
    "StateProvince": "sample string 10",
    "PostalCode": "sample string 11",
    "CountryCode": "sample string 12",
    "ExtendedData": "sample string 13"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAddressResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AddressResponseModel>
    <AddressType>SoldTo</AddressType>
    <Name>sample string 4</Name>
    <Attention>sample string 5</Attention>
    <Phone>sample string 6</Phone>
    <Street1>sample string 7</Street1>
    <Street2>sample string 8</Street2>
    <City>sample string 9</City>
    <StateProvince>sample string 10</StateProvince>
    <PostalCode>sample string 11</PostalCode>
    <CountryCode>sample string 12</CountryCode>
    <ExtendedData>sample string 13</ExtendedData>
    <Id>1</Id>
    <Created>2021-05-13T16:59:18.5197249-04:00</Created>
    <Updated>2021-05-13T16:59:18.5197249-04:00</Updated>
  </AddressResponseModel>
  <AddressResponseModel>
    <AddressType>SoldTo</AddressType>
    <Name>sample string 4</Name>
    <Attention>sample string 5</Attention>
    <Phone>sample string 6</Phone>
    <Street1>sample string 7</Street1>
    <Street2>sample string 8</Street2>
    <City>sample string 9</City>
    <StateProvince>sample string 10</StateProvince>
    <PostalCode>sample string 11</PostalCode>
    <CountryCode>sample string 12</CountryCode>
    <ExtendedData>sample string 13</ExtendedData>
    <Id>1</Id>
    <Created>2021-05-13T16:59:18.5197249-04:00</Created>
    <Updated>2021-05-13T16:59:18.5197249-04:00</Updated>
  </AddressResponseModel>
</ArrayOfAddressResponseModel>