GET CustomerAddress/GetCustomerAddress?CustomerID={CustomerID}&BillToOrShipTo={BillToOrShipTo}&BillToShipToName={BillToShipToName}

Returns a list of customer addresses.

Request Information

URI Parameters

Name	Description	Type	Additional Information
CustomerID	Customer ID of the address records to return. (optional)	string	Default value is string.Empty
BillToOrShipTo	Return only BillTo or ShipTo addresses. "B" for BillTo Only and "S" for ShipTo Only. Default is blank for all address types. (optional)	string	Default value is string.Empty
BillToShipToName	BillTo / ShipTo Name of the address records to return. (optional)	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns a list of customer addresses.

AgvCustomerAddress

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many ClsCustAddr JSON dictionaries.	string
AddressList	JSON dictionary of Customer Addresses	Collection of ClsCustAddr

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "AddressList": [
    {
      "CustID": "sample string 5",
      "BillToORShipTo": "sample string 6",
      "BillToShipToName": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "City": "sample string 11",
      "State": "sample string 12",
      "Zip": "sample string 13",
      "Country": "sample string 14",
      "GeoCode": "sample string 15",
      "SalespersonID": "sample string 16",
      "Territory": "sample string 17",
      "County": "sample string 18",
      "TaxRate": 19.1,
      "Inactive": true,
      "GeoCodedLatitude": 23.1,
      "GeoCodedLongitude": 25.1,
      "PrimaryAddress": true,
      "BillToShipToCrossReference": "sample string 27",
      "DefaultFederalPermit": "sample string 28",
      "StateTaxCode": "sample string 29",
      "AdjTaxCode": "sample string 30",
      "DefaultStateCountyPermit": "sample string 31",
      "HealthID": "sample string 32",
      "HINIdentifer": "sample string 33",
      "GLN": "sample string 34"
    },
    {
      "CustID": "sample string 5",
      "BillToORShipTo": "sample string 6",
      "BillToShipToName": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Address3": "sample string 10",
      "City": "sample string 11",
      "State": "sample string 12",
      "Zip": "sample string 13",
      "Country": "sample string 14",
      "GeoCode": "sample string 15",
      "SalespersonID": "sample string 16",
      "Territory": "sample string 17",
      "County": "sample string 18",
      "TaxRate": 19.1,
      "Inactive": true,
      "GeoCodedLatitude": 23.1,
      "GeoCodedLongitude": 25.1,
      "PrimaryAddress": true,
      "BillToShipToCrossReference": "sample string 27",
      "DefaultFederalPermit": "sample string 28",
      "StateTaxCode": "sample string 29",
      "AdjTaxCode": "sample string 30",
      "DefaultStateCountyPermit": "sample string 31",
      "HealthID": "sample string 32",
      "HINIdentifer": "sample string 33",
      "GLN": "sample string 34"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvCustomerAddress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Customer">
  <AddressList xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.AR">
    <d2p1:ClsCustAddr>
      <d2p1:Address1>sample string 8</d2p1:Address1>
      <d2p1:Address2>sample string 9</d2p1:Address2>
      <d2p1:Address3>sample string 10</d2p1:Address3>
      <d2p1:AdjTaxCode>sample string 30</d2p1:AdjTaxCode>
      <d2p1:BillToORShipTo>sample string 6</d2p1:BillToORShipTo>
      <d2p1:BillToShipToCrossReference>sample string 27</d2p1:BillToShipToCrossReference>
      <d2p1:BillToShipToName>sample string 7</d2p1:BillToShipToName>
      <d2p1:City>sample string 11</d2p1:City>
      <d2p1:Country>sample string 14</d2p1:Country>
      <d2p1:County>sample string 18</d2p1:County>
      <d2p1:CustID>sample string 5</d2p1:CustID>
      <d2p1:DefaultFederalPermit>sample string 28</d2p1:DefaultFederalPermit>
      <d2p1:DefaultStateCountyPermit>sample string 31</d2p1:DefaultStateCountyPermit>
      <d2p1:GLN>sample string 34</d2p1:GLN>
      <d2p1:GeoCode>sample string 15</d2p1:GeoCode>
      <d2p1:GeoCodedLatitude>23.1</d2p1:GeoCodedLatitude>
      <d2p1:GeoCodedLongitude>25.1</d2p1:GeoCodedLongitude>
      <d2p1:HINIdentifer>sample string 33</d2p1:HINIdentifer>
      <d2p1:HealthID>sample string 32</d2p1:HealthID>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:PrimaryAddress>true</d2p1:PrimaryAddress>
      <d2p1:SalespersonID>sample string 16</d2p1:SalespersonID>
      <d2p1:State>sample string 12</d2p1:State>
      <d2p1:StateTaxCode>sample string 29</d2p1:StateTaxCode>
      <d2p1:TaxRate>19.1</d2p1:TaxRate>
      <d2p1:Territory>sample string 17</d2p1:Territory>
      <d2p1:Zip>sample string 13</d2p1:Zip>
    </d2p1:ClsCustAddr>
    <d2p1:ClsCustAddr>
      <d2p1:Address1>sample string 8</d2p1:Address1>
      <d2p1:Address2>sample string 9</d2p1:Address2>
      <d2p1:Address3>sample string 10</d2p1:Address3>
      <d2p1:AdjTaxCode>sample string 30</d2p1:AdjTaxCode>
      <d2p1:BillToORShipTo>sample string 6</d2p1:BillToORShipTo>
      <d2p1:BillToShipToCrossReference>sample string 27</d2p1:BillToShipToCrossReference>
      <d2p1:BillToShipToName>sample string 7</d2p1:BillToShipToName>
      <d2p1:City>sample string 11</d2p1:City>
      <d2p1:Country>sample string 14</d2p1:Country>
      <d2p1:County>sample string 18</d2p1:County>
      <d2p1:CustID>sample string 5</d2p1:CustID>
      <d2p1:DefaultFederalPermit>sample string 28</d2p1:DefaultFederalPermit>
      <d2p1:DefaultStateCountyPermit>sample string 31</d2p1:DefaultStateCountyPermit>
      <d2p1:GLN>sample string 34</d2p1:GLN>
      <d2p1:GeoCode>sample string 15</d2p1:GeoCode>
      <d2p1:GeoCodedLatitude>23.1</d2p1:GeoCodedLatitude>
      <d2p1:GeoCodedLongitude>25.1</d2p1:GeoCodedLongitude>
      <d2p1:HINIdentifer>sample string 33</d2p1:HINIdentifer>
      <d2p1:HealthID>sample string 32</d2p1:HealthID>
      <d2p1:Inactive>true</d2p1:Inactive>
      <d2p1:PrimaryAddress>true</d2p1:PrimaryAddress>
      <d2p1:SalespersonID>sample string 16</d2p1:SalespersonID>
      <d2p1:State>sample string 12</d2p1:State>
      <d2p1:StateTaxCode>sample string 29</d2p1:StateTaxCode>
      <d2p1:TaxRate>19.1</d2p1:TaxRate>
      <d2p1:Territory>sample string 17</d2p1:Territory>
      <d2p1:Zip>sample string 13</d2p1:Zip>
    </d2p1:ClsCustAddr>
  </AddressList>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvCustomerAddress>