Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including sphere-stock-import with all npm packages installed. Try it out:

var sphereStockImport = require("sphere-stock-import")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

sphere-stock-import v3.0.3

Import stock information into commercetools' inventory from CSV or XML, with SFTP support!

commercetools logo

Stock import

NPM

Build Status NPM version Coverage Status Dependency Status devDependency Status

This module allows to import stock information from CSV and XML files, with SFTP support.

Make sure to check out the new sphere-node-cli for performant imports using JSON.

Getting started

$ npm install -g sphere-stock-import

# output help screen
$ stock-import

SFTP

By default you need to specify the path to a local file in order to read the import information, via the --file option.

When using SFTP, you should not use the --file option, instead you need to provide at least the required --sftp* options:

  • --sftpCredentials (or --sftpHost, --sftpUsername, --sftpPassword)
  • --sftpSource
  • --sftpTarget

CSV Format

A simple example:

sku,quantityOnStock,restockableInDays,supplyChannel,expectedDelivery
foo,9,3,channel-key,2016-10-27T14:36:04.487Z
bar,-1,3,channel-key,2016-10-27T14:36:04.487Z
SKU-123,42,3,other-channel,2016-10-27T14:36:04.487Z

Custom fields

sku,quantityOnStock,customType,customField.foo,customField.bar
123,77,my-type,12,nac
abc,-3,my-type,5,ho

Please note: We do not support the localized set type.

XML Format

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <row>
    <code>foo</code>
    <quantityOnStock>7</quantityOnStock>
  </row>
  <row>
    <code>bar</code>
    <quantityOnStock>1</quantityOnStock>
  </row>
</root>

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt. More info here

Releasing

Releasing a new version is completely automated using the Grunt task grunt release.

grunt release // patch release
grunt release:minor // minor release
grunt release:major // major release

License

Copyright (c) 2014 SPHERE.IO Licensed under the MIT license.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free