IRP Service Marketplace

Service Marketplace (2)

IRP Shopper

Admin Users (2)

Advanced Pricing (3)

Application Settings (15)

Common Tasks (1)

Customers (5)

Data Imports / Exports (10)

EPOS (15)

Integration (4)

Interface & Design (25)

Interface Translations (9)

Interventions (1)

Languages (1)

Live Chat (4)

Loyalty Schemes (3)

Orders (12)

Payment Processing (16)

PPC & SEO (13)

Price Adjustments (2)

Price Match (2)

Products (17)

Programming Utilities (3)

Promotions (4)

Questions & Answers (1)

Referrals (2)

Reviews (1)

Search (5)

Security (6)

Server Management (12)

Shipping (11)

Site Help (2)

Site Scripts (1)

Statistics (4)

Stock Control (11)

Subscriptions (1)

System Logs (3)

Telesales (3)

Trade Site (8)

Web Services (1)

IRP Marketing Cloud

Email Marketing (11)

Feed Management (5)

Orders Tracking (3)

IRP Marketplaces

Marketplaces (5)

IRP Freshdesk

Freshdesk (1)

Training Videos

Peer Support

Overview - Legacy (Integration)

You can find this section under Integration > Overview - Legacy in the IRP Admin left navigation menu.

The page presents you with an overview of ‘legacy’ integrations on the IRP. The page also provides you with summary log files that show what integration actions have been carried out and when they occurred, whether or not those actions were successful and details such as the name and IP address of the IRP Admin users who performed the integrations.

This is useful information because, if you notice that some data has been incorrectly formatted or that it is wrong in some way or other on your website, you need to know when the integration was carried out and by whom. You can then proceed to contact the user for more details, if necessary. You can then go on to correct the errors.

The overview page (UniversalIntegrationOverview.aspx) for legacy integrations appears as follows:

The information is grouped into the following sections:

Product integration overview

You use Product Integration to format and create recurring bulk imports of product data. This section includes the following summary information:

Is Integration Active: (Yes or No) This indicates whether product integration is ready to run, based on field mapping prerequisites and the presence of a product integration SQL query. If Integration is active, you will see a summary of information displayed in the lower part of the section (see ‘Integration Details’) below.
Product Data Last Integrated: This shows the date and time when the product integration was last performed. If not applicable, this will state ‘Not Integrated’. Click the Edit button to go to the Product section.

When setting up your Legacy Custom Integration for the first time you should follow these steps:

Set Data Manipulation Steps using the Manipulate Imported Data tab. See the Legacy Integrations: How To Add or Edit Data Manipulation Steps article for details.
Set Data Field Mappings using the Map Imported Fields tab. See the Legacy Integrations: How To Edit Field Mappings for Product Integrations article for details.
Create Integration SQL Query using the Integration Query tab. See the Legacy Integrations: How To Add or Edit an Integration Query article for details.
Perform the integration as described in the Legacy Integrations: How To Perform an Integration article.

After these steps have been completed, you do not need to perform them again unless the import file format changes.

Stock integration overview

Stock Integration is used to format and create recurring bulk imports of stock data. The section can also be used to update any value contained in the Stock table of your IRP database including Part Codes, EAN Codes, Postage Weights, prices, RRPs, etc. This section includes the following summary information:

Is Integration Active: (Yes or No) This indicates whether stock integration is ready to run, based on field mapping prerequisites and the presence of a stock levels integration SQL query. If Integration is active, you will see a summary of information displayed in the lower part of the section (see ‘Integration Details’) below.
Stock Data Last Integrated: This shows the date and time when the stock integration was last performed. If not applicable, this will state ‘Not Integrated’. Click the Edit button to go to the Stock section.

When setting up your Legacy Custom Integration for the first time you should follow these steps:

Set Data Manipulation Steps using the Manipulate Imported Data tab. See the Legacy Integrations: How To Add or Edit Data Manipulation Steps article for details.
Set Data Field Mappings using the Map Imported Fields tab. See the Legacy Integrations: How To Edit Field Mappings for Stock Integrations article for details.
Create Integration SQL Query using the Integration Query tab. See the Legacy Integrations: How To Add or Edit an Integration Query article for details.
Perform the integration as described in the Legacy Integrations: How To Perform an Integration article.

