PrestaShop

• Introduction
  • Example of Operation
  • Data Schema
• Configuration
  • Before you start
  • Start creating the module
  • Initial settings
  • Authorization with PrestaShop
  • Setting up the module in the schedule

Introduction

The PrestaShop module allows for automatic data collection from your store.

Example of Operation

1. Configure the module in the platform by granting access to your PrestaShop store.
2. Set up the module on a schedule - data will be collected and stored in the WitCloud dataset.
3. After the table is processed, you can use other reporting modules that are integrated with it.

Data Schema

We gather the most important information from PrestaShop into several tables. Below are the table names and schemas:

1. prestashop_addresses

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
id_customer	NULLABLE	STRING
id_manufacturer	NULLABLE	STRING
id_supplier	NULLABLE	STRING
id_warehouse	NULLABLE	STRING
id_country	NULLABLE	STRING
id_state	NULLABLE	STRING
alias	NULLABLE	STRING
company	NULLABLE	STRING
lastname	NULLABLE	STRING
firstname	NULLABLE	STRING
vat_number	NULLABLE	STRING
address1	NULLABLE	STRING
address2	NULLABLE	STRING
postcode	NULLABLE	STRING
city	NULLABLE	STRING
other	NULLABLE	STRING
phone	NULLABLE	STRING
phone_mobile	NULLABLE	STRING
dni	NULLABLE	STRING
deleted	NULLABLE	BOOLEAN
date_add	NULLABLE	DATETIME
date_upd	NULLABLE	DATETIME

2. prestashop_categories

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
id_parent	NULLABLE	STRING
active	NULLABLE	BOOLEAN
id_shop_default	NULLABLE	STRING
is_root_category	NULLABLE	BOOLEAN
position	NULLABLE	STRING
date_add	NULLABLE	DATETIME
date_upd	NULLABLE	DATETIME
name	REPEATED	RECORD
link_rewrite	REPEATED	RECORD
description	REPEATED	RECORD
meta_title	REPEATED	RECORD
meta_description	REPEATED	RECORD
meta_keywords	REPEATED	RECORD
associations	NULLABLE	RECORD
name.id	NULLABLE	STRING
name.value	NULLABLE	STRING
link_rewrite.id	NULLABLE	STRING
link_rewrite.value	NULLABLE	STRING
description.id	NULLABLE	STRING
description.value	NULLABLE	STRING
meta_title.id	NULLABLE	STRING
meta_title.value	NULLABLE	STRING
meta_description.id	NULLABLE	STRING
meta_description.value	NULLABLE	STRING
meta_keywords.id	NULLABLE	STRING
meta_keywords.value	NULLABLE	STRING
associations.categories	REPEATED	RECORD
associations.categories.id	NULLABLE	STRING
associations.products	REPEATED	RECORD
associations.products.id	NULLABLE	STRING

3. prestashop_combinations

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
id_product	NULLABLE	STRING
location	NULLABLE	STRING
ean13	NULLABLE	STRING
isbn	NULLABLE	STRING
upc	NULLABLE	STRING
mpn	NULLABLE	STRING
quantity	NULLABLE	INTEGER
reference	NULLABLE	STRING
supplier_reference	NULLABLE	STRING
wholesale_price	NULLABLE	FLOAT
price	NULLABLE	FLOAT
ecotax	NULLABLE	FLOAT
weight	NULLABLE	FLOAT
unit_price_impact	NULLABLE	FLOAT
minimal_quantity	NULLABLE	INTEGER
low_stock_threshold	NULLABLE	INTEGER
low_stock_alert	NULLABLE	BOOLEAN
default_on	NULLABLE	BOOLEAN
available_date	NULLABLE	STRING
associations	NULLABLE	RECORD
associations.product_option_values	REPEATED	RECORD
associations.product_option_values.id	NULLABLE	STRING
associations.images	REPEATED	RECORD
associations.images.id	NULLABLE	STRING

4. prestashop_currencies

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
names	REPEATED	RECORD
name	NULLABLE	STRING
symbol	REPEATED	RECORD
iso_code	NULLABLE	STRING
numeric_iso_code	NULLABLE	STRING
precision	NULLABLE	FLOAT
conversion_rate	NULLABLE	FLOAT
deleted	NULLABLE	BOOLEAN
active	NULLABLE	BOOLEAN
unofficial	NULLABLE	STRING
modified	NULLABLE	BOOLEAN
pattern	REPEATED	RECORD
names.id	NULLABLE	STRING
names.value	NULLABLE	STRING
symbol.id	NULLABLE	STRING
symbol.value	NULLABLE	STRING
pattern.id	NULLABLE	STRING
pattern.value	NULLABLE	STRING

