Contact Service 3.0

08 Apr 2024
9 Minutes to read

Print
Share
Dark
Light
PDF

Contact Service 3.0

Updated on 08 Apr 2024
9 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

WSDL:

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

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

Australian URL:

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

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

Methods:

SearchContacts()
Use this method to search across contacts.

GetContact()
Use this method to get a single contact.

GetContactStatus()
Use this method to get a contacts status (Subscriber, Purchaser, Club Member).

SearchShippingAddresses()
Use this method to search across shipping addresses.

SearchContactTypes()
Use this method to search across contact types.

GetContactType()
Use this method to get a single contact type.

AddUpdateContactType()
Use this method to add or update an existing contact type.

AddContactTypeToContact()
Use this method to add a contact type to a contact.

RemoveContactTypeFromContact()
Use this method to remove a contact type from a contact.

SearchMergedContacts()
Use this method to find contact that have been merged.

MergeContact()
Use this method to merge one contact into another contact.

UpsertContact()
Use this method to upsert contacts.

SearchContacts()

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 SearchContacts() function to get a single contact or a list of contacts using the search options listed below. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
WebsiteIDs	Comma-separated list of UUIDs		Available for Enterprise Webservices. Leave blank for all Websites
ContactID	UUID		UUID of the contact
AltContactID	String 50
CustomerNumber	Integer
FirstName	String 50
LastName	String 50
Company	String 255
City	String 50
StateCode	String 50
Phone	String 50
Email	String 100
EmailStatus	String 50
ContactType	String 50
DateModifiedFrom*	DateTime		ISO 8601 format. E.g.: 2017-10-26T19:43:31Z
DateModifiedTo*	DateTime
SortBy	comma separated, from list of set values	LastName	Allowed values: LastName, Company, City, StateCode, Email, CustomerNumber, LTV
MaxRows	Integer	100
Page	Integer	1

Sample Request:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v300="http://V300">
<soapenv:Body>
  <SearchContacts>
    <Request>
      <Security>
        <Username>Your_Username</Username>
        <Password>Your_Password</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <ContactID></ContactID>
      <AltContactID></AltContactID>
      <CustomerNumber>1234</CustomerNumber>
      <FirstName></FirstName>
      <LastName></LastName>
      <Company></Company>
      <City></City>
      <StateCode></StateCode>
      <Phone></Phone>
      <Email></Email>
      <EmailStatus></EmailStatus>
      <ContactType></ContactType>
      <DateModifie dFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <SortBy>LastName</SortBy>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchContacts>
</soapenv:Body>
</soapenv: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>
  <SearchContactsResponse>
    <SearchContactsReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful> 
      <Contacts>
        <Contact>
          <Address>120 Wellington Rd.</Address>
          <Address2></Address2>
          <BirthDate/>
          <City>Sumas</City>
          <Company></Company>
          <ContactID>89eab9c7-a2c9-bfd7-e9e9-421b924a56f0</ContactID>
          <CountryCode>US</CountryCode>
          <CustomerNumber>1234</CustomerNumber>
          <DateAdded>2011-03-08T21:22:30.890Z</DateAdded>
          <DateModified>2011-04-19T16:50:12.507Z</DateModified>
          <Email>john.smith@gmail.com</Email>
          <EmailStatus>Double Opt In</EmailStatus>
          <FirstName>John</FirstName>
          <IsNonTaxable>true</IsNonTaxable>
          <LastLoginDate/>
          <LastName>Smith</LastName>
          <LastOrderDate>2012-04-23T21:29:03.000Z</LastOrderDate>
          <LifetimeValue>3463.89</LifetimeValue>
          <MasterContactID>3463.89</MasterContactID>
          <OrderCount>11</OrderCount>
          <Phone>604-852-8140</Phone>
          <StateCode>WA</StateCode>
          <SourceCode/>
          <Title/>
          <Username/>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
          <WholesaleNumber/>
          <ZipCode>98295</ZipCode>
        </Contact>
      </Contacts>
      <RecordCount>1</RecordCount>
    </SearchContactsReturn>
  </SearchContactsResponse>
</soapenv:Body>
</soapenv:Envelope>

