WitCloud Docs

# Magento

# Introduction

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

We collect the most important information from the Magento to 6 different tables:

  1. magento_orders
Expand for the data schema
Field name Type Mode
applied_rule_ids STRING NULLABLE
base_currency_code STRING NULLABLE
base_discount_amount FLOAT NULLABLE
base_discount_invoiced FLOAT NULLABLE
base_grand_total FLOAT NULLABLE
base_discount_tax_compensation_amount FLOAT NULLABLE
base_discount_tax_compensation_invoiced FLOAT NULLABLE
base_shipping_amount FLOAT NULLABLE
base_shipping_discount_amount FLOAT NULLABLE
base_shipping_discount_tax_compensation_amnt FLOAT NULLABLE
base_shipping_incl_tax FLOAT NULLABLE
base_shipping_invoiced FLOAT NULLABLE
base_shipping_tax_amount FLOAT NULLABLE
base_subtotal FLOAT NULLABLE
base_subtotal_incl_tax FLOAT NULLABLE
base_subtotal_invoiced FLOAT NULLABLE
base_tax_amount FLOAT NULLABLE
base_tax_invoiced FLOAT NULLABLE
base_total_due FLOAT NULLABLE
base_total_invoiced FLOAT NULLABLE
base_total_invoiced_cost FLOAT NULLABLE
base_total_paid FLOAT NULLABLE
base_to_global_rate FLOAT NULLABLE
base_to_order_rate FLOAT NULLABLE
billing_address_id FLOAT NULLABLE
coupon_code STRING NULLABLE
created_at TIMESTAMP NULLABLE
customer_email STRING NULLABLE
customer_firstname STRING NULLABLE
customer_group_id INTEGER NULLABLE
customer_id INTEGER NULLABLE
customer_is_guest INTEGER NULLABLE
customer_lastname STRING NULLABLE
customer_note_notify INTEGER NULLABLE
discount_amount FLOAT NULLABLE
discount_description STRING NULLABLE
discount_invoiced FLOAT NULLABLE
email_sent INTEGER NULLABLE
entity_id INTEGER NULLABLE
global_currency_code STRING NULLABLE
grand_total FLOAT NULLABLE
discount_tax_compensation_amount FLOAT NULLABLE
discount_tax_compensation_invoiced FLOAT NULLABLE
increment_id STRING NULLABLE
is_virtual INTEGER NULLABLE
order_currency_code STRING NULLABLE
protect_code STRING NULLABLE
quote_id INTEGER NULLABLE
remote_ip STRING NULLABLE
shipping_amount FLOAT NULLABLE
shipping_description STRING NULLABLE
shipping_discount_amount INTEGER NULLABLE
shipping_discount_tax_compensation_amount INTEGER NULLABLE
shipping_incl_tax FLOAT NULLABLE
shipping_invoiced FLOAT NULLABLE
shipping_tax_amount FLOAT NULLABLE
state STRING NULLABLE
status STRING NULLABLE
store_currency_code STRING NULLABLE
store_id INTEGER NULLABLE
store_name STRING NULLABLE
store_to_base_rate FLOAT NULLABLE
store_to_order_rate FLOAT NULLABLE
subtotal FLOAT NULLABLE
subtotal_incl_tax FLOAT NULLABLE
subtotal_invoiced FLOAT NULLABLE
tax_amount FLOAT NULLABLE
tax_invoiced FLOAT NULLABLE
total_due FLOAT NULLABLE
total_invoiced FLOAT NULLABLE
total_item_count INTEGER NULLABLE
total_paid FLOAT NULLABLE
total_qty_ordered INTEGER NULLABLE
updated_at TIMESTAMP NULLABLE
weight FLOAT NULLABLE
x_forwarded_for STRING NULLABLE
items RECORD REPEATED
items. amount_refunded FLOAT NULLABLE
items. applied_rule_ids STRING NULLABLE
items. base_amount_refunded FLOAT NULLABLE
items. base_discount_amount FLOAT NULLABLE
items. base_discount_invoiced FLOAT NULLABLE
items. base_discount_tax_compensation_amount FLOAT NULLABLE
items. base_discount_tax_compensation_invoiced FLOAT NULLABLE
items. base_original_price FLOAT NULLABLE
items. base_price FLOAT NULLABLE
items. base_price_incl_tax FLOAT NULLABLE
items. base_row_invoiced FLOAT NULLABLE
items. base_row_total FLOAT NULLABLE
items. base_row_total_incl_tax FLOAT NULLABLE
items. base_tax_amount FLOAT NULLABLE
items. base_tax_invoiced FLOAT NULLABLE
items. created_at TIMESTAMP NULLABLE
items. discount_amount FLOAT NULLABLE
items. discount_invoiced FLOAT NULLABLE
items. discount_percent INTEGER NULLABLE
items. free_shipping INTEGER NULLABLE
items. discount_tax_compensation_amount FLOAT NULLABLE
items. discount_tax_compensation_invoiced FLOAT NULLABLE
items. is_qty_decimal INTEGER NULLABLE
items. is_virtual INTEGER NULLABLE
items. item_id INTEGER NULLABLE
items. name STRING NULLABLE
items. no_discount INTEGER NULLABLE
items. order_id INTEGER NULLABLE
items. original_price INTEGER NULLABLE
items. price FLOAT NULLABLE
items. price_incl_tax FLOAT NULLABLE
items. product_id INTEGER NULLABLE
items. product_type STRING NULLABLE
items. qty_canceled INTEGER NULLABLE
items. qty_invoiced INTEGER NULLABLE
items. qty_ordered INTEGER NULLABLE
items. qty_refunded INTEGER NULLABLE
items. qty_shipped INTEGER NULLABLE
items. quote_item_id INTEGER NULLABLE
items. row_invoiced FLOAT NULLABLE
items. row_total FLOAT NULLABLE
items. row_total_incl_tax FLOAT NULLABLE
items. row_weight FLOAT NULLABLE
items. sku STRING NULLABLE
items. store_id INTEGER NULLABLE
items. tax_amount FLOAT NULLABLE
items. tax_invoiced FLOAT NULLABLE
items. tax_percent INTEGER NULLABLE
items. updated_at TIMESTAMP NULLABLE
items. weee_tax_applied STRING NULLABLE
items. weight FLOAT NULLABLE
items. product_option RECORD NULLABLE
items.product_option. extension_attributes RECORD NULLABLE
items.product_option.extension_attributes. configurable_item_options RECORD REPEATED
items.product_option.extension_attributes.configurable_item_options. option_id STRING NULLABLE
items.product_option.extension_attributes.configurable_item_options. option_value INTEGER NULLABLE
billing_address RECORD NULLABLE
billing_address. address_type STRING NULLABLE
billing_address. city STRING NULLABLE
billing_address. country_id STRING NULLABLE
billing_address. email STRING NULLABLE
billing_address. entity_id INTEGER NULLABLE
billing_address. firstname STRING NULLABLE
billing_address. lastname STRING NULLABLE
billing_address. parent_id INTEGER NULLABLE
billing_address. postcode STRING NULLABLE
billing_address. street STRING REPEATED
billing_address. telephone STRING NULLABLE
payment RECORD NULLABLE
payment. account_status STRING NULLABLE
payment. amount_ordered FLOAT NULLABLE
payment. amount_paid FLOAT NULLABLE
payment. base_amount_ordered FLOAT NULLABLE
payment. base_amount_paid FLOAT NULLABLE
payment. base_amount_paid_online FLOAT NULLABLE
payment. base_shipping_amount FLOAT NULLABLE
payment. base_shipping_captured FLOAT NULLABLE
payment. cc_exp_year STRING NULLABLE
payment. cc_last4 STRING NULLABLE
payment. cc_ss_start_month STRING NULLABLE
payment. cc_ss_start_year STRING NULLABLE
payment. entity_id INTEGER NULLABLE
payment. last_trans_id STRING NULLABLE
payment. method STRING NULLABLE
payment. parent_id INTEGER NULLABLE
payment. shipping_amount FLOAT NULLABLE
payment. shipping_captured FLOAT NULLABLE
status_histories RECORD REPEATED
status_histories. comment STRING NULLABLE
status_histories. created_at TIMESTAMP NULLABLE
status_histories. entity_id INTEGER NULLABLE
status_histories. is_customer_notified INTEGER NULLABLE
status_histories. is_visible_on_front INTEGER NULLABLE
status_histories. parent_id INTEGER NULLABLE
status_histories. status STRING NULLABLE
extension_attributes RECORD NULLABLE
extension_attributes. shipping_assignments RECORD REPEATED
extension_attributes.shipping_assignments. shipping RECORD NULLABLE
extension_attributes.shipping_assignments.shipping. address RECORD NULLABLE
extension_attributes.shipping_assignments.shipping.address. address_type STRING NULLABLE
extension_attributes.shipping_assignments.shipping.address. city STRING NULLABLE
extension_attributes.shipping_assignments.shipping.address. country_id STRING NULLABLE
extension_attributes.shipping_assignments.shipping.address. email STRING NULLABLE
extension_attributes.shipping_assignments.shipping.address. entity_id INTEGER NULLABLE
extension_attributes.shipping_assignments.shipping.address. firstname STRING NULLABLE
extension_attributes.shipping_assignments.shipping.address. lastname STRING NULLABLE
extension_attributes.shipping_assignments.shipping.address. parent_id INTEGER NULLABLE
extension_attributes.shipping_assignments.shipping.address. postcode STRING NULLABLE
extension_attributes.shipping_assignments.shipping.address. street STRING REPEATED
extension_attributes.shipping_assignments.shipping.address. telephone STRING NULLABLE
extension_attributes.shipping_assignments.shipping. method STRING NULLABLE
extension_attributes.shipping_assignments.shipping. total RECORD NULLABLE
extension_attributes.shipping_assignments.shipping.total. base_shipping_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. base_shipping_discount_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. base_shipping_discount_tax_compensation_amnt FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. base_shipping_incl_tax FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. base_shipping_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. base_shipping_tax_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. shipping_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. shipping_discount_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. shipping_discount_tax_compensation_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. shipping_incl_tax FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. shipping_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.shipping.total. shipping_tax_amount FLOAT NULLABLE
extension_attributes.shipping_assignments. items RECORD REPEATED
extension_attributes.shipping_assignments.items. amount_refunded INTEGER NULLABLE
extension_attributes.shipping_assignments.items. applied_rule_ids STRING NULLABLE
extension_attributes.shipping_assignments.items. base_amount_refunded INTEGER NULLABLE
extension_attributes.shipping_assignments.items. base_discount_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_discount_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_discount_tax_compensation_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_discount_tax_compensation_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_original_price INTEGER NULLABLE
extension_attributes.shipping_assignments.items. base_price FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_price_incl_tax FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_row_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_row_total FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_row_total_incl_tax FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_tax_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.items. base_tax_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.items. created_at TIMESTAMP NULLABLE
extension_attributes.shipping_assignments.items. discount_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.items. discount_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.items. discount_percent INTEGER NULLABLE
extension_attributes.shipping_assignments.items. free_shipping INTEGER NULLABLE
extension_attributes.shipping_assignments.items. discount_tax_compensation_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.items. discount_tax_compensation_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.items. is_qty_decimal INTEGER NULLABLE
extension_attributes.shipping_assignments.items. is_virtual INTEGER NULLABLE
extension_attributes.shipping_assignments.items. item_id INTEGER NULLABLE
extension_attributes.shipping_assignments.items. name STRING NULLABLE
extension_attributes.shipping_assignments.items. no_discount INTEGER NULLABLE
extension_attributes.shipping_assignments.items. order_id INTEGER NULLABLE
extension_attributes.shipping_assignments.items. original_price INTEGER NULLABLE
extension_attributes.shipping_assignments.items. price FLOAT NULLABLE
extension_attributes.shipping_assignments.items. price_incl_tax FLOAT NULLABLE
extension_attributes.shipping_assignments.items. product_id INTEGER NULLABLE
extension_attributes.shipping_assignments.items. product_type STRING NULLABLE
extension_attributes.shipping_assignments.items. qty_canceled INTEGER NULLABLE
extension_attributes.shipping_assignments.items. qty_invoiced INTEGER NULLABLE
extension_attributes.shipping_assignments.items. qty_ordered INTEGER NULLABLE
extension_attributes.shipping_assignments.items. qty_refunded INTEGER NULLABLE
extension_attributes.shipping_assignments.items. qty_shipped INTEGER NULLABLE
extension_attributes.shipping_assignments.items. quote_item_id INTEGER NULLABLE
extension_attributes.shipping_assignments.items. row_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.items. row_total FLOAT NULLABLE
extension_attributes.shipping_assignments.items. row_total_incl_tax FLOAT NULLABLE
extension_attributes.shipping_assignments.items. row_weight FLOAT NULLABLE
extension_attributes.shipping_assignments.items. sku STRING NULLABLE
extension_attributes.shipping_assignments.items. store_id INTEGER NULLABLE
extension_attributes.shipping_assignments.items. tax_amount FLOAT NULLABLE
extension_attributes.shipping_assignments.items. tax_invoiced FLOAT NULLABLE
extension_attributes.shipping_assignments.items. tax_percent INTEGER NULLABLE
extension_attributes.shipping_assignments.items. updated_at TIMESTAMP NULLABLE
extension_attributes.shipping_assignments.items. weee_tax_applied STRING NULLABLE
extension_attributes.shipping_assignments.items. weight FLOAT NULLABLE
extension_attributes.shipping_assignments.items. product_option RECORD NULLABLE
extension_attributes.shipping_assignments.items.product_option. extension_attributes RECORD NULLABLE
extension_attributes.shipping_assignments.items.product_option.extension_attributes. configurable_item_options RECORD REPEATED
extension_attributes.shipping_assignments.items.product_option.extension_attributes.configurable_item_options. option_id STRING NULLABLE
extension_attributes.shipping_assignments.items.product_option.extension_attributes.configurable_item_options. option_value INTEGER NULLABLE
extension_attributes. payment_additional_info RECORD REPEATED
extension_attributes.payment_additional_info. key STRING NULLABLE
extension_attributes.payment_additional_info. value STRING NULLABLE
extension_attributes. applied_taxes RECORD REPEATED
extension_attributes.applied_taxes. code STRING NULLABLE
extension_attributes.applied_taxes. title STRING NULLABLE
extension_attributes.applied_taxes. percent INTEGER NULLABLE
extension_attributes.applied_taxes. amount FLOAT NULLABLE
extension_attributes.applied_taxes. base_amount FLOAT NULLABLE
extension_attributes. item_applied_taxes RECORD REPEATED
extension_attributes.item_applied_taxes. type STRING NULLABLE
extension_attributes.item_applied_taxes. applied_taxes RECORD REPEATED
extension_attributes.item_applied_taxes.applied_taxes. code STRING NULLABLE
extension_attributes.item_applied_taxes.applied_taxes. title STRING NULLABLE
extension_attributes.item_applied_taxes.applied_taxes. percent FLOAT NULLABLE
extension_attributes.item_applied_taxes.applied_taxes. amount FLOAT NULLABLE
extension_attributes.item_applied_taxes.applied_taxes. base_amount FLOAT NULLABLE
extension_attributes. converting_from_quote BOOLEAN NULLABLE
extension_attributes. cash_on_delivery_fee INTEGER NULLABLE
extension_attributes. base_cash_on_delivery_fee INTEGER NULLABLE
  1. magento_products