After these steps have been completed, you do not need to perform them again unless the import file format changes.

Custom integration overview

You can use this section for any type of custom integration, for example you may want to use it for Orders Integration — you could upload a file to the IRP from your EPOS system then run SQL on it to update your Order statuses. This section includes the following summary information:

Is Integration Active: (Yes or No) This indicates whether custom integration is ready to run, based on the presence of a stock integration SQL query. If Integration is active, you will see a summary of information displayed in the lower part of the section (see ‘Integration Details’) below.
Custom Data Last Integrated: This shows the date and time when the custom integration was last performed. If not applicable, this will state ‘Not Integrated’. Click the Edit button to go to the Custom section.

When setting up your Legacy Custom Integration for the first time you should follow these steps:

Set Data Manipulation Steps using the Manipulate Imported Data tab. See the Legacy Integrations: How To Add or Edit Data Manipulation Steps article for details.
Create Integration SQL Query using the Integration Query tab. See the Legacy Integrations: How To Add or Edit an Integration Query article for details.
Perform the integration as described in the Legacy Integrations: How To Perform an Integration article.

After these steps have been completed, you do not need to perform them again unless the import file format changes.

Legacy integration details

If Integration is active, you will see a summary of information displayed in the lower part of the section. The details include:

File Last Uploaded: The date and time of the last Integration File Upload.
Number of Rows in Import Table: The Number of Rows in the Integration Import table following the Upload of a delimited file.
Data Last Staged: The last date and time that Integration data was staged prior to Integration.
Number of Rows in Staging Table: The Number of rows in the Integration staging table.
Pre-Requisite Field Mappings Assigned: Have the Pre-Requisite Field Mappings been set up for the Integration (Yes/No)?
Field Mappings: The Number of Field Mappings between Integration Import Fields and Integration Staging Fields (including the Pre Requisite Field Mappings).
Data Manipulation Steps: The Number of Active Manipulation Steps to be performed on Imported Integration data prior to it being Staged.
Integration SQL Query Set Up: Is there a Integration SQL Query set up for the Integration (Yes/No)?

Integration log

The Integration Log section includes the following summary information. You can use the search bar to find particular files and if you expand Other Options under the Search bar, you can search by Integration Type (Product, Stock or Custom):

Username: This shows the username of the IRP Admin user who carried out a stock levels integration.
Type: This shows the type of integration — Product, Stock or Custom.
Detail: This shows the action that the user carried out, for example, “Field Mappings Deleted”.
Success: This shows whether the action was successful (True) or unsuccessful (False).
IP Address: This shows the user’s IP address.
TimeStamp: This shows the date and time when the user carried out the action.

You can add Integrations by clicking the Add Product Integration, Edit Stock Integration, Add Custom Integration or Add New Dynamic Integration buttons at the top of the screen.

Also you can click the Dynamic Integrations button to go to the main IntegrationOverview.aspx screen where you can see an overview of dynamic integrations, as described at the start of this topic.

Tags:

Product Integrations

Custom Integrations

Stock Integrations

Dynamic Integration

Integration Overview

Legacy Integrations

Universal Integrations

Integration File Last Uploaded

Integration SQL Set Up

Integration Data Last Staged

Automation Enabled

Data Manipulation Steps

Rows in Staging Table

History Log Entries

Has Automation URL

Add New Integration

Is Integration Active

Product Data Last Integrated

Stock Data Last Integrated

Custom Data Last Integrated

Number of Rows in Import Table

Number of Rows in Staging Table

Pre-Requisite Field Mappings Assigned

Integration SQL Query Set Up

Integration Log

How To Perform an Integration

Remove Quotation Marks

Automated Integrations

No Post Data Received

HTTP Post not enabled for this Integration

Automation Disabled for this Integration

Integration does not Exist

Error Integrating Staged data

Error Staging Uploaded file

Error Uploading Integration data

Automated Integration Successful

How To Guides (5)

Legacy Integrations: How To Add or Edit Data Manipulation Steps

Copy URL

