Baselinker

Getting started

In this article, you can find information about BaseLinker integration, which allows Allegro and eMag orders to be processed directly into BaseLinker API and sent to JOY without the need to create orders in the Tau Ceti platform.

  RememberYou can find more about Allegro integration in the Allegro article

This integration allows employees to edit, if needed information on the BaseLinker panel and helps to identify Allegro and eMag orders.

This integration also provides constant communication between the Tau Ceti platform and BaseLinker API with automatic updates for products and stocks.

Table of contents:

1. Configuring the BaseLinker
2. BaseLinker product fields
3. BaseLinker / Orders tab
   1. Filters section
   2. Orders section
   3. Order details
4. Baselinker categories
5. BaseLinker delivery mapping
   1. Adding a new delivery method
6. BaseLinker campaign codes
   1. Creating a new campaign code
7. BaseLinker errors

 

---

 

Configuring the BaseLinker

BaseLinker configuration can be found in the
System > System / Settings > Integrations > BaseLinker

Visualization of the system settings integration location

Visualization of the BaseLinker settings

In the BaseLinker tab we can find the following options:

• Functionality enabled – Switch that turns on or off the functionality.
• Debug mode – Switch that turns on the debug mode. By default, it should be turned off.
• Synchronize products - Turns ON/OFF products update executed daily. If disabled it will block the manual operation of products and categories creation. This switch does not affect stock updates.
• Synchronize product attributes - Turns ON/OFF support for attributes within products add & update processes. Every attribute is exported as a variant within BaseLinker API.
• Update stock - Switch which defines if the product's stock should be sent to the BaseLinker API. Stocks are updated every 15 minutes.
• Waybill Enabled - Switch which defines if information about a waybill should be sent to the BaseLinker API.
• Order prefix – Prefix of the orders made with BaseLinker.
• Campaign code – Optional field of the campaign codes that will be used by orders made with BaseLinker API.
• Sales Channel -A field that defines the sales channel used during order export to JOY
  (field: salesChannel).
• Default postal code - Postal code used during order export to JOY if the order has no postal code within BaseLinker API.
• EasyBox parser - Turns ON/OFF decoding locker number for EasyBox service. Such locker number is placed within the address normally used for storing street names and numbers. EasyBox parcel numbers are not available within information about the "selected delivery point" within BaseLinker API.
  
• JOY Export: Append state name to the city - Turns ON/OFF Appending the state name field to the value of the city field during order export to JOY. This switch alters both delivery and billing addresses.
• BaseLinker altshop - Altshop that is used to get products that should be exported to the BaseLinker.
• Remove diactrics - Turns ON/OFF removing diacritics from products name and description.
• Product name: add "Yves Rocher" - Turns ON/OFF the addition of the ", Yves Rocher" to the product name.
• Product name: add capacity - Turns ON/OFF adding ", {capacity}" to the product name.
• Warranty field value - Value for the "warranty" feature exported for every product.
• Product price spread field value - Value used while calculating "min_sale_price" and "max_sale_price" features exported for every product. A value of 50 will mean that the minimum sale price will be set to 50% of the product promotion price and the maximum sale price will be set to 150% of the product promotion price.
  
• Manufacturer name - Value used as manufacturer name during product synchronization.
• Sex feature URL name - Value of field "URL name" which can be found within the e-commerce properties dictionary. This value is used to find the sex features which will be exported as the "sex" feature to BaseLinker.
  
