# BaseLinker
# Introduction
The BaseLinker 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 BaseLinker.
- 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
Two tables appear in your dataset:
- baselinker_orders
Expand for the data schema
Field name | Type | Mode |
---|---|---|
order_id | STRING | NULLABLE |
invoice_country | STRING | NULLABLE |
pack_state | INTEGER | NULLABLE |
shop_order_id | STRING | NULLABLE |
invoice_city | STRING | NULLABLE |
invoice_address | STRING | NULLABLE |
invoice_nip | STRING | NULLABLE |
pick_state | INTEGER | NULLABLE |
invoice_company | STRING | NULLABLE |
delivery_point_city | STRING | NULLABLE |
delivery_point_postcode | STRING | NULLABLE |
delivery_package_nr | STRING | NULLABLE |
extra_field_1 | STRING | NULLABLE |
extra_field_2 | STRING | NULLABLE |
delivery_country | STRING | NULLABLE |
invoice_country_code | STRING | NULLABLE |
delivery_point_address | STRING | NULLABLE |
delivery_point_id | STRING | NULLABLE |
order_page | STRING | NULLABLE |
want_invoice | BOOLEAN | NULLABLE |
delivery_country_code | STRING | NULLABLE |
delivery_city | STRING | NULLABLE |
delivery_address | STRING | NULLABLE |
payment_method | STRING | NULLABLE |
delivery_company | STRING | NULLABLE |
invoice_fullname | STRING | NULLABLE |
delivery_fullname | STRING | NULLABLE |
delivery_package_module | STRING | NULLABLE |
delivery_price | FLOAT | NULLABLE |
payment_done | FLOAT | NULLABLE |
invoice_postcode | STRING | NULLABLE |
payment_method_cod | INTEGER | NULLABLE |
delivery_postcode | STRING | NULLABLE |
date_in_status | TIMESTAMP | NULLABLE |
order_status_id | INTEGER | NULLABLE |
admin_comments | STRING | NULLABLE |
user_comments | STRING | NULLABLE |
currency | STRING | NULLABLE |
delivery_point_name | STRING | NULLABLE |
STRING | NULLABLE | |
date_add | TIMESTAMP | NULLABLE |
phone | STRING | NULLABLE |
order_source | STRING | NULLABLE |
delivery_method | STRING | NULLABLE |
order_source_id | INTEGER | NULLABLE |
external_order_id | STRING | NULLABLE |
date_confirmed | TIMESTAMP | NULLABLE |
user_login | STRING | NULLABLE |
order_source_info | STRING | NULLABLE |
confirmed | BOOLEAN | NULLABLE |
products | RECORD | REPEATED |
products. weight | FLOAT | NULLABLE |
products. quantity | INTEGER | NULLABLE |
products. product_id | INTEGER | NULLABLE |
products. auction_id | INTEGER | NULLABLE |
products. price_brutto | FLOAT | NULLABLE |
products. ean | STRING | NULLABLE |
products. sku | STRING | NULLABLE |
products. storage | STRING | NULLABLE |
products. variant_id | INTEGER | NULLABLE |
products. order_product_id | INTEGER | NULLABLE |
products. tax_rate | INTEGER | NULLABLE |
products. attributes | STRING | NULLABLE |
products. name | STRING | NULLABLE |
products. storage_id | STRING | NULLABLE |
user_login_hash | STRING | NULLABLE |
phone_hash | STRING | NULLABLE |
invoice_fullname_hash | STRING | NULLABLE |
email_hash | STRING | NULLABLE |
delivery_fullname_hash | STRING | NULLABLE |
delivery_address_hash | STRING | NULLABLE |
delivery_point_address_hash | STRING | NULLABLE |
invoice_address_hash | STRING | NULLABLE |
- baselinker_order_statuses
Expand for the data schema
Field name | Type | Mode |
---|---|---|
id | STRING | NULLABLE |
name | STRING | NULLABLE |
name_for_customer | STRING | NULLABLE |
color | STRING | NULLABLE |
# Configuration
# Before you start
Make sure you have adequate access to a BaseLinker account that can generate the API token
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 BaseLinker 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 BaseLinker
In the next step, we need to grant WitCloud access to BaseLinker. It is necessary for WitCloud to be able to download data.
To do this, press the Click here to authorize button.
And paste the API token from the BaseLinker panel.
After proper authorization, select your account from the list and click Finish button.
Advanced options
By default, all sensitive data we collect is hashed by us. If you want access to specific fields without hashing, you can check them here.
# Setting the module in the schedule
Your BaseLinker 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).