Ecommerce Fulfillment
Menu
TOP

SearchGiftCards()

Part Of: Gift Card Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the SearchGiftCards() function to get the gift cards 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
GiftCardID UUID   UUID of the Vin65 Gift Card
Title String 100    
CardNumber Integer    
Code String 50    
IsActive Boolean    
OrderNumber Integer   The order number the gift card was sold on.
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>
  <SearchGiftCards>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <GiftCardID></GiftCardID>
      <Title></Title> 
      <CardNumber></CardNumber>
      <Code></Code>
      <IsActive>1</IsActive>
      <OrderNumber></OrderNumber>
      <DateModifiedFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchGiftCards>
</soap:Body>
</soap:Envelope>

Sample Response:

 <?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schem as.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <SearchGiftCardsResponse>
    <SearchGiftCardsReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <GiftCards>
        <GiftCard>
          <CardNumber>1066</CardNumber>
          <Code>6TABEHSZZQUSANPX</Code>
          <CurrentBalance>70.00</CurrentBalance>
          <DateAdded>2011-03-02T17:49:32.407Z</DateAdded>
          <DateModified>2011-03-02T17:49:32.407Z</DateModified>
          <ExpiryDate/>
          <GiftCardID>acd3e3cf-1cc4-81ae-7514-d559e0de28aa</GiftCardID>
          <InitialAmount>70.00</InitialAmount>
          <IsActive>true</IsActive>
          <Notes/>
          <Title>Sample Gift Card Title</Title>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </GiftCard>
        <GiftCard>
          <CardNumber>1067</CardNumber>
          <Code>6TABEHSZZQUSANPX</Code>
          <CurrentBalance>75.00</CurrentBalance>
          <DateAdded>2011-03-02T17:56:03.487Z</DateAdded>
          <DateModified>2011-03-02T17:56:03.487Z</DateModified>
          <ExpiryDate/>
          <GiftCardID>ad1e2a90-0695-d7d6-a684-ba7fec9ca015</GiftCardID>
          <InitialAmount>75.00</InitialAmount>
          <IsActive>true</IsActive>
          <Notes>Purchased with order number: 2904</Notes>
          <Title>Sample Gift Card Title</Title>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </GiftCard>
      </GiftCards>
      <RecordCount>2</RecordCount>
    </SearchGiftCardsReturn>
  </SearchGiftCardsResponse>
</soapenv:Body>
</soapenv:Envelope>

Page Top