🌐

Other languages available for this guide

🇫🇷 La version française de ce guide
🇪🇸 La versión española de esta guía
🇮🇹 La versione italiana di questa guida

Overview

This article explains in detail the structure of the configuration file used to define the behavior of the import engine.

Think of this article as a compendium: instead of reading it from cover to cover, which may be a daunting task, use it to find the information you need. The file contains hyperlinks to make it easier to find the configuration options for your scope.

You will find an example of a file at the end of the article.

Prerequisites

• A basic or better knowledge of the JSON syntax.
• A contact in Splio to receive and validate your config file.
• A text or code editor.

Use your favorite text or code editor to create and edit config files. An editor which can validate JSON syntax is recommended, as it will help you catch the most basic mistakes, such as missing commas, quotation marks, or brackets. If you do not know any such software, you might use JSON Editor Online, which is free software and is available via the website.

Definition of the config file

The configuration file is a text file conforming to the JavaScript Object Notation (JSON) format.

• Filename: _imports_config.json
• Encoding: UTF-8 without BOM
• Format: JSON

The placeholders in the following definition which need to be replaced with actual names and values are enclosed in pointy brackets ("<>"). The optional parts are enclosed within square brackets ("[]"). Ellipsis (". . .") replaces repetitions.

{
   "<universe>":{
     "<scope1>":{
       "<sub-sequence1>":{
         "<configoption11>":"<value11>"[,
         "<configoption12>":"<value12>"[, . . . ] ]
       }[,
       "<sub-sequence2>":{
         "<configoption21>":"<value21>"[,
         "<configoption22>":"<value22>"[, . . . ] ]
       }[, . . . ] ]
     }[,
     "<scope2>":{
       "<sub-sequence3>":{
         "<configoption31>":"<value31>"[, 
         "<configoption32>":"<value32>"[, . . . ] ]
       }[,
       "<sub-sequence4>":{
         "<configoption41>":"<value41>"[,
         "<configoption42>":"<value42>"[, . . . ] ]
       }[, . . . ] ]
     }[, . . . ] ]
   }
 }

Universe

The file must contain exactly one "" object. The name of this object must match the name of your Splio universe and needs to be part of the filename.

Scope

The universe must contain at least one "" object. Scopes represent data types that are imported into the Splio database.

The following scopes are available:

• contacts
• products
• stores
• orders
• abandonedcarts
• ordersitems
• masterreward, earnreward, burnreward (referring to Loyalty Rewards)
• creditpoints
• events
• deletecontacts
• cardcode (Loyalty subscriptions)
• tier_change

Only the contact scope has a corresponding deletion scope.

Sub-sequence

Each scope must contain one or more "" objects. Sub-sequences are used to define import files, which always belong to a specific sub-sequence within a scope. Sub-sequences represent various data sources (e.g., external bases) or imports within the same scope carried out for different reasons.

All configuration options are defined within sub-sequences.

Scopes and configuration options

The following subsections list the configuration options available within each scope.

Contacts

The following configuration options are available for contacts:

Hint: if you do not wish to clear (initialize) any lists, provide an empty list as value: "init lists": [ ].

Products

Products represent various merchandise which can be purchased by contacts. The following configuration options are available for products:

Stores

Stores represent physical or online stores.

The following configuration options are available for stores:

Orders

Orders represent purchases made by contacts. The following configuration options are available for orders:

Abandonedcarts

Abandonedcarts represent purchases that were not completed. The following configuration options are available for abandonedcarts:

Ordersitems

Ordersitems represent individual items on an order or in an abandoned cart cart.

Note that items in this scope cannot be updated via import but will be deleted whenever a corresponding order or abandonedcart is imported (e.g., updated).

Loyalty subscriptions (cardcode)

This scope uses the same set of configuration options as Ordersitems above.

Tier change

Credit points (creditpoints), Events (events), Delete contacts (deletecontacts)

This group of import scopes shares the same set of two configuration options.

Loyalty Rewards (masterreward, earnreward, burnreward)

Importing the rewards-related scopes is described in the Loyalty rewards article.