Terminology

In order to understand references to specific parts and concepts in the Integration Platform and its API we have collected a glossary to explain each specific term in depth, as a reference when needed.

This is not an exhaustive list of each available endpoint and field but rather a glossary highlighting the most important and frequently used words and concepts throughout the documentation.

API

The Application Programming Interface based on RESTful design used to interact with the Integration Platform.

Auto Invoice

Automation mechanism in the Integration Platform to automatically create Invoices from Orders on given rules and actions configured by the user.

Connection

A unique instance of a Connector. Connections (and its Plug`s) are the tools used to exchange data with a remote system. There can be more than one Connection per Connector on one single Tenant.

Connection Id

A unique identifier of a specific Connection and referenced as connectionId.

Connector

An implemented system integration to a specific remote system within the Integration Platform. Examples of such implemented Connectors are WooCommerce, Shopify, QuickBooks Online and many more grouped into major categories such as Ecommerce, Accounting, Payments etc.

Connector (external)

A Connector developed by an external developer, via the Integration Platform API and settings available via external UI.

Connector (native)

A Connector offered by the Integration Platform where all settings are available via UI.

Currency

Custom Data

Export

When a record is sent from the Integration Platform to a remote system, this is called Export. The direction of data flow is always referenced from the Integration Platform’s point of view.

HTTP

The Hypertext Transfer Protocol is a web communication protocol in plain text.

HTTP Basic Access Authentication

A method to provide a username and password when making a request. In basic HTTP Authentication, a request contains a header field in the form of Authorization: Basic , where credentials is the Base64 encoding of username and password joined by a single colon :. Read more about Basic Access Authentication.

HTTPS

Hypertext Transfer Protocol Secure encrypted either using SSL (Secure Socket Layer) or TLS (Transport Layer Security).

Import

When a record is retrieved (read) from the remote system into the Integration Platform, this is called Import. The direction of data flow is always referenced from the Integration Platforms point of view.

Last modified

All records within the Integration Platform have fields named lastModified to indicate, when in time, the record was last modified. On GET requests, you can use the query parameter modifiedAtOrAfter to only retrieve modified records from the supplied timestamp value. This is a highly effective way to only process relevant records and work with a delta of records.

Last modified by

All records within the Integration Platform have fields named lastModifiedBy to indicate by whom or what the record was last modified. The value of this field references a User on the Tenant.

The format of the value is {Type}/{Id} where type can be any of the following;

CONNECTOR: A record can be created through a connection which can be a part of an API-connector or any other Connector In this case the Record Source contains information of: connectionType, connectionId, code and connectionName. The field code is the only field that can be modified through the API. The field can be used to identify a specific source in case the remote system supports multiple sources.
USER: A record changed by a logged in user or a user can in some cases also create a record directly from the admin interface. The source will only contain type=user and a login. This information is read only from the API.
AUTOMATIC: A record can be created automatically by the system and such a case is, for instance, an invoice being created from an order automatically by the Auto Invoice feature.

Manipulator

The manipulator is used to alter information in two scenarios:

During import: The data can be altered in the last step before it is saved in the Integration Platform. Connection specific settings will be applied before the manipulator.
During export: The data can be altered in the first step when it is collected from the Integration Platform. Connection specific settings will be applied after the manipulator.

Money

Plug

Each Connector has an array of Plugs implemented. Each Plug is used on the Connection to transfer data to or from the Integration Platform. A plug is used to perform a specific task e.g import orders or update stock value for products.

Record

A record denotes a single unique entity within the Integration Platform. It might be a single Order, Invoice, Product or any other unique entity of a record type supported by the Integration Platform.

Record type

Read more at Tenant API -> Record types.

Remote system

A remote system is any system that is connected through a so-called Connection in the Integration Platform. This can be a system using the API-connector or any of the supported out-of-the-box Connectors, e.g. to an ERP or E-commerce system.

Reseller

A reseller account allows the owner to create Tenants. A reseller can be a company that has multiple customers where each customer gets its own Tenant in the Integration Platform.

graph TB r[Reseller] --> t1[Tenant1] r[Reseller] --> t2[Tenant2] r[Reseller] --> t3[Tenant3]

Tenant

A top level account belonging to a customer (most often a company). The Tenant can have multiple users.