
Home Downloads Example Files XSD's XML-3 API Extension DLL Implementation Test Plan Developer Authentication Usage Products Usage XML-3 API Extension DLL Customer Customer testimonials

How It Works
- Security
- Ordering
- Products
- Support
How to get started
Implementing XML-3
Specifications
- Methods
- Return / Error codes
Web Service Links
- Security
- Products
- Orders

New Method Planning
01/02/2012
Planning has begun to introduce new methods into the new XML-3 API. These methods will include some ... Read More
XML-3 to receive Returns API
01/02/2012
Planning has begun to implement a new Returns API into XML-3. With this new API you will be able to ... Read More
XML-3 Goes Live
01/02/2012
We are proud to announce that XML-v3 has finished in Beta and is now live. XML-v3 has also been laun... Read More

How It Works

This section explains how the product services work and how we recomend implementing them. Below you will find all the required information about the services including basic flow diagrams and file examples.

Products Download Process

The product services offer three methods to deliver all the information you will need to download your catalogue. Each method should be pulled down at different times throughout the day and with the GetProductStock and GetProductPrices downloads should be multiple times throughout the day at different intervals, Below is a process flow for each method laying out the prefered method for implementation.

** Please note that the times illustrated in the diagrams below are simply recommendations. If method execution is seen to be excessive VIP has the right to enforce time restrictions for all of the mentioned web methods. If enforcements occur notification will be given through this website.

Methods Explained

The GetProducts method is used to supply the unique customer product catalogue information. The feed includes product information such as SKU, Description, EAN, Manufacturers Part Number and Product Group and Manufacturer. The feed also includes our full technical specification for each product in the feed. In XML-3 we have chosen to strip down the files to each individual purpose. This has made the files much lighter and increased performance. The original Product XML file was between 17MB and 20MB. This new Products file is a little over 6MB in size and introduces a new schema definition that is much simpler to implement and understand. Below is an example of the new feed.

The GetProductPrices method is used to supply all prices related to the customer product catalogue. The feed has also been reduced in size by making the schema more simple and easy to implement. A new Special Offer feature has also been added to the pricing feed. Previously customers were asked to identify products as being on special offer by checking the product status. The new pricing feed includes a flag that indicates if a product is on special offer and also includes a new OfferDisount field that shows the offer price along side the original price. This allows you to spot offers instantly and see the savings all in one place. Below is an example of the new feed.

The GetProductStock method is used to supply all stock related information for the customer product catalogue. The stock feed is very light and can be quickly downloaded for regular intervals of stock updates to your systems. We recommend no more than 10-15 minute intervals between downloads. Because we have introduced a live stock check for items that you wish to order the feed does not need to be processed any more frequent than this. The stock feed includes information such as Available Quantity, On Order Qty, Product Status and Due Date information for items with stock on order. Below is an example of the new feed.

Product Statuses

Product statuses are used to identify where in the life cycle the product currently sits. The statuses represented in the XML-3 feeds are a direct representation of the statuses in our active systems. You can use the product status to determine such things as when a product is coming to the end of its shelf life and when a product is new to your catalogue. Not all statuses will appear in the feed but below is a definition of what each status is and what it represents.

Status	Description
10	The product is not available for sale, product has no price set or tech spec assigned.
12	The product is not available for sale, product has price set but no tech spec assigned.
14	The product is not available for sale, product has no price set but does have a tech spec assigned.
20	A New product that is out of stock but has a PO raised for delivery. Stock is available for back order.
22	A New product that is out of stock but has a PO raised for delivery. All stock has already been allocated.
24	A New product that is out of stock but has no PO raised for delivery.
26	A new product that is in stock. Product stays at 26 for 14 days after which automation changes product to standard stock 36.
30	A Standard product that is out of stock but there is a PO raised and stock is available for back order.
32	A Standard product that is out of stock but has a PO raised for delivery. All stock has already been allocated.
34	A Standard product that is out of stock but has no PO raised for delivery.
36	A Standard product that is in stock.
38	A Standard product that is back in stock. Product stays at 38 for 14 days after which automation changes product to standard stock 36.
40	Products are at the end of life cycle with warning message stating end of life. No stock is remaining. Product stays at 40 for 14 days after which is changed to 42.
42	End of life product with no stock held and none on order.
46	End of life with remaining stock. Will change to status 40 once all stock is sold. If more stock is found or delivered since status change to 42, the system will cycle product back to 40.
50	Returned Product
54	Returned no Stock
56	Returned with Stock
59	Returned Reserved. This is when stock is stored for replacements.