TOP

SearchShippingAddress()

Part Of: Contact Webservice 3.0

WSDL:

https://webservices.vin65.com/V300/ContactService.cfc?wsdl

Australian URL:

https://webservices.aus.vin65.com/V300/ContactService.cfc?wsdl

Description:

Use the SearchShippingAddresses() function to get a single shipping address or a list of address book entries using the search options listed below. Required fields are indicated by a '*'

Parameters:

Attribute Data Type Default Description
WebsiteIDs UUID List   Available for Enterprise Webservices
Comma seperated list of WebsiteIDs in Enterprise
Leave blank for all Websites
ContactID UUID   UUID of the Vin65 Contact
ShippingAddressID UUID    
AltShippingAddressID String 50    
IsPrimary Boolean    
DateModifiedFrom* DateTime   in ISO 8601 notation
DateModifiedTo* DateTime    
MaxRows Integer 100  
Page Integer  

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSch ema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <SearchShippingAddresses>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <ContactID></ContactID>
      <ShippingAddressID></ShippingAddressID>
      <AltShippingAddressID></AltShippingAddressID>
      <IsPrimary></IsPrimary>
      <DateModifiedFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchShippingAddresses>
</soap:Body> 
</soap:Envelope> 

Sample Response:

 <?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <SearchShippingAddressesResponse>
    <SearchShippingAddressesReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful> 
      <ShippingAddresses>
        <ShippingAddress>
          <Address>115 First Street</Address>
          <Address2></Address2>
          <Birthdate>1902-01-02T08:00:00.000Z</Birthdate>
          <City>Sumas</City>
          <Company></Company>
          <ContactID>8c6d813f-9038-b3a5-4714-6a67131d25c3</ContactID>
          <CountryCode>US</CountryCode>
          <DateAdded>2010-10-03T05:48:38.100Z</DateAdded>
          <DateModified>2011-04-11T20:18:54.343Z</DateModified>
          <Email></Email>
          <Firstname>John</Firstname>
          <Lastname>Smith</Lastname>
          <Phone></Phone>
          <ShippingAddressID>d335af93-9211-da2f-a334-de3302ccbb33</ShippingAddressID>
          <StateCode>WA</StateCode>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
          <ZipCode></ZipCode>
        </ShippingAddress>
        <ShippingAddress>
          <Address>1700 Soscol St.</Address>
          <Address2></Address2>
          <Birthdate>2009-11-10T08:00:00.000Z</Birthdate>
          <City>Napa</City>
          <Company>NVPOS</Company>
          <ContactID>7bffad51-1cc4-fbb6-23f3-cd65cc2947b0</ContactID>
          <CountryCode>US</CountryCode>
          <DateAdded>2011-03-09T21:33:55.307Z</DateAdded>
          <DateModified>2011-03-09T21:33:55.307Z</DateModified>
          <Email>test@test.com</Email>
          <Firstname>Joe</Firstname>
          <Lastname>Smith</Lastname>
          <Phone>707-666-5555</Phone>
          <ShippingAddressID>bdd1e973-2264-112b-b1ab-82727e13a716</ShippingAddressID>
          <StateCode>CA</StateCode>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
          <ZipCode>94559</ZipCode>
        </ShippingAddress>
      </ShippingAddresses>
      <RecordCount>2</RecordCount>
    </SearchShippingAddressesReturn>
  </SearchShippingAddressesResponse>
</soapenv:Body>
</soapenv:Envelope> 

Page Top