TOP

SearchOrders()

Part Of: Order Webservice 3.0

WSDL:

https://webservices.vin65.com/V301/OrderService.cfc?wsdl

Australian URL:

https://webservices.aus.vin65.com/V301/OrderService.cfc?wsdl

Description:

Use the SearchOrders() function to get a single order or a list of orders using the search options listed below. Required fields are indicated by a '*'

Webservices V3.0+ date/time stamps are UTC time.

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
OrderID UUID   UUID of the Vin65 Order
OrderNumber Integer    
OrderStatus

Enumerated ("Submitted", "Quarantine", "Pending", "Completed", "Cancelled","Hold")

   
PaymentStatus Enumerated ("Refunded", "Voided", "Submitted", "Declined", "Paid", Authorized", "Pending")    
ShippingStatus Enumerated ("PickedUp, "SentToFulfillment", "Shipped", "NoStatus")    
Type String 50    
IsAPickupOrder Boolean    
IsPendingPickup Boolean    
IsARMSOrder Boolean   Is this order from RMS.
IncludeExternalOrders Boolean 1  
PickupLocationCode String 50    
ContactID UUID    
BillFirstName String 50    
BillLastName String 50    
ShipFirstName String 50    
ShipLastName String 50    
ShipStateCode String 50    
DateSubmittedFrom DateTime    
DateSubmittedTo DateTime    
DateCompletedFrom DateTime    
DateCompletedTo DateTime    
DateModifiedFrom DateTime    
DateModifiedTo DateTime    
DateShippedFrom DateTime    
DateShippedTo 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/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <SearchOrders>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <OrderID></OrderID>
      <OrderStatus>Completed</OrderStatus>
      <Type></Type>
      <DateCompletedFrom>2011-01-01T12:21:43</DateCompletedFrom>
      <DateCompletedTo>2011-09-12T12:21:43</DateCompletedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page> 
    </Request> 
  </SearchOrders>
</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>
  <SearchOrdersResponse> 
    <SearchOrdersReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <Orders>
        <Order>
          <BillFirstName>Robert</BillFirstName>
          <BillLastName>Brooks</BillLastName>
          <CompletedDate>2011-10-12T07:00:00.000Z</CompletedDate>
          <ContactID>53adb940-1cc4-81ae-75bd-c23688b90118</ContactID>
          <DateModified>2011-10-12T07:00:00.000Z</DateModified>
          <GiftMessage></GiftMessage>
          <IsAPickupOrder>false</IsAPickupOrder>
          <IsARMSOrder>false</IsARMSOrder>
          <IsExternalOrder>false</IsExternalOrder>
          <IsPendingPickup/>
          <OrderID>53adb9b3-1cc4-81ae-753d-57e6bff2c698</OrderID>
          <OrderNotes></OrderNotes>
          <OrderNumber>243</OrderNumber>
          <OrderStatus>Completed</OrderStatus>
          <OrderTotal>26.00</OrderTotal>
          <PaymentStatus></PaymentStatus>
          <ShipFirstName>Robert</ShipFirstName>
          <ShipLastName>Brooks</ShipLastName>
          <ShipStateCode>CA</ShipStateCode>
          <ShippedDate/>
          <ShippingStatus>NoStatus</ShippingStatus>
          <ShippingType></ShippingType>
          <SubmittedDate>2011-10-12T07:00:00.000Z</SubmittedDate>
          <TrackingNumber></TrackingNumber>
          <Type>ClubOrder</Type>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </Order>
        <Order>
          <BillFirstName>Jason</BillFirstName>
          <BillLastName>Cordova</BillLastName>
          <CompletedDate>2011-10-12T07:00:00.000Z</CompletedDate>
          <DateModified>2011-10-12T07:00:00.000Z</DateModified>
          <ContactID>53c50536-1cc4-81ae-7547-24175bd1c2ef</ContactID>
          <GiftMessage></GiftMessage>
          <IsAPickupOrder>false</IsAPickupOrder>
          <IsARMSOrder>false</IsARMSOrder>
          <IsExternalOrder>false</IsExternalOrder>
          <IsPendingPickup/>
          <OrderID>53c505eb-1cc4-81ae-75f6-6377c60cba8e</OrderID>
          <OrderNotes></OrderNotes>
          <OrderNumber>251</OrderNumber>
          <OrderStatus>Completed</OrderStatus>
          <OrderTotal>26.00</OrderTotal>
          <PaymentStatus></PaymentStatus>
          <ShipFirstName>Jason</ShipFirstName>
          <ShipLastName>Cordova</ShipLastName>
          <ShipStateCode>TX</ShipStateCode>
          <ShippedDate/>
          <ShippingStatus>NoStatus</ShippingStatus>
          <ShippingType></ShippingType>
          <SubmittedDate>2011-10-12T07:00:00.000Z</SubmittedDate>
          <TrackingNumber></TrackingNumber>
          <Type>ClubOrder</Type>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        </Order>
      </Orders>
      <RecordCount>2</RecordCount>
    </SearchOrdersReturn>
  </SearchOrdersResponse>
</soapenv:Body>
</soapenv:Envelope>   

Page Top