GetContact()

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 GetContact() function to get a single contact. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Description
WebsiteID	UUID	Available For Enterprise Webservices UUID of the Vin65 Website Not necessary if ContactID is present Useful if searching by AltContactID or CustomerNumber and AltContactID or CustomerNumber is not unique across Enterprise
ContactID	UUID	UUID of the Vin65 Contact
AltContactID	String 50
CustomerNumber	Integer

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <GetContact>
    <Request>
      <Security>
        <Username>//Your Usernam e//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      <ContactID></ContactID>
      <AltContactID></AltContactID>
      <CustomerNumber>1234</CustomerNumber>
    </Request>
  </GetContact>
</soap:Body> 
</soap:Envelope>

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://sche mas.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <GetContactResponse>
    <GetContactReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <Contact>
        <Address>120 Wellington Rd.</Address>
        <Address2></Address2>
        <BirthDate/>
        <City>Sumas</City>
        <Company></Company>
        <ContactID>89eab9c7-a2c9-bfd7-e9e9-421b924a56f0</ContactID>
        <CountryCode>US</CountryCode>
        <CustomerNumber>1234</CustomerNumber>
        <DateAdded>2011-03-08T21:22:30.890Z</DateAdded>
        <DateModified>2011-04-19T16:50:12.507Z</DateModified>
        <Email>john.smith@gmail.com</Email>
        <EmailStatus>Double Opt In</EmailStatus>
        <FirstName>John</FirstName>
        <IsNonTaxable>true</IsNonTaxable>
        <LastLoginDate/>
        <LastName>Smith</LastName>
        <LastOrderDate>2012-04-23T21:29:03.000Z</LastOrderDate>
        <LifetimeValue>3463.89</LifetimeValue>
        <OrderCount>11</OrderCount>
        <Phone>604-852-8140</Phone>
        <StateCode>WA</StateCode>
        <SourceCode>Event</SourceCode>
        <Title></Title>
        <Username></Username>
        <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        <WholesaleNumber></WholesaleNumber>
        <ZipCode>98295</ZipCode>
      </Contact>
      <RecordCount>1</RecordCount>
    </GetContactReturn>
  </GetContactResponse>
</soapenv:Body>
</soapenv:Envelope>

GetContactStatus()

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 GetContactStatus() function to get a single contact status (Status, Subscriber, Purchaser, Club Member). Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Description
WebsiteID	UUID	Available For Enterprise Webservices UUID of the Vin65 Website Not necessary if ContactID is present Useful if searching by AltContactID or CustomerNumber and AltContactID or CustomerNumber is not unique across Enterprise
ContactID	UUID	UUID of the Vin65 Contact
AltContactID	String 50
CustomerNumber	Integer

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <GetContactStatus>
    <Request> 
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      <ContactID></ContactID>
      <AltContactID></AltContactID>
      <CustomerNumber>1234</CustomerNumber>
      <ContactStatus>1stTimeCustomer</ContactStatus>
    </Request>
  </GetContactStatus>
</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>
  <GetContactStatusResponse> 
    <GetContactStatusReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <IsClubMember>false</IsClubMember>
      <IsSubscriber>true</IsSubscriber>
      <IsPurchaser>true</IsPurchaser>
<ContactStatus>1stTimeCustomer</ContactStatus>
      <RecordCount>1</RecordCount>
    </GetContactStatusReturn>
  </GetContactStatusResponse>
</soapenv:Body>
</soapenv:Envelope>

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	1

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>

SearchContactTypes()

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 SearchContactTypes() function to get a single contact type or a list of contact types 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
ContactTypeID	UUID		UUID of the Vin65 Contact Type
ContactType	String 50
DateModifiedFrom	DateTime
DateModifiedTo	DateTime
MaxRows	Integer	100
Page	Integer	1

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <SearchContactTypes> 
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <ContactTypeID></ContactTypeID>
      <ContactType></ContactType>
      <DateModifiedFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchContactTypes>
</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> 
  <SearchContactTypesResponse>
    <SearchContactTypesReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <ContactTypes>
        <ContactType>
          <ContactType>200 Club</ContactType>
          <ContactTypeID>7887de3f-dc0f-c933-195e-de6812e2b585</ContactTypeID>
          <DateAdded>2011-03-08T21:22:30.890Z</DateAdded>
          <DateModified>2011-04-19T16:50:12.507Z</DateModified>
          <IsPublic>1</IsPublic>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </ContactType>
      </ContactTypes>
      <RecordCount>1</RecordCount>
    </SearchContactTypesReturn>
  </SearchContactTypesResponse>