5. prestashop_manufacturers

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	INTEGER
active	NULLABLE	BOOLEAN
link_rewrite	NULLABLE	STRING
name	NULLABLE	STRING
date_add	NULLABLE	DATETIME
date_upd	NULLABLE	DATETIME
description	REPEATED	RECORD
short_description	REPEATED	RECORD
meta_title	REPEATED	RECORD
meta_description	REPEATED	RECORD
meta_keywords	REPEATED	RECORD
description.id	NULLABLE	STRING
description.value	NULLABLE	STRING
short_description.id	NULLABLE	STRING
short_description.value	NULLABLE	STRING
meta_title.id	NULLABLE	STRING
meta_title.value	NULLABLE	STRING
meta_description.id	NULLABLE	STRING
meta_description.value	NULLABLE	STRING
meta_keywords.id	NULLABLE	STRING
meta_keywords.value	NULLABLE	STRING

6. prestashop_order_states

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
unremovable	NULLABLE	STRING
delivery	NULLABLE	STRING
hidden	NULLABLE	BOOLEAN
send_email	NULLABLE	BOOLEAN
module_name	NULLABLE	STRING
invoice	NULLABLE	BOOLEAN
color	NULLABLE	STRING
logable	NULLABLE	BOOLEAN
shipped	NULLABLE	BOOLEAN
paid	NULLABLE	BOOLEAN
pdf_delivery	NULLABLE	BOOLEAN
pdf_invoice	NULLABLE	BOOLEAN
deleted	NULLABLE	BOOLEAN
name	REPEATED	RECORD
template	REPEATED	RECORD
name.id	NULLABLE	STRING
name.value	NULLABLE	STRING
template.id	NULLABLE	STRING
template.value	NULLABLE	STRING

7. prestashop_orders

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
id_address_delivery	NULLABLE	STRING
id_address_invoice	NULLABLE	STRING
id_cart	NULLABLE	STRING
id_currency	NULLABLE	STRING
id_lang	NULLABLE	STRING
id_customer	NULLABLE	STRING
id_carrier	NULLABLE	STRING
current_state	NULLABLE	STRING
module	NULLABLE	STRING
invoice_number	NULLABLE	STRING
invoice_date	NULLABLE	STRING
delivery_number	NULLABLE	STRING
delivery_date	NULLABLE	STRING
valid	NULLABLE	BOOLEAN
date_add	NULLABLE	DATETIME
date_upd	NULLABLE	DATETIME
shipping_number	NULLABLE	STRING
note	NULLABLE	STRING
id_shop_group	NULLABLE	STRING
id_shop	NULLABLE	STRING
secure_key	NULLABLE	STRING
payment	NULLABLE	STRING
recyclable	NULLABLE	BOOLEAN
gift	NULLABLE	BOOLEAN
gift_message	NULLABLE	STRING
mobile_theme	NULLABLE	BOOLEAN
total_discounts	NULLABLE	FLOAT
total_discounts_tax_incl	NULLABLE	FLOAT
total_discounts_tax_excl	NULLABLE	FLOAT
total_paid	NULLABLE	FLOAT
total_paid_tax_incl	NULLABLE	FLOAT
total_paid_tax_excl	NULLABLE	FLOAT
total_paid_real	NULLABLE	FLOAT
total_products	NULLABLE	FLOAT
total_products_wt	NULLABLE	FLOAT
total_shipping	NULLABLE	FLOAT
total_shipping_tax_incl	NULLABLE	FLOAT
total_shipping_tax_excl	NULLABLE	FLOAT
carrier_tax_rate	NULLABLE	FLOAT
total_wrapping	NULLABLE	FLOAT
total_wrapping_tax_incl	NULLABLE	FLOAT
total_wrapping_tax_excl	NULLABLE	FLOAT
round_mode	NULLABLE	STRING
round_type	NULLABLE	STRING
conversion_rate	NULLABLE	FLOAT
reference	NULLABLE	STRING
associations	NULLABLE	RECORD
associations.order_rows	REPEATED	RECORD
associations.order_rows.id	NULLABLE	STRING
associations.order_rows.product_id	NULLABLE	STRING
associations.order_rows.product_attribute_id	NULLABLE	STRING
associations.order_rows.product_quantity	NULLABLE	STRING
associations.order_rows.product_name	NULLABLE	STRING
associations.order_rows.product_reference	NULLABLE	STRING
associations.order_rows.product_ean13	NULLABLE	STRING
associations.order_rows.product_isbn	NULLABLE	STRING
associations.order_rows.product_upc	NULLABLE	STRING
associations.order_rows.product_price	NULLABLE	STRING
associations.order_rows.id_customization	NULLABLE	STRING
associations.order_rows.unit_price_tax_incl	NULLABLE	STRING
associations.order_rows.unit_price_tax_excl	NULLABLE	STRING

