Sales Channel Integrations: Generic FileSystem
The Kornit X Platform allows orders to be created by uploading specificaly formatted CSV files to an SFTP site. 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 the platform 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.
CSV Format
The below related to the default "CSV" data strategy.
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. |
Explaination of the integration settings
The table below shows the Sales Channel 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 checkbox must be ticked to activate the integration. |
| 2 | Email errors To | Email address(es) to send errors to if the integration runs into problems. |
| 3 | Skip On Error | Any CSV files containing invalid fields will be skipped if this option is enabled. |
| 4 | Convert Textual Items | If the Item Code field in the CSV is valid and this is enabled, auto create a print job from the order. |
| 5 | Data Format Strategy | Select a CSV data format. Choose CSV if using the default format. |
| 6 | FS Type | Define what type of server is being used, SFTP or FTP . |
| 7 | FS Root | Define the root directory (OPTIONAL). |
| 8 | Pull Path | Define the path to pull the CSV files from, as a sub folder of FS Root (OPTIONAL). |
| 9 | Push Path | Define the path for OMS to upload CSV order status files to (OPTIONAL). |
| 10 | Public Key * | When using the SFTP FS Type, this key needs to be copied into the ~/.ssh/authorized_keys file on the server being connected to. |
| 11 | Host | The public hostname or IP address of the server to connect to. The hostname or IP must be added to the OMS firewall. |
| 12 | Port * | 22 is the default port for SFTP. Enter another value here if using a non-standard port. |
| 13 | Username | The (S)FTP user name. |
| 14 | Password | The FTP password. Not required when using SFTP. |
| 15 | Product Supplier | Enter the Product Supplier company reference ID in this column (OPTIONAL). |
| 16 | Order Destination | Enter the reference ID of the preferred dropship company in the Order Destination column (OPTIONAL). |
| 17 | Add new Supplier Map entry | Click this icon to add a new entry to the Supplier Map (OPTIONAL). |
Updated Integration Features
We pride ourselves on constant evolution and the release of new features and enhancements every week. If you are interested in knowing what features arrive, they will be continually updated within the "Core Platform Feature Updates" Article - CLICK HERE
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.
Still Need Help?
You can access our extensive knowledge base or raise a ticket with our technical support teams using the buttons below
Related Articles
Sales Channel Integrations: CDiscount
Introduction The CDiscount Retailer Integration connects to the CDiscount Marketplace API to import valid orders on CDiscount into the Kornit X Sales Module. The API requires the client to have a active CDiscount Seller account on which items to be ...Sales Channel Integrations: EBay
Introduction The eBay Retailer Integration connects to the eBay Fulfilment API to import valid orders on eBay into the Kornit X Sales Module. The Fulfilment API requires the client to have a active eBay Selling account on which items to be sold are ...Sales Channel Integrations: Channel Advisor
Introduction The Kornit X platform has been connected to Channel Advisor via an integration which allows orders to be pulled into the Sales Module. Integration Setup To set this up please enter the required connection credentials and options and ...Sales Channel Integrations | Mirakl
Introduction The Kornit X platform has been connected to Mirakl via an integration which allows orders to be pulled into the Sales Module. Users can enable this on Sales Channel company types to connect and use this. To contact Mirakl about working ...Sales Channel Integrations | Wayfair
Introduction The Kornit X platform has been connected to Wayfair via an integration which allows orders to be pulled into the Sales Module. Users can enable this on Sales Channel company types to connect and use this. To contact Wayfair about ...