If you are using the 301 GetOrder() or SearchOrders(), we are making stability improvements that may effect you. Click Here for more information.

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 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. This element is present in V301 and higher.
IncludeExternalOrders	Boolean	1
PickupLocationCode	String 50		This element is present in V301 and higher.
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
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>
  <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></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

GetOrderDetail()

Part Of: Order Webservice 3.0

If you are using the 301 GetOrder() or SearchOrders(), we are making stability improvements that may effect you. Click Here for more information.

WSDL:

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

Australian URL:

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

Description:

Use the GetOrder() function to get a order contact. Required fields are indicated by a '*'

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

Parameters:

Attribute	Data Type	Default	Description
WebsiteID	UUID		Available For Enterprise Webservices UUID of the Vin65 Website Not necessary if OrderID is present Useful if searching by OrderNumber and OrderNumber is not unique across Enterprise
OrderID	UUID		UUID of the Vin65 OrderID
OrderNumber	Integer
ShowKitAsIndividualSKUs	Boolean	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>
  <GetOrderDetail> 
    <Request>
      <Security>
        <Username>Your Username</Username>
        <Password>Your Password</Password>
      </Security>
      <OrderID>f660d5e3-0173-4a19-0838-3eff95f2f20b</OrderID>
    </Request>
  </GetOrderDetail>
