Creating products from csv

Whenever dealing with static table data, it's easier to export it as a csv file than going through the trouble of reading the xlsx file or connecting to a live spreadsheet. The purpose of this quick guide is to provide a code example on how to transform the .csv file into a json file that can be used to create product in the platform.

Code Example

Node

const csv = require('csv-parser');
const fs = require('fs');
const results = [];
fs.createReadStream('data.csv')
  .pipe(csv())
  .on('data', (data) => results.push(data))
  .on('end', () => {
    const importData = results.map((value) => ({
      product: {
        name: value.SKU,
        type: 'item',
        metadata: Object.entries(value).map(([mKey, mValue]) => ({
          type: 'String',
          name: mKey,
          values: [],
          defaultValue: mValue,
        })),
        tags: ['fabric'],
        keywords: [value.Categorization],
        rules: [],
        attributes: [],
      },
    }));
    fs.writeFileSync('fabrics.json', JSON.stringify(importData));
  });

CSV Data Example

SKU,Categorization,Colour,Season,Label
YGFFG, Striped, White, Winter, White Wool
TT77K, Plain, Blue, Summer, Blue Satin

In this example we are creating a JSON file containing the 2 products contained in this data set. We are tagging them as fabric and adding a dynamic metadata fields and the keyword based on one of the columns. They can then be used as a part attribute on another catalog item which will serve as the main configurator. The script can be adjusted to your particular needs and data structure. Once you have written the file, you can use the import function on the catalog or the Product Import API.

If the 3D assets are already set up in the asset library, you might also find useful using the following function to get a list of 3D assets, find the proper match using a naming convention or looking for metadata, and use their assetId as part of the product JSON.

"asset": {
      "assetId": "string",
      "configuration": {},
    }

const axios = require('axios');
const querystring = require('querystring');
const API_PATH = 'https://preview.threekit.com/api/';
const GET_ASSETS = 'products/export/json';

const getAssetList = (orgId, authToken, queryParams) => {
const url = `${API_PATH}${GET_ASSETS}?orgId=${orgId}&bearer_token=${authToken}&all=true${
  queryParams ? `&${querystring.stringify(queryParams)}` : ''
}&all=true`;
return axios({
  method: 'get',
  url,
}).then((res) => res.data);
};

module.exports = getAssetList;

The JSON list you get from this function has the same schema as the product JSON. Example:

const materials = await getAssetList(orgId, token, {type: "material"});
materials.find(material => material.product.name === value.SKU);

Menu

In this article

Code Example

Node

CSV Data Example

Menu

Creating products from csv

In this article

Code Example

Node

CSV Data Example

Related articles