Subscribe

Vendure - Importing data

โœ๏ธ

A first look at how we can import product data in Vendure

15 Dec, 2022 ยท 3 min read

Product imports are an essential element that I found great when working with Vendure. It was super important to me to be able to import products and their data.

Many people might have the exact needs as they often already have a webshop or system to keep track of these things.

In this article, we'll look at how we can use the data import feature of Vendure.

Importing products

When importing products, Vendure accepts a flat .csv format, and it can hold products, assets, variants, and even custom fields. These elements will be created during the import, which is excellent.

You can find an example of the CSV format on the Vendure docs

The are multiple ways of doing the import, and I decided I wanted to be able to run it manually, so I created my script for it.

I called the script populate-server.ts. It's important to note that this uses the Vendure core populate function, which takes two parameters, the first being the initial data and the second your import.

My complete file looks like this.

// populate-server.ts
import { bootstrap } from '@vendure/core';
import { populate } from '@vendure/core/cli';
import path from 'path';

import { config } from './src/vendure-config';
import { initialData } from './my-initial-data';

const productsCsvFile = path.join(__dirname, 'import.csv');

populate(() => bootstrap(config), initialData, productsCsvFile)
  .then((app) => {
    return app.close();
  })
  .then(
    () => process.exit(0),
    (err) => {
      console.log(err);
      process.exit(1);
    }
  );

Let's go ahead and also create this my-initial-data.ts file. This file can be used to set up the admin section of your Vendure server.

In my case, I limited quite a bit of the setup, and my file looks like this.

import { InitialData, LanguageCode } from '@vendure/core';

export const initialData: InitialData = {
  paymentMethods: [],
  defaultLanguage: LanguageCode.en,
  countries: [],
  defaultZone: 'SA',
  taxRates: [],
  shippingMethods: [],
  collections: [],
};

You can find the complete object you can construct on the Vendure docs.

Note: Every time you run your import, these will be executed, so running it more than once will result in duplicates.

To run the actual import, we can use the following command:

yarn ts-node populate-server.ts

Depending on the number of products, it can take some time to finish.

I often ran the script for testing purposes to get the proper import set. You might have to play around with your CSV format if importing many custom fields this way.

Thank you for reading, and let's connect!

Thank you for reading my blog. Feel free to subscribe to my email newsletter and connect on Facebook or Twitter

Spread the knowledge with fellow developers on Twitter
Tweet this tip
Powered by Webmentions - Learn more

Read next ๐Ÿ“–

Vendure community and more

21 Dec, 2022 ยท 2 min read

Vendure community and more

Deploying Vendure

20 Dec, 2022 ยท 3 min read

Deploying Vendure

Join 1980 devs and subscribe to my newsletter