Data Manipulation steps are used to manipulate/edit the data you are uploading into a compatible format so that it can be imported into your IRP database successfully. This section allows you to set the step/s which will be performed on the import data. They will be repeated automatically, each time a Stock Integration is performed. There are a number of different manipulations which can be performed on an import file:

Setting	Description
Custom Manipulation	This allows you to execute a SQL Script. This option should be used if you cannot manipulate data using the following Data Manipulations. In the example below, the Price value is being changed to the Price plus 10% where the original Price value is less than £5.
Add New Field	This allows you to add a new field to the import file. You can provide the Name, Data Type, Size and Default values as well as enable/disable Null values. In the example below, the EntryDate value is being added to record the date that the data was entered. A default value of the current date is being set using the GETDATE() command.
Remove Field	This allows you to remove an existing field from the import file. In the example below, the ManufacturerCode field will be removed from the import file.
Rename Field	This allows you to rename an existing field in the import file. You must supply the Field you wish to rename and the new name value. In the example below, the ManufacturerCode field will be renamed PartCode in the import file.
Change Field Type	This allows you to change the Data Type and/or Size of an existing field in the import file. In the example below, the Data Type of the Price Field will be changed to Money.
Replace Text	This allows you to replace text in an existing field with a different value in the import file. In the example below, the text 'Size 8' is being replaced with 'Small' in the Option field.
Remove Text	This allows you to remove text from an existing field in the import file. In the example below, the text 'Brand X' will be removed from anywhere in the Model field.
Append Text	This allows you to append text to an existing field in the import file. In the example below, the text 'Brand Y' will be added to the beginning of the Model field.
Split Field	This allows you to split the value held in one field into two separate fields. In the example below, the ManufacturerCode field contains values such as 'CAT01-15895'. This value contains the Category ID of 'CAT01' and the product PartCode of '15895'. The values are separated by the '-' character. This will split these two values into separate fields called Category and PartCode.
Remove Quotation Marks	This allows you to remove quotation marks from an existing field in the import file. In the example below, quotation marks will be removed from the Model field.
Set Field Value	This allows you to set a default value for all records in an existing field, in the import file. In the example below, a default value of '1' will be set against all records of the StockHeldExternally field.
Capitalize Field	This allows you to capitalize the first character of an existing field in the import file. In the example below, the first letter of the value stored in the Brand field will be capitalized in each record of the import file.
Remove Whitespace	This allows you to remove all whitespace from an existing field in the import file. In the example below, all whitespace in the PartCode field will be removed in each record of the import file.

Add Data Manipulations

To add a Data Manipulation Step, follow these steps:

Go to Integration > Overview in the IRP left navigation menu.
Click the Edit button for the type of legacy integration that you want to perform (Product, Stock or Custom).

Click the Manipulate Imported Data tab.
There are three sections here:

Setting	Description
Add Data Manipulation Step	Allows you to add a new Data Manipulation Step.
Edit Data Manipulation Steps	Allows you to edit an existing Data Manipulation Step.
Sample of Imported Stock Data	Displays a sample data set of the previously imported data.

To add a Data Manipulation Step, select the Manipulation from the drop down and enter the required values discussed above.
Please note that further information on each value is displayed by hovering the mouse pointer over the corresponding text field.
Once you are satisfied with the manipulation, click the Add Step button to save it.
Repeat points 3 and 4 for each Data Manipulation required in the Stock Integration.

Edit Data Manipulations

Once a Data Manipulation Step has been added, you can edit the following details:

Setting	Description
Execution Order	The order in which the manipulations will occur. This will be important in certain cases. For example, if you are adding a new Field upon which you plan to perform another data manipulation on. The column must exist with its values before any further manipulations can be carried out on it.
Notes	Admin Notes can be used to inform other users of the purpose of the Data Manipulation Step.

Once changes have been made, click the Update Data Manipulation Steps button to save them.

Legacy Integrations: How To Edit Field Mappings for Product Integrations

Copy URL

Field Mappings are used to link the fields in the import file to fields in your IRP database. Setting the Field Mappings will ensure that the correct fields and values are updated and stored within your IRP database when a file is integrated.

Required Field Mappings

