@commercelayer/contentful-seeder

Contentful Seeder

A Node JS library that lets you import Commerce Layer seed data into Contentful.

What is Commerce Layer?

Commerce Layer is a headless platform that lets you easily build enterprise-grade ecommerce into any website, by using the language, CMS, and tools you already master and love.

Table of contents

• How it works
• Getting started
  • Installation
  • Import
• Usage
  • The seeder function
  • The returned object

How it works

This seeder is the easiest way to bulk import a set of products, based on a specific content model — both brought to you by Commerce Layer — into your Contentful space.

Before running the seeder, make sure you've set up the content model in question into Contentful (you can use our dedicated content model importer).

This seeder is built for Node.js and doesn't run in the browser.

Getting Started

To be ready to use the Contentful Seeder, you need to install it and then get the credentials that will allow you to manage your space in Contentful.

Installation

Contentful Seeder is available as an npm package:

// npm
npm install @commercelayer/contentful-seeder

// yarn
yarn add @commercelayer/contentful-seeder

Import

You can use the ES6 default import as follows:

import seeder from '@commercelayer/contentful-seeder'

Usage

The seeder function

The seeder function returns a promise and you need to pass to it as a parameter an object containing:

• accessToken: string — your Contentful content management token (required)
• spaceId: string — your Contentful space ID (required)
• environmentId: string — your Contentful environment ID (required)
• locale: string — your Contentful locale (optional — default: en-US)
• maxVariants: number — the maximum number of variants that will be imported (optional / default: all)
• sizes: { load?: boolean, externalUrl?: string } — predefined set of sizes (optional / default: { load: true })
• variants: { load?: boolean, externalUrl?: string } — predefined set of variants (optional / default: { load: true })
• taxons: { load?: boolean, externalUrl?: string } — predefined set of taxons (optional / default: { load: true })
• taxonomies: { load?: boolean, externalUrl?: string } — predefined set of taxonomies (optional / default: { load: true })
• catalogs: { load?: boolean, externalUrl?: string } — predefined set of catalogs (optional / default: { load: true })
• countries: { load?: boolean, externalUrl?: string } — predefined set of countries (optional / default: { load: true })

// default import — all the products, no taxonomies, en-US locale

seeder({
  accessToken: 'your-content-management-token',
  spaceId: 'your-space-id',
  environmentId: 'your-environment-id'
}).then((result) => {
  console.log(result)
})

// custom import — ten items for each content type, with external countries, it-IT locale

seeder({
  accessToken: 'your-content-management-token',
  spaceId: 'your-space-id',
  environmentId: 'your-environment-id',
  locale: 'it-IT',
  maxVariants: 10,
  countries: {
    externalUrl: 'your-external-url'
  }
}).then((result) => {
  console.log(result)
})

Please note that this seeder automatically sets the status of each Contentful entry it creates to PUBLISHED.

The returned object

The promise returned by the seeder function is an object containing all the items imported, by content type:

{
  sizes: [
    { id: '1st-size-id', name: 'First Size Name' },
    { id: '2nd-size-id', name: 'Second Size Name' },
    ...
  ],
  variants: [
    {
      id: '1st-variant-id',
      name: 'First Variant Name',
      imageId: '1st-variant-image-id',
      reference: '1STVARIANTREF'
    },
    {
      id: '2nd-variant-id',
      name: 'Second Variant Name',
      imageId: '2nd-variant-image-id',
      reference: '2NDVARIANTREF'
    },
    ...
  ],
  products: [
    {
      id: '1st-product-id',
      name: 'First Product Name',
      reference: '1STPRODUCTREF'
    },
    {
      id: '2nd-product-id',
      name: 'Second Product Name',
      reference: '2NDPRODUCTREF'
    },
    ...
  ],
  taxonomies: [
    { id: '1st-taxonomy-id', name: 'First Taxonomy Name' },
    { id: '2nd-taxonomy-id', name: 'Second Taxonomy Name' },
    ...
  ]
}

License

This repository is published under the MIT license.