</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> 
  <GetOrderDetailResponse>
    <GetOrderDetailReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <Order>
        <AmountPaidByGiftCard>0.00</AmountPaidByGiftCard>
        <AmountPaidByPoints>0.00</AmountPaidByPoints>
        <BillContact>
          <Address>123 Test Ave</Address>
          <Address2></Address2>
          <AltContactID>110ae037-5a79-e111-936b-000c295a8381</AltContactID>
          <BirthDate>1902-03-19T08:00:00.000Z</BirthDate>
          <City>Testville</City>
          <ClubName>Red Club</ClubName>
          <ClubShipmentName>2014 May Shipment</ClubShipmentName>
          <Company></Company>
          <ContactID>4c58d5ef-edf8-b355-ebf8-d36c39c44d7e</ContactID>
          <CountryCode></CountryCode>
          <CustomerNumber>9050</CustomerNumber>
          <DateAdded>2012-01-17T23:38:12.590Z</DateAdded>
          <DateModified>2012-04-24T18:17:26.217Z</DateModified>
          <Email>josh@vin65.com</Email>
          <FirstName>Josh</FirstName>
          <IsNonTaxable>false</IsNonTaxable>
          <LastLoginDate>2012-04-24T18:17:26.217Z</LastLoginDate>
          <LastName>Clysdale</LastName>
          <LastOrderDate>2012-04-24T17:41:56.457Z</LastOrderDate>
          <LifetimeValue>2320.94</LifetimeValue>
          <OrderCount>18</OrderCount>
          <Phone>000-000-0000</Phone>
          <StateCode>CA</StateCode>
          <SourceCode>Event</SourceCode>
          <Title></Title>
          <Username>test123</Username>
          <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
          <WholesaleNumber></WholesaleNumber>
          <ZipCode>123456</ZipCode>
        </BillContact>
        <CompletedDate/>
        <Deposit>1.20</Deposit> 
           <!--This is where the California CRV value will be returned-->
        <FulfillmentHouse>WineDirectFulfillment</FulfillmentHouse>
        <FutureShipDate/>
        <GiftMessage></GiftMessage>
        <Handling>10.50</Handling>
        <IsAPickupOrder>false</IsAPickupOrder>
        <IsExternalOrder>false</IsExternalOrder>
        <OrderCoupons>
          <OrderCoupon>
            <Code></Code>
            <CouponName>$25 Dollar Off Case Discount</CouponName>
            <ProductValue>25.00</ProductValue>
            <ShippingValue>0.00</ShippingValue>
            <TotalValue>25.00</TotalValue>
          </OrderCoupon>
        </OrderCoupons>
        <OrderID>f660d5e3-0173-4a19-0838-3eff95f2f20b</OrderID>
        <OrderItems>
          <OrderItem>
            <CostOfGood>0.00</CostOfGood>
            <InventoryPool>WineDirect</InventoryPool>
            <OriginalPrice>74.00</OriginalPrice>
            <ParentSKUID></ParentSKUID>
            <Price>71.92</Price>
            <ProductID>eaecdcc6-08ee-88fb-6368-2fb5f5bc8e0e</ProductID>
            <ProductSKUID>eaecdce8-ee5a-7217-ed1e-c6f6c3afa066</ProductSKUID>
            <Quantity>12</Quantity>
            <SKU>Gew&#xFC;rztraminer</SKU>
            <SalesTax>72.76</SalesTax>
            <ShippedDate/>
            <ShippingSKU></ShippingSKU>
            <ShippingService>UPS</ShippingService>
            <IsNonTaxable>false</IsNonTaxable>
            <IsSubSKU>false</IsSubSKU>
            <SubTitle></SubTitle>
            <Title>Gew&#xFC;rztraminer</Title>
            <TrackingNumber></TrackingNumber>
            <Type>Wine</Type>
            <UnitDescription>375ml</UnitDescription>
            <Weight>3.0</Weight>
          </OrderItem>
        </OrderItems>
        <OrderNotes>Original Order</OrderNotes>
        <OrderNumber>60345</OrderNumber>
        <OrderStatus>Submitted</OrderStatus>
        <PaymentStatus>Authorized</PaymentStatus>
        <PaymentTerms></PaymentTerms>
        <PickupLocationCode/> 
        <PointsInUse>0</PointsInUse>
        <PriceLevel>Retail</PriceLevel>
        <PreviousOrderNumber></PreviousOrderNumber>
        <RequestedShipDate/>
        <RMS>
          <BatchID></BatchID>
          <CashierID></CashierID>
          <RegisterNumber></RegisterNumber>
          <StoreID></StoreID>
        </RMS>
        <SalesAssociate></SalesAssociate>
        <SalesAttribute></SalesAttribute>
        <ShipToAddress>
          <Address>123 Test Ave</Address>
          <Address2></Address2>
          <BirthDate>1902-03-19T08:00:00.000Z</BirthDate>
          <City>Testville</City>
          <Company></Company>
          <CountryCode></CountryCode>
          <Email>josh@vin65.com</Email>
          <FirstName>Josh</FirstName>
          <LastName>Clysdale</LastName>
          <Phone>000-000-0000</Phone>
          <StateCode>CA</StateCode>
          <Title></Title>
          <ZipCode>123456</ZipCode>
        </ShipToAddress>
        <ShippedDate/>
        <Shipping>18.85</Shipping>
        <ShippingService>UPS</ShippingService>
        <ShippingStatus></ShippingStatus>
        <ShippingType/>
        <SourceCode></SourceCode>
        <SubTotal>863.04</SubTotal>
        <SubmittedDate/>
        <Tax>72.76</Tax>
        <Tender>
          <Tender>
            <AmountTendered>900.00</AmountTendered>
            <CardExpiryMo>1</CardExpiryMo>
            <CardExpiryYr>2015</CardExpiryYr>
            <CardNumber>************5454</CardNumber>
            <CardType>Visa</CardType>
            <NameOnCard></NameOnCard>
            <PaymentType>CreditCard</PaymentType>
            <IsActive>true</IsActive>
          </Tender>
          <Tender>
            <AmountTendered>66.35</AmountTendered>
            <PaymentType>Cash</PaymentType>
            <IsActive>true</IsActive>
          </Tender>
        </Tender>
          <Tender>
            <AmountTendered>966.35</AmountTendered>
            <CardExpiryMo>1</CardExpiryMo>
            <CardExpiryYr>2015</CardExpiryYr>
            <CardNumber>************5454</CardNumber>
            <CardType>Visa</CardType>
            <NameOnCard></NameOnCard>
            <PaymentType>CreditCard</PaymentType>
            <IsActive>false</IsActive>
          </Tender>
          <Tender>
        <Tip>0.00</Tip>
        <Total>966.35</Total>
        <TotalAfterTip>966.35</TotalAfterTip>
        <TrackingNumber></TrackingNumber>
        <TransactionType>Order</TransactionType>
        <Type>AdminPanel</Type>
        <WebsiteID>66272648-1e0b-4e34-f09b-81477a31b25f</WebsiteID>
        <WholesaleNumber></WholesaleNumber>
      </Order>
      <RecordCount>1</RecordCount>
    </GetOrderDetailReturn>
  </GetOrderDetailResponse>
</soapenv:Body>
</soapenv:Envelope>

Page Top

UpsertOrder()

