@commercetools/csv-parser-orders

CSV Parser Orders

Convert commercetools orders CSV data to JSON

This module is update actions based. Update actions currently supported is:

• Add ReturnInfo
• Change the state of LineItem according to allowed transitions

Usage

npm install @commercetools/csv-parser-orders -g

CLI

Usage: csvparserorders [options]
Convert commercetools orders CSV data to JSON.

Options:
  --help, -h        Show help text.                                    [boolean]
  --version, -v     Show version number.                               [boolean]
  --type, -t        Predefined type of csv
                             [required] [choices: "lineitemstate", "returninfo"]
  --inputFile, -i   Path to CSV file.                         [default: "stdin"]
  --outputFile, -o  Input CSV file.                          [default: "stdout"]
  --batchSize, -b   Number of CSV rows to handle simultaneously.  [default: 100]
  --delimiter, -d   Used CSV delimiter.                           [default: ","]
  --strictMode, -s  Parse CSV strictly.                          [default: true]
  --projectKey, -p  API project key.                                  [required]
  --host            HTTP client host parameter.
  --protocol        HTTP client protocol parameter.
  --accessToken     HTTP client access token.
  --logLevel        Logging level: error, warn, info or verbose.
                                                               [default: "info"]

When running with --outputFile set, logging information is shown directly otherwise it goes to csvparserorders.log with the exception of fatal errors.

JS

You can also use this tool as a required module

import { LineItemStateCsvParser } from '@commercetools/csv-parser-orders'
import fs from 'fs'

const apiCredentials = {
    project_key: process.env.CM_PROJECT_KEY,
    client_id: '*********',
    client_secret: '*********'
};

const lineitemstate = new LineItemStateCsvParser(
  {
    config: apiCredentials,
    access_token: <access_token>,
  },
  {
    error: console.error,
    warn: console.warn,
    info: console.log,
    verbose: console.log,
  },
  {
    strictMode: true
  }
)

lineItemState.parse(
  fs.createReadStream('./input.csv'),
  fs.createWriteStream('./output.json')
);

Errors on the level error come from events that are fatal and thus stop the stream of data

Data is exported in JSON in this format

[{
  "orderNumber": "234",
  "lineItems": [{
    "state": [{
      "quantity": 10,
      "fromState": "processing",
      "toState": "shipped"
    }]
  }]
}]

Configuration

CsvParserOrders main methods accepts three objects as arguments:

• API client config (required)
  • See the SDK client documentation for more information.
• Logger takes object with four functions (optional)
• Config (optional)
  • batchSize: number of CSV rows to handle simultaneously. (default: 100)
  • delimiter: the used CSV delimiter (default: ,)
  • strictMode: whether to parse the CSV strictly (default: true)

Contributing

See CONTRIBUTING.md for info on contributing to eslint-config