Overview

This document explains how to integrate with Toolio. First part of the document covers the data models that Toolio expects and the second part covers how to integrate with your data sources.

For those that prefer a more visual walkthrough, here is a quick video guide that goes over this document and the model & attribute documentation.

Data Models and Attributes

Core Models

Toolio supports importing the following core data models, which are described further described in their documentation below

Data Model

Overview

Product (docs / sample)

Variant (SKU) level product meta data along with all the required attributes. Attributes from the Product feed will be automatically used to enrich data from the other seeds.

Inventory (docs / sample)

Sales and returns information that is aggregated over a specific time unit, such as day or week. If desired, data can also be shared in the order / transaction level granularity.

Sale (docs / sample)

SKU level inventory information by location over time. By default we request ending inventory, along with its Cost, Retail and Ticket value for each timestamp.

Purchase Order (docs / sample)

SKU level purchase order information. This feed is used to calculate Receipts (i.e. new SKU deliveries) and On Order metrics.

Plan (docs / sample)

Import feed for merchandise plans created outside of Toolio. Plan feed is NOT required for the core Toolio integration. Plans are stored per attribute combination over time.

Core Attributes

Toolio uses attributes for planning and reporting. You can think of attributes, as dimensions you want to report by or as columns on an Excel sheet. Each model has a set of core attributes that are needed for the system to operate. You can see the core attributes in the core model documentation.

Custom Attributes

Each core model also supports adding custom attributes as additional data elements. Custom attributes allow you to input additional dimensions in the system and use those dimensions for planning purposes. Below are a few examples for the attributes you might want to add for the different objects:

Product

  • Division (men, women, kids)
  • Department (apparel, footwear, accessories)
  • Class (sandals, boots, sneakers, flats, etc.)

Sale

  • Markdown (e.g. true, false)

The attributes defined on product are automatically associated with Sale, Inventory and Purchase Order, hence if you are using an attribute on Product, you won’t have to add them to the other data models.

Slugs

Since the display name of the attribute can change over time, it is important to have a deterministic value to refer to that attribute, and this is called a slug. Toolio relies on the attribute slug to identify the attribute while importing data. Toolio uses the snake case naming convention for attribute names. With core attributes, the slug will be the value defined in the attribute column in the core model documentation.

Slugs for custom attributes will be prefixed with `col_`. So if you have a new attribute called Division on the Product model, the slug for that attribute will be `col_division`.

Integrations

Toolio supports integration through various methods and systems. Check out our list of integrations below:

Did this answer your question?