There are a number of required Field Mappings which must be set:

Setting	Description & Data Type
CategoryExternal / CategoryID	CategoryExternal - An alphanumeric identifier for a Category, external to the IRP. CategoryID - A unique numeric identifier for a Category within the IRP. Data Type: Nvarchar(30) / Int
ExternalStockID / StockID	ExternalStockID - A unique alphanumeric identifier for a Stock Item, external to the IRP. StockID - A unique numeric identifier for a Stock Item within the IRP. Data Type: Nvarchar(20) / Int
ModelExternal / ModelID	ModelExternal - An alphanumeric identifier for a Model, external to the IRP. ModelID - A unique numeric identifier for a Model within the IRP. Data Type: Nvarchar(250) / Int
Brand	An alphanumeric identifier for a Brand, e.g. Brand Name. Data Type: Nvarchar(30)
Category	An alphanumeric identifier for a Category, e.g. Category Name. Data Type: Nvarchar(50)
Model	An alphanumeric identifier for a Model, e.g. Model Name. Data Type: Nvarchar(250)

After these have been added, click the Update Pre-Requisites button to save them.

Optional Field Mappings

After the required fields have been added, new functionality will appear in the Set up Field Mappings section. This will allow you to add the following optional Field Mappings via drop down:

Setting

Description & Data Type

BrandExternal

An external alphanumeric identifier for a Brand, e.g. Industry abbreviation for brand used by suppliers, etc. The North face - TNF.
Data Type: Nvarchar(30)

CategoryID

A unique numeric identifier for a Category within the IRP.
Data Type: Int

CategoryExternal

An alphanumeric identifier for a Category, external to the IRP.
Data Type: Nvarchar(50)

Description

Model Description.
Data Type: Nvarchar(max)

EAN13PartCode

EAN13PartCode/Barcode value for the Stock Item.
Data Type: Nvarchar(20)

ExternalStockID

An alphanumeric identifier for a Stock Item, external to the IRP.
Data Type: Nvarchar(50)

ImageUrlsModel

The URL for the Model Image.
Data Type: Nvarchar(max)

ImageUrlsStock

The URL/s for Stock Image/s.
Data Type: Nvarchar(max)

InStock

The Web (total available) Stock Level for the Stock Item.
Data Type: Nvarchar(Int)

ISBNNumber

ISBN Number for the Stock Item.
Data Type: Nvarchar(20)

KitStatus

Numeric value which represents the Model's Kit Status:

Setting	Description
0	Not A Kit
1	Not A Kit
2	Kit Item Only

Data Type: SmallInt

LocalPrice

The Price of a Stock Item for the Stock Location set in the Integration. This price will be used if the user logs in to the EPOS system.
Data Type: Money

LocalStockLevel

The Stock Level of a Stock Item at the Stock Location set in the Integration.
Data Type: Int

ModelExternal

An alphanumeric Name for a Model, external to the IRP.
Data Type: Nvarchar(250)

ModelID

A unique numeric identifier for a Model within the IRP.
Data Type: Int

Offer

The Offer Status for the Model and associated Stock Items:

Setting	Description
0	Not On Offer
1	Sale
2	Clearance
3	Sale & Clearance
4	Back In Stock
100	New

Data Type: SmallInt

Option

The Stock Option - Size and/or Colour, e.g. XL/Black, 12/Red, 150ml, etc.
Data Type: Nvarchar(36)

OutOfStockStatus

The Out of Stock Status for a Stock Item:

Setting	Description
0	Normal - Allows Customer to set up a Stock Notification for when the Stock Item comes back in Stock.
500	Special Order -
1000	Discontinued - Stock Item cannot be ordered when the Web Stock Level reaches zero. This stock Item can only be purchased if the Stock level is greater than zero.
Any Positive Integer	Available In - Available In x-y days. The value entered here will be the y value. The x value will be y divided by 2. This will be rounded up when odd numbers are used. For example, If you set the value to 10, the Stock Option listing on the Model's page will read: Available in 5 - 10 days. If you set the value to 7, the Stock Option listing on the Model's page will read: Available in 4 - 7 days.

Data Type: SmallInt

PartCode

