Classic WineDirect Documentation

Club Membership Service 3.0

31 Mar 2023
2 Minutes to read

Print
Share
Dark
Light
PDF

Club Membership Service 3.0

Updated on 31 Mar 2023
2 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/ClubMembershipService.cfc?wsdl

Australian URL:

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

Methods:

SearchClubMemberships()
Use this method to search across club memberships.

SearchClubs()
Use this method to search across clubs.

GetClubMembership()
Use this method to get a single club membership.

SearchClubMemberships()

Part Of: Clubmembership Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the SearchClubMembership() function to find a one or more Club Memberships inside Vin65. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
WebsiteIDs	UUID List		Available for Enterprise Webservices Comma separated list of WebsiteIDs in Enterprise Leave blank for all Websites
ClubMembershipID	UUID		UUID of the ClubMembership
AltClubMembershipID	String 50
ClubID	UUID
AltClubID	String 50
ClubName	String 255
ContactID	UUID
CurrentMembershipStatus	String 50		List of allowed values: Active, Cancelled, OnHold
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/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <SearchClubMemberships>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <ClubMembershipID></ClubMembershipID>
      <AltClubMembershipID></AltClubMembershipID>
      <ClubID></ClubID>
      <AltClubID></AltClubID>
      <ClubName></ClubName>
      <ContactID></ContactID>
      <CurrentMembershipStatus></CurrentMembershipStatus>
      <DateModifiedFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:2 1:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchClubMemberships>
</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>
  <SearchClubMembershipsResponse>
    <SearchClubMembershipsReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <ClubMemberships> 
        <ClubMembership>
          <CancelDate/>
          <ClubCancellationReason></ClubCancellationReason>
          <ClubCancellationReasonID></ClubCancellationReasonID>
          <ClubID>5f8e3300-bd9b-de91-7db4-85b3dab6f7d9</ClubID>
          <ClubMembershipID>8f145794-e5d2-c668-6ef7-a896ae71142f</ClubMembershipID>
          <ClubName>Pinot Noir Club</ClubName>
          <Contact>
            <Address>115 First Street</Address>
            <Address2></Address2>
            <BirthDate>1900-01-01T08:00:00.000Z</BirthDate>
            <City>Sumas</City>
            <Company></Company>
            <ContactID>8c6d813f-9038-b3a5-4714-6a67131d25c3</ContactID>
            <CountryCode></CountryCode>
            <CustomerNumber>7703</CustomerNumber>
            <Email>andrew@vin65.com</Email>
            <FirstName>Andrew</FirstName>
            <LastName>Kamphuis</LastName>
            <Phone>604-852-8140</Phone>
            <StateCode>WA</StateCode>
            <ZipCode>98295</ZipCode>
          </Contact>
          <CreditCardID>96f18a5b-c5a9-46d3-acb8-9b138b107edf</CreditCardID>
          <CurrentClubMembershipStatus/>
          <CurrentNumberOfShipments>0</CurrentNumberOfShipments>
          <DateAdded>2011-01-18T13:58:08.253Z</DateAdded>
          <DateModified>2011-01-25T04:33:14.840Z</DateModified>
          <GiftMessage></GiftMessage>
          <IsGift>false</IsGift>
          <IsPickup>false</IsPickup>
          <IsPrePay>false</IsPrePay>
          <LastProcessedDate/>
          <Notes></Notes>
          <OnHoldStartDate/>
          <OnHoldUntilDate/>         
          <PickupHandlingFee>0.00</PickupHandlingFee>
          <PickupLocationCode/>
          <PrePayOrderNumber/>
          <RetainClubPrivileges>false</RetainClubPrivileges>
          <SalesAssociate></SalesAssociate>
          <SalesAssociateID></SalesAssociateID>
          <ShipTo>ShippingAddress</ShipTo>
          <ShippingAddress>
            <Address>27564 Rondell Street</Address>
            <Address2></Address2>
            <AltShippingAddressID>1079925</AltShippingAddressID>
            <Birthdate>1900-01-02T08:00:00.000Z</Birthdate>
            <City>Agoura Hills</City>
            <Company></Company>
            <CountryCode>US</CountryCode>
            <Email>millertimekm70@sbcglobal.net</Email>
            <Firstname>Kelly</Firstname>
            <Lastname>Mr Miller</Lastname>
            <Phone>818-597-1181</Phone>
            <ShippingAddressID>f0dfdf18-cb80-c100-a4d2-f9783d52b1aa</ShippingAddressID>
            <StateCode>CA</StateCode>
            <ZipCode>91301</ZipCode>
          </ShippingAddress>
          <SignupDate>2012-04-18T07:00:00.000Z</SignupDate>
          <SourceCode></SourceCode>
          <TotalNumberOfShipments/>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </ClubMembership>
      </ClubMemberships>
      <RecordCount>1</RecordCount>
    </SearchClubMembershipsReturn>
  </SearchClubMembershipsResponse>
</soapenv:Body>
</soapenv:Envelope>

SearchClubs()

Part Of: Clubmembership Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the SearchClubs() function to find Club inside Vin65. 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
ClubID	UUID
AltClubID	String 50
ClubName	String 255
IsActive	Boolean
DateModifiedFrom	DateTime
DateModifiedTo	DateTime
MaxRows	Integer	100
Page	Integer	1

Sample Request:

