POST api/v3/customers/{customerId}/addressBookEntryList

Retrieves a list of address book entries for a customer

Request Information

URI Parameters

Name	Description	Type	Additional information
customerId	The id of the customer for which to retrieve address book entries	integer	Required

Body Parameters

The parameters defining the requested items.

CustomerAddressBookEntrySearchRequest

Name	Description	Type	Additional information
MatchPartial	Allow partial match	boolean	Default value is false
StartingRowNumber	Starting row number	integer	Default value is 0
RowCount	Maximum number of rows to return.	integer	Default value is 50
FilterText	The text to match in First Name, Last Name, Company Name, Location Code, or Location Name	string	None.
TradeLocation	Should only TradeLocations be returned. Null = don't care, True = Only Trade Locations, False = No Trade Locations	boolean	None.
IsConsignee	Should only Consignees be returned. Null = don't care, True = Only Consignees, False = No Consignees	boolean	None.
CustomerLocationId	Customer Location Id to filter results by. If set, only entries that would apply to the indicated Location will be returned.	integer	None.
City	City for which to return entries	string	None.
CountryCode	Country code for which to return entries	string	Max length: 2

Request Formats

application/json, text/json

Sample:

{
  "MatchPartial": true,
  "StartingRowNumber": 2,
  "RowCount": 3,
  "FilterText": "sample string 4",
  "TradeLocation": true,
  "IsConsignee": true,
  "CustomerLocationId": 1,
  "City": "sample string 5",
  "CountryCode": "sample string 6"
}

application/xml, text/xml

Sample:

<CustomerAddressBookEntrySearchRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MatchPartial>true</MatchPartial>
  <StartingRowNumber>2</StartingRowNumber>
  <RowCount>3</RowCount>
  <FilterText>sample string 4</FilterText>
  <TradeLocation>true</TradeLocation>
  <IsConsignee>true</IsConsignee>
  <CustomerLocationId>1</CustomerLocationId>
  <City>sample string 5</City>
  <CountryCode>sample string 6</CountryCode>
</CustomerAddressBookEntrySearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A collection of objects describing all of the address book entries for the customer

Collection of CustomerAddressBookEntry