Expand for the data schema
Field name Type Mode
id INTEGER NULLABLE
sku STRING NULLABLE
name STRING NULLABLE
attribute_set_id INTEGER NULLABLE
price FLOAT NULLABLE
status INTEGER NULLABLE
visibility INTEGER NULLABLE
type_id STRING NULLABLE
created_at STRING NULLABLE
updated_at STRING NULLABLE
weight FLOAT NULLABLE
extension_attributes RECORD NULLABLE
extension_attributes. website_ids INTEGER REPEATED
extension_attributes. category_links RECORD REPEATED
extension_attributes.category_links. position INTEGER NULLABLE
extension_attributes.category_links. category_id STRING NULLABLE
extension_attributes. bundle_product_options RECORD REPEATED
extension_attributes.bundle_product_options. option_id INTEGER NULLABLE
extension_attributes.bundle_product_options. title STRING NULLABLE
extension_attributes.bundle_product_options. required BOOLEAN NULLABLE
extension_attributes.bundle_product_options. type STRING NULLABLE
extension_attributes.bundle_product_options. position INTEGER NULLABLE
extension_attributes.bundle_product_options. sku STRING NULLABLE
extension_attributes.bundle_product_options. product_links RECORD REPEATED
extension_attributes.bundle_product_options.product_links. can_change_quantity INTEGER NULLABLE
extension_attributes.bundle_product_options.product_links. id STRING NULLABLE
extension_attributes.bundle_product_options.product_links. is_default BOOLEAN NULLABLE
extension_attributes.bundle_product_options.product_links. option_id INTEGER NULLABLE
extension_attributes.bundle_product_options.product_links. position INTEGER NULLABLE
extension_attributes.bundle_product_options.product_links. price FLOAT NULLABLE
extension_attributes.bundle_product_options.product_links. price_type INTEGER NULLABLE
extension_attributes.bundle_product_options.product_links. qty FLOAT NULLABLE
extension_attributes.bundle_product_options.product_links. sku STRING NULLABLE
extension_attributes. stock_item RECORD NULLABLE
extension_attributes.stock_item. item_id INTEGER NULLABLE
extension_attributes.stock_item. product_id INTEGER NULLABLE
extension_attributes.stock_item. stock_id INTEGER NULLABLE
extension_attributes.stock_item. qty INTEGER NULLABLE
extension_attributes.stock_item. is_in_stock BOOLEAN NULLABLE
extension_attributes.stock_item. is_qty_decimal BOOLEAN NULLABLE
extension_attributes.stock_item. show_default_notification_message BOOLEAN NULLABLE
extension_attributes.stock_item. use_config_min_qty BOOLEAN NULLABLE
extension_attributes.stock_item. min_qty INTEGER NULLABLE
extension_attributes.stock_item. use_config_min_sale_qty INTEGER NULLABLE
extension_attributes.stock_item. min_sale_qty INTEGER NULLABLE
extension_attributes.stock_item. use_config_max_sale_qty BOOLEAN NULLABLE
extension_attributes.stock_item. max_sale_qty INTEGER NULLABLE
extension_attributes.stock_item. use_config_backorders BOOLEAN NULLABLE
extension_attributes.stock_item. backorders INTEGER NULLABLE
extension_attributes.stock_item. use_config_notify_stock_qty BOOLEAN NULLABLE
extension_attributes.stock_item. notify_stock_qty INTEGER NULLABLE
extension_attributes.stock_item. use_config_qty_increments BOOLEAN NULLABLE
extension_attributes.stock_item. qty_increments INTEGER NULLABLE
extension_attributes.stock_item. use_config_enable_qty_inc BOOLEAN NULLABLE
extension_attributes.stock_item. enable_qty_increments BOOLEAN NULLABLE
extension_attributes.stock_item. use_config_manage_stock BOOLEAN NULLABLE
extension_attributes.stock_item. manage_stock BOOLEAN NULLABLE
extension_attributes.stock_item. low_stock_date STRING NULLABLE
extension_attributes.stock_item. is_decimal_divided BOOLEAN NULLABLE
extension_attributes.stock_item. stock_status_changed_auto INTEGER NULLABLE
extension_attributes. downloadable_product_links RECORD REPEATED
extension_attributes.downloadable_product_links. id INTEGER NULLABLE
extension_attributes.downloadable_product_links. title STRING NULLABLE
extension_attributes.downloadable_product_links. sort_order INTEGER NULLABLE
extension_attributes.downloadable_product_links. is_shareable INTEGER NULLABLE
extension_attributes.downloadable_product_links. price INTEGER NULLABLE
extension_attributes.downloadable_product_links. number_of_downloads INTEGER NULLABLE
extension_attributes.downloadable_product_links. link_type STRING NULLABLE
extension_attributes.downloadable_product_links. link_file STRING NULLABLE
extension_attributes.downloadable_product_links. link_file_content RECORD NULLABLE
extension_attributes.downloadable_product_links.link_file_content. file_data STRING NULLABLE
extension_attributes.downloadable_product_links.link_file_content. name STRING NULLABLE
extension_attributes.downloadable_product_links. link_url STRING NULLABLE
extension_attributes.downloadable_product_links. sample_type STRING NULLABLE
extension_attributes.downloadable_product_links. sample_file STRING NULLABLE
extension_attributes.downloadable_product_links. sample_file_content RECORD NULLABLE
extension_attributes.downloadable_product_links.sample_file_content. file_data STRING NULLABLE
extension_attributes.downloadable_product_links.sample_file_content. name STRING NULLABLE
extension_attributes.downloadable_product_links. sample_url STRING NULLABLE
extension_attributes. downloadable_product_samples RECORD REPEATED
extension_attributes.downloadable_product_samples. id INTEGER NULLABLE
extension_attributes.downloadable_product_samples. title STRING NULLABLE
extension_attributes.downloadable_product_samples. sort_order INTEGER NULLABLE
extension_attributes.downloadable_product_samples. sample_type STRING NULLABLE
extension_attributes.downloadable_product_samples. sample_file STRING NULLABLE
extension_attributes.downloadable_product_samples. sample_file_content RECORD NULLABLE
extension_attributes.downloadable_product_samples.sample_file_content. file_data STRING NULLABLE
extension_attributes.downloadable_product_samples.sample_file_content. name STRING NULLABLE
extension_attributes.downloadable_product_samples. sample_url STRING NULLABLE
extension_attributes. giftcard_amounts RECORD REPEATED
extension_attributes.giftcard_amounts. attribute_id INTEGER NULLABLE
extension_attributes.giftcard_amounts. website_id INTEGER NULLABLE
extension_attributes.giftcard_amounts. value INTEGER NULLABLE
extension_attributes.giftcard_amounts. website_value INTEGER NULLABLE
extension_attributes. configurable_product_options RECORD REPEATED
extension_attributes.configurable_product_options. id INTEGER NULLABLE
extension_attributes.configurable_product_options. attribute_id STRING NULLABLE
extension_attributes.configurable_product_options. label STRING NULLABLE
extension_attributes.configurable_product_options. position INTEGER NULLABLE
extension_attributes.configurable_product_options. is_use_default BOOLEAN NULLABLE
extension_attributes.configurable_product_options. values RECORD REPEATED
extension_attributes.configurable_product_options.values. value_index INTEGER NULLABLE
extension_attributes.configurable_product_options. product_id INTEGER NULLABLE
extension_attributes. configurable_product_links INTEGER REPEATED
extension_attributes. vertex_commodity_code RECORD NULLABLE
extension_attributes.vertex_commodity_code. code STRING NULLABLE
extension_attributes.vertex_commodity_code. type STRING NULLABLE
product_links RECORD REPEATED
product_links. sku STRING NULLABLE
product_links. link_type STRING NULLABLE
product_links. linked_product_sku STRING NULLABLE
product_links. linked_product_type STRING NULLABLE
product_links. position INTEGER NULLABLE
product_links. extension_attributes RECORD NULLABLE
product_links.extension_attributes. qty INTEGER NULLABLE
options RECORD REPEATED
options. product_sku STRING NULLABLE
options. option_id INTEGER NULLABLE
options. title STRING NULLABLE
options. type STRING NULLABLE
options. sort_order INTEGER NULLABLE
options. is_require BOOLEAN NULLABLE
options. price FLOAT NULLABLE
options. price_type STRING NULLABLE
options. sku STRING NULLABLE
options. file_extension STRING NULLABLE
options. max_characters INTEGER NULLABLE
options. image_size_x INTEGER NULLABLE
options. image_size_y INTEGER NULLABLE
options. values RECORD REPEATED
options.values. title STRING NULLABLE
options.values. sort_order INTEGER NULLABLE
options.values. price FLOAT NULLABLE
options.values. price_type STRING NULLABLE
options.values. sku STRING NULLABLE
options.values. option_type_id INTEGER NULLABLE
options. extension_attributes RECORD NULLABLE
options.extension_attributes. vertex_flex_field STRING NULLABLE
media_gallery_entries RECORD REPEATED
media_gallery_entries. id INTEGER NULLABLE
media_gallery_entries. media_type STRING NULLABLE
media_gallery_entries. label STRING NULLABLE
media_gallery_entries. position INTEGER NULLABLE
media_gallery_entries. disabled BOOLEAN NULLABLE
media_gallery_entries. types STRING REPEATED
media_gallery_entries. file STRING NULLABLE
media_gallery_entries. content RECORD REPEATED
media_gallery_entries.content. base64_encoded_data STRING NULLABLE
media_gallery_entries.content. type STRING NULLABLE
media_gallery_entries.content. name STRING NULLABLE
media_gallery_entries. extension_attributes RECORD REPEATED
media_gallery_entries.extension_attributes. video_content RECORD REPEATED
media_gallery_entries.extension_attributes.video_content. media_type STRING NULLABLE
media_gallery_entries.extension_attributes.video_content. video_provider STRING NULLABLE
media_gallery_entries.extension_attributes.video_content. video_url STRING NULLABLE
media_gallery_entries.extension_attributes.video_content. video_title STRING NULLABLE
media_gallery_entries.extension_attributes.video_content. video_description STRING NULLABLE
media_gallery_entries.extension_attributes.video_content. video_metadata STRING NULLABLE
tier_prices RECORD REPEATED
tier_prices. customer_group_id INTEGER NULLABLE
tier_prices. qty FLOAT NULLABLE
tier_prices. value FLOAT NULLABLE
tier_prices. extension_attributes RECORD NULLABLE
tier_prices.extension_attributes. percentage_value FLOAT NULLABLE
tier_prices.extension_attributes. website_id INTEGER NULLABLE
custom_attributes RECORD REPEATED
custom_attributes. attribute_code STRING NULLABLE
custom_attributes. value STRING REPEATED

# Configuration

# Before you start

TIP

Make sure you have adequate access to the Magento store. To configure the module, you will need an API token that can be generated in the Magento panel according to this instruction: 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.

image alt text

Select Magento 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.

# Authorization with Magento

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

To do this, press the Click here to authorize button

image alt text

And fill out the Magento authorization form.

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

← Optimise →