PUT CustomerAddress/PutByHin

Update a customer bill to / ship to address geocode info

Request Information

URI Parameters

Body Parameters

The model used to update the customer's address geocode information by HIN Identifier

ClsCustAddrUpdateGeoCode

Name	Description	Type	Additional Information
HINIdentifier	HIN Identifier	string	Required Max length: 16
GeoCodedLatitude	Latitude of the address	decimal number	Required Max of 6 decimal places Range: inclusive between -90 and 90
GeoCodedLongitude	Longitude of the address	decimal number	Required Max of 6 decimal places Range: inclusive between -180 and 180

Name

Description

Type

Additional Information

HINIdentifier

HIN Identifier

string

Required

Max length: 16

GeoCodedLatitude

Latitude of the address

decimal number

Required

Max of 6 decimal places

Range: inclusive between -90 and 90

GeoCodedLongitude

Longitude of the address

decimal number

Required

Max of 6 decimal places

Range: inclusive between -180 and 180

Request Formats

application/json, text/json

Sample:

{
  "HINIdentifier": "sample string 3",
  "GeoCodedLatitude": 4.1,
  "GeoCodedLongitude": 5.1
}

application/xml, text/xml

Sample:

<ClsCustAddr.ClsCustAddrUpdateGeoCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.AR">
  <GeoCodedLatitude>4.1</GeoCodedLatitude>
  <GeoCodedLongitude>5.1</GeoCodedLongitude>
  <HINIdentifier>sample string 3</HINIdentifier>
</ClsCustAddr.ClsCustAddrUpdateGeoCode>

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 'ClsCustAddrUpdateGeoCode'.

Response Information

Resource Description

Update a customer bill to / ship to address geocode info

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",
      "CustAddrGuid": "498245c7-27c5-4071-aa5e-7929d8f25ca8",
      "LastModifiedDate": "2025-08-23T07:37:36.7077472+00:00"
    },
    {
      "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",
      "CustAddrGuid": "498245c7-27c5-4071-aa5e-7929d8f25ca8",
      "LastModifiedDate": "2025-08-23T07:37:36.7077472+00:00"
    }
  ]
}

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:CustAddrGuid>498245c7-27c5-4071-aa5e-7929d8f25ca8</d2p1:CustAddrGuid>
      <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:LastModifiedDate>2025-08-23T07:37:36.7077472+00:00</d2p1:LastModifiedDate>
      <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:CustAddrGuid>498245c7-27c5-4071-aa5e-7929d8f25ca8</d2p1:CustAddrGuid>
      <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:LastModifiedDate>2025-08-23T07:37:36.7077472+00:00</d2p1:LastModifiedDate>
      <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>