Name	Description	Type	Additional information
AddressBookEntryId	The id of the entry	integer	None.
LocationId	The id of a customer location this entry is for. Null means customer level. Populated means location level.	integer	None.
FirstName	The First name of the entry	string	None.
LastName	The Last name of the entry	string	None.
PhoneNumber	The phone number of the entry	string	None.
EmailAddress	The email address of the entry	string	None.
Address	The Address of the entry	Address	Required
CompanyName	The associated Company name of the entry	string	None.
VatCode	The VAT code for the entry	string	None.
LocationCode	A customer designated location code for the entry	string	None.
LocationName	A customer designated location name for the entry	string	None.
RelatedConsigneeId	The ID of a related consignee addressbook entry. Used during international shipping.	integer	None.
TradeLocation	Is the entry identified as a Trade Location. Makes a difference during international shipping.	boolean	None.
Consignee	Is the entry a Consignee entry for use during international shipping.	boolean	None.
GroupName	The name of the group of related entries the entry belongs to.	string	None.
ConsigneeIdentifier1	Additional identification on commerical invoices for consignee. "RFC# xxxxx" or "CURP# xxxx" as example	string	None.
ConsigneeIdentifier2	Additional identification on commerical invoices for consignee. "RFC# xxxxx" or "CURP# xxxx" as example	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AddressBookEntryId": 1,
    "LocationId": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "PhoneNumber": "sample string 4",
    "EmailAddress": "sample string 5",
    "Address": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "Street3": "sample string 3",
      "City": "sample string 4",
      "Region": "sample string 5",
      "Postalcode": "sample string 6",
      "PostalZip4": "sample string 7",
      "CountryCode": "sample string 8"
    },
    "CompanyName": "sample string 6",
    "VatCode": "sample string 7",
    "LocationCode": "sample string 8",
    "LocationName": "sample string 9",
    "RelatedConsigneeId": 1,
    "TradeLocation": true,
    "Consignee": true,
    "GroupName": "sample string 12",
    "ConsigneeIdentifier1": "sample string 13",
    "ConsigneeIdentifier2": "sample string 14"
  },
  {
    "AddressBookEntryId": 1,
    "LocationId": 1,
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "PhoneNumber": "sample string 4",
    "EmailAddress": "sample string 5",
    "Address": {
      "Street1": "sample string 1",
      "Street2": "sample string 2",
      "Street3": "sample string 3",
      "City": "sample string 4",
      "Region": "sample string 5",
      "Postalcode": "sample string 6",
      "PostalZip4": "sample string 7",
      "CountryCode": "sample string 8"
    },
    "CompanyName": "sample string 6",
    "VatCode": "sample string 7",
    "LocationCode": "sample string 8",
    "LocationName": "sample string 9",
    "RelatedConsigneeId": 1,
    "TradeLocation": true,
    "Consignee": true,
    "GroupName": "sample string 12",
    "ConsigneeIdentifier1": "sample string 13",
    "ConsigneeIdentifier2": "sample string 14"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerAddressBookEntry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomerAddressBookEntry>
    <AddressBookEntryId>1</AddressBookEntryId>
    <LocationId>1</LocationId>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <PhoneNumber>sample string 4</PhoneNumber>
    <EmailAddress>sample string 5</EmailAddress>
    <Address>
      <Street1>sample string 1</Street1>
      <Street2>sample string 2</Street2>
      <Street3>sample string 3</Street3>
      <City>sample string 4</City>
      <Region>sample string 5</Region>
      <Postalcode>sample string 6</Postalcode>
      <PostalZip4>sample string 7</PostalZip4>
      <CountryCode>sample string 8</CountryCode>
    </Address>
    <CompanyName>sample string 6</CompanyName>
    <VatCode>sample string 7</VatCode>
    <LocationCode>sample string 8</LocationCode>
    <LocationName>sample string 9</LocationName>
    <RelatedConsigneeId>1</RelatedConsigneeId>
    <TradeLocation>true</TradeLocation>
    <Consignee>true</Consignee>
    <GroupName>sample string 12</GroupName>
    <ConsigneeIdentifier1>sample string 13</ConsigneeIdentifier1>
    <ConsigneeIdentifier2>sample string 14</ConsigneeIdentifier2>
  </CustomerAddressBookEntry>
  <CustomerAddressBookEntry>
    <AddressBookEntryId>1</AddressBookEntryId>
    <LocationId>1</LocationId>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <PhoneNumber>sample string 4</PhoneNumber>
    <EmailAddress>sample string 5</EmailAddress>
    <Address>
      <Street1>sample string 1</Street1>
      <Street2>sample string 2</Street2>
      <Street3>sample string 3</Street3>
      <City>sample string 4</City>
      <Region>sample string 5</Region>
      <Postalcode>sample string 6</Postalcode>
      <PostalZip4>sample string 7</PostalZip4>
      <CountryCode>sample string 8</CountryCode>
    </Address>
    <CompanyName>sample string 6</CompanyName>
    <VatCode>sample string 7</VatCode>
    <LocationCode>sample string 8</LocationCode>
    <LocationName>sample string 9</LocationName>
    <RelatedConsigneeId>1</RelatedConsigneeId>
    <TradeLocation>true</TradeLocation>
    <Consignee>true</Consignee>
    <GroupName>sample string 12</GroupName>
    <ConsigneeIdentifier1>sample string 13</ConsigneeIdentifier1>
    <ConsigneeIdentifier2>sample string 14</ConsigneeIdentifier2>
  </CustomerAddressBookEntry>
</ArrayOfCustomerAddressBookEntry>