TABLE OF CONTENTS
- 1) Description
- 2) Setup
- 3) PrestaShop as Source
- 4) PrestaShop as Target
- 5) Frequently used Workflows
- 6) Related Content
1) Description
With nearly 300,000 e-commerce websites already using its software across the globe, PrestaShop is the leading open-source e-commerce solution in Europe and Latin America. Thanks to PrestaShop Essentials, its suite of modules that offers secure payment solutions worldwide, performance analysis and web marketing, and PrestaShop Platform, its hosting offer, PrestaShop allows companies to easily deploy their business on a larger scale.
2) Setup
Step 1: Enter the name of the integration
Either while Creating a Task or in the Integrations menu.
Enter the name of the integration in the search bar.
Step 2: Write the integration name
Enter the Name of the Integration.
You can optionally also enter a description.
Step 3: Credentials page
You will be prompted for the Shop URL and Webservice Key.
Step 4: Obtaining Credentials
To obtain the Shop URL, head over to your PrestaShop dashboard, and copy the URL from the address bar.
Or simply right click it and click on "Copy Link Adress".
To obtain the Webservice key, head over to your PrestaShop dashboard.
In the lower-left corner of the screen, click on "Advanced Settings", as shown in the picture below:
Then, select "Web service" from the dropdown menu, as shown in the picture below:
Next, click on "Add web service key", found in the upper right corner of the screen, as shown in the picture below:
Now you need to click the "Produce" button found on the right-hand side, for the key to generate, as well as enter a description for it, as shown in the picture below:
Next, you need to grant the desired permissions, and click the "to save" button, as shown in the picture below:
After that is done simply copy the generated key and paste it where you were prompted to by SyncSpider.
Now all that's left to do is to install the SyncSpider module on your PrestaShop account.
Start by clicking the "Download" button, as shown in the picture below:
A .zip file should get download to your machine. There is no need to extract anything.
Simply head over to PrestaShop's dashboard once again, and click on "Modules" found on the left-hand side, and then on "Module manager", as shown in the picture below:
Then, in the upper-right corner of the screen, click on "Upload module", as shown in the picture below:
Now, simply drag and drop the downloaded .zip file where prompted, or select the destination path leading to it, as shown in the picture below:
After the SyncSpider module has been uploaded, and Shop URL and Web Service key pasted where prompted to by SyncSpider, click on "Finish".
Important: Enabling CGI mode is only necessary if PHP on your server is configured to run in CGI mode.
3) PrestaShop as Source
3.1 Product
3.1.1 Source Configuration
Choose product unique identifier field (UID)
A unique identifier is an identifier that is guaranteed to be unique among all identifiers used for those objects and for a specific purpose.
You can choose between the following options:
- ID
A unique identifier code for the product.
- Reference Code
A unique combination of letters and numbers used to identify a folder or item to facilitate storage and retrieval.
- EAN-13 or JAN Barcode
Encodes a GTIN-13 and is used to identify individual items at retail point of sale.
- UPC Barcode
A barcode symbology that is widely used worldwide for tracking trade items in stores. UPC consists of 12 digits that are uniquely assigned to each trade item.
- Name
Name of the specific product
Choose Language
You can choose between the following options:
- English
- Deutsch (German)
Include Product Attributes in parent products
3.1.2 Filtering
PrestaShop with Product as Source allows to be filtered by the following fields and conditions:
ID | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
New | Is not set, Is set, Equals, Not Equals |
Tax Rules Group | Is not set, Is set, Equals, Not Equals, Contains, Not in a Sequence, In a Sequence |
Reference code | Is not set, Is set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
Supplier reference | Is not set, Is Set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
Width | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Height | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Depth | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Weight | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
EAN-13 or JAN barcode | Is not set, Is set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
UPC barcode | Is not set, Is set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
Is virtual | Is not set, Is set, Equals, Not Equals |
On Sale label | Is not set, Is set, Equals, Not Equals |
Online only (not sold in store) | Is not set, Is set, Equals, Not Equals |
Eco-tax (tax incl.) | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Minimal quantity | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Retail Price | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Wholesale Price | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Additional shipping fees | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between
|
Customizable | Is not set, Is set, Equals, Not Equals |
Enabled | Is not set, Is set, Equals, Not Equals |
Available for order | Is not set, Is set, Equals, Not Equals |
Available date | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not IN a Sequence, Between |
Condition | Is not set, Is set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
Show price | Is not set, Is set, Equals, Not Equals |
Visible | Is not set, Is set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
Date Added | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not IN a Sequence, Between |
3.1.3 Mapping
Constant Value | const |
ID | number |
Reference code | text |
Parent UID | text |
Tax Rules Group | options |
Quantity | number |
Product Type | options |
Model Type | options |
Is Variation (Combination) | bool |
Package width (cm) | number |
Package height (cm) | number |
Package depth(cm) | number |
Package weight(kg) | number |
Quantity Discount | number |
EAN-13 or JAN barcode | number |
UPC barcode | number |
On Sale label | bool |
Online only (not sold in store) | bool |
Eco-tax(tax incl.) | number |
Minimal quantity | number |
Manufacturer | options |
Retail Price | number |
Wholesale price | number |
Specific Prices | COLLECTION |
Specific.prices.Currency | options |
Specific.prices.Country | options |
Specific.prices.Group | options |
Specific.prices.Impact on price | number |
Specific.prices.Starting at (units) | number |
Specific.prices.Reduction | number |
Specific.prices.Reduction type | options |
Specific.prices.Tax Included | bool |
Specific.prices.From date | date |
Specific.prices.End date | date/ |
Additional Shipping fees | number |
Customizable | bool |
Enabled | bool |
Available for order | bool |
Available date | date |
Condition | options |
Show price | bool |
Visible | options |
Date Added | date |
Date Updated | date |
Meta description | text |
Meta title | text |
Friendly URL | text |
Name | text |
Description | text |
Short Description | text |
Displayed text when in-stock | text |
Displayed text when backordering is allowed | text |
Categories | hierarchy |
Images | COLLECTION |
Images.Image | image |
Images.Position | number |
Gallery images | COLLECTION |
Gallery.images.image | image |
Gallery.images.position | number |
Tags | COLLECTION |
Tags.name | text |
Product Attributes | COLLECTION |
Product.Attributes.Value | text |
Product.Attributes.Name | options |
Size (Attribute) | options |
Color (Attribute) | options |
Dimension (Attribute) | options |
Paper Type (Attribute) | options |
Product Features | COLLECTION |
Product.Features.Value | text |
Product.Features.Name | options |
Composition (Feature) | options |
Property (Feature) | options |
Delivery time of in-stock products | text |
Delivery time of out-of-stock | text |
3.2 Order
3.2.1 Source Configuration
Import behavior
Choose which orders you want to import (filters will still apply).
You can choose between the following options:
- Import all orders
- Import only new orders (created since the last task run)
- Import only orders where the Order Status has changed (changed since the last task run)
Choose Language
You can choose between the following options:
- English
- Deutsch (German)
3.2.2 Filtering
Order ID | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Currency | Is not set, Is set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
Carrier | Is not set, Is set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
Order status | Is not set, Is set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
Invoice date | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Delivery date | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Valid order | Is not set, Is set, Equals, Not Equals |
Recyclable | Is not set, Is set, Equals, Not Equals |
Gift | Is not set, Is set, Equals, Not Equals |
Total discounts | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total discounts (tax included) | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total discounts (tax excluded | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total (tax included) | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total (tax excluded) | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total paid | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total products | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total products with tax | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total shipping | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total shipping (tax included) | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total shipping (tax excluded) | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total wrapping | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total wrapping (tax included) | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Total wrapping (tax excluded) | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
Internal order reference | Is not set, Is set, Equals, Not Equals, Contains, Not Contain, Not in a Sequence, In a Sequence |
Date created | Is not set, Is set, Greater Than, Less Than, Equals, Not Equals, In a Sequence, Not In a Sequence, Between |
3.2.3 Mapping
Constant Value | const |
Order ID | number |
Shipping address | COMPLEX |
Shipping.address.First name | text |