- APIs
- Webservices V2
- Contact Service 2.0
WSDL:
https://webservices.vin65.com/v201/contactService.cfc?wsdl
Australian URL:
https://webservices.aus.vin65.com/v201/contactService.cfc?wsdl
- getClubLevel
- getClubMembership
- getContact
- getContactTypeForContact
- getShippingAddress
- upsertClubMembership
- upsertContact
- upsertShippingAddress
getClubLevel
This method will list all of the Club Levels for a given website.
Request
There are no further request parameters.
Response
clubLevelID (string)
This matches the club ID
clubName (string)
This is the club name.
altClubID (string)
Alternative club ID name for vendors.
teaser (string)
Club tease from our site admin.
description (string)
Club description from our site admin.
isActive (boolean)
If club is active.
getClubMembership
Request
contactID (string)
A GUID reference to the contact in the Vin65 system. Specifying a contactID will return all club membership records for that contact.
altContactID (string)
A string reference to the contact in your system. If you have previously set this value, you can now retrieve club memberships using your reference ID rather than Vin65’s. Specifying an altContactID will return all club membership records for that contact.
clubMembershipID (string)
A GUID reference to a specific club membership in the Vin65 system. Specifying a clubMembershipID will return a single record and contactID and altContactID will be ignored.
altClubMembershipID (string)
A string reference to a specific club membership in your system. If you have previously set this value, you can now retrieve the club membership using your reference ID rather than Vin65’s. Specifying an altClubMembershipID will return a single record and contactID and altContactID will be ignored.
Response
firstName (string)
The first name of the customer.
lastName (string)
The last name of the customer.
company (string)
The customer's business or company.
address (string)
The street address of the customer.
address2 (string)
Additional address information. For example, unit#, apt#, etc.
city (string)
The customer's city of residence.
stateCode (string)
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)
The 2-digit code for the country. United States = US, Canada = CA, Australia = AU.
zipcode (string)
The customer's zip code or Postal Code.
mainPhone (string)
The customer's main phone number. Format is in: 000-000-0000.
email (string)
Each customer must have a unique email address.
birthdate (date)
The birthdate of the customer. Format is in: MM/DD/YYYY or DD/MM/YYYY.
isActive(boolean)
O indicates inactive, while 1 indicates active.
dateAdded (date)
Can be entered as MM/DD/YYYY or DD/MM/YYYY
dateModified (date)
Can be entered as MM/DD/YYYY or DD/MM/YYYY
getContact
Request
contactID (string)
A GUID reference to the contact in the Vin65 system. Specifying a contactID will return a single specific contact record.
altContactID (string)
A string reference to the contact in your system. If you have previously set this value, you can now retrieve contacts using your reference ID rather than Vin65’s. Specifying an altContactID will return a single specific contact record.
customerNumber (string)
A unique human-readable number assigned to a contact in the Vin65 system. Specifying a customerNumber will return a single specific contact record.
firstName (string)
A contact’s first name. Unlikely to be unique, this may return multiple records and is useful for searching.
lastName (string)
A contact’s last name. Unlikely to be unique, this may return multiple records and is useful for searching.
eMail (string)
A contact’s email address. Likely to be unique but may return return multiple records.
Company (string)
A contact’s company. Unlikely to be unique, this may return multiple records and is useful for searching.
City (string)
A contact’s city. Unlikely to be unique, this may return multiple records and is useful for searching.
Phone (string)
A contact’s phone number. Unlikely to be unique, this may return multiple records and is useful for searching.
contactType (string)
A string specifying a contact type that has been defined in the Vin65 admin panel. Typical values are “VIP”, “Friends and Family”, or “Bob’s A-List”. Some coordination is required to make sure the contact type specified exists in the Vin65 system.
fromDate (date)
A filter criteria specifying that only records modified after this date are to be returned.
toDate (date)
A filter criteria specifying that only records modified before this date are to be returned.
Page (numeric)
Used for pagination in conjunction with maxRecordCount. It allows the caller to request data in segments. The page parameter specifies which segment and the maxRecordCount specifies how big the segment should be. For example, if you display 20 records on a page and you want the third page, you would set page equal to 3 and maxRecordCount equal to 20.
maxRecordCount (numeric)
Specifies the maximum number of records to return. Typically used for pagination in conjunction with page. It allows the caller to request data in segments. The page parameter specifies which segment and the maxRecordCount specifies how big the segment should be. For example, if you display 20 records on a page and you want the third page, you would set page equal to 3 and maxRecordCount equal to 20.
Response
accountNumber (string)
A unique human-readable account number within the Vin65 system assigned to each contact.
lastLogin (date)
Can be entered as MM/DD/YYYY or DD/MM/YYYY
dateAdded (date)
Can be entered as MM/DD/YYYY or DD/MM/YYYY
dateModified (date)
Can be entered as MM/DD/YYYY or DD/MM/YYYY
dateImported (date)
Can be entered as MM/DD/YYYY or DD/MM/YYYY
getContactTypeForContact
Request
contactID (string)
A GUID reference to the contact in the Vin65 system that you want to return contact types for.
altContactID (string)
A string reference to the contact in your system. If you have previously set this value, you can now retrieve contact types using your reference ID rather than Vin65’s.
Response
contactType (string)
The name of the contact type assigned to the contact.
getShippingAddress
Request
contactID (string)
A GUID reference to the contact in the Vin65 system. Specifying a contactID will return all shipping address records for that contact.
altContactID (string)
A string reference to the contact in your system. If you have previously set this value, you can now retrieve shipping addresses using your reference ID rather than Vin65’s. Specifying an altContactID will return all shipping address records for that contact.
shippingAddressID (string)
A GUID reference to a specific shipping address in the Vin65 system. Specifying a shippingAddressID will return a single record and contactID and altContactID will be ignored.
altShippingAddressID (string)
A string reference to a specific shipping address in your system. If you have previously set this value, you can now retrieve the shipping address using your reference ID rather than Vin65’s. Specifying an altShippingAddressID will return a single record and contactID and altContactID will be ignored.
Response
dateAdded
Can be entered as MM/DD/YYYY or DD/MM/YYYY
dateModified
Can be entered as MM/DD/YYYY or DD/MM/YYYY
upsertClubMembership
Request
This method requires an array of ClubMembership objects be passed in. The properties of the ClubMembership object are listed below.
contactID (string)
A GUID reference to the contact in the Vin65 system. Either contactID or altContactID are required.
altContactID (string)
A string reference to the contact in your system. It must have been previously set in Vin65 to be used here, otherwise the upsert will fail due to no contacts with this ID being found. Either contactID or altContactID are required.
clubMembershipID (string)
A GUID reference to the club membership in the Vin65 system. This should only be used for updates of existing records with a known clubMembershipID. Otherwise it’s ignored.
altClubMembershipID (string)
A string reference to the club membership in your system. The system will attempt to find a match with this ID when provided, but if it doesn’t find a match, a new record will be created with this altClubMemershipID set for future updates.
clubName (string)-REQUIRED
The exact club name as it exists in the Vin65 system. The clubName is used to determine which club the contact is a member of. Providing a clubName that does not exist in Vin65 will result in an error.
shipTo (string)
This is an enumerated string that should be set to one of: “ShippingAddress” or “BillingAddress”. If nothing is passed in, “BillingAddress” is assumed. If “ShippingAddress” is passed in, you must also pass in a shippingAddressID. You may need to add the shipping address first if it does not yet exist.
shippingAddressID (string)
Used in conjunction with “shipTo” when “ShippingAddress” is passed in.
signupDate (date)
The date that the member signed up for the club.
onHoldUntilDate (date)
If a club membership is on hold, this field is the date that the hold is to be released.
cancelDate (date)
The date that a club membership was cancelled.
retainClubPrivileges (Boolean)
If a club is on hold, a winery may allow the member to retain club privileges. Set this to true if that is the case. Default is false.
isGift (Boolean)
Whether or not this is a gift membership.
giftMessage (string)
Gift message for the gift membership. To be passed to fulfillment, typically printed on the invoice.
sourceCode (string)
A text field typically used for tracking the source of the membership via codes printed on marketing materials. Can also be used to store meta data for reporting instead.
notes (string)
Notes about the membership from the member. Typically things like ship date preferences or requests for special services.
isPickup (Boolean)
If this membership is a pickup only membership, set this to true.
isPrePay (Boolean)
If the membership was pre-paid, set this to true.
prePayOrderNumber (string)
If the membership was pre-paid and you have the order number where the payment was made, enter that here.
totalNumberOfShipments (numeric)
If this is a gift membership for a specific number of shipments, you can set this field to that number. Vin65 club processing will respect this number and remove the club membership from processing after the number has been reached.
Response
There are no additional response parameters.
upsertContact
Request
This method requires an array of Contact objects be passed in. The properties of the Contact object are listed below. When passing in contacts, the system will attempt to find a match first on contactID if provided, then it will try altContactID, and finally it will try email address. If no matches are found, a new record will be added.
contactID (string)
A GUID reference to the contact in the Vin65 system.
altContactID (string)
A string reference to the contact in your system. Setting this will allow future updates to occur using your ID instead of the Vin65 ID.
altAccountNumber (string)
This is an account number in your system that can be tracked in Vin65. It is not used for matching of accounts in anyway, but rather just for reference. Typically used with RMS integrations.
firstName (string)
The first name of the customer.
lastName (string)
The last name of the customer.
title (string)
The customer's title.
company (string)
The customer's business or company.
address (string)
The street address of the customer.
address2 (string)
Additional address information. For example, unit #, apt #, etc.
city (string)
The customer's city of residence.
stateCode (string)
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)
This is a standard two letter country code, default is “US”.
zipCode (string)
The customer's zip code or Postal Code.
mainPhone (string)
The customer's main phone number. Format is in: 000-000-0000
cellPhone (string)
Deprecated Field - Input ignored.
fax (string)
Deprecated Field - Input ignored.
email (string)-REQUIRED
This is a required field. When upserting customers, email is used to match existing records if no other IDs are passed in.
isSingleOptIn (Boolean)
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.
username(string)
Usernames must be unique and greater than 6 characters.
password(string)
Passwords must be greater than 6 characters.
birthDate (date)
priceLevel (string)
A string representation of a price level that must already exist in the Vin65 platform. If it exists, the contact will have that price level assigned, otherwise this field is ignored.
isNonTaxable (Boolean)
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.
isDirectToTrade (Boolean)
Set this to true for “direct to trade” customers. This will give them DTT pricing and enable other DTT features of the system. If this is set to true, you must also set the wholesaleNumber field. Default is false.
wholesaleNumber (string)
Used in conjunction with the isDirectToTrade field as described above.
paymentTerms (string)
Enumerated type that is either blank (default), “Net 10”, “Net 30”, or “Upon Receipt”.
facebookProfileID (string)
Used to store a Facebook ID for Facebook related services in the Vin65 platform.
Response
There are no additional response parameters.
upsertShippingAddress
Request
This method requires an array of ShippingAddress objects be passed in. The properties of the ShippingAddress object are listed below.
contactID (string)
A GUID reference to the contact in the Vin65 system. Either contactID or altContactID are required.
altContactID (string)
A string reference to the contact in your system. It must have been previously set in Vin65 to be used here, otherwise the upsert will fail due to no contacts with this ID being found. Either contactID or altContactID are required.
shippingAddressID (string)
A GUID reference to the shipping address in the Vin65 system. This should only be used for updates of existing records with a known shippingAddressID. Otherwise it’s ignored.
altShippingAddressID (string)
A string reference to the shipping address in your system. The system will attempt to find a match with this ID when provided, but if it doesn’t find a match, a new record will be created with this altShippingAddressID set for future updates.
Nickname (string)
A text field describing the shipping address as it will appear in the contact’s address book.
birthDate (date)
The birthday of the customer. Format is in: MM/DD/YYYY or DD/MM/YYYY.
firstname (string)
The first name of the customer.
lastname (string)
The last name of the customer.
company (string)
The customer's business or company.
address (string)
The street address of the customer.
address2 (string)
Additional address information. For example, unit #, apt #, etc.
city (string)
The customer's city of residence.
stateCode (string)
countryCode (string)
This is a standard two letter country code, default is “US”.
zipCode (string)
The customer's zip code or Postal Code.
mainPhone (string)
The customer's main phone number. Format is in: 000-000-0000
Email (string)
Each customer must have a unique email address.
isPrimary (boolean)
Only one shipping address can be set as the primary. If you set an address as primary, all other addresses will be checked for and cleared of this flag.
CashierID (string)
Response
There are no additional response parameters.