8. prestashop_product_option_values

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
id_attribute_group	NULLABLE	STRING
color	NULLABLE	STRING
position	NULLABLE	STRING
name	REPEATED	RECORD
name.id	NULLABLE	STRING
name.value	NULLABLE	STRING

9. prestashop_product_options

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
is_color_group	NULLABLE	BOOLEAN
group_type	NULLABLE	STRING
position	NULLABLE	STRING
name	REPEATED	RECORD
public_name	REPEATED	RECORD
associations	NULLABLE	RECORD
name.id	NULLABLE	STRING
name.value	NULLABLE	STRING
public_name.id	NULLABLE	STRING
public_name.value	NULLABLE	STRING
associations.product_option_values	REPEATED	RECORD
associations.product_option_values.id	NULLABLE	STRING

10. prestashop_products

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
id_manufacturer	NULLABLE	STRING
id_supplier	NULLABLE	STRING
id_category_default	NULLABLE	STRING
new	NULLABLE	STRING
cache_default_attribute	NULLABLE	STRING
id_default_image	NULLABLE	STRING
id_default_combination	NULLABLE	STRING
id_tax_rules_group	NULLABLE	STRING
position_in_category	NULLABLE	STRING
type	NULLABLE	STRING
id_shop_default	NULLABLE	STRING
reference	NULLABLE	STRING
supplier_reference	NULLABLE	STRING
location	NULLABLE	STRING
width	NULLABLE	FLOAT
height	NULLABLE	FLOAT
depth	NULLABLE	FLOAT
weight	NULLABLE	FLOAT
quantity_discount	NULLABLE	BOOLEAN
ean13	NULLABLE	STRING
isbn	NULLABLE	STRING
upc	NULLABLE	STRING
mpn	NULLABLE	STRING
cache_is_pack	NULLABLE	BOOLEAN
cache_has_attachments	NULLABLE	BOOLEAN
is_virtual	NULLABLE	BOOLEAN
state	NULLABLE	STRING
additional_delivery_times	NULLABLE	STRING
delivery_in_stock	REPEATED	RECORD
delivery_out_stock	REPEATED	RECORD
product_type	NULLABLE	STRING
on_sale	NULLABLE	BOOLEAN
online_only	NULLABLE	BOOLEAN
ecotax	NULLABLE	FLOAT
minimal_quantity	NULLABLE	INTEGER
low_stock_threshold	NULLABLE	STRING
low_stock_alert	NULLABLE	BOOLEAN
price	NULLABLE	FLOAT
wholesale_price	NULLABLE	FLOAT
unity	NULLABLE	STRING
unit_price_ratio	NULLABLE	STRING
additional_shipping_cost	NULLABLE	FLOAT
customizable	NULLABLE	STRING
text_fields	NULLABLE	STRING
uploadable_files	NULLABLE	STRING
active	NULLABLE	BOOLEAN
redirect_type	NULLABLE	STRING
id_type_redirected	NULLABLE	STRING
available_for_order	NULLABLE	STRING
available_date	NULLABLE	STRING
show_condition	NULLABLE	BOOLEAN
condition	NULLABLE	STRING
show_price	NULLABLE	BOOLEAN
indexed	NULLABLE	BOOLEAN
visibility	NULLABLE	STRING
advanced_stock_management	NULLABLE	BOOLEAN
date_add	NULLABLE	DATETIME
date_upd	NULLABLE	DATETIME
pack_stock_type	NULLABLE	STRING
meta_description	REPEATED	RECORD
meta_keywords	REPEATED	RECORD
meta_title	REPEATED	RECORD
link_rewrite	REPEATED	RECORD
name	REPEATED	RECORD
description	REPEATED	RECORD
description_short	REPEATED	RECORD
available_now	REPEATED	RECORD
available_later	REPEATED	RECORD
associations	NULLABLE	RECORD
delivery_in_stock.id	NULLABLE	STRING
delivery_in_stock.value	NULLABLE	STRING
delivery_out_stock.id	NULLABLE	STRING
delivery_out_stock.value	NULLABLE	STRING
meta_description.id	NULLABLE	STRING
meta_description.value	NULLABLE	STRING
meta_keywords.id	NULLABLE	STRING
meta_keywords.value	NULLABLE	STRING
meta_title.id	NULLABLE	STRING
meta_title.value	NULLABLE	STRING
link_rewrite.id	NULLABLE	STRING
link_rewrite.value	NULLABLE	STRING
name.id	NULLABLE	STRING
name.value	NULLABLE	STRING
description.id	NULLABLE	STRING
description.value	NULLABLE	STRING
description_short.id	NULLABLE	STRING
description_short.value	NULLABLE	STRING
available_now.id	NULLABLE	STRING
available_now.value	NULLABLE	STRING
available_later.id	NULLABLE	STRING
available_later.value	NULLABLE	STRING
associations.categories	REPEATED	RECORD
associations.categories.id	NULLABLE	STRING
associations.images	REPEATED	RECORD
associations.images.id	NULLABLE	STRING
associations.combinations	REPEATED	RECORD
associations.combinations.id	NULLABLE	STRING
associations.product_option_values	REPEATED	RECORD
associations.product_option_values.id	NULLABLE	STRING
associations.product_features	REPEATED	RECORD
associations.product_features.id	NULLABLE	STRING
associations.product_features.id_feature_value	NULLABLE	STRING
associations.tags	REPEATED	RECORD
associations.tags.id	NULLABLE	STRING
associations.stock_availables	REPEATED	RECORD
associations.stock_availables.id	NULLABLE	STRING
associations.stock_availables.id_product_attribute	NULLABLE	STRING
associations.attachments	REPEATED	RECORD
associations.attachments.id	NULLABLE	STRING
associations.accessories	REPEATED	RECORD
associations.accessories.id	NULLABLE	STRING
associations.product_bundle	REPEATED	RECORD
associations.product_bundle.id	NULLABLE	STRING
associations.product_bundle.id_product_attribute	NULLABLE	STRING
associations.product_bundle.quantity	NULLABLE	INTEGER