</soapenv:Body>
</soapenv:Envelope>

GetContactType()

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 GetContactType() function to get a single contact type. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
ContactTypeID	UUID		UUID of the Vin65 Contact Type

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body> 
  <GetContactType>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <ContactTypeID>ef0db0d3-fc40-c0e1-1faf-25e7d0015c1b</ContactTypeID>
    </Request>
  </GetContactType>
</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>
  <GetContactTypeResponse>
    <GetContactTypeReturn> 
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <ContactType>
        <ContactType>200 Club</ContactType>
        <ContactTypeID>ef0db0d3-fc40-c0e1-1faf-25e7d0015c1b</ContactTypeID>
        <DateAdded>2011-03-08T21:22:30.890Z</DateAdded>
        <DateModified>2011-04-19T16:50:12.507Z</DateModified>
        <IsPublic>1</IsPublic>
        <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      </ContactType>
      <RecordCount>1</RecordCount>
    </GetContactTypeReturn>
  </GetContactTypeResponse>
</soapenv:Body>
</soapenv:Envelope>

AddUpdateContactType()

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 AddUpdateContactType() function to either add a new contact type or update a current contact type. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
WebsiteID	UUID*		Only required for Enterprise Webservices UUID of the Vin65 Website
ContactTypeID	UUID		UUID of the Vin65 Contact Type
ContactType	String 50*
IsPublic	Boolean	False
DateAdded	DateTime		Controlled by Vin65 System
DateModified	DateTime		Controlled by Vin65 System

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <AddUpdateContactType>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <ContactType>
        <WebsiteID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</WebsiteID>
        <ContactTypeID>43e15e63-2264-112b-b157-70b1cc864227</ContactTypeID>
        <ContactType>Employee</ContactType>
        <IsPublic>False</IsPublic>
      </ContactType>
      <Mode>Strict</Mode> 
    </Request>
</AddUpdateContactType>
</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>
  <AddUpdateContactTypeResponse>
    <AddUpdateContactTypeReturn>
      <Errors></Errors> 
      <IsSuccessful>true</IsSuccessful>
      <ContactTypeID>43e15e63-2264-112b-b157-70b1cc864227</ContactTypeID>
      <RecordCount>1</RecordCount>
    </AddUpdateContactTypeReturn>
  </AddUpdateContactTypeResponse>
</soapenv:Body>
</soapenv:Envelope>

AddContactTypeToContact()

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 AddContactTypeToContact() function to add a Contact Type to a Contact. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
ContactID	UUID*		UUID of the Vin65 Contact
ContactTypeID	UUID*		UUID of the Vin65 Contact Type

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <AddContactTypeToContact>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password// </Password>
      </Security>
      <ContactID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</ContactID>
      <ContactTypeID>43e15e63-2264-112b-b157-70b1cc864227</ContactTypeID>
    </Request>
</AddContactTypeToContact>
</soap:Body>
</soap:Envelope>

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlso ap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <AddContactTypeToContactResponse>
    <AddContactTypeToContactReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <RecordCount>1</RecordCount>
    </AddContactTypeToContactReturn>
  </AddContactTypeToContactResponse>
</soapenv:Body>
</soapenv:Envelope>

RemoveContactTypeFromContact()

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 RemoveContactTypeFromContact() function to remove a Contact Type from a Contact. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
ContactID	UUID*		UUID of the Vin65 Contact
ContactTypeID	UUID*		UUID of the Vin65 Contact Type

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <RemoveContactTypeFromContact>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <ContactID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</ContactID>
      <ContactTypeID>43e15e63-2264-112b-b157-70b1 cc864227</ContactTypeID>
    </Request>
</RemoveContactTypeFromContact>
</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>
  <RemoveContactTypeFromContactResponse>
    <RemoveContactTypeFromContactReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <RecordCount>1</RecordCount>
    </RemoveContactTypeFromContactReturn>
  </RemoveContactTypeFromContactResponse>
</soapenv:Body>
</soapenv:Envelope>