Manufacturers PartCode for a Stock Item.
Data Type: Nvarchar(20)

PostageWeight

Weight of an Item in grams.
Data Type: Int

Price

The Website Price of a Stock Item.
Data Type: Money)

RRP

The RRP of the Model and associated Stock Items.
Data Type: Money

StockID

A unique numeric identifier for a Stock Item within the IRP.
Data Type: Int

StockLocation

The Stock Location Name for the Stock Location which you are updating/adding Stock Items to.
Data Type: Nvarchar(50)

SupplierCostPrice

The Supplier Cost price for a Stock Item.
Data Type: Money

SupplierName

The Name of the Supplier for this Model/Stock Item.
Data Type: Nvarchar(50)

UPCAPartCode

The Universal Product Code for this Stock Item.
Data Type: Nvarchar(20)

VatRate

The Vat Rate for this Stock Item as a decimal, e.g. 0.05, 0.20, etc.
Data Type: Decimal (18,2)

ImportedTimeStamp

Set DateTime value when this integration was performed. Will be automatically generated if not included.
Data Type: DateTime

Add Field Mappings

To add Field Mappings, follow these steps:

Go to Integration > Overview in the IRP left navigation menu.
Click the Edit button for the Product legacy integration that you want to work with.

Click the Map Imported Fields tab.
> There are three sections here:

Setting	Description
Set up Field Mappings	Allows you to add a new Field Mapping.
Edit Field Mappings	Allows you to edit an existing Field Mapping.
Sample of Imported Stock Data	Displays a sample data set of the previously imported data.

Enter the Required Field Mappings values (column headers) from your import file:
Please note that the first three options also require the relevant data type to be set by selecting the corresponding radio button.
Click the Update Pre-Requisites button to add the Required Field mappings.
Add any Optional Field Mappings you can provide data for:
Click the Add Field Mapping button after entering a Field name to add the Optional Field mappings. Repeat this step for each additional Optional Field Mapping.

Edit Field Mappings

To edit Field Mappings, simply change the Import Field value to the correct value and click the Update Field Mappings button to save the changes.

Legacy Integrations: How To Edit Field Mappings for Stock Integrations

Copy URL

Required Field Mappings

There are two required Field Mappings which must be set:

Setting	Description & Data Type
ExternalStockID EAN13PartCode PartCode StockID	ExternalStockID - A unique alphanumeric identifier for a Stock Item, external to the IRP. EAN13PartCode - EAN13PartCode/Barcode value for the Stock Item. PartCode - Manufacturers PartCode for a Stock Item. StockID - A unique numeric identifier for a Stock Item within the IRP. Data Type: Nvarchar(20) / Nvarchar(20) / Nvarchar(20) / Int
Web Stock Level	The Web (Total) Stock level for a particular Stock Item. This value will determine how many units of a particular item can be purchased on the site. Data Type: Int

After these have been added, click the Update Pre-Requisites button to save them.

Optional Field Mappings

After the required fields have been added, new functionality will appear in the Set up Field Mappings section. This will allow you to add the following optional Field Mappings via drop down:

Setting

Description & Data Type

EAN13PartCode

EAN13PartCode/Barcode value for the Stock Item.
Data Type: Nvarchar(20)

ExternalStockID

An alphanumeric identifier for a Stock Item, external to the IRP.
Data Type: Nvarchar(50)

PartCode

Manufacturers PartCode for a Stock Item.
Data Type: Nvarchar(20)

Price

The Website Price of a Stock Item.
Data Type: Money

RRP

The RRP of the Stock Item.
Data Type: Money

StockID

A unique numeric identifier for a Stock Item within the IRP.
Data Type: Int

StockLevel

The Local Stock Level of a Stock Item at the Stock Location set in the Integration.
Data Type: Int

StockLocation

The Stock Location Name for the Stock Location which you are updating/adding Stock Items to.
Data Type: Nvarchar(50)

StockLocationID

A unique numeric identifier for the Stock Location which you are updating/adding Stock Items to, within the IRP.
Data Type: Int

ISBNNumber

ISBN Number for the Stock Item.
Data Type: Nvarchar(20)

Offer

