Inventory NodeJs client
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
src/InventoryClient
test
LICENSE
README.md
git_push.sh
mocha.opts
package.json

README.md

InventoryClient

InventoryClient - JavaScript client for InventoryClient Orkiv Inventory API client This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build date: 2016-08-05T15:19:16.028-04:00
  • Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

git

If the library is hosted at a git repository, e.g. https://github.com/Orkiv/Inventory-javascript-client then install it via:

    npm install Orkiv/Inventory-javascript-client --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var InventoryClient = require('InventoryClient');

var defaultClient = InventoryClient.ApiClient.instance;

// Configure API key authorization: APIKey
var APIKey = defaultClient.authentications['APIKey'];
APIKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//APIKey.apiKeyPrefix['APIKey'] = "Token"

// Configure API key authorization: AccountID
var AccountID = defaultClient.authentications['AccountID'];
AccountID.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//AccountID.apiKeyPrefix['accountid'] = "Token"

var api = new InventoryClient.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.allGet(callback);

Documentation for API Endpoints

All URIs are relative to https://www.orkiv.com/i/api

Class Method HTTP request Description
InventoryClient.DefaultApi allGet GET /all/
InventoryClient.DefaultApi categoriesDelete DELETE /categories/
InventoryClient.DefaultApi categoriesPost POST /categories/
InventoryClient.DefaultApi categoriesPut PUT /categories/
InventoryClient.DefaultApi itemAddPost POST /item/add/
InventoryClient.DefaultApi itemAddbulkPost POST /item/addbulk/
InventoryClient.DefaultApi itemDelete DELETE /item/
InventoryClient.DefaultApi itemGet GET /item/
InventoryClient.DefaultApi itemMediaDelete DELETE /item-media/
InventoryClient.DefaultApi itemMediaPost POST /item-media/
InventoryClient.DefaultApi itemPut PUT /item/
InventoryClient.DefaultApi itemsCountPost POST /items/count/
InventoryClient.DefaultApi itemsPost POST /items/
InventoryClient.DefaultApi ordersPost POST /orders/
InventoryClient.DefaultApi ordersServicesPost POST /orders/services/
InventoryClient.DefaultApi queryPost POST /query/
InventoryClient.DefaultApi servicesDelete DELETE /services/
InventoryClient.DefaultApi servicesGet GET /services/
InventoryClient.DefaultApi servicesOpenGet GET /services/open/
InventoryClient.DefaultApi servicesPost POST /services/
InventoryClient.DefaultApi servicesPut PUT /services/
InventoryClient.DefaultApi variationDelete DELETE /variation/
InventoryClient.DefaultApi variationGet GET /variation/
InventoryClient.DefaultApi variationPost POST /variation/
InventoryClient.DefaultApi variationPut PUT /variation/
InventoryClient.DefaultApi writeDelete DELETE /write/
InventoryClient.DefaultApi writePost POST /write/

Documentation for Models

Documentation for Authorization

APIKey

  • Type: API key
  • API key parameter name: APIKey
  • Location: HTTP header

AccountID

  • Type: API key
  • API key parameter name: accountid
  • Location: HTTP header