Setting up a Generic Filesystem (FTP or SFTP) Retailer Integration

Introduction

The Kornit X Platform allows orders to be created by uploading specially formatted CSV files to a FTP (insecure) or ideally an SFTP site. These are referred to within the Platform as Generic Filesystem integrations. The standard CSV format is explained below but custom formats can also be used. This article will explain how to configure such integrations.

Any CSV files uploaded to a generic filesystem integration will be fetched for processing by OMS once every 30 minutes, both on the hour and half past the hour. Successfully processed CSV files get renamed with a timestamp and .complete suffix whilst unsuccessfully processed files gain a .error suffix.

The Required CSV Format

The following table describes which columns can be included in your CSV. Some are mandatory and are denoted with an asterisk (*). An example CSV file can be downloaded from the Attachments section in the right hand column.

Column header	Description
order.external_ref*	Your own order reference
order.sale_datetime	The date and time that the order was placed. The date format must be in the form YYYY-MM-DD HH:MM:SS, i.e. "2016-01-23 15:02:00"
order.shipping_company	Company Name if used
order.shipping_address_1	Shipping Address 1
order.shipping_address_2	Shipping Address 2
order.shipping_address_3	Shipping Address 3
order.shipping_address_4	Shipping Address 4
order.shipping_address_5	Shipping Address 5
order.shipping_postcode	Shipping Postcode
order.shipping_country	Shipping Country
order.shipping_country_code	Shipping Country Code ( ISO 3166-1 alpha-2 )
order.shipping_method	Shipping Method i.e Next Day
order.shipping_carrier	Shipping Carrier i.e Royal Mail
order.billing_address_1	Billing Address 1
order.billing_address_2	Billing Address 2
order.billing_address_3	Billing Address 3
order.billing_address_4	Billing Address 4
order.billing_address_5	Billing Address 5
order.billing_postcode	Billing Postcode
order.billing_country	Billing Country
order.customer_name	Customer Name
order.customer_email	Customer Email
item.sku	Your item SKU
item.description	Brief item description
item.colour	Colour (text field - any colour)
item.size	Size (arbitrary type)
item.quantity	Quantity
item.type	Item type Set to 1 to use item.external_url to define the orders artwork. Set to 3 to use print on demand references from CPP Set to 5 for textual items. This is used for items with no custom artwork but instead using the textual customisation fields textual.field_name1, textual.field_value1 etc.
item.print_on_demand_ref	The print on demand reference for the item orders obtained from CPP - Only for item type 3
item.external_url	URL to your artwork. Only for external URL items. Not restricted to any specific file format or file specification. Only used when item.type is set to 1.
item.external_thumbnail_url	URL to a thumbnail of your artwork. Only for external URL items. Not restricted to any specific file format or file specification. Only used when item.type is set to 1.
textual.field_name1	1st personalisation text field name. Only used when item.type is set to 5.
textual.field_value1	1st personalisation text field value. Only used when item.type is set to 5.
textual.field_name2	2nd personalisation text field name. Only used when item.type is set to 5.
textual.field_value2	2nd personalisation text field value. Only used when item.type is set to 5.
textual.field_nameN	nth personalisation text field name. Only used when item.type is set to 5.
textual.field_valueN	nth personalisation text field value. Only used when item.type is set to 5.

Locating the Generic Filesystem integration settings

After logging into the platform simply, head to the sales channel company of which you need to set the integration up and select "Generic Filesystem" from the options for "Sales Channel Integration.

To enable the integration simply open the "Generic FileSystem" option as shown below and click to enable.

There are settings that need to be set for this to connect and those are detailed in the below section of this article.

Explanation of the Generic Filesystem Integration settings

The screenshot below shows the retailer integration generic filesystem settings when the FS type menu is set to SFTP . Elements marked with an asterisk(*) are not available when using the FTP FS Type mode. The purpose of each element is explained in the table below:

Number	Element Name	Element Description
1	Enabled	This slider must be enabled for this integration to be active.
2	Email Errors To	An Email Address/Addressees that will send any errors encountered on this integration to.
3	Skip On Error	If this slider has been enabled, any CSV files containing any errors will simply be skipped.
4	Convert Textual Items	With this slider enabled, if the item code field in the CSV is valid, this will auto create a print job from this order.
5	Data Format Strategy	This dropdown will allow users to select a default CSV format. Some companies may have their own specific format which will appear but if not simply select "Standard CSV" by default.
6	FS Type	With this dropdown users must select the type being used which would either by SFTP or FTP.
7	FS Root	In this text fields users must define the root directory.
8	Pull Path	With this optional field, you can define the path to pull the CSV files from as a subfolder of the FS Root.
9	Push Path	With this optional field. you can define the path for the Platform to upload the CSV order status files to.
10	Public Key*	Only needed when setting an SFTP FS Type. Please note this key needs to be copied direct from the "~/.ssh/authorized_keys" file on the server being connected to.
11	Host	This text field must contain the Hostname of IP Address of the server to connect to. Please note either option must be added to the order manager firewall.
12	Port*	Only needed when setting an SFTP FS Type. 22 is usually the standard port but for any non-standard ports please set the correct different value required.
13	Username	This is either the SFTP or FTP username associated.
14	Password	This is the FTP password, this is not required for SFTP.
15	Product Supplier	Please enter the product fulfiller company ref ID here.
16	Order Destination	With this optional field users need to set the reference ID of the preferred dropship company in the order destination column.
17	Add New Supplier Map Entry	Clicking this icon will add a new entry to the supplier map.

Inclusion of "incoming" folder 

For any orders coming through this type of integration they must be placed into a folder that must be called "incoming". This is due to the fact that integrations of this type will always check for a colder called "incoming" within the FS Root set against the integration. 

Please note that lower case characters will be required for the folder.

As an example, if you want to set the root to " /home/kornitx/KORNITTESTCSV", within the integration settings tab on the Platform you need to create a "/home/kornitx/KORNITTESTCSV/incoming" root on the sever and the orders must be placed within the "incoming" folder. 

Updated Generic Filesystem Features

At KornitX we have continued to develop updates for variants and this is due to the fact we pride ourselves on constant evolution and the release of new features and enhancements every week. We have detailed each new enhancement below. If you are interested in knowing what features arrive, they will be continually updated within the "Core Platform Feature Updates" Article - CLICK HERE

Updated Support For Generic Filesystem Orders Going Into Networks

This was added on 12-04-2021

The Generic Filesystem was updated to ensure orders that flow through companies with the integration enabled can also send orders through Networks which can be setup for fulfillers who are part of a network. 

• Related Articles

• Notification Integration | Generic Filesystem

  Introduction This article has been created to show how to setup the Notification Integration that Kornit X has built to connect to a Generic Filesystem Setup To setup the Generic Filesystem Notification integration, please head to your company and ...

• Shipper Integration | Generic Label

  Introduction This article has been created to show how to setup the Shipping Integration that Kornit X has built to connect to a Generic Label. Setup To setup the Generic Label integration, please head to your company and within the advanced settings ...

• Sales Channel Integration | Walmart Marketplace

  Introduction This article has been created to show how to setup the sales channel retailer integration Kornit X has built to connect to the Walmart Marketplace.  Setup To setup the Walmart Marketplace integration, please head to your retailer company ...

• Product Integration | Generic API

  Introduction This article has been created to show how to setup the Product integration Kornit X has built to connect to Generic API.  Setup To setup the Generic API integration, please head to your category and within and within the advanced ...

• Sales Channel Integration | Fruugo

  Introduction This article has been created to show how to setup the Retailer Integration that Kornit X has built to connect to Base JP.  Setup To setup the Fruugo Retailer integration, please head to your company and within the advanced settings head ...