Shoplo

• Introduction
  • An example of operation
  • Data schema
• Configuration
  • Before you start
  • Start creating the module
  • Initial settings
  • Authorization with Shoplo
  • Setting the module in the schedule

Introduction

The shoplo module allows you to automatically collect your store's data.

An example of operation

1. We configure the module in the platform by granting access to the Shoplo store
2. We set the module on the schedule - the data will be collected and stored in witcloud dataset
3. After the table is processed, you can use other reporting modules or combine it with analytics

Data schema

Two tables appear in your dataset:

1. shoplo_orders

Expand for the data schema

Field name	Type	Mode
created_at	TIMESTAMP	NULLABLE
delivery_name	STRING	NULLABLE
delivery_price	FLOAT	NULLABLE
discount_code	STRING	NULLABLE
discount_on_value	STRING	NULLABLE
discount_type	STRING	NULLABLE
discount_value	FLOAT	NULLABLE
discount_apply_once	BOOLEAN	NULLABLE
id	STRING	NULLABLE
uuid	STRING	NULLABLE
landing_site	STRING	NULLABLE
order_date	TIMESTAMP	NULLABLE
order_number	STRING	NULLABLE
order_status	STRING	NULLABLE
payment	STRING	NULLABLE
payment_date	TIMESTAMP	NULLABLE
payment_name	STRING	NULLABLE
payment_status	STRING	NULLABLE
fulfillment_status	STRING	NULLABLE
price	FLOAT	NULLABLE
price_after_discount	FLOAT	NULLABLE
cancelled_at	TIMESTAMP	NULLABLE
cancel_reason	STRING	NULLABLE
referring_site	STRING	NULLABLE
require_shipping	BOOLEAN	NULLABLE
notes	STRING	NULLABLE
updated_at	TIMESTAMP	NULLABLE
user_agent	STRING	NULLABLE
user_key	STRING	NULLABLE
weight	FLOAT	NULLABLE
status	STRING	NULLABLE
shipping_id	STRING	NULLABLE
shipping_address	RECORD	NULLABLE
shipping_address.company	STRING	NULLABLE
shipping_address.phone	STRING	NULLABLE
shipping_address.zip_code	STRING	NULLABLE
shipping_address.city	STRING	NULLABLE
shipping_address.region	STRING	NULLABLE
shipping_address.country	STRING	NULLABLE
shipping_address.country_code	STRING	NULLABLE
shipping_address.latitude	FLOAT	NULLABLE
shipping_address.longitude	FLOAT	NULLABLE
billing_address	RECORD	NULLABLE
billing_address.phone	STRING	NULLABLE
billing_address.zip_code	STRING	NULLABLE
billing_address.city	STRING	NULLABLE
billing_address.region	STRING	NULLABLE
billing_address.country	STRING	NULLABLE
billing_address.country_code	STRING	NULLABLE
billing_address.tax_id	STRING	NULLABLE
billing_address.latitude	FLOAT	NULLABLE
billing_address.longitude	FLOAT	NULLABLE
fulfillments	RECORD	NULLABLE
fulfillments.id	STRING	NULLABLE
fulfillments.order_id	STRING	NULLABLE
fulfillments.status	STRING	NULLABLE
fulfillments.tracking_company	STRING	NULLABLE
fulfillments.tracking_number	STRING	NULLABLE
fulfillments.tracking_url	STRING	NULLABLE
fulfillments.inpost_machine	STRING	NULLABLE
fulfillments.cac_point	STRING	NULLABLE
fulfillments.created_at	TIMESTAMP	NULLABLE
fulfillments.updated_at	TIMESTAMP	NULLABLE
order_items	RECORD	REPEATED
order_items.id	STRING	NULLABLE
order_items.uuid	STRING	NULLABLE
order_items.name	STRING	NULLABLE
order_items.price	FLOAT	NULLABLE
order_items.product_id	STRING	NULLABLE
order_items.promotion	RECORD	REPEATED
order_items.promotion.title	STRING	NULLABLE
order_items.promotion.amount	FLOAT	NULLABLE
order_items.promotion.type	STRING	NULLABLE
order_items.properties	RECORD	REPEATED
order_items.properties.type	STRING	NULLABLE
order_items.properties.value	STRING	NULLABLE
order_items.quantity	INTEGER	NULLABLE
order_items.require_shipping	BOOLEAN	NULLABLE
order_items.sku	STRING	NULLABLE
order_items.barcode	STRING	NULLABLE
order_items.tax	FLOAT	NULLABLE
order_items.tax_type	STRING	NULLABLE
order_items.title	STRING	NULLABLE
order_items.variant_id	STRING	NULLABLE
order_items.weight	FLOAT	NULLABLE
customer	RECORD	NULLABLE
customer.id	STRING	NULLABLE
customer.uuid	STRING	NULLABLE
customer.email	STRING	NULLABLE
customer.orders_count	INTEGER	NULLABLE
customer.orders_price_sum	FLOAT	NULLABLE
customer.accept_newsletter	BOOLEAN	NULLABLE
customer.created_at	TIMESTAMP	NULLABLE
customer.updated_at	TIMESTAMP	NULLABLE

