Intact Xline API User Manual

Your website is integrated with the Xline APIs which means that your products, pricing, stock levels, customers and orders are automatically synced.

The following User Manual describes how to manage the website integration using Xline API.

This integration will do the following:

• Download all web orders into INTACT every 1 hour
• Upload products, customers, pricing and stock changes 3 times a day - once during the night, once around lunchtime, and once around 6pm.
  • And also do live real-time checks for stock and pricing when the customer goes through the checkout (this is optional).

What product fields are web integrated

The following product fields can be integrated with the website:

• Title - the title of the product
• TaxCode - the VAT/TAX code for the product.  These tax codes can be set up on the website as tax bands.  Just email the HelpDesk with the list of tax codes on Intact and the corresponding tax rate to use for each code.
  • Ex Vat prices come from Intact and then Vat/Tax is added depending on the TaxCode assigned to the product.

The "Prevent this item from being uploaded to the web" checkbox on the EPOS is tied to the "Active" checkbox on the product on the website  Never update the Active flag on the website - always use the "Prevent this item from being uploaded to the web" checkbox on INTACT to make a product active or inactive on the website. 

NOTE: By default, all products have the "Prevent" box above set to UNCHECKED - which means that all products are ENABLED FOR THE WEB by default.  So it is a good idea to have them BULK CHECKED before turning on the website integration - and then uncheck them one at a time going forward.

When uploading products to the website, the following products are skipped:

• Products with a blank title
• Products with a zero price
• Product codes with a forward slash in their title ("/") - as the product code is needed for urls and forward slash is a special character for urls

You can also map an INTACT User Defined Field (UDF) to additional fields.

What price fields are web integrated

You have 9 "selling price fields" per product in Intact.  You need to let the HelpDesk know which of the 9 price fields are to be used for the following prices.  For example, you may decide to use "selling price 1" for the EURO prices - and "selling price 2" for the promotion prices (for setting "WAS-NOW" pricing).

Alternatively, you can also map an INTACT User Defined Field (UDF) to any of the above price fields.

Special Pricing for an Intact Account

All other "selling prices" other than above are treated as price plans which can be used for specific client pricing. Each client on Intact has a "Price Code" field which allows them to be attached to an alternative "selling price" list.

Fir example, you may use "Selling Price 7", "Selling Price 8" and "Selling Price 9" as 3 different price plans for 3 different categories of accounts.  And you may then assign certain accounts with "Price Plan Code" of 7, others with 8 and others again with 9.

Automated Stock Control

All stock changes are automatically synced with the website - including any in-store stock changes.

Note that web stock changes are reflected immediately as web orders are made on the site - and the instore changes come through 3 times a day - or when a customer gets to the basket page with a product to complete a purchase (as we do a real-time stock check with Intact when the customer goes to the VIEW BASKET page at the start of the CHECKOUT).

AB Commerce receives the AVAILABLE stock quantity amount (i.e. it does not include RESERVED or ON ORDER stock).

View Basket Page

There are calls made to Intact when a customer gets to the View Basket Page to check the stock and pricing of all products in the customers basket to ensure that they are up to date. If a customer has been assigned a special price on Intact this is also checked here.

This is NOT turned on by default as it requires a high speed connection to your Intact server as if this is slow, every time the client goes to the checkout, the website will slow down for that client by a number of seconds.

Contact the Help Desk if you want this turned on.

Customers Integration

All Intact accounts will be synced 3 times a day with the website - and will appear under TRADE CUSTOMERS in the website admin.

To enable a customer to log in, they need to be given a login. Contact the Help Desk to arrange for training on how to do this for each client login.

Orders Integration

Your New Orders are automatically sent to Intact every 1 hour. Once they have been downloaded on Intact they are automatically move to the "Order Downloaded" order status. Do not move any orders that are in the "New Order" status on the website or else they will not be sent to Intact.

AB Commerce will automatically create an Intact Sales Order within 1 hour on Intact - a sales order will reserve the associated stock on the order but will not create a stock movement. You also have an option to allocate a payment received from the customer, this will be posted as a deposit against the sales order.

Before your orders integration can start downloading orders, the following settings need to be set up by the Help Desk.  To do this, set up the necessary changes on INTACT and then email in the following codes to the Help Desk:

You also need to set up a product code in INTACT for your shipping rate.  The default product code for the shipping rate in AB COMMERCE is WEBSHIP so set up a product called "Shipping" in your Intact Catalogue using this product code.

When a sales order is created for the web order, please note the following:

• If this is a CLICK AND COLLECT order, the DeliveryAddress1 of the order has "OUTLET: OutletName" in it - with OutletName being the name of your outlet that they selected to collect their order from.
• If this is a cash customer and it is for a DELIVERY (not click and collect), a new cash customer is created in INTACT.
• The SUMMARY of the sales order contains the EMAIL ADDRESS and any DELIVERY INFORMATION entered for the order.
• DELIVERY INFORMATION collected during the CHECKOUT is also placed in the ADDITIONAL INFO field. There is a maximum of 44 characters for this field so if the field is more than 44 characters, it is spread across the 4 additional info fields (AdditionalInfo1, AdditionalInfo2, AdditionalInfo3, AdditionalInfo4) up to a maximum of 44 X 4 = 176 characters.

VAT Integration

All orders when uploaded to INTACT are uploaded with the price ex vat and the vat treated separately.

If the product prices are set to INCLUDE VAT for the website, then we adjust the prices going back to INTACT by subtracting their VAT rate from the price - using the VAT rate recorded on INTACT.

The exception to this is if you set a TRADE ACCOUNT to be EXCLUDED FROM PAYING VAT/TAX.  In this case, the order will import into INTACT with zero for VAT - so test this to ensure that Intact does not add vat to the account for their orders automatically.

Payment Types

There are 2 payment types required to be set up on INTACT for the website on Intact:

1. Amount Paid on Order
2. Online Vouchers Amount

Ask your Intact support to set up the payment type for "ABC Vouchers" which stands for "AB Commerce Online Vouchers" and they will give you a payment string similar to the following (they will know what it means) - which you give to the Help Desk to add to your configuration:

string paymentSplit = $"0|0|{deposit:0.##}|0|0|{vouchers:0.##}";

Also, talk to INTACT about whether you need to create a new nominal account in INTACT for the "ABC Vouchers" to keep those separate from the Intact voucher values.

Intact Invoices Format

You may find that your invoices are missing fields (e.g. you may not have an EIRCODE on your invoice because your form was set up before EIRCODEs were launched).  If you are missing a field on an invoice, simply just add it to the INTACT FORM for that invoice.  The field is being populated in the database - it is just not being displayed on the form yet.

Monitoring the BATCH JOB

You can monitor the batch job through our standard batch jobs dashboard.  Contact the Help Desk to arrange for training on how to monitor the batch jobs.

We make calls to Xline once a day during the night for downloading the entire product catalogue in the "Initialise Routines" batch job. We then create csv files from this data that are processed through the other batch jobs such as the "Import Products" job - or "Import Stock" - or "Import Customers".  You can see this data and also see the steps taken for processing this data as well as any errors that are raised.