This web service allows you download all web orders that are at the NEW ORDER status.
Pass the following parameters into the web service ExportOrders:
Parameter |
Type |
Comments |
Login |
String |
The login for your batch user account |
Password |
String |
The password for your batch user account |
FilterStatusID |
Guid |
The status of the orders that you want to download – this should be set to “NewOrder” status of f3d75ee4-7dd5-428e-964c-19252f283c31 |
OPTION TO FILTER BY OUTLET: There is an alternative web service where you can call ExportOrdersForOutlet which accepts all of the parameters above but also a 4th parameter called OutletCode which is a string. If you pass in WEBONLY for OutletCode, it will return only orders selected for delivery.
The following are some of the fields returned in the XML that can be used:
Field |
Type |
Comments |
OrderID |
Guid |
The unique ID of the order (may not be needed as the next field OrdNo is also unique and should be used as the unique ID as it allows users look up the order on the ePos/ERP by order number) |
OrdNo |
Text (20) |
The unique ORDER NUMBER of the order |
Date |
DateTime |
The date of the order |
CurrCode |
Text (3) |
The currency of the order – e.g.: · EUR = Euro · GBP = Great British Pounds / Sterling · USD = US Dollars |
BaseItemsTotal |
Decimal |
The total value of the items in the order (excludes order level amounts such as shipping, transaction fee, collection fee, etc) This amount is in the website's base currency - so if the base currency is EURO, then this will always be the EURO value even if the order is in another currency like STERLING or US DOLLARS. The website uses an approximate exchange rate to calculate this base value. |
|
Text (100) |
The email of the person who made the order |
DelType |
Guid |
The type of delivery: · Collection = 3f991fbf-5c85-4d9e-a0b3-b791713c4aa0 · ShipTo = 1db23f89-21e9-4780-a74f-edd8780298fe |
OutletCode |
Text (50) |
The unique outlet code (if Collection selected during Checkout) |
Outlet |
Text (150) |
The outlet name (if Collection selected during Checkout) |
OutletID |
Guid |
The unique ID of the outlet - this should not need to be used as the OutletCode above is also unique for the outlet |
ShipFirstName |
Text (100) |
Ship To First Name - or Collector's First Name if Collection selected during Checkout |
ShipLastName |
Text (100) |
Ship To Last Name - or Collector's Last Name if Collection selected during Checkout |
ShipAdd1 ShipAdd2 ShipAdd3 ShipAdd4 |
Text (150) |
Ship To Address - only collected if ShipTo selected during Checkout |
ShipPostCode |
Text (20) |
Ship To Postal Code |
ShipCountry (replaces ShipRegion) |
Text (150) |
Ship To Country Name |
ShipCountryCode (replaces ShipRegionID) |
Text (3) |
Ship To Country ISO Code – this is the unique 3 digit ISO code for the country - for example: - IRL = Ireland - GBR = United Kingdom
|
ShipMobile ShipPhoneDay ShipPhoneEve |
Text (50) |
Ship To Phone Numbers - currently only ShipPhoneDay is being populated during the Checkout |
GiftMsg |
Text (4000) |
The gift message entered with the order |
Comments |
Text (4000) |
The comments (e.g. delivery instructions) entered with the order |
And for each ORDERITEM node within the ORDER node:
Field |
Type |
Comments |
ItemID |
Guid |
The unique ID of the order item |
Code |
Text (50) |
The product code |
Title |
Text (100) |
The product title |
BasePrice |
Decimal |
The unit price - use this field with the next field PriceDisc as PriceDisc includes any ORDER LEVEL DISCOUNT apportioned across all the order items This amount is in the website's base currency - so if the base currency is EURO, then this will always be the EURO value even if the order is in another currency like STERLING or US DOLLARS. |
BasePriceDisc |
Decimal |
The unit price discount amount - Net Unit Price = Price - PriceDisc This amount is in the website's base currency. |
BaseOrigPrice |
Decimal |
The unit price before any promotions. This amount is in the website's base currency. |
Qty |
Int |
The quantity ordered |
BaseLineTax |
Decimal |
OPTIONAL: If the website is adding tax to the order, this is the total tax for this order item. |
BaseTotal |
Decimal |
Net Unit Price X Quantity This amount is in the website's base currency. |
PromText |
Text (250) |
The promotion text for this item if a promotion was on the product |
Weight |
Decimal |
The unit weight of the item |
Price PriceDisc OrigPrice LineTax Total |
Decimal |
These fields are the same as the "Base" equivalent fields except they are in the currency of the order. So if this order is a STERLING order, these would be the sterling amounts. |
ShortDesc |
Text (4000) |
For Custom Built Products Only (built with the product configurator) - this contains a list of all the features selected by the customer when building this product |
ParentCode |
Text (50) |
If this is a version, this is the parent product code |
The following are some of the advanced ORDER fields returned in the XML that can be used:
Field |
Type |
Comments |
PONo |
Text (50) |
The Purchase Order Number |
StatID StatCode Status |
Guid Text (20) Text (50) |
The order status |
Curr |
Text (5) |
The currency symbol |
BaseAmtPaid |
Decimal |
The amount paid during the checkout. This amount is in the website's base currency. |
TrackRef |
Text (250) |
The order tracking reference number |
ContID |
Guid |
If the customer is logged in, their unique ID will be here |
CustCode |
Text (50) |
This is the unique customer code (which can be used instead of the GUID above) |
CustCodeNo |
Integer |
Each customer may be given a unique code number (which can also be used instead of the above two) |
Company |
Text (150) |
The customer name |
IsSpecial |
True / False |
TRUE if this is a "Special" account (e.g. was originally set up on the ePos/ERP system) |
PrimContID PrimCustCode PrimCustCodeNo |
Guid Text (50) Integer |
For customers who are sub-accounts of a primary customer account - this is the primary account code and code number |
SUFirstName SULastName SUContID |
Text (100) Text (100) Guid |
For super users who submit an order on behalf of a customer, this is their first name and last name and unique ID |
BaseShippingFee |
Decimal |
The total shipping costs - note that this can be ignored as the shipping fee also comes down as an order item with a product code of WEBSHIP - if you want to change this product code, just email the new product code into the Help Desk NOTE: There is a field called "Shipping" in the XML - please ignore this as it is not used anymore This amount is in the website's base currency. |
BaseDiscount |
Decimal |
The total discount on the order - note that this can be ignored as the discount is apportioned across each order item so the order item field "PriceDisc" contains the unit price adjusted for the discount amount apportioned to it. This amount is in the website's base currency. |
BaseTaxTotal |
Decimal |
The total tax amount. |
BaseTotal |
Decimal |
The total order value - note that this can be ignored as the shipping and discount are incorporated into the order items below (using PriceDisc as well as the Price) so the ItemsTotal only needs to be used. This amount is in the website's base currency. |
ItemsTotal AmtPaid ShippingFee Discount Total TaxTotal |
Decimal |
These fields are the same as the "Base" equivalent fields except they are in the currency of the order. So if this order is a STERLING order, these would be the sterling amounts. |
BillFirstName BillLastName BillCompany BillAdd1 BillAdd2 BillCity (replaced BillAdd3) BillState (replaced BillAdd4) BillPostCode BillCountry (replaced BillRegion) BillCountryCode |
Text(100) Text(100) Text(100) Text(150) Text(150) Text(150) Text(150) Text(20) Text(150) Text(3) |
Billing Address Fields Only included if the user enters their billing details at checkout (turned off for some websites) |
PaymentType PaymentTypeID |
Text (100) Guid |
The payment type - the following are the IDs: · Pay On Account = 83152DE9-FFC5-466D-94D2-0D0FB5C34550 · Credit / Debit Card = BB0B4922-901E-40AF-9F6B-5BC8E38D8621 · PayPal = F680CBFD-B8D0-49C6-9F1F-430012DF5827 · Humm = 18265B3C-B878-40B3-8AAB-F8425FA89AF1 |
PayProvRef |
|
Payment Provider Reference - for some payment providers, this is their unique reference number (for tracking the payment for this order) |
Custom1 ... Custom10 |
Text (3900) |
Optional custom fields that can be added to the checkout for the customer to enter values into (allowed up to 10 custom fields) |
TaxNo |
Text(50) |
Optional field. Used where the customer has a tax/vat number. This can be set for trade customers or can be added to an order at checkout for regions outside Ireland. |
CollDate
|
Date & Time |
If the user selects a date (and possibly time), for COLLECTION this field contains the date and time in the following format: 2 Sep 2022 19:30 |
DelDate
|
Date & Time |
Similar to COLLDATE above, this is for HOME DELIVERY as opposed to COLLECTION |
ShipLocID
ShipLoc
|
Text(50) Text(100) |
If you have multiple shipping options for a country/region, this field contains the UNIQUE ID (ShipLocID) of the shipping option selected by the customer along with the TITLE (ShipLoc) |
The following are some of the advanced ORDER ITEM fields returned in the XML that can be used:
NOTE: Contact the HELP DESK if you want these extra fields as they are not included in the standard installation and need to be turned on
Field |
Type |
Comments |
BarCode |
Text (20) |
The BarCode of the product |
ImageURLThumb |
Text (250) |
The url to the THUMBNAIL image for this product - 100X100 pixels in size. |
WebStockQty |
Number |
If stock control is enabled for this product, this is the current live stock level for this product in our database |
Comments
0 comments
Please sign in to leave a comment.