# Shoper
# Introduction
The shoper module allows you to automatically collect your store's data.
# An example of operation
- We configure the module in the platform by granting access to the Shoper store
- We set the module on the schedule - the data will be collected and stored in witcloud dataset
- After the table is processed, you can use other reporting modules or combine it with analytics
# Data schema
We collect the most important information from the Shoper to 6 different tables:
- shoper_orders
Expand for the data schema
Field name | Type | Mode |
---|---|---|
order_id | STRING | NULLABLE |
user_id | STRING | NULLABLE |
date | TIMESTAMP | NULLABLE |
status_date | TIMESTAMP | NULLABLE |
confirm_date | TIMESTAMP | NULLABLE |
delivery_date | TIMESTAMP | NULLABLE |
status_id | STRING | NULLABLE |
sum | FLOAT | NULLABLE |
payment_id | STRING | NULLABLE |
user_order | BOOLEAN | NULLABLE |
shipping_id | STRING | NULLABLE |
shipping_cost | FLOAT | NULLABLE |
STRING | NULLABLE | |
code | STRING | NULLABLE |
confirm | BOOLEAN | NULLABLE |
notes | STRING | NULLABLE |
notes_priv | STRING | NULLABLE |
notes_pub | STRING | NULLABLE |
currency_id | STRING | NULLABLE |
currency_rate | FLOAT | NULLABLE |
paid | FLOAT | NULLABLE |
discount_client | FLOAT | NULLABLE |
discount_group | FLOAT | NULLABLE |
discount_levels | FLOAT | NULLABLE |
discount_code | FLOAT | NULLABLE |
code_id | STRING | NULLABLE |
lang_id | STRING | NULLABLE |
origin | STRING | NULLABLE |
registered | BOOLEAN | NULLABLE |
promo_code | STRING | NULLABLE |
is_paid | BOOLEAN | NULLABLE |
is_overpayment | BOOLEAN | NULLABLE |
is_underpayment | BOOLEAN | NULLABLE |
total_parcels | INTEGER | NULLABLE |
total_products | INTEGER | NULLABLE |
loyalty_cost | INTEGER | NULLABLE |
loyalty_score | INTEGER | NULLABLE |
shipping_tax_name | STRING | NULLABLE |
shipping_tax_value | FLOAT | NULLABLE |
shipping_tax_id | STRING | NULLABLE |
delivery_address | RECORD | NULLABLE |
delivery_address. address_id | STRING | NULLABLE |
delivery_address. order_id | STRING | NULLABLE |
delivery_address. type | STRING | NULLABLE |
delivery_address. city | STRING | NULLABLE |
delivery_address. postcode | STRING | NULLABLE |
delivery_address. state | STRING | NULLABLE |
delivery_address. country | STRING | NULLABLE |
delivery_address. phone | STRING | NULLABLE |
delivery_address. country_code | STRING | NULLABLE |
billing_address | RECORD | NULLABLE |
billing_address. address_id | STRING | NULLABLE |
billing_address. order_id | STRING | NULLABLE |
billing_address. type | STRING | NULLABLE |
billing_address. city | STRING | NULLABLE |
billing_address. postcode | STRING | NULLABLE |
billing_address. state | STRING | NULLABLE |
billing_address. country | STRING | NULLABLE |
billing_address. phone | STRING | NULLABLE |
billing_address. country_code | STRING | NULLABLE |
- shoper_order_products
Expand for the data schema
Field name | Type | Mode |
---|---|---|
id | STRING | NULLABLE |
order_id | STRING | NULLABLE |
product_id | STRING | NULLABLE |
type | STRING | NULLABLE |
stock_id | STRING | NULLABLE |
price | FLOAT | NULLABLE |
discount_perc | FLOAT | NULLABLE |
quantity | INTEGER | NULLABLE |
delivery_time | INTEGER | NULLABLE |
name | STRING | NULLABLE |
code | STRING | NULLABLE |
pkwiu | STRING | NULLABLE |
tax | STRING | NULLABLE |
tax_value | FLOAT | NULLABLE |
unit | STRING | NULLABLE |
option | STRING | NULLABLE |
unit_fp | BOOLEAN | NULLABLE |
weight | FLOAT | NULLABLE |
loyalty | RECORD | NULLABLE |
loyalty. exchanged | BOOLEAN | NULLABLE |
loyalty. score | INTEGER | NULLABLE |
loyalty. ratio | STRING | NULLABLE |
delivery_time_hours | FLOAT | NULLABLE |
children | RECORD | REPEATED |
children. id | STRING | NULLABLE |
children. order_id | STRING | NULLABLE |
children. stock_id | STRING | NULLABLE |
children. price | FLOAT | NULLABLE |
children. discount_perc | FLOAT | NULLABLE |
children. quantity | INTEGER | NULLABLE |
children. delivery_time | INTEGER | NULLABLE |
children. name | STRING | NULLABLE |
children. code | STRING | NULLABLE |
children. pkwiu | STRING | NULLABLE |
children. tax | STRING | NULLABLE |
children. tax_value | FLOAT | NULLABLE |
children. unit | STRING | NULLABLE |
children. option | STRING | NULLABLE |
children. unit_fp | BOOLEAN | NULLABLE |
children. weight | FLOAT | NULLABLE |
- shoper_producers
Expand for the data schema
Field name | Type | Mode |
---|---|---|
producer_id | STRING | NULLABLE |
name | STRING | NULLABLE |
web | STRING | NULLABLE |
gfx | STRING | NULLABLE |
isdefault | BOOLEAN | NULLABLE |
translations | RECORD | REPEATED |
translations. language | STRING | NULLABLE |
translations. translation_id | STRING | NULLABLE |
translations. producer_id | STRING | NULLABLE |
translations. lang_id | STRING | NULLABLE |
translations. name | STRING | NULLABLE |
translations. description | STRING | NULLABLE |
translations. seo_title | STRING | NULLABLE |
translations. seo_description | STRING | NULLABLE |
translations. seo_keywords | STRING | NULLABLE |
translations. seo_url | STRING | NULLABLE |
- shoper_products
Expand for the data schema
Field name | Type | Mode |
---|---|---|
product_id | STRING | NULLABLE |
type | STRING | NULLABLE |
producer_id | STRING | NULLABLE |
group_id | STRING | NULLABLE |
tax_id | STRING | NULLABLE |
category_id | STRING | NULLABLE |
unit_id | STRING | NULLABLE |
add_date | TIMESTAMP | NULLABLE |
edit_date | TIMESTAMP | NULLABLE |
other_price | FLOAT | NULLABLE |
promo_price | FLOAT | NULLABLE |
code | STRING | NULLABLE |
dimension_w | FLOAT | NULLABLE |
dimension_h | FLOAT | NULLABLE |
dimension_l | FLOAT | NULLABLE |
ean | STRING | NULLABLE |
pkwiu | STRING | NULLABLE |
is_product_of_day | BOOLEAN | NULLABLE |
loyalty_score | INTEGER | NULLABLE |
loyalty_price | INTEGER | NULLABLE |
in_loyalty | BOOLEAN | NULLABLE |
bestseller | BOOLEAN | NULLABLE |
newproduct | BOOLEAN | NULLABLE |
vol_weight | FLOAT | NULLABLE |
gauge_id | STRING | NULLABLE |
currency_id | STRING | NULLABLE |
additional_isbn | STRING | NULLABLE |
additional_kgo | STRING | NULLABLE |
additional_bloz7 | STRING | NULLABLE |
additional_bloz12 | STRING | NULLABLE |
additional_gtu | STRING | NULLABLE |
additional_producer | STRING | NULLABLE |
related | STRING | REPEATED |
options | STRING | REPEATED |
main_image | RECORD | NULLABLE |
main_image. gfx_id | STRING | NULLABLE |
main_image. order | INTEGER | NULLABLE |
main_image. name | STRING | NULLABLE |
main_image. unic_name | STRING | NULLABLE |
main_image. hidden | BOOLEAN | NULLABLE |
stock | RECORD | NULLABLE |
stock. stock_id | STRING | NULLABLE |
stock. product_id | STRING | NULLABLE |
stock. extended | BOOLEAN | NULLABLE |
stock. price | FLOAT | NULLABLE |
stock. active | BOOLEAN | NULLABLE |
stock. default | BOOLEAN | NULLABLE |
stock. stock | FLOAT | NULLABLE |
stock. warn_level | FLOAT | NULLABLE |
stock. sold | FLOAT | NULLABLE |
stock. code | STRING | NULLABLE |
stock. ean | STRING | NULLABLE |
stock. weight | FLOAT | NULLABLE |
stock. weight_type | STRING | NULLABLE |
stock. availability_id | STRING | NULLABLE |
stock. delivery_id | STRING | NULLABLE |
stock. gfx_id | STRING | NULLABLE |
stock. package | FLOAT | NULLABLE |
stock. price_wholesale | FLOAT | NULLABLE |
stock. price_special | FLOAT | NULLABLE |
stock. calculation_unit_id | STRING | NULLABLE |
stock. calculation_unit_ratio | FLOAT | NULLABLE |
categories | STRING | REPEATED |
special_offer | RECORD | NULLABLE |
special_offer. promo_id | STRING | NULLABLE |
special_offer. date_from | TIMESTAMP | NULLABLE |
special_offer. date_to | TIMESTAMP | NULLABLE |
special_offer. discount | FLOAT | NULLABLE |
special_offer. discount_wholesale | FLOAT | NULLABLE |
special_offer. discount_special | FLOAT | NULLABLE |
unit_price_calculation | BOOLEAN | NULLABLE |
children | RECORD | REPEATED |
children. id | STRING | NULLABLE |
children. bundle_id | STRING | NULLABLE |
children. stock_id | STRING | NULLABLE |
children. product_id | STRING | NULLABLE |
children. stock | FLOAT | NULLABLE |
children. order | INTEGER | NULLABLE |
translations | RECORD | REPEATED |
translations. language | STRING | NULLABLE |
translations. translation_id | STRING | NULLABLE |
translations. lang_id | STRING | NULLABLE |
translations. name | STRING | NULLABLE |
translations. description | STRING | NULLABLE |
translations. short_description | STRING | NULLABLE |
translations. active | BOOLEAN | NULLABLE |
translations. seo_title | STRING | NULLABLE |
translations. seo_description | STRING | NULLABLE |
translations. seo_keywords | STRING | NULLABLE |
translations. seo_url | STRING | NULLABLE |
translations. permalink | STRING | NULLABLE |
- shoper_stock
Expand for the data schema
Field name | Type | Mode |
---|---|---|
stock_id | STRING | NULLABLE |
product_id | STRING | NULLABLE |
extended | BOOLEAN | NULLABLE |
price | FLOAT | NULLABLE |
active | BOOLEAN | NULLABLE |
default | BOOLEAN | NULLABLE |
stock | FLOAT | NULLABLE |
warn_level | FLOAT | NULLABLE |
warehouses | RECORD | REPEATED |
warehouses. id | STRING | NULLABLE |
warehouses. stock | FLOAT | NULLABLE |
sold | FLOAT | NULLABLE |
code | STRING | NULLABLE |
ean | STRING | NULLABLE |
weight | FLOAT | NULLABLE |
weight_type | STRING | NULLABLE |
availability_id | STRING | NULLABLE |
delivery_id | STRING | NULLABLE |
gfx_id | STRING | NULLABLE |
package | FLOAT | NULLABLE |
price_wholesale | FLOAT | NULLABLE |
price_special | FLOAT | NULLABLE |
price_type_special | INTEGER | NULLABLE |
price_type_wholesale | INTEGER | NULLABLE |
price_buying | FLOAT | NULLABLE |
calculation_unit_id | STRING | NULLABLE |
calculation_unit_ratio | FLOAT | NULLABLE |
- shoper_categories
Expand for the data schema
Field name | Type | Mode |
---|---|---|
category_id | STRING | NULLABLE |
root | BOOLEAN | NULLABLE |
order | INTEGER | NULLABLE |
translations | RECORD | REPEATED |
translations. language | STRING | NULLABLE |
translations. trans_id | STRING | NULLABLE |
translations. category_id | STRING | NULLABLE |
translations. lang_id | STRING | NULLABLE |
translations. name | STRING | NULLABLE |
translations. description | STRING | NULLABLE |
translations. description_bottom | STRING | NULLABLE |
translations. seo_title | STRING | NULLABLE |
translations. seo_description | STRING | NULLABLE |
translations. seo_keywords | STRING | NULLABLE |
translations. seo_url | STRING | NULLABLE |
translations. permalink | STRING | NULLABLE |
translations. active | BOOLEAN | NULLABLE |
translations. isdefault | BOOLEAN | NULLABLE |
translations. items | INTEGER | NULLABLE |
# Configuration
# Before you start
Make sure you have adequate access to the Shoper store
You can find a description of this process here link (opens new window)
# Start creating the module
From the menu on the left, select the Collect tab, then click the Add new data Collect button.
Select Shoper from the list of available modules
# Initial settings
In the first step, we only have two fields to fill.
Collect name - the name of our module. It will be visible under this name elsewhere on the platform.
Shop url - shoper website url.
# Authorization with Shoper
In the next step, we need to grant WitCloud access to Shoper. It is necessary for WitCloud to be able to download data.
To do this, press the Click here to authorize button
And fill out the Shoper login form.
After proper authorization, select your account from the list and click Finish button
# Setting the module in the schedule
Your Shoper module is already created in WitCloud 📊. The last step is to establish a schedule and include our module in it. You can read about how to do it here link (opens new window)