1. Establish an automated connection with Quicklizard
Quicklizard can integrate with any backend system through Quicklizards’s REST API or SFTP Files. As designed in the ERP System, the customer product structure will be carried over to the Quicklizard Pricing engine and will be enhanced and fed back to the ERP as needed.
1.1 API
This manual covers SFTP connections, but it's important to note that the API is the preferred method for integration. It offers maximum flexibility, allowing you to schedule and adjust updates as often as needed. For more information, see our technical documentation at help.quicklizard.com
1.2 SFTP
This method is used to transfer files to Quicklizard. It is usually used for a limited time since it is easier to start with an extract from the ERP than to put in the time and create an automated integration via the API.
SFTP, short for Secure File Transfer Protocol, is ideal for transferring sensitive data securely to Quicklizard platform. As It encrypts both the server information and the data in transit. Quicklizard's SFTP server is compatible with both Windows and Linux operating systems..
1.2.1 Access Quicklizard’s SFTP Server
Generate an SSH-2 RSA key
How to access Quicklizard SFTP Server on Windows
Step 1: Download the PuTTYgen key generator: www.puttygen.com/download-putty.
Step 2: Click the “Generate” button in the PuTTYgen Key Generator or any other Key generator.
Note: Please check the RSA radio button under the “Type of key to generate.”
Step 3: Copy the key generated under “Public key for pasting into OpenSSH authorized_keys file” and save it in a text editor on your local machine.
📝 Users must copy the whole key, don’t include the phrase RSA-key.
📝Do not click on "Save public key" and save it to a folder as it would create a file with an invalid key structure: "Begin SSH-2 key <key> End SSH-2 key".
Step 4: Click on the "Save private key" button to save the private key on your local machine (private_key.ppk).
Step 5: Send the file containing the public key that you have generated to Quicklizard.
Step 6: Fill in all the information in WinSCP with your credentials:
File Protocol: SFTP
Host Name: sftp02.quicklizard.com
Port Number: 22
User Name: Your username (To be generated by Quicklizard)
Password: No need for a password unless specified
Step 7: After entering all the required details, click on "Advanced" → SSH → Authentication→ and then insert the path of your private key under "Private key file."
Note: This is not a mandatory step. You can usually connect to the SFTP server without stating your private key's path. However, if you cannot connect to the SFTP server using the conventional way, follow Step 7.
Step 8: Click on the "Ok" button.
Step 9: Finally, click "Login" to connect to the SFTP folder.
How to Access Quicklizard SFTP Server via Linux terminal
Step 1: Generate the public key using the command (ssh-keygen) in the Linux terminal.
📝 Please note that the Quicklizard SFTP server corresponds with the SSH-2 key.
📝 The hostname for the Quicklizard SFTP server is sftp02.quicklizard.com
📝 SSH-2 public key must start with ssh-RSA followed by a long key. For example, ssh-RSA <Key>
📝 Ensure the file containing your public key is in a hidden folder named .ssh.
Step 2: Once you have generated the public key, send the file containing your public key to Quicklizard.
Step 3: Finally, connect to the SFTP server by using the “sftp” command (sftp [username]@[hostname]) in the terminal.
For example, “sftp [username]@sftp02.quiclizard.com”.
Hostname: sftp02.quicklizard.com
Username: Your Username
Note: In case you have located your public key elsewhere, use the below format:
sftp -o "IdentityFile=[path]" -P [port] [username]@[hostname]
Explanation:
[path]= The full path leading to the public key file on your local machine.
[port]= The port used. For the SFTP connection, we have used port 22.
Then [username]@[hostname]
Here’s the format of the command:
sftp -o "IdentityFile=/home/lizard/Desktop/example_ssh" -P 22 [username]@sftp02.quickilizard.com
2. Create your product feed
In order to begin using Quicklizard, it is essential to transfer your products to the platform. This process is mandatory.
To accomplish this, you need to create a product feed. The product feed must adhere to a specific template to ensure proper population of the platform.
To get started, download this template for creating the file.
Below, you'll find a table with a brief explanation for each field in the template:
Field Name |
Description |
Data Type |
channel |
The pricing channel in which this product should be updated at. |
String |
product_id |
Your product's unique identifier |
String |
title |
The product name |
String |
permalink |
The link to the product in your site |
String |
image |
A URL to the image of the product |
String |
disabled |
Optional- Add this column if you wish to disable product pricing. Send "1" for products you don't want to price and "0" for products you do. |
Number |
shelf |
The current shelf price |
Number |
cost |
The product's cost |
Number |
inventory |
The product's inventory |
Number |
attrs:<attribute_name> |
Any additional attribute you need for your pricing strategy. <attribute_name> should be replaced with the relevant name. For example, attrs:brand, attrs:ean, attrs:mpn. |
String |
📝 Ensure your file is UTF-8 encoded and saved as CSV, XML, or JSON.
3. Create competitor's prices feed
To transfer competitors' prices to the Quicklizard platform, you must consider the competitors types first. According to your chosen type, generate a file to send via SFTP.
There are three different types of competitors defined in the Quicklizard platform that have a direct effect on pricing recommendations:
Direct
Cheapest Competitor
List Competitor
If you want to use a direct competitor, set up a “competitor prices” file.
To update the competitors extracted from a marketplace, you must set up two files - “competitors prices” and “store list.”
3.1 Competitors' Prices File
Download the template.
Note: Ensure that the competitor’s prices file contains all your products.
If competitors are unavailable for a product, the line for that particular product should be kept empty.
If your file contains over 30000 lines, send the competitors in a few separate files up to 30000 lines.
The table below shows the columns that you will find in the competitor’s prices file:
product_id: |
A unique identifier of the product for which this competitor should be updated. |
Source |
For the direct competitor: Contain "Shop webpage." For the marketplace extract: Contain the domain of the marketplace (For example, google.com) |
Retailer name |
For direct competitors: Contain the competitor domain For the marketplace extract: Contain the specific seller name |
Listing URL |
The listing in the marketplace/ on the competitor's site |
Product URL |
The listing in the marketplace/ on the competitor's site |
Price |
Competitor price |
In stock |
1: In-stock, 0: Out of stock |
attribute A |
Optional: Can contain any relevant data from the competitor site |
attribute B |
Optional: Can contain any relevant data from the competitor site |
📝 The file should be UTF-8 encoded and saved as CSV, XML, or JSON
3.2 Store List
A store list should include everything you have under “retailer name” on the competitor’s prices file. This list will be available as a drop-down on the Quicklizard platform for the pricing manager to configure their preferences.
📝 Each value in a store list should only exist once.
4. Create your analytics feed
While updating the analytics to the Quicklizard platform is highly recommended, it is not mandatory.
If you choose to update them, use SFTP integration only if you don’t have the technical ability to use the other options Quicklizard offers. You can read a summary of the two other options Quicklizard has available here.
In the analytics feed, each product should only appear in the file once. If there is more than one relevant event for a product, you should compile the events into a single row.
Note: If a purchase's time stamp is essential to you, don't choose this option, as it only updates the relevant date in the system.
Download this template to start working on the file.
You are required to send the following:
From |
The date and Time of the first purchase of this product |
To |
The date and Time of the last purchase of this product |
Product_id |
The product’s unique Identifiers |
Views |
Number of times this product was viewed |
Tag |
This is not a mandatory field, you can read about tagging here |
Conversions |
Number of transactions that were made |
Units |
Number of units that were purchased |
Revenue |
The revenue that was generated from the purchase of the product |
Profit |
This is not a mandatory field |
Client_key |
The unique identifier of your system |
Channel |
The unique identifier of your channel |
4.1 Other ways to send analytics
Two other methods can be used to update analytics:
Javascript SDK
Server to server
If you are debating which way to go, contact Quicklizard support.
4.1.1 Javascript SDK
You can send us details about the product views and purchases with just a few lines of Javascript code added to the main pages of your online store.
Some of your users deploy ad blockers that block our SDK. So, this isn’t the best option if you are looking for 100% accuracy.
Read all about the SDK in the SDK docs.
4.1.2 Server to Server
You may send product and payment confirmation events from your backend to our server-to-server SDK events API endpoint.
This integration is more suitable when you cannot embed our JS SDK in your pages or want stricter control over what data is sent to Quicklizard. It is important to note that SDK events should be sent from your backend in product and payment confirmation pages.
Please read all about the server-to-server implementation in our technical documentation.
Comments
0 comments
Please sign in to leave a comment.