SearchMergedContacts()

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 SearchMergedContacts() function to get a list of all contacts that have been merged 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
DateMergedFrom	DateTime
DateMergedTo	DateTime
MaxRows	Integer	100
Page	Integer	1

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <SearchMergedContacts>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <DateMergedFrom>2011-01-01T12:21:43</DateMergedFrom>
      <DateMergedTo>2011-09-12T12:21:43</DateMergedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchMergedContacts>
</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>
  <SearchMergedContactsResponse>
    <SearchMergedContactsReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful> 
      <MergedContacts>
        <MergedContact>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
          <ContactID>89eab9c7-a2c9-bfd7-e9e9-421b924a56f0</ContactID>
          <MergedIntoContactID>9b0971bd-bab6-f888-9cfc-ab6ba035b9c3</MergedIntoContactID>
          <DateMerged>2011-03-08T21:22:30.890Z</DateMerged>
        </MergedContact>
      </MergedContacts>
      <RecordCount>1</RecordCount>
    </SearchMergedContactsReturn>
  </SearchMergedContactsResponse>
</soapenv:Body>
</soapenv:Envelope>

MergeContact()

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 MergeContact() function to get a merge one contact into another. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Description
WebsiteID	UUID	Available For Enterprise Webservices UUID of the Vin65 Website Not necessary if ContactID is present Useful if searching by AltContactID or CustomerNumber and AltContactID or CustomerNumber is not unique across Enterprise
ContactID	UUID	UUID of the Vin65 Contact
AltContactID	String 50
CustomerNumber	Integer
MergeIntoContactID	UUID	UUID of the Vin65 Contact
MergeIntoAltContactID	String 50
MergeIntoCustomerNumber	Integer

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <GetContact>
    <Request>
      <Security>
        <Username>//Your Usernam e//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      <ContactID></ContactID>
      <AltContactID></AltContactID>
      <CustomerNumber>1234</CustomerNumber>
      <MergeIntoContactID></MergeIntoContactID>
      <MergeIntoAltContactID></MergeIntoAltContactID>
      <MergeIntoCustomerNumber>1235</MergeIntoCustomerNumber>     
    </Request>
  </GetContact>
</soap:Body> 
</soap:Envelope>

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://sche mas.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <MergeContactResponse>
    <MergeContactReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <ContactID>89eab9c7-a2c9-bfd7-e9e9-421b924a56f0</ContactID>
      <MergeIntoContactID>9b0971bd-bab6-f888-9cfc-ab6ba035b9c3</MergeIntoContactID>      
      <RecordCount>1</RecordCount>
    </MergeContactReturn>
  </MergeContactResponse>
</soapenv:Body>
</soapenv:Envelope>

UpsertContact()

Part Of: Contact Webservice 3.04

WSDL:

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

Australian URL:

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

Description:

Use the UpsertContact() function to upsert an array of contacts. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
ContactID	UUID	Auto-generated if contact doesn't exist by "AltContactID" or "Email"	UUID of the WineDirect Contact
AltContactID	String 50		A string reference to the contact in your system. Setting this will allow future updates to occur using your AltContactID instead of the WineDirect "ContactID".
FirstName	String 50		The first name of the customer.
LastName	String 50		The last name of the customer.
Title	String 50		The customer's title.
Company	String 255		The customer's business or company.
Address	String 255		The street address of the customer.
Address2	String 255		Additional address information. For example, unit #, apt #, etc.
City	String 50		The customer's city of residence.
StateCode	String 50		The two character abbreviated state code or province code. For example, California = CA, British Columbia = BC. Australia state codes, South Australia = SA, Victoria = VIC etc.
CountryCode	String 50		This is a standard two letter country code, default is “US”.
ZipCode	String 50		The customer's zip code or Postal Code.
MainPhone	String 50		The customer's main phone number. Format is in: 000-000-0000
Email	String 100		When upserting customers, email is used to match existing records if no other IDs are passed in.
Username	String 100		Usernames must be unique and greater than 6 characters. Required if "Password" is passed in.
Password	String 255		Passwords must be greater than 6 characters. Required if "Username" is passed in.
Birthdate	Date		Formatted as a YYYY-MM-DD
PriceLevel	String 50		The name of a price level that must already exist in the WineDirect platform. If it exists, the contact will have that price level assigned. If it does not exist, you will get an error.
IsNonTaxable	Boolean	False	Set this to true for contacts that are not required to pay tax. Tax calculations will use this flag to make them exempt if appropriate. Default is false.
WholesaleNumber	String 50		The Wholesale number of the customer.
PaymentTerms	String 50		Enumerated type that is either blank (default), “Net 10”, “Net 30”, or “Upon Receipt”.
FacebookProfileID	String 50		Used to store a Facebook ID for Facebook related services in the WineDirect platform.
CreditCardType	String 50		If it exists, this will overwrite the primary credit card. Must be one of the following values: MasterCard,Visa,AmericanExpress,Diners,Discover,JCB
CreditCardNumber	String 255		If it exists, this will overwrite the primary credit card. Must match the format of the passed in "CreditCardType".
.CreditCardExpirationMonth	Integer		If it exists, this will overwrite the primary credit card. Must be a valid integer between 1 and 12.
CreditCardExpirationYear	Integer		If it exists, this will overwrite the primary credit card. Must be a valid 4 digit year.
CreditCardNameOnCard	String 255		If it exists, this will overwrite the primary credit card. Name that appears on the Credit Card.
IsSingleOptIn	Boolean	False	Set this to true for customers who have requested to opt into a mailing list. This will set their email status to "Single Opt In", and will send them an "Email Verification" email which contains a link to Double Opt In. Default is false.