11. prestashop_shop_urls

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
id_shop	NULLABLE	STRING
active	NULLABLE	BOOLEAN
main	NULLABLE	BOOLEAN
domain	NULLABLE	STRING
domain_ssl	NULLABLE	STRING
physical_uri	NULLABLE	STRING
virtual_uri	NULLABLE	STRING

12. prestashop_stocks

Expand to view the data schema.

fullname	mode	type	description
id	NULLABLE	STRING
id_warehouse	NULLABLE	STRING
id_product	NULLABLE	STRING
id_product_attribute	NULLABLE	STRING
reference	NULLABLE	STRING
ean13	NULLABLE	STRING
isbn	NULLABLE	STRING
upc	NULLABLE	STRING
mpn	NULLABLE	STRING
physical_quantity	NULLABLE	INTEGER
usable_quantity	NULLABLE	INTEGER
price_te	NULLABLE	FLOAT

Configuration

Before you start

TIP

To create the module, you will need your store's domain and an API token generated in the PrestaShop panel. Instructions for generating the token can be found here: Link to the instructions (opens new window)

Start creating the module

From the menu on the left side, select the Collect tab, then click the Add new data collect button.

From the list of available modules, select PrestaShop

Initial settings

In the first step, you need to fill in two fields.

Collect name - the name of your module. It will be visible under this name in other places on the platform.

Shop url - the URL of your store.

Authorization with PrestaShop

In the next step, we need to grant WitCloud access to your PrestaShop store. This is necessary for WitCloud to retrieve data.

To do this, click the Click here to authorize button.

Fill out the form with your PrestaShop login details.

After successful authorization, select your account from the list and click the Next button.

Setting up the module in the schedule

Your PrestaShop module has been created in WitCloud 📊. The final step is to determine the historical data range you need to retrieve. The schedule for fetching current data will be created automatically.

Enter the appropriate range and click the Finish button.