https://github.com/commercetools/sphere-stock-import

Import your stock information into SPHERE.IO's inventory from CSV or XML, with SFTP support!
https://github.com/commercetools/sphere-stock-import

audit-import-export

Last synced: 11 months ago
JSON representation

Import your stock information into SPHERE.IO's inventory from CSV or XML, with SFTP support!

• Host: GitHub
• URL: https://github.com/commercetools/sphere-stock-import
• Owner: commercetools
• License: mit
• Created: 2013-12-01T18:27:34.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-11-17T12:13:30.000Z (over 1 year ago)
• Last Synced: 2025-08-18T01:37:10.472Z (11 months ago)
• Topics: audit-import-export
• Language: CoffeeScript
• Homepage:
• Size: 957 KB
• Stars: 1
• Watchers: 26
• Forks: 5
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-MIT

Awesome Lists containing this project

README

          


  
🚨 Non-maintainable 🚨

  
Starting January 1, 2025, we will no longer provide maintenance or updates for the CLI ImpEx tools. After this date, this tool will no longer receive bug fixes, security patches, or new features.





# Stock import

[![NPM](https://nodei.co/npm/sphere-stock-import.png?downloads=true)](https://www.npmjs.org/package/sphere-stock-import)

[![Build Status](https://secure.travis-ci.org/sphereio/sphere-stock-import.png?branch=master)](http://travis-ci.org/sphereio/sphere-stock-import) [![NPM version](https://badge.fury.io/js/sphere-stock-import.png)](http://badge.fury.io/js/sphere-stock-import) [![Coverage Status](https://coveralls.io/repos/sphereio/sphere-stock-import/badge.png)](https://coveralls.io/r/sphereio/sphere-stock-import) [![Dependency Status](https://david-dm.org/sphereio/sphere-stock-import.png?theme=shields.io)](https://david-dm.org/sphereio/sphere-stock-import) [![devDependency Status](https://david-dm.org/sphereio/sphere-stock-import/dev-status.png?theme=shields.io)](https://david-dm.org/sphereio/sphere-stock-import#info=devDependencies)

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`](https://github.com/sphereio/sphere-node-cli) for performant imports using JSON.

## Getting started

```bash

$ 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

  

    foo

    7

  

  

    bar

    1

  

```

## 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](http://gruntjs.com/).

More info [here](CONTRIBUTING.md)

## Releasing

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

```javascript

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](LICENSE-MIT).