Sample Request:

<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <UpsertContact>
    <Request>
      <Security>
        <Username>//Your Usernam e//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <Contacts>
        <Contact>
          <Firstname>Michael</Firstname>
          <Lastname>Hersch</Lastname>
          <Email>michael.hersch@winedirect.com</Email>
        </Contact>
        <Contact>
          <Email>invalidemail</Email>
        </Contact>
      </Contacts>
    </Request>
  </UpsertContact>
</soap:Body> 
</soap:Envelope>

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soapenv:Body>
    <UpsertContactResponse>
      <UpsertContactReturn>
        <ContactResults>
          <ContactResults>
            <Contact>
              <Address></Address>
              <Address2></Address2>
              <AltContactID></AltContactID>
              <Birthdate />
              <City></City>
              <Company></Company>
              <ContactID>5897B83E-EC54-1187-9214-72B17F0ED71C</ContactID>
              <CountryCode></CountryCode>
              <CreditCardExpirationMonth />
              <CreditCardExpirationYear />
              <CreditCardNameOnCard />
              <CreditCardNumber />
              <CreditCardType />
              <CustomerNumber>22796</CustomerNumber>
              <DateAdded>2019-07-24T21:28:08.297Z</DateAdded>
              <DateModified>2019-07-24T21:28:08.297Z</DateModified>
              <Email>michael.hersch@winedirect.com</Email>
              <FacebookProfileID></FacebookProfileID>
              <Firstname>Michael</Firstname>
              <IsNonTaxable>false</IsNonTaxable>
              <IsSingleOptIn />
              <LastLoginDate />
              <Lastname>Hersch</Lastname>
              <MainPhone></MainPhone>
              <Password />
              <PaymentTerms></PaymentTerms>
              <PriceLevel></PriceLevel>
              <StateCode></StateCode>
              <Title></Title>
              <Username></Username>
              <WholesaleNumber></WholesaleNumber>
              <ZipCode></ZipCode>
            </Contact>
            <Errors />
            <IsSuccessful>true</IsSuccessful>
          </ContactResults>
          <ContactResults>
            <Contact />
            <Errors>
              <Errors>
                <ErrorCode>InvalidEmailFormat</ErrorCode>
                <ErrorMessage>Email must be valid.</ErrorMessage>
              </Errors>
            </Errors>
            <IsSuccessful>false</IsSuccessful>
          </ContactResults>
        </ContactResults>
        <Errors>
          <Errors>
            <ErrorCode>InvalidContact</ErrorCode>
            <ErrorMessage>1 contact(s) failed to upsert. View 'ContactResults' for more details.</ErrorMessage>
          </Errors>
        </Errors>
        <IsSuccessful>false</IsSuccessful>
        <RecordCount>1.0</RecordCount>
      </UpsertContactReturn>
    </UpsertContactResponse>
  </soapenv:Body>
</soapenv:Envelope>

Was this article helpful?

What's Next

Club Membership Service 3.0