WitCloud Docs

# Shopify

# Introduction

The Shopify 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 Shopify 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

After starting the module, two new tables will appear in the WitCloud dataset:

image alt text

  1. shopify_orders
Expand for the data schema
Field name Type Mode
id INTEGER NULLABLE
admin_graphql_api_id STRING NULLABLE
app_id INTEGER NULLABLE
browser_ip STRING NULLABLE
buyer_accepts_marketing BOOLEAN NULLABLE
cancel_reason STRING NULLABLE
cancelled_at STRING NULLABLE
cart_token STRING NULLABLE
checkout_id STRING NULLABLE
checkout_token STRING NULLABLE
closed_at STRING NULLABLE
confirmed BOOLEAN NULLABLE
contact_email STRING NULLABLE
created_at TIMESTAMP NULLABLE
currency STRING NULLABLE
current_subtotal_price STRING NULLABLE
current_subtotal_price_set RECORD NULLABLE
current_subtotal_price_set. shop_money RECORD NULLABLE
current_subtotal_price_set.shop_money. amount STRING NULLABLE
current_subtotal_price_set.shop_money. currency_code STRING NULLABLE
current_subtotal_price_set. presentment_money RECORD NULLABLE
current_subtotal_price_set.presentment_money. amount STRING NULLABLE
current_subtotal_price_set.presentment_money. currency_code STRING NULLABLE
current_total_discounts STRING NULLABLE
current_total_discounts_set RECORD NULLABLE
current_total_discounts_set. shop_money RECORD NULLABLE
current_total_discounts_set.shop_money. amount STRING NULLABLE
current_total_discounts_set.shop_money. currency_code STRING NULLABLE
current_total_discounts_set. presentment_money RECORD NULLABLE
current_total_discounts_set.presentment_money. amount STRING NULLABLE
current_total_discounts_set.presentment_money. currency_code STRING NULLABLE
current_total_duties_set STRING NULLABLE
current_total_price STRING NULLABLE
current_total_price_set RECORD NULLABLE
current_total_price_set. shop_money RECORD NULLABLE
current_total_price_set.shop_money. amount STRING NULLABLE
current_total_price_set.shop_money. currency_code STRING NULLABLE
current_total_price_set. presentment_money RECORD NULLABLE
current_total_price_set.presentment_money. amount STRING NULLABLE
current_total_price_set.presentment_money. currency_code STRING NULLABLE
current_total_tax STRING NULLABLE
current_total_tax_set RECORD NULLABLE
current_total_tax_set. shop_money RECORD NULLABLE
current_total_tax_set.shop_money. amount STRING NULLABLE
current_total_tax_set.shop_money. currency_code STRING NULLABLE
current_total_tax_set. presentment_money RECORD NULLABLE
current_total_tax_set.presentment_money. amount STRING NULLABLE
current_total_tax_set.presentment_money. currency_code STRING NULLABLE
customer_locale STRING NULLABLE
device_id STRING NULLABLE
email STRING NULLABLE
financial_status STRING NULLABLE
fulfillment_status STRING NULLABLE
gateway STRING NULLABLE
landing_site STRING NULLABLE
landing_site_ref STRING NULLABLE
location_id INTEGER NULLABLE
name STRING NULLABLE
note STRING NULLABLE
number INTEGER NULLABLE
order_number INTEGER NULLABLE
order_status_url STRING NULLABLE
original_total_duties_set STRING NULLABLE
payment_gateway_names STRING REPEATED
phone STRING NULLABLE
presentment_currency STRING NULLABLE
processed_at TIMESTAMP NULLABLE
processing_method STRING NULLABLE
reference STRING NULLABLE
referring_site STRING NULLABLE
source_identifier STRING NULLABLE
source_name STRING NULLABLE
source_url STRING NULLABLE
subtotal_price STRING NULLABLE
subtotal_price_set RECORD NULLABLE
subtotal_price_set. shop_money RECORD NULLABLE
subtotal_price_set.shop_money. amount STRING NULLABLE
subtotal_price_set.shop_money. currency_code STRING NULLABLE
subtotal_price_set. presentment_money RECORD NULLABLE
subtotal_price_set.presentment_money. amount STRING NULLABLE
subtotal_price_set.presentment_money. currency_code STRING NULLABLE
tags STRING NULLABLE
taxes_included BOOLEAN NULLABLE
test BOOLEAN NULLABLE
token STRING NULLABLE
total_discounts STRING NULLABLE
total_discounts_set RECORD NULLABLE
total_discounts_set. shop_money RECORD NULLABLE
total_discounts_set.shop_money. amount STRING NULLABLE
total_discounts_set.shop_money. currency_code STRING NULLABLE
total_discounts_set. presentment_money RECORD NULLABLE
total_discounts_set.presentment_money. amount STRING NULLABLE
total_discounts_set.presentment_money. currency_code STRING NULLABLE
total_line_items_price STRING NULLABLE
total_line_items_price_set RECORD NULLABLE
total_line_items_price_set. shop_money RECORD NULLABLE
total_line_items_price_set.shop_money. amount STRING NULLABLE
total_line_items_price_set.shop_money. currency_code STRING NULLABLE
total_line_items_price_set. presentment_money RECORD NULLABLE
total_line_items_price_set.presentment_money. amount STRING NULLABLE
total_line_items_price_set.presentment_money. currency_code STRING NULLABLE
total_outstanding STRING NULLABLE
total_price STRING NULLABLE
total_price_set RECORD NULLABLE
total_price_set. shop_money RECORD NULLABLE
total_price_set.shop_money. amount STRING NULLABLE
total_price_set.shop_money. currency_code STRING NULLABLE
total_price_set. presentment_money RECORD NULLABLE
total_price_set.presentment_money. amount STRING NULLABLE
total_price_set.presentment_money. currency_code STRING NULLABLE
total_price_usd STRING NULLABLE
total_shipping_price_set RECORD NULLABLE
total_shipping_price_set. shop_money RECORD NULLABLE
total_shipping_price_set.shop_money. amount STRING NULLABLE
total_shipping_price_set.shop_money. currency_code STRING NULLABLE
total_shipping_price_set. presentment_money RECORD NULLABLE
total_shipping_price_set.presentment_money. amount STRING NULLABLE
total_shipping_price_set.presentment_money. currency_code STRING NULLABLE
total_tax STRING NULLABLE
total_tax_set RECORD NULLABLE
total_tax_set. shop_money RECORD NULLABLE
total_tax_set.shop_money. amount STRING NULLABLE
total_tax_set.shop_money. currency_code STRING NULLABLE
total_tax_set. presentment_money RECORD NULLABLE
total_tax_set.presentment_money. amount STRING NULLABLE
total_tax_set.presentment_money. currency_code STRING NULLABLE
total_tip_received STRING NULLABLE
total_weight INTEGER NULLABLE
updated_at TIMESTAMP NULLABLE
user_id INTEGER NULLABLE
line_items RECORD REPEATED
line_items. id INTEGER NULLABLE
line_items. admin_graphql_api_id STRING NULLABLE
line_items. fulfillable_quantity INTEGER NULLABLE
line_items. fulfillment_service STRING NULLABLE
line_items. fulfillment_status STRING NULLABLE
line_items. gift_card BOOLEAN NULLABLE
line_items. grams INTEGER NULLABLE
line_items. name STRING NULLABLE
line_items. price STRING NULLABLE
line_items. price_set RECORD NULLABLE
line_items.price_set. shop_money RECORD NULLABLE
line_items.price_set.shop_money. amount STRING NULLABLE
line_items.price_set.shop_money. currency_code STRING NULLABLE
line_items.price_set. presentment_money RECORD NULLABLE
line_items.price_set.presentment_money. amount STRING NULLABLE
line_items.price_set.presentment_money. currency_code STRING NULLABLE
line_items. product_exists BOOLEAN NULLABLE
line_items. product_id INTEGER NULLABLE
line_items. quantity INTEGER NULLABLE
line_items. requires_shipping BOOLEAN NULLABLE
line_items. sku STRING NULLABLE
line_items. taxable BOOLEAN NULLABLE
line_items. title STRING NULLABLE
line_items. total_discount STRING NULLABLE
line_items. total_discount_set RECORD NULLABLE
line_items.total_discount_set. shop_money RECORD NULLABLE
line_items.total_discount_set.shop_money. amount STRING NULLABLE
line_items.total_discount_set.shop_money. currency_code STRING NULLABLE
line_items.total_discount_set. presentment_money RECORD NULLABLE
line_items.total_discount_set.presentment_money. amount STRING NULLABLE
line_items.total_discount_set.presentment_money. currency_code STRING NULLABLE
line_items. variant_id INTEGER NULLABLE
line_items. variant_inventory_management STRING NULLABLE
line_items. variant_title STRING NULLABLE
line_items. vendor STRING NULLABLE
refunds RECORD REPEATED
refunds. id INTEGER NULLABLE
refunds. admin_graphql_api_id STRING NULLABLE
refunds. created_at TIMESTAMP NULLABLE
refunds. note STRING NULLABLE
refunds. order_id INTEGER NULLABLE
refunds. processed_at TIMESTAMP NULLABLE
refunds. restock BOOLEAN NULLABLE
refunds. total_duties_set RECORD NULLABLE
refunds.total_duties_set. shop_money RECORD NULLABLE
refunds.total_duties_set.shop_money. amount STRING NULLABLE
refunds.total_duties_set.shop_money. currency_code STRING NULLABLE
refunds.total_duties_set. presentment_money RECORD NULLABLE
refunds.total_duties_set.presentment_money. amount STRING NULLABLE
refunds.total_duties_set.presentment_money. currency_code STRING NULLABLE
refunds. user_id INTEGER NULLABLE
refunds. transactions RECORD REPEATED
refunds.transactions. id INTEGER NULLABLE
refunds.transactions. admin_graphql_api_id STRING NULLABLE
refunds.transactions. amount STRING NULLABLE
refunds.transactions. authorization STRING NULLABLE
refunds.transactions. created_at TIMESTAMP NULLABLE
refunds.transactions. currency STRING NULLABLE
refunds.transactions. device_id STRING NULLABLE
refunds.transactions. error_code STRING NULLABLE
refunds.transactions. gateway STRING NULLABLE
refunds.transactions. kind STRING NULLABLE
refunds.transactions. location_id STRING NULLABLE
refunds.transactions. message STRING NULLABLE
refunds.transactions. order_id INTEGER NULLABLE
refunds.transactions. parent_id INTEGER NULLABLE
refunds.transactions. processed_at TIMESTAMP NULLABLE
refunds.transactions. source_name STRING NULLABLE
refunds.transactions. status STRING NULLABLE
refunds.transactions. test BOOLEAN NULLABLE
refunds.transactions. user_id INTEGER NULLABLE
refunds. refund_line_items RECORD REPEATED
refunds.refund_line_items. id INTEGER NULLABLE
refunds.refund_line_items. line_item_id INTEGER NULLABLE
refunds.refund_line_items. location_id INTEGER NULLABLE
refunds.refund_line_items. quantity INTEGER NULLABLE
refunds.refund_line_items. restock_type STRING NULLABLE
refunds.refund_line_items. subtotal INTEGER NULLABLE
refunds.refund_line_items. subtotal_set RECORD NULLABLE
refunds.refund_line_items.subtotal_set. shop_money RECORD NULLABLE
refunds.refund_line_items.subtotal_set.shop_money. amount STRING NULLABLE
refunds.refund_line_items.subtotal_set.shop_money. currency_code STRING NULLABLE
refunds.refund_line_items.subtotal_set. presentment_money RECORD NULLABLE
refunds.refund_line_items.subtotal_set.presentment_money. amount STRING NULLABLE
refunds.refund_line_items.subtotal_set.presentment_money. currency_code STRING NULLABLE
refunds.refund_line_items. total_tax INTEGER NULLABLE
refunds.refund_line_items. total_tax_set RECORD NULLABLE
refunds.refund_line_items.total_tax_set. shop_money RECORD NULLABLE
refunds.refund_line_items.total_tax_set.shop_money. amount STRING NULLABLE
refunds.refund_line_items.total_tax_set.shop_money. currency_code STRING NULLABLE
refunds.refund_line_items.total_tax_set. presentment_money RECORD NULLABLE
refunds.refund_line_items.total_tax_set.presentment_money. amount STRING NULLABLE
refunds.refund_line_items.total_tax_set.presentment_money. currency_code STRING NULLABLE
refunds.refund_line_items. line_item RECORD NULLABLE
refunds.refund_line_items.line_item. id INTEGER NULLABLE
refunds.refund_line_items.line_item. admin_graphql_api_id STRING NULLABLE
refunds.refund_line_items.line_item. fulfillable_quantity INTEGER NULLABLE
refunds.refund_line_items.line_item. fulfillment_service STRING NULLABLE
refunds.refund_line_items.line_item. fulfillment_status STRING NULLABLE
refunds.refund_line_items.line_item. gift_card BOOLEAN NULLABLE
refunds.refund_line_items.line_item. grams INTEGER NULLABLE
refunds.refund_line_items.line_item. name STRING NULLABLE
refunds.refund_line_items.line_item. price STRING NULLABLE
refunds.refund_line_items.line_item. price_set RECORD NULLABLE
refunds.refund_line_items.line_item.price_set. shop_money RECORD NULLABLE
refunds.refund_line_items.line_item.price_set.shop_money. amount STRING NULLABLE
refunds.refund_line_items.line_item.price_set.shop_money. currency_code STRING NULLABLE
refunds.refund_line_items.line_item.price_set. presentment_money RECORD NULLABLE
refunds.refund_line_items.line_item.price_set.presentment_money. amount STRING NULLABLE
refunds.refund_line_items.line_item.price_set.presentment_money. currency_code STRING NULLABLE
refunds.refund_line_items.line_item. product_exists BOOLEAN NULLABLE
refunds.refund_line_items.line_item. product_id INTEGER NULLABLE
refunds.refund_line_items.line_item. quantity INTEGER NULLABLE
refunds.refund_line_items.line_item. requires_shipping BOOLEAN NULLABLE
refunds.refund_line_items.line_item. sku STRING NULLABLE
refunds.refund_line_items.line_item. taxable BOOLEAN NULLABLE
refunds.refund_line_items.line_item. title STRING NULLABLE
refunds.refund_line_items.line_item. total_discount STRING NULLABLE
refunds.refund_line_items.line_item. total_discount_set RECORD NULLABLE
refunds.refund_line_items.line_item.total_discount_set. shop_money RECORD NULLABLE
refunds.refund_line_items.line_item.total_discount_set.shop_money. amount STRING NULLABLE
refunds.refund_line_items.line_item.total_discount_set.shop_money. currency_code STRING NULLABLE
refunds.refund_line_items.line_item.total_discount_set. presentment_money RECORD NULLABLE
refunds.refund_line_items.line_item.total_discount_set.presentment_money. amount STRING NULLABLE
refunds.refund_line_items.line_item.total_discount_set.presentment_money. currency_code STRING NULLABLE
refunds.refund_line_items.line_item. variant_id INTEGER NULLABLE
refunds.refund_line_items.line_item. variant_inventory_management STRING NULLABLE
refunds.refund_line_items.line_item. variant_title STRING NULLABLE
refunds.refund_line_items.line_item. vendor STRING NULLABLE
  1. shopify_products