The Offer Status for the Stock Item:

Setting	Description
0	Not On Offer
1	Sale
2	Clearance
3	Sale & Clearance
4	Back In Stock
100	New

Data Type: SmallInt

Option

The Stock Option - Size and/or Colour, e.g. XL/Black, 12/Red, 150ml, etc.
Data Type: Nvarchar(36)

PostageWeight

Weight of an Item in grams.
Data Type: Int

SupplierCostPrice

The Supplier Cost price for a Stock Item.
Data Type: Money

UPCAPartCode

The Universal Product Code for this Stock Item.
Data Type: Nvarchar(20)

Add Field Mappings

To add Field Mappings, follow these steps:

Go to Integration > Overview in the IRP left navigation menu.
Click the Edit button for the Stock legacy integration that you want to work with.

Click the Map Imported Fields tab.
> There are three sections here:

Setting	Description
Set up Field Mappings	Allows you to add a new Field Mapping.
Edit Field Mappings	Allows you to edit an existing Field Mapping.
Sample of Imported Stock Data	Displays a sample data set of the previously imported data.

Enter the Required Field Mappings values (column headers) from your import file:
Please note that the first mapping requires you to select the corresponding Field using the drop down box.
Click the Update Pre-Requisites button to add the Required Field mappings.
Add any Optional Field Mappings you can provide data for:
Click the Add Field Mapping button after entering a Field name to add the Optional Field mappings. Repeat this step for each additional Optional Field Mapping.

Edit Field Mappings

To edit Field Mappings, simply change the Import Field value to the correct value and click the Update Field Mappings button to save the changes.

Legacy Integrations: How To Add or Edit an Integration Query

Copy URL

The Integration Query is the SQL Query which will run to import the data from the import file/staging table to the various tables in your IRP database. Without the query, Integration is not possible.

An understanding of SQL, IRP Database Structure and your data is required to create the import script. We advise that you contact your IRP Support Team regarding the creation of this query.

Note that this tab will be displayed only if your Admin User account has DBA status.

To add or edit an Integration Query, follow these steps:

Go to Integration > Overview in the IRP left navigation menu.
Click the Edit button for the type of legacy integration that you want to perform (Product, Stock or Custom).
Click the Integration Query tab.
We advise creating this query in an external editor and ensuring that it is valid before pasting it into the Query SQL field.
Click the Update Integration Query button to save the query.

With the Data Manipulation steps, Field Mappings (not applicable to Custom Integrations) and Integration Query set, you can go on to perform the integration as described in the Legacy Integrations How To Add or Edit an Integration Query article.

Legacy Integrations: How To Perform an Integration

Copy URL

After setting the Data Manipulation steps, Field Mappings (not applicable to Legacy Custom Integrations) and Integration Query, you can perform an integration to update the data held in your IRP database.

To perform a legacy integration, follow these steps:

Go to Integration > Overview in the IRP left navigation menu.
Click the Edit button for the type of legacy integration that you want to perform (Product, Stock or Custom).
Remain on the Upload and Integrate tab.
Step 1: Upload and Import Delimited File
1. Click the Choose File button and select the integration file on your machine.
2. If the Column Headers are included in the file, check the File Has Column Names checkbox. This will ensure that the first row is left out of the integration.
3. Click the Upload button to upload the data.
Step 2: Stage Imported Data
Click the Stage button to perform the Data Manipulation Steps and the Field Mappings (if relevant) defined previously. A sample of the data that will be imported will be displayed in the Sample of Imported Data section. If you are happy with the sample data, proceed to the next step. Otherwise, make any necessary changes to the Data Manipulation Steps or Field mappings and repeat the last two steps, until correct.
Step 3: Integrate Staged Data
Click the Integrate button to run the Integration Query.

How can we help you?

Overview - Legacy (Integration)

Product integration overview

Stock integration overview

Custom integration overview

Legacy integration details

Integration log

How To Guides (5)

Add Data Manipulations

Edit Data Manipulations

Required Field Mappings

Optional Field Mappings

Add Field Mappings

Edit Field Mappings

Required Field Mappings

Optional Field Mappings

Add Field Mappings

Edit Field Mappings