Part Of: Order Webservice 3.04

WSDL:

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

Australian URL:

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

Description:

Use the UpsertOrder() function to upsert an array of orders. Required fields are indicated by a *.

Parameters:

Attribute	Data Type	Default	Description
Orders *	Array of Objects		Contains the following attributes. At least 1 is required in the Orders array.
Order.WebsiteCode	String 50		A text code to identify a source of orders for websites with multiple sources pushing orders in. Typically this is used for wineries with multiple tasting rooms.
Order.ContactID	UUID		The internal WineDirect ID for the contact this order belongs to, if known.
Order.AltContactID	String 50		Your external reference for the contact this order belongs to, if known.
Order.OrderType	String 50	POS	One of 'AdminPanel, ClubOrder, Facebook, iPad, Mobile, POS, Telemarketing or Website'. Note client can modify order types, if defaults are changed and you pass in an order type that does not exist, the response will be a friendly error with a list of order types that are accepted.
Order.OrderNumber *	String 50		The order number in your system.
Order.OrderDate *	Date		The date the order was first placed.
Order.ShipDate	Date		The date the order is shipped.
Order.ShippingStatus	String 255	Handled Externally	Shipping Status must be one of: 'Picked Up, Handled Externally, No Shipping Required, Sent to Fulfillment, Shipped'.
Order.BillingBirthdate	Date		Billing contact's birthdate. Format is in: MM/DD/YYYY or DD/MM/YYYY.
Order.BillingFirstName	String 50		Billing contact's first name.
Order.BillingLastName	String 50		Billing contact's last name.
Order.BillingCompany	String 100		Billing contact's company.
Order.BillingAddress	String 100		Billing contact's address.
Order.BillingAddress2	String 100		Additional information regarding the billing contact's address.
Order.BillingCity	String 100		Billing contact's city.
Order.BillingStateCode	String 2		Billing address State/Provice code. Two character abreviated state or province code. Example: California = CA and British Columbia = BC
Order.BillingZipCode	String 50		Billing contact's address zip code.
Order.BillingPhone	String 50		Billing contact's phone number. Format is in: 000-000-0000.
Order.BillingEmail *	String 100		Billing contact's email address. Used as a secondary means of matching order history to customer records. If no customer number is included orders will be matched with a customer record using the billing email address. If no customer record is found that matches the email, a new contact record will be created.
Order.ShippingBirthdate	Date		Shipping contact's birthdate. Format is in: MM/DD/YYYY or DD/MM/YYYY.
Order.ShippingFirstName	String 50		Shipping contact's first name.
Order.ShippingLastName	String 50		Shipping contact's last name.
Order.ShippingCompany	String 100		Shipping contact's company.
Order.ShippingAddress	String 100		Shipping contact's address.
Order.ShippingAddress2	String 100		Additional information regarding the shipping contact's address.
Order.ShippingCity	String 100		Shipping contact's city.
Order.ShippingStateCode	String 2		Shipping address State/Provice code. Two character abreviated state or province code. Example: California = CA and British Columbia = BC
Order.ShippingZipCode	String 50		Shipping contact's address zip code.
Order.ShippingPhone	String 50		Shipping contact's phone number. Format is in: 000-000-0000.
Order.ShippingEmail	String 100		Shipping recipient's email address.
Order.ShippingAddressID	UUID		If the order is being shipped to a known address book entry whose internal WineDirect ID is known, you can provide that here and it will be updated with any changes included in the order.
Order.AltShippingAddressID	String 50		Your shipping address ID, if known, will be used to either match to an existing entry in WineDirect or create a new one on the fly.
Order.GiftMessage	String 1024		Gift message included on the order.
Order.OrderNotes	String 1024		These notes are typically from the customer intended to be viewed by the winery or fulfillment. They are visible to the customer, so do not put internal notes in this field that you don’t want them to see.
Order.SubTotal	Numeric		The total of line items in the order only.
Order.Shipping	Numeric		The amount charged for shipping.
Order.Handling	Numeric		The amount charged for handling.
Order.Tax	Numeric		The amount charged for tax, not the tax rate.
Order.Total	Numeric		The total amount charged which should equal the sum of subtotal, shipping, handling, and tax.
Order.SendToFulfillment	Boolean	False	Sends orders to fulfillment through the WineDirect fulfillment manager if set to true.
Order.TransactionType	String		Either 'Order' or 'Refund'. If it's a 'Refund' - need to pass in 'PreviousOrderID' or 'PreviousOrderNumber'.
Order.PreviousOrderNumber	Numeric		Internal WineDirect order number for the previous order.
Order.PreviousOrderID	UUID		Internal WineDirect ID for the previous order.
Order.SourceCode	String		A way to identify where orders came from (used in reporting).
Order.SalesAssociate	String		Matches the name of an existing Sales Associate in the system. A friendly error will be returned if there are no matches.
Order.IsPickup	Boolean	True	Whether the order is a pickup or shipping order.
Order.Tenders	Array of Objects		Each Tender contains the following attributes.
Order.Tender.PaymentType *	String 50		Payment Type must be one of the following: 'GiftCard, Points, Cash, Check, CreditCard, OnAccount, ZeroDollarInvoice, Other'. If the payment type is 'CreditCard', then 'CreditCardExpirationMonth', 'CreditCardExpirationYear', and 'CreditCardType' are required
Order.Tender.PaymentDate	Date		Date the payment took place.
Order.Tender.AmountTendered *	Numeric		Amount the tender covered of the order.
Order.Tender.CreditCardExpirationMonth	Integer		Month of the credit card's expiry. Required if 'PaymentType' is 'CreditCard'.
Order.Tender.CreditCardExpirationYear	Integer		Year of the credit card's expiry. Required if 'PaymentType' is 'CreditCard'.
Order.Tender.CreditCardType	String		An enumerated field that is one of: 'Visa, MasterCard, AmericanExpress, Discover, JCB, Diners'. Required if 'PaymentType' is 'CreditCard'.
Order.Tender.CreditCardName	String 100		The name on the credit card.
Order.Tender.CreditCardNumber	String		The credit card number.
Order.Tender.PointsRedeemed	Integer		Number of points redeemed.
Order.Tender.GiftCardID	UUID		The WineDirect ID of a gift card, if known.
Order.Tender.GiftCardCode	String 50		The code for the Gift Card.
Order.Tender.GiftCardNumber	Integer		The Gift Card number.
Order.Tender.GiftCardVendor	Integer		The vendor of the Gift Card.
Order.OrderItems	Array of Objects		Each OrderItem contains the following attributes.
Order.OrderItem.Quantity *	Integer		Quantity of the order item.
Order.OrderItem.ProductName	String 255		Name of the product.
Order.OrderItem.ProductSKU *	String 255		SKU of the product.
Order.OrderItem.InventoryPoolID	UUID		The WineDirect ID for the inventory pool that the SKU's quantity should be deprecated from.
Order.OrderItem.DepartmentCode	String 50		The department code for this item. If this code is pre-setup in WineDirect then reports will show the department name otherwise they will just show the code that is uploaded for this item.
Order.OrderItem.SubDepartmentCode	String 50		The sub department code for this item. If this code is pre-setup in WineDirect then reports will show the sub department name otherwise they will just show the code that is uploaded for this item.
Order.OrderItem.OriginalPrice	Numeric		Unit original price before discounts.
Order.OrderItem.Price *	Numeric		Unit price after discounts that will be multiplied by quantity to get the extended price.
Order.OrderItem.CostOfGood	Numeric		Unit cost of good.
Order.OrderItem.SalesTax	Numeric		Optionally, set the amount of tax to be applied to a specific item in the order.
Order.OrderItem.IsNonTaxable	Boolean	False	Set to true to mark an item as non-taxable for the purpose of calculating tax by line item.
Order.OrderItem.ShippingService	String 100		The shipping code used on this order item. Typically things like “GROUND”, “2DAY”, etc.
Order.OrderItem.ShippingPartner	String 100		The shipping company used. Typically “InHouseFedEx”, “InHouseUPS”, “WineShipping”, etc.
Order.RMS	Object		Only used for WineDirect RMS cloud connect POS order uploads. Attributes are described below.
Order.RMS.BatchID	String 50
Order.RMS.CashierID	String 20
Order.RMS.RegisterNumber	String 20
Order.RMS.StoreID	String 20

Sample Request:

<?xml version="1.0" encoding="UTF-8"?>
<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/" >
<soapenv:Header/>
<soapenv:Body>
  <UpsertOrder>
    <Request>
      <Security>
        <Password>//Your Username//</Password>
        <Username>//Your Password//</Username>
      </Security>
      <Orders>
        <item>
          <OrderNumber>123</OrderNumber>
          <OrderDate>2019-07-20</OrderDate>
          <OrderType>AdminPanel</OrderType>
          <BillingEmail>michael.hersch@winedirect.com</BillingEmail>
          <BillingFirstName>Michael</BillingFirstName>
          <BillingLastName>Hersch</BillingLastName>
          <OrderItems>
            <item>
              <ProductSKU>2004Shiraz</ProductSKU>
              <Quantity>2</Quantity>
              <Price>75.00</Price>
            </item>
          </OrderItems>
          <Tenders>
            <item>
              <PaymentType>Cash</PaymentType>
              <AmountTendered>150</AmountTendered>
            </item>
          </Tenders>
          <SubTotal>150.00</SubTotal>
          <Total>150.00</Total>
        </item>
        <item>
          <OrderNumber>456</OrderNumber>
          <OrderType>AdminPanel</OrderType>
        </item>
      </Orders>
    </Request>
  </UpsertOrder>
</soapenv:Body>
</soapenv: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>
    <UpsertOrderResponse>
      <UpsertOrderReturn>
        <Errors>
          <Errors>
            <ErrorCode>InvalidOrder</ErrorCode>
            <ErrorMessage>1 orders(s) failed to upsert. View 'OrderResults' for more details.</ErrorMessage>
          </Errors>
        </Errors>
        <IsSuccessful>false</IsSuccessful>
        <OrderResults>
          <OrderResults>
            <Errors />
            <IsSuccessful>true</IsSuccessful>
            <Order>
              <AltOrderNumber>123</AltOrderNumber>
              <BillContact>
                <Address></Address>
                <Address2></Address2>
                <BirthDate />
                <CashierID />
                <City></City>
                <Company></Company>
                <ContactID>5897B83E-EC54-1187-9214-72B17F0ED71C</ContactID>
                <CountryCode></CountryCode>
                <CustomerNumber />
                <DateAdded>2014-04-03T21:54:16.703Z</DateAdded>
                <DateModified>2019-07-29T16:59:04.003Z</DateModified>
                <Email>michael.hersch@winedirect.com</Email>
                <FirstName>Michael</FirstName>
                <IsNonTaxable>false</IsNonTaxable>
                <LastLoginDate>2018-07-25T17:51:31.000Z</LastLoginDate>
                <LastName>Hersch</LastName>
                <LastOrderDate>2019-07-20T07:00:00.000Z</LastOrderDate>
                <LifetimeValue>52316.17</LifetimeValue>
                <MasterContactID />
                <OrderCount>517.0</OrderCount>
                <Phone></Phone>
                <SourceCode></SourceCode>
                <StateCode></StateCode>
                <Title></Title>
                <Username>michael.hersch@winedirect.com</Username>
                <WebsiteID>00000000-0000-0000-0000-000000000000</WebsiteID>
                <WholesaleNumber></WholesaleNumber>
                <ZipCode></ZipCode>
              </BillContact>
              <ClubName></ClubName>
              <ClubShipmentName></ClubShipmentName>
              <CompletedDate>2019-07-20T07:00:00.000Z</CompletedDate>
              <CorporateOrderBatchID />
              <CorporateOrderNumber />
              <Deposit>0.0</Deposit>
              <FFSN></FFSN>
              <FulfillmentHouse></FulfillmentHouse>
              <FutureShipDate />
              <GiftMessage></GiftMessage>
              <Handling>0.0</Handling>
              <IsAPickupOrder>true</IsAPickupOrder>
              <IsExternalOrder>true</IsExternalOrder>
              <Marketplace />
              <OrderCoupons />
              <OrderID>72B6CF66-B479-47A6-B51E-7844EF88A207</OrderID>
              <OrderItems>
                <OrderItems>
                  <CostOfGood>0.0</CostOfGood>
                  <Department></Department>
                  <DepartmentCode></DepartmentCode>
                  <InventoryPool></InventoryPool>
                  <IsNonTaxable>false</IsNonTaxable>
                  <IsSubSKU>false</IsSubSKU>
                  <OriginalPrice>75.0</OriginalPrice>
                  <ParentSKU />
                  <ParentSKUID></ParentSKUID>
                  <Price>75.0</Price>
                  <ProductID>B6E75D00-DA92-F695-E7A5-0ADDC6ACB6D6</ProductID>
                  <ProductSKUID>B6E75D59-AB45-48C3-49F8-7FD821B39EA8</ProductSKUID>
                  <Quantity>2.0</Quantity>
                  <SKU>2004Shiraz</SKU>
                  <SalesTax>0.0</SalesTax>
                  <ShippedDate />
                  <ShippingSKU></ShippingSKU>
                  <ShippingService></ShippingService>
                  <SubDepartment></SubDepartment>
                  <SubDepartmentCode></SubDepartmentCode>
                  <SubTitle></SubTitle>
                  <Title></Title>
                  <TrackingNumber></TrackingNumber>
                  <Type>Wine</Type>
                  <UnitDescription>Bottle</UnitDescription>
                  <Weight />
                </OrderItems>
              </OrderItems>
              <OrderNotes></OrderNotes>
              <OrderNumber>77728</OrderNumber>
              <OrderStatus>Completed</OrderStatus>
              <PaymentStatus>External</PaymentStatus>
              <PaymentTerms />
              <PickupDate />
              <PickupLocationCode></PickupLocationCode>
              <PreviousOrderNumber />
              <PriceLevel></PriceLevel>
              <RMS>
                <BatchID></BatchID>
                <CashierID></CashierID>
                <RegisterNumber></RegisterNumber>
                <StoreID></StoreID>
              </RMS>
              <RequestedDeliveryDate />
              <RequestedShipDate />
              <SalesAssociate></SalesAssociate>
              <SalesAttribute></SalesAttribute>
              <ShipToAddress>
                <Address></Address>
                <Address2></Address2>
                <BirthDate />
                <City></City>
                <Company></Company>
                <CountryCode></CountryCode>
                <Email></Email>
                <FirstName></FirstName>
                <LastName></LastName>
                <Phone></Phone>
                <StateCode></StateCode>
                <Title></Title>
                <ZipCode></ZipCode>
              </ShipToAddress>
              <ShippedDate />
              <Shipping>0.0</Shipping>
              <ShippingService></ShippingService>
              <ShippingStatus>Handled Externally</ShippingStatus>
              <ShippingType />
              <SourceCode></SourceCode>
              <SubTotal>150.0</SubTotal>
              <SubmittedDate>2019-07-20T07:00:00.000Z</SubmittedDate>
              <Tax>0.0</Tax>
              <Tender>
                <Tender>
                  <AmountTendered>150.0</AmountTendered>
                  <CardExpiryMo />
                  <CardExpiryYr />
                  <CardNumber></CardNumber>
                  <CardType></CardType>
                  <GiftCardCode />
                  <GiftCardID />
                  <GiftCardNumber />
                  <GiftCardVendor />
                  <IsActive>true</IsActive>
                  <NameOnCard></NameOnCard>
                  <PaymentDate />
                  <PaymentStatus>External</PaymentStatus>
                  <PaymentTerms></PaymentTerms>
                  <PaymentType>Cash</PaymentType>
                  <PointsID />
                  <PointsRedeemed />
                </Tender>
              </Tender>
              <Tip>0.0</Tip>
              <Total>150.0</Total>
              <TotalAfterTip>150.0</TotalAfterTip>
              <TrackingNumber></TrackingNumber>
              <TransactionType>Order</TransactionType>
              <Type>AdminPanel</Type>
              <WebsiteID>00000000-0000-0000-0000-000000000000</WebsiteID>
              <WholesaleNumber></WholesaleNumber>
            </Order>
          </OrderResults>
          <OrderResults>
            <Errors>
              <Errors>
                <ErrorCode>InvalidMemberParameters</ErrorCode>
                <ErrorMessage>A valid email address, contactID, or altContactID is required.</ErrorMessage>
              </Errors>
              <Errors>
                <ErrorCode>InvalidOrderDate</ErrorCode>
                <ErrorMessage>Order Date must be a valid date.</ErrorMessage>
              </Errors>
            </Errors>
            <IsSuccessful>false</IsSuccessful>
            <Order />
          </OrderResults>
        </OrderResults>
        <RecordCount>1.0</RecordCount>
      </UpsertOrderReturn>
    </UpsertOrderResponse>
  </soapenv:Body>
</soapenv:Envelope>

Page Top

Was this article helpful?

What's Next

Product Webservice 3.0