2. shoplo_products

Expand for the data schema

Field name	Type	Mode
id	STRING	NULLABLE
uuid	STRING	NULLABLE
name	STRING	NULLABLE
url	STRING	NULLABLE
description	STRING	NULLABLE
short_description	STRING	NULLABLE
require_shipping	BOOLEAN	NULLABLE
availability	BOOLEAN	NULLABLE
tax	FLOAT	NULLABLE
tax_type	STRING	NULLABLE
price_min	FLOAT	NULLABLE
price_max	FLOAT	NULLABLE
buy_if_empty	BOOLEAN	NULLABLE
promotion_id	STRING	NULLABLE
width	FLOAT	NULLABLE
height	FLOAT	NULLABLE
depth	FLOAT	NULLABLE
diameter	FLOAT	NULLABLE
thumbnail	STRING	NULLABLE
created_at	TIMESTAMP	NULLABLE
updated_at	TIMESTAMP	NULLABLE
images	RECORD	REPEATED
images.id	INTEGER	NULLABLE
images.uuid	STRING	NULLABLE
images.position	INTEGER	NULLABLE
images.product_id	INTEGER	NULLABLE
images.created_at	TIMESTAMP	NULLABLE
images.updated_at	TIMESTAMP	NULLABLE
images.ext	STRING	NULLABLE
images.title	STRING	NULLABLE
images.src	STRING	NULLABLE
vendor	STRING	NULLABLE
metadata	RECORD	NULLABLE
metadata.meta_title	STRING	NULLABLE
metadata.meta_description	STRING	NULLABLE
metadata.meta_keywords	STRING	NULLABLE
variants	RECORD	REPEATED
variants.id	STRING	NULLABLE
variants.uuid	STRING	NULLABLE
variants.product_id	STRING	NULLABLE
variants.sku	STRING	NULLABLE
variants.property_name_1	STRING	NULLABLE
variants.property_name_2	STRING	NULLABLE
variants.property_name_3	STRING	NULLABLE
variants.price	FLOAT	NULLABLE
variants.price_regular	FLOAT	NULLABLE
variants.quantity	INTEGER	NULLABLE
variants.weight	FLOAT	NULLABLE
variants.add_to_magazine	BOOLEAN	NULLABLE
variants.magazine_group	STRING	NULLABLE
variants.buy_if_empty	BOOLEAN	NULLABLE
variants.thumbnail	STRING	NULLABLE
variants.availability	BOOLEAN	NULLABLE
variants.availability_description	STRING	NULLABLE
variants.availability_type	STRING	NULLABLE
variants.barcode	INTEGER	NULLABLE
variants.created_at	TIMESTAMP	NULLABLE
variants.updated_at	TIMESTAMP	NULLABLE
variants.title	STRING	NULLABLE
variants.position	INTEGER	NULLABLE
categories	RECORD	REPEATED
categories.id	STRING	NULLABLE
categories.uuid	STRING	NULLABLE
categories.parent	STRING	NULLABLE
categories.title	STRING	NULLABLE
categories.tree	STRING	NULLABLE

Configuration

Before you start

Make sure you have adequate access to the Shoplo store

Start creating the module

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

Select "Shoplo" from the list of available modules

Initial settings

In the first step, we only have one field to fill.

Collect name - the name of our module. It will be visible under this name elsewhere on the platform.

Authorization with Shoplo

In the next step, we need to grant WitCloud access to Shoplo. It is necessary for WitCloud to be able to download data.

To do this, press the "Authorize Shoplo" button

And fill out the Shoplo login form.

After proper authorization, select your account from the list and click 'Finish' button

Setting the module in the schedule

Your Shoplo 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)