• Product image size - Image size identifier which will be used during exporting product images to BaseLinker. It must be an existing image size, eg. "500x500".
• API url – API url. It should always be https://api.BaseLinker.com/connector.php
• API Token – API token. This token can be found in the BaseLinker panel > User profile > My account > API > Your API token.
• Inventory ID - Inventory ID which should be gathered from the BaseLinker panel. It can be found in the lower-left corner of the Inventory edit form. Only inventory with this ID will be updated during product and stock synchronizations.
• Warehouse ID - Warehouse ID which should be gathered from the BaseLinker panel. It can be found in the lower-left corner of the Warehouse edit form. All stocks will be exported only for this warehouse. If there are any other warehouses within BaseLinker API, they will be ignored.
• Support company data - Turns ON/OFF considering company fields when importing orders from the BaseLinker. It also affects the export of billing data to the JOY as a result of BaseLinker order import with or without company data. It alters only BaseLinker orders and works regardless of the current value of the Company Fields switch (e-commerce related).
• Company ID field identifier - The identifier of the extra field that contains the company ID. It can be found in BaseLinker panel section Orders > Settings > Additional fields > ID and should look like extra_field_64542.
• Panel URL - It is used to generate buttons linking to the BaseLinker panel. Example: https://panel-e.BaseLinker.com.

With all necessary options set and saved, we can find export and update buttons in the
Orders > BaseLinker / Processes

Visualization of the BaseLinker processes

In BaseLinker Catalog we have 4 processes:

• Adding new categories (1) – Export all the categories to the BaseLinker. The category tree is defined by the exisiting categories in Catalog > Categories / list. It is possible to define what categories should be exported to JOY in Orders > BaseLinker / categories ( You can find more about this section here BaseLinker categories ) When this option is used again, we do not duplicate already exported categories, but only add new ones, and also old categories are not automatically removed.
• Adding new products (2) – Exports products that are enabled on the selected in the System / Settings altshop and assigned to the categories. This option also does not duplicate already exported products, only adds new ones, and products with stock <= 0 are also ignored. It also controls the creation of product variants, which means that when Synchronize product attributes is active in the system settings, running product adding will add all active attributes to existing products. When one of the attributes is missing, it will be added. Product variants are created even if their stock value equals 0.
  Please note, that only product main category will be assigned to it on the BaseLinker platform.
  Below you will find supported fields:

• Field name	Description	Data source
  inventory_ID	Catalog ID	ID from TC system settings (BaseLinker_inventory_id)
  product_ID	Product ID	Always null
  is_Bundle	Is the product a part of a set	Always false
  ean	EAN of a product	First found in the database EAN of the product. In case of multiple EAN codes, the first one taken from the database is exported.
  sku	SKU of a product	Main SKU of the product. Attribute sku if data is generated for product variant.
  tax_rate	VAT tax rate	Vat percentage taken from TC system settings from vat_percentage field.
  weight	Weight of the product	Capacity field from the product page. This field is converted to a floating point number or 0.0.
  height	Height of the product	Always 0.0
  width	Width of the product	Always 0.0
  length	Length of the product	Always 0.0
  star	Star type (indication in the BaseLinker panel)	Always 0
  manufacturer_id	Manufacturer ID	Manufacturer ID with a name that matches the BaseLinker_manufacturer_name system setting. Obtained from the getInventoryManufacturers method. If the manufacturer does not exist, it is created automatically.
  category_id	Category ID	ID obtained from the API in the process of going through the categories to create a product. In the case of finding a product within several categories, it is the ID of the first category encountered
  prices	The list of prices in the price groups.	id-price-group: price, where ID of the group is taken from the getInventoryPriceGroups method. Always default price group is used (is_default: true).
  locations	Additional information regarding the location of the product in the warehouse	Always an empty table ([])
  text_fields	descriptive fields with possible variants in different languages / for different integrations	Object with a set of fields compatible with the Supported text fields table.
  images	Product pictures	List of images assigned to attribute if data is generated for product variant. The main photo is marked with index 0. We pass the photos as string url: {address}. If there are currently fewer photos than there were previously, the pre-existing object indexes are transferred with the value "" in order to force the deletion of the old photos. We are transferring photos in size 500x500px (system setting: BaseLinker_product_img_size). The list is limited to 15 items. Note: BaseLinker returns a list of photos with indexes increased by 1. When referring to these images, this index should always be decreased by 1. For update requests, the numbering is from 0, when retrieving product information, the numbering is from 1. We only provide images related to the SKU set in the product, i.e. in the case of a SKU color variant, we will transfer only photos associated with a particular color.
  links	Identifications of the product in the other warehouses.	Always an empty table ([])
  stock	Stock value	{ "stock-id": { "stock-status" } where ID of the warehouse comes from the system setting, while the stock is set according to the default altshop configuration. The logic is according to the cyclic process of updating stock levels.

  Fields stock, parent_id, and bundle_products are not exported to BaseLinker.
  

• Updating existing products (3) – Updates whole existing products and product variants with their picture, data, and stock. This method is performed cyclically every 24 hours for the RO market. All fields that are being updated by adding new products are updated except fields star, stock, parent_id, and bundle_products which are not updated.
  When the products update process detects a product or variant which is inactive, it will set status feature to 0.
• Updating products stocks (4) –  Updates only existing product stocks and their variants without changing anything else. This method is performed cyclically every 15min for PL and RO markets. It excludes updating parent product stock as BaseLinker does not allow to set it. The stock of the parent product in BaseLinker is a sum of stocks assigned to all variants. The stock update process supports variants regardless the state of Synchronize product attributes switch. Depending on the product configuration, we send to BaseLinker:
  • The true value of the stock minus the minimum stock.
  • Value 99 in case of always in the stock setting.
  • Value 0 if set to never in stock.

For each process, we are able to see their current status, last usage time, and a button to run the selected process. Available statuses are:

• started - the process is currently working.
• not-working - the process is not currently running and is not scheduled to run automatically (it will run only when you click on the run now button).
• disabled - the process is deactivated by system settings.
• scheduled - the process is not currently running, but it is scheduled to run automatically.

Supported text fields in the product import:

Name of the field	Description	Data source
name	Name of the product	Product name. adds - {color name} if data is generated for product variant. Value ", Yves Rocher" is added if the system setting BaseLinker_product_name_manufacturer is equal to 1. Value ", {capacity}" is added if the system setting BaseLinker_product_name_capacity is equal to 1 and the product has a non-empty capacity field value. Within the text, all diacritical characters are converted to characters in the ASCII range if the setting of the BaseLinker_remove_diactrics system setting has a value of 1.
description	Description of the product	combined text of all descriptions in order: main, effects, usage, ingredients, capacity, additional_info, notes. Within the text, all diacritical characters are converted to characters in the ASCII range if the setting of the BaseLinker_remove_diactrics system setting has a value of 1.
description_extra1	Additional description 1	Always an empty string ("")
description_extra2	Additional description 2	Always an empty string ("")
description_extra3	Additional description 3	Always an empty string ("")
description_extra4	Additional description 4	Always an empty string ("")
features	Features of the product	List of product features with additional features (please see Supported Features section). status is 0 when the product is globally inactive (disabled in product definition). status is 0 if the product is active but data is generated for the inactive product variant.

 

Supported features

Within the features field within the product data, we upload:

• A warranty feature with a value derived from the system setting BaseLinker_warranty_field_value.
• The part_number feature with the product's main SKU.
• The min_sale_price feature with a value calculated according to the formula {spread} * {promotion price} / 100, where {spread} is the value of the system setting BaseLinker_price_spread_field_value.
• Feature max_sale_price with a value calculated according to the formula (100 + {spread}) * {promotion price} / 100*, where {spread} is the value of the system setting BaseLinker_price_spread_field_value.
  The base_price feature with the promotional price of the product.
  The sale_price feature with the value calculated according to the formula {price} - {vat percentage} * {promotion price} / 100.
• Status feature with a value of 1 if the product is active in BaseLinker's alt shop, 0 otherwise.
• Feature sex with the value of the feature assigned to the product within the
  e-commerce database.
  The link is after the SEO (url friendly) name of the feature. The SEO name comes from the
  BaseLinker_sex_feature_url_name system setting. If a product has more than one value assigned to the feature, they are separated by a comma with a space.

All values are cast to a string type

 

---

 

BaseLinker product fields

Updating the product changes almost the same amount of fields as importing the new ones.

Visualization of the BaseLinker product edit

In the first tab “General Information” we have fields:

• Product name – The name of the product which is taken from the product “Name” field on the Yves Rocher platform. We add to this field automatically after the comma “Yves Rocher” and after another comma the capacity of the product from the product “capacity” field
• Category – The category of the product.
• Manufacturer – default value that will always be “Yves Rocher Romania” for RO website, other values will be visible for other countries
• Quantity in storage – The quantity of the product taken from the “Stock value” field on the Yves Rocher platform product page.
• Gross price – Base price of the product. If the product doesn’t have a promotion price it will be the catalog price taken from the “Price” product field. If the product has a promotion price it will take from the Altshop “Price” field from a specific product
• Purchase price – Same as Gross price
• EAN – EAN of the product which is added in the import process of the products to the Yves Rocher platform.
• Catalog number – SKU – SKU of the product taken from the “SKU” field.
• VAT rate – fixed value set in the BaseLinker settings
• Weight – The weight of the product taken from the “Capacity” product field.

Visualization of the BaseLinker product edit description

In the descriptions tab, we can see product descriptions. The product description is taken from all description fields on Yves Rocher platform and put in one Description field on the
BaseLinker platform.

Visualization of the BaseLinker product edit photos

In the Photos tab, we can see exported photos of the products. If the product has additional pictures they will be visible in Additional photo 1, Additional photo 2 etc. fields.

Visualization of the BaseLinker product edit parameters

In the parameters tab we can see all product parameters:

• Status – Status of the product. 1 equals active, 0 equals that product is inactive. The default value is 1, but if the stock of the product falls to 0 the product status will change also to 0, so customers won’t be able to buy it. Disabling the product in the altshop also will change the status value to 0.
• Min_sale_price – Minimal sale price for the product. It is equal to 50% of the base price of the selected product.
• Max_sale_price – Maximal sale price for the product. It is equal to 150% of the base price of the selected product.
• Base_price – Base price of the product. It is taken from the product catalog or promotional price, same as in the “gross price” in the general information tab
• Sale_price – Sale price of the product. Base price minus VAT percentage.
• Warranty – The fixed value of 12 month
• Part_number – Product SKU number is taken from the SKU field.
• Sex – Male / Female values. It is only taken and read from the products that have the “sex” tag assigned to them.

 

---

 

BaseLinker / Orders tab

The BaseLinker / orders tab allows us to see all successfully exported orders made in the Allegro or eMag platform and imported to BaseLinker API. This tab can be found in

Orders > BaseLinker / Orders

All possible operations to perform on the BaseLinker view can be done in the Filters (1), and Orders (2) tabs.

Visualization of the BaseLinker orders tab

 

Filters section

The Filters section allows sorting of the BaseLinker orders, based on the available filters. Below you will find a description of available filters

Visualization of the filters tab in the BaseLinker page

• Creation time - Range of dates when filtered orders have been created.
• Status - Current status of the BaseLinker orders. Possible order statuses are:
  
  • Order created
  • Order data validation & mapping success
  • Order data validation & mapping failure
  • JOY export success
  • JOY export failure
  • Order canceled
  • Order unpaid

After defining the above filters, select the Apply Filters button to get a list of sites according to the applied filters.  

 

Orders section

The Orders section allows for organizing the BaseLinker orders and searching for the desired ones.

Below you will find a description of all possible actions you can perform in the orders section.

Visualization of the orders tab in the BaseLinker orders page

• Select the Show X entries(1) field to set the number of BaseLinker orders, displayed on one page (min 10 / max 100).
• The names of the columns (2) that contain information about target orders. Each column is susceptible to sorting.
  To sort the records, click on the title of the column in question.
  
  • ID - TauCeti internal ID of the order
  • External ID – Allegro / eMag ID of the order
  • First/last name – First and last name of the customer
  • E-mail – Customers email address
  • Mobile – Customers mobile number
  • Creation Time – Creation time of the order
  • Order ID – BaseLinker ID of the order
  • Status – Current status of the order. Possible statuses are:
    • Order created
    • Order data validation & mapping success
    • Order data validation & mapping failure
    • JOY export success
    • JOY export failure
    • Order canceled
    • Order unpaid
  • Actions - A show more button, which will open the selected order. Order details are described in the Order details section
• Search box (3) where you can search for orders by customers e-mail address, mobile number, name and surname, order ID, and External ID.
• Page buttons (4), which allows user to change the page of currently viewed BaseLinker orders.

 

Order details

When pressing the show more button you will get redirected to the selected order details.

Visualization of the order tab

The first tab is the Order tab. In the Order tab we can check the order:

• ID – Internal ID of the order.
• Import date - Date of the order import to the TauCeti platform.
• Order ID – BaseLinker platform order ID. This field has three additional actions:
  • View button allows to see the order as a customer in the BaseLinker
  • View in BaseLinker button allows to check particular order in BaseLinker.
  • Cancel button is only visible when order is not exported to JOY (i.e. because it has an error). It allows to cancel the selected order in TC and BaseLinker.
• Order Status – Current status of the order.
• First/last name – First and last name of the customer.
• E-mail – Customers E-mail address.
• Mobile – Customers mobile number.
• Creation Time – Date of creation of the order.
• Confirmation time – Date of confirmation time. This date is provided by BaseLinker API.

The next tab is with Delivery Address data.

Visualization of the delivery address tab

In this tab we can see delivery address data provided by the customer with postal code and city. Right below the delivery address data we can find company data fields. These fields are only visible if the Support company data switch in system / settings is enabled.

Visualization of the Company tab

In the Company data tab we have listed the provided name of the company, its tax ID, and Company ID.

The next visible tab is the Order data tab. The order tab shows basic information about the order.

Visualization of the order data tab

In this tab we can see Order information like:

• Status – BaseLinker status number. This number is provided by BaseLinker
• Delivery – The selected delivery method by customer.
• Delivery cost – Cost of the delivery
• Delivery point – Delivery post identification. It’ll be only filled when customer selects delivery to certain delivery point.
• Delivery point name – Full name of the delivery point.
• Delivery point address – Street name and number where selected delivery point is located
• Delivery point postcode – Postal code of the delivery point
• Delivery point city – City name, where delivery point is located.

Visualization of the payment tab

In Payment tab, we can see what payment method has been selected and how much customer paid using this payment method.

Visualization of the order lines tab

In the Order lines tab we can see all purchased products with their SKU, name, price, quantity and total value. If voucher was used in the order on the e-mag platform it will be also visible here with it's amount that has been deducted. When the order is exported to the JOY platform the amount of the discount is deducted from the order value, as JOY doesn't accept product negative
product values.

Last visible tab is the Events tab.

Visualization of the events tab

In the Events tab, we can see all events that happened in a particular order. If one order is edited in BaseLinker panel, the change will be visible in that order in the Events tab.

 

 

---

 

BaseLinker categories

In this section, you can select the desired product categories, that should be exported to the Baselinker platform. The categories are created according to the existing category tree, that is configured in Catalog > Categories / list.

Visualization of the Baselinker categories section

This table contains the following columns:

• Name - The name of the category. The categories are displayed as a tree. It means that it is impossible to select a subcategory without selecting the category higher in the branch.
• BaseLinker Inventory ID - The internal BaseLinker inventory ID of the category. It is only displayed once the category has been successfully exported to BaseLinker
• Synchronized to BaseLinker - The date and time when the category was exported to BaseLinker.
• Update time - The date and time when the category status has been last updated. Changing the is active? tickbox will update the update time.
• Is active? - A tickbox that defines if the category should be exported to BaseLinker. Only selected tickboxes will be exported. It is possible to deselected or selected all categories using the Deselect all categories or Select all categories buttons at the top of the table.

When the changes to the category selection are done they need to be saved using the Save button located in the top right corner of the table.

 

---

 

BaseLinker delivery mapping

In this section, we can edit, delete or add new BaseLinker delivery methods and map them to the Yves-Rocher delivery methods. In order to map BaseLinkers delivery method with available Yves-Rocher delivery methods we need to navigate to:

Orders > BaseLinker / Delivery mapping

Below you will find a description of all possible actions you can perform in the BaseLinker / Delivery mapping tab.

Visualization of the BaseLinker delivery tab

• Select the Show X entries (1) field to set the number of BaseLinker delivery methods, displayed on one page (min 10 / max 100).
• The names of the columns (2) that contain information about target delivery methods. Each column is susceptible to sorting.
  To sort the records, click on the title of the column in question.
  
  • BaseLinker Name – Name of the delivery method provided by BaseLinker
  • Joy name – Export tag of the delivery method sent to JOY. Export tags can be found in System > Delivery types / list. Based on that mapped name JOY sends to us waybill number which our system imports it to BaseLinker.
  • Courier Code – Courier Code provided by BaseLinker.
  • Name – System name of the delivery method.
  • Actions - There are two available actions:
    • View - View created a delivery method
    • Delete - Delete the selected delivery method
• Select the Add delivery method (3) button to go to the adding the new delivery method. You can learn more about adding of the new delivery method in the Adding a new delivery method chapter
• Search box (4) where you can search for delivery methods by their BaseLinker name, JOY name, or courier code.
• Page buttons (5), which allow users to change the page of currently viewed delivery options.

 

Adding a new delivery method

To link the new delivery method we need to fill all the fields according to the columns described above. After saving the new delivery method with correct data our delivery method will be automatically linked and all Allegro / eMag orders will be exported to JOY with delivery according to Joy name column.

Visualization of the adding of the new delivery method

 

---

 

BaseLinker campaign codes

Campaign codes used by the BaseLinker need to be created in the
Orders > BaseLinker / Campaign codes

Without a proper campaign code, BaseLinker orders won't be able to be exported to JOY.
Below you will find a description of all possible actions you can perform in the BaseLinker / Campaign codes tab.

Visualization of the BaseLinker campaign codes tab

• Select the Show X entries (1) field to set the number of BaseLinker campaign codes, displayed on one page (min 10 / max 100).
• The names of the columns (2) that contain information about target campaign codes. Each column is susceptible to sorting.
  To sort the records, click on the title of the column in question.
  • ID - An internal identification number of the created campaign code
  • Name – Name of the integration. This name must match a source of the order (i.e. Allegro).
  • Campaign code – Campaign code value. This value has to match the campaign code created in the JOY platform.
  • Actions - There are two available actions:
    • Edit - Edit selected campaign code.
    • Delete - Delete the selected campaign code.
• Select the Add integration campaign code (3) button to go to the adding of a new campaign code. You can find more information about editing and creating of campaign codes in the Creating a new campaign code chapter.
• Search box (4) where you can search for campaign codes by their Name, JOY name, or campaign code.
• Page buttons (5), which allow users to change the page of currently viewed campaign codes.

Creating a new campaign code

When editing or creating a new campaign code user has to define two values

Visualization of the campaign code creation

• Name - Name of the integration. This name must match a source of the order (i.e. Allegro).
• Campaign Code  - Campaign code value. This value has to match the campaign code created in the JOY platform.

With both fields filled in we can save the changes by pressing the Save button.

 

---

 

BaseLinker errors

BaseLinker / errors is the tab where we can see all errors regarding importing orders made on Allegro / eMag platform. This tab can be found in

Orders > BaseLinker / Errors

Visualization of the BaseLinker errors tab

In this tab we can find various individual JOY errors similar to Orders / To Verify tab.
When error has been fixed we can try to re-import the order by clicking Force re-export (1) button.