<soap:Envelope xmlns:soap="https://sch emas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <SearchClubs>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <ClubID></ClubID>
      <AltClubID></AltClubID>
      <ClubName></ClubName>
      <IsActive></IsActive>
      <DateModifiedFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchClubs>
</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>
  <SearchClubsResponse>
    <SearchClubsReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <Clubs>
        <Club>
          <ClubID>5c084faf-2264-112b-b1d1-a1651619eb 75</ClubID>
          <ClubName>Icewine Club</ClubName>
          <DateAdded>2010-05-31T18:24:38.823Z</DateAdded>
          <DateModified>2011-02-29T22:48:44.700Z</DateModified>
          <Description></Description>
          <IsActive>true</IsActive>
          <Teaser></Teaser>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </Club>
        <Club>
          <AltClubID>Mixed Club</AltClubID>
          <ClubID>2676105b-2264-112b-b153-1e69551ec522</ClubID>
          <ClubName>Mixed Club</ClubName>
          <DateAdded>2010-03-24T23:42:17.600Z</DateAdded>
          <DateModified>2011-01-13T22:39:35.277Z</DateModified>
          <Description></Description>
          <IsActive>true</IsActive>
          <Teaser></Teaser>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </Club>
      </Clubs>
      <RecordCount>2</RecordCount>
    </SearchClubsReturn>
  </SearchClubsResponse>
</soapenv:Body>
</soapenv:Envelope>

GetClubMembership()

Part Of: Clubmembership Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the GetClubMembership() function to find a single Club Membership inside Vin65. 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 ClubMembershipID is present Useful if searching by AltClubMembershipID and AltClubMembershpID is not unique across Enterprise
ClubMembershipID	UUID	UUID of the ClubMembership
AltClubMembershipID	String 50

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>
  <GetClubMembership>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteID></WebsiteID>
      <ClubMembershipID>8f145794-e5d2-c668-6ef7-a896ae71142f</ClubMembershipID>
      <AltClubMembershipID></AltClubMembershipID>
    </Request>
  </GetClubMembership>
</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> 
  <GetClubMembershipResponse>
    <GetClubMembershipReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <ClubMembership>
        <CancelDate/>
        <ClubCancellationReason></ClubCancellationReason>
        <ClubCancellationReasonID></ClubCancellationReasonID>
        <ClubID>5f8e3300-bd9b-de91-7db4-85b3dab6f7d9</ClubID>
        <ClubMembershipID>8f145794-e5d2-c668-6ef7-a896ae71142f</ClubMembershipID>
        <ClubName>Pinot Noir Club</ClubName>
        <Contact>
          <Address>115 First Street</Address>
          <Address2></Address2>
          <BirthDate>1900-01-01T08:00:00.000Z</BirthDate>
          <City>Sumas</City>
          <Company></Company>
          <ContactID>8c6d813f-9038-b3a5-4714-6a67131d25c3</ContactID>
          <CountryCode></CountryCode>
          <CustomerNumber>7703</CustomerNumber>
          <Email>andrew@vin65.com</Email>
          <FirstName>Andrew</FirstName>
          <LastName>Kamphuis</LastName>
          <Phone>604-852-8140</Phone>
          <StateCode>WA</StateCode>
          <ZipCode>98295</ZipCode>
        </Contact>
        <CreditCardID>96f18a5b-c5a9-46d3-acb8-9b138b107edf</CreditCardID>
        <CurrentClubMembershipStatus/>
        <CurrentNumberOfShipments>0</CurrentNumberOfShipments>
        <DateAdded>2011-01-18T13:58:08.253Z</DateAdded>
        <DateModified>2011-01-25T04:33:14.840Z</DateModified>
        <GiftMessage></GiftMessage>
        <IsGift>false</IsGift>
        <IsPickup>false</IsPickup>
        <IsPrePay>false</IsPrePay>
        <LastProcessedDate/>
        <Notes></Notes>
        <OnHoldStartDate/>
        <OnHoldUntilDate/>
        <PickupHandlingFee>0.00</PickupHandlingFee>
        <PickupLocationCode/>
        <PrePayOrderNumber/>
        <RetainClubPrivileges>false</RetainClubPrivileges>
        <SalesAssociate></SalesAssociate>
        <SalesAssociateID></SalesAssociateID>
        <ShipTo>ShippingAddress</ShipTo>
        <ShippingAddress>
          <Address>27564 Rondell Street</Address>
          <Address2></Address2>
          <AltShippingAddressID>1079925</AltShippingAddressID>
          <Birthdate>1900-01-02T08:00:00.000Z</Birthdate>
          <City>Agoura Hills</City>
          <Company></Company>
          <CountryCode>US</CountryCode>
          <Email>millertimekm70@sbcglobal.net</Email>
          <Firstname>Kelly</Firstname>
          <Lastname>Mr Miller</Lastname>
          <Phone>818-597-1181</Phone>
          <ShippingAddressID>f0dfdf18-cb80-c100-a4d2-f9783d52b1aa</ShippingAddressID>
          <StateCode>CA</StateCode>
          <ZipCode>91301</ZipCode>
        </ShippingAddress>
        <SignupDate>2012-04-18T07:00:00.000Z</SignupDate>
        <SourceCode></SourceCode>
        <TotalNumberOfShipments/>
        <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
      </ClubMembership>
      <RecordCount>1</RecordCount>
    </GetClubMembershipReturn>
  </GetClubMembershipResponse>
</soapenv:Body>
</soapenv:Envelope>

Was this article helpful?

What's Next

Credit Card Service 3.0