Introduction
API

SFTP

Use Cases#

This section will cover the integration use cases & file format/configurations for carrying out updates to your Catalog using SFTP.

There are several ways of updating item level information in your item catalog, all operations can be carried out using different file formats generated by your SFTP client.

Updating your Catalog by using Double File Format (Single Vendor or Multivendor)#

  1. Create a CSV file including all the products that you want to update. The file should contain

    1. Product Identifier

      1. sku- string, optional field

      2. barcode- string, optional field

      3. Both can be used. You should only use one of them per product.

    2. Catalog update level data

      1. price- double, optional\ - always must to be more than 0

      2. active- boolean, optional\ - Can be used with ‘true’ and ‘false’ or ‘1’ and ’0’

      3. quantity- integer, optional\ - This field is not stored in our system. We are comparing this number with salesbuffer and based on that- activating or deactivating the product.
        If quantity > sales buffer → active
        If quantity = or < sales buffer → inactive

        To update the status of your products, you must use only one of the fields: active or quantity.

Here is the example of how the file can look like:

3. **Vendors**: If you want to create an update for two or more vendors in the same file, you can use the Multivendor option. For that you can add 2 more columns to the existing file:
* `vendors` \- in this column you can add all vendors (stores in the chain) you want to run this update for separating with comma. If you want to run the update for all vendors, you can simply put ‘all’ in that column
* `exclude` \- in order to use this column, you have to put ‘all’ in the column ‘vendors’ and use the column ‘exclude’ for the vendors you want to exclude from the update. Separate the vendors by using commas.
  1. When you have your file ready (for the test store), you can push it to the Central Server to the **Assortment folder by using the credentials received from your Account Manager. More on this in the Credentials and Access section.**

  2. Check the updates in Partner Portal in Shops Integrations Section Under Assortment updates. You can also download the file you have recently uploaded and review the errors if any occurred.


SFTPHow to IntegrateSFTPTesting the Integration