Expand for the data schema
Field name Type Mode
id INTEGER NULLABLE
title STRING NULLABLE
body_html STRING NULLABLE
vendor STRING NULLABLE
product_type STRING NULLABLE
created_at TIMESTAMP NULLABLE
handle STRING NULLABLE
updated_at TIMESTAMP NULLABLE
published_at STRING NULLABLE
template_suffix STRING NULLABLE
status STRING NULLABLE
published_scope STRING NULLABLE
tags STRING NULLABLE
admin_graphql_api_id STRING NULLABLE
variants RECORD REPEATED
variants. id INTEGER NULLABLE
variants. product_id INTEGER NULLABLE
variants. title STRING NULLABLE
variants. price STRING NULLABLE
variants. sku STRING NULLABLE
variants. position INTEGER NULLABLE
variants. inventory_policy STRING NULLABLE
variants. compare_at_price STRING NULLABLE
variants. fulfillment_service STRING NULLABLE
variants. inventory_management STRING NULLABLE
variants. option1 STRING NULLABLE
variants. option2 STRING NULLABLE
variants. option3 STRING NULLABLE
variants. created_at TIMESTAMP NULLABLE
variants. updated_at TIMESTAMP NULLABLE
variants. taxable BOOLEAN NULLABLE
variants. barcode STRING NULLABLE
variants. grams INTEGER NULLABLE
variants. image_id STRING NULLABLE
variants. weight INTEGER NULLABLE
variants. weight_unit STRING NULLABLE
variants. inventory_item_id INTEGER NULLABLE
variants. inventory_quantity INTEGER NULLABLE
variants. old_inventory_quantity INTEGER NULLABLE
variants. requires_shipping BOOLEAN NULLABLE
variants. admin_graphql_api_id STRING NULLABLE
options RECORD REPEATED
options. id INTEGER NULLABLE
options. product_id INTEGER NULLABLE
options. name STRING NULLABLE
options. position INTEGER NULLABLE
options. values STRING REPEATED
image STRING NULLABLE

# Configuration

# Before you start

TIP

Make sure you have adequate access to the Shopify store

# Start creating the module

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

image alt text

Select "Shopify" from the list of available modules.

image alt text

# 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.

image alt text

# Authorization with Shopify

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

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

image alt text

Enter the url of your store without the http / https prefix.

image alt text

Next fill out the login form on the Shopify platform.

image alt text

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

image alt text

# Setting the module in the schedule

Your module is now created in WitCloud 📊. The final step is to determine the time range for which you need to retrieve historical data. The schedule for retrieving current data will be created automatically.

Enter the appropriate range and click the Finish button.

Last updated: 2023-07-05T14:12:16.000Z

← TikTok Ads →