Part Of: Order Webservice 3.04


Australian URL:


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


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.


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    


String 20    


String 20    


String 20    

Sample Request:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:xsi="" xmlns:xsd="" xmlns:soapenv="" >
        <Password>//Your Username//</Password>
        <Username>//Your Password//</Username>

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="" xmlns:xsd="" xmlns:xsi="">
            <ErrorMessage>1 orders(s) failed to upsert. View 'OrderResults' for more details.</ErrorMessage>
            <Errors />
                <BirthDate />
                <CashierID />
                <CustomerNumber />
                <MasterContactID />
              <CorporateOrderBatchID />
              <CorporateOrderNumber />
              <FutureShipDate />
              <Marketplace />
              <OrderCoupons />
                  <ParentSKU />
                  <ShippedDate />
                  <Weight />
              <PaymentTerms />
              <PickupDate />
              <PreviousOrderNumber />
              <RequestedDeliveryDate />
              <RequestedShipDate />
                <BirthDate />
              <ShippedDate />
              <ShippingStatus>Handled Externally</ShippingStatus>
              <ShippingType />
                  <CardExpiryMo />
                  <CardExpiryYr />
                  <GiftCardCode />
                  <GiftCardID />
                  <GiftCardNumber />
                  <GiftCardVendor />
                  <PaymentDate />
                  <PointsID />
                  <PointsRedeemed />
                <ErrorMessage>A valid email address, contactID, or altContactID is required.</ErrorMessage>
                <ErrorMessage>Order Date must be a valid date.</ErrorMessage>
            <Order />

Page Top