InventoryClient.DefaultApi

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

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

allGet

[InventoryGroup] allGet()

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

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

Parameters

This endpoint does not need any parameter.

Return type

[InventoryGroup]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

categoriesDelete

Response categoriesDelete(id)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | Id of category to remove


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

Parameters

Name	Type	Description	Notes
id	String	Id of category to remove

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

categoriesPost

[Category] categoriesPost(opts)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var opts = { 
  'query': new InventoryClient.Category() // Category | Category to query against system
};

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

Parameters

Name	Type	Description	Notes
query	Category	Category to query against system	[optional]

Return type

[Category]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

categoriesPut

Category categoriesPut(id, category)

If no ID is specified a new category will be created!

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | category id to update.

var category = new InventoryClient.Category(); // Category | New category information.


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

Parameters

Name	Type	Description	Notes
id	String	category id to update.
category	Category	New category information.

Return type

Category

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

itemAddPost

Item itemAddPost(item)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var item = new InventoryClient.ItemRequest(); // ItemRequest | Item to create.


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

Parameters

Name	Type	Description	Notes
item	ItemRequest	Item to create.

Return type

Item

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

itemAddbulkPost

Response itemAddbulkPost(items)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var items = [new InventoryClient.ItemRequest()]; // [ItemRequest] | Items to create.


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

Parameters

Name	Type	Description	Notes
items	[ItemRequest]	Items to create.

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

itemDelete

Response itemDelete(id)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | item id to remove


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

Parameters

Name	Type	Description	Notes
id	String	item id to remove

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

itemGet

Item itemGet(id)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | Item ID to open.


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

Parameters

Name	Type	Description	Notes
id	String	Item ID to open.

Return type

Item

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

itemMediaDelete

Response itemMediaDelete(imageurl)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var imageurl = "imageurl_example"; // String | URL of image to remove


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

Parameters

Name	Type	Description	Notes
imageurl	String	URL of image to remove

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

itemMediaPost

'String' itemMediaPost(id, image)

This endpoint is currently in testing.

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | Valid item id to bind image to.

var image = "/path/to/file.txt"; // File | Image.


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

Parameters

Name	Type	Description	Notes
id	String	Valid item id to bind image to.
image	File	Image.

Return type

'String'

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: multipart/form-data, application/x-www-form-urlencoded
Accept: application/json

itemPut

Response itemPut(id, item)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | item id to update.

var item = new InventoryClient.ItemRequest(); // ItemRequest | New item information.


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

Parameters

Name	Type	Description	Notes
id	String	item id to update.
item	ItemRequest	New item information.

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

itemsCountPost

'Number' itemsCountPost(opts)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var opts = { 
  'minprice': 3.4, // Number | Min price of items to find
  'maxprice': 3.4, // Number | Max price of items to find
  'query': new InventoryClient.ItemRequest() // ItemRequest | Item to query against system.
};

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

Parameters

Name	Type	Description	Notes
minprice	Number	Min price of items to find	[optional]
maxprice	Number	Max price of items to find	[optional]
query	ItemRequest	Item to query against system.	[optional]

Return type

'Number'

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

itemsPost

[Item] itemsPost(opts)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var opts = { 
  'minprice': 3.4, // Number | Min price of items to find
  'maxprice': 3.4, // Number | Max price of items to find
  'query': new InventoryClient.ItemRequest() // ItemRequest | Item to query against system.
};

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

Parameters

Name	Type	Description	Notes
minprice	Number	Min price of items to find	[optional]
maxprice	Number	Max price of items to find	[optional]
query	ItemRequest	Item to query against system.	[optional]

Return type

[Item]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

ordersPost

[Order] ordersPost(opts)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var opts = { 
  'query': new InventoryClient.OrderRequest() // OrderRequest | Order to query against item invoices.
};

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

Parameters

Name	Type	Description	Notes
query	OrderRequest	Order to query against item invoices.	[optional]

Return type

[Order]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

ordersServicesPost

[Order] ordersServicesPost(opts)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var opts = { 
  'query': new InventoryClient.OrderRequest() // OrderRequest | Order to query against service invoices.
};

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

Parameters

Name	Type	Description	Notes
query	OrderRequest	Order to query against service invoices.	[optional]

Return type

[Order]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

queryPost

[Item] queryPost(opts)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var opts = { 
  'page': 3.4, // Number | Current page index.
  'categoryid': "categoryid_example", // String | Get items under specified category id.
  'sort': "sort_example", // String | Comma delimited Sort string. ie ; +ordprice. Please use number based fields only
  'search': "search_example", // String | Performs a regex pattern match against the items within your account
  'minprice': 3.4, // Number | Min price in hundreds (cents).
  'maxprice': 3.4, // Number | Max price in hundreds (cents).
  'query': new InventoryClient.ItemRequest() // ItemRequest | Custom parameters to query against system.
};

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

Parameters

Name	Type	Description	Notes
page	Number	Current page index.	[optional]
categoryid	String	Get items under specified category id.	[optional]
sort	String	Comma delimited Sort string. ie ; +ordprice. Please use number based fields only	[optional]
search	String	Performs a regex pattern match against the items within your account	[optional]
minprice	Number	Min price in hundreds (cents).	[optional]
maxprice	Number	Max price in hundreds (cents).	[optional]
query	ItemRequest	Custom parameters to query against system.	[optional]

Return type

[Item]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

servicesDelete

Response servicesDelete(id)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | ID of the service to update


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

Parameters

Name	Type	Description	Notes
id	String	ID of the service to update

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

servicesGet

[Service] servicesGet()

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

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

Parameters

This endpoint does not need any parameter.

Return type

[Service]

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

servicesOpenGet

Service servicesOpenGet(id)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | ID of service to open


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

Parameters

Name	Type	Description	Notes
id	String	ID of service to open

Return type

Service

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

servicesPost

Service servicesPost(service)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var service = new InventoryClient.ServiceRequest(); // ServiceRequest | Service to create.


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

Parameters

Name	Type	Description	Notes
service	ServiceRequest	Service to create.

Return type

Service

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

servicesPut

Response servicesPut(id, service)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | ID of the service to update

var service = new InventoryClient.ServiceRequest(); // ServiceRequest | New service data to set.


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

Parameters

Name	Type	Description	Notes
id	String	ID of the service to update
service	ServiceRequest	New service data to set.

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

variationDelete

Response variationDelete(id)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | variation id to remove


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

Parameters

Name	Type	Description	Notes
id	String	variation id to remove

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

variationGet

Variation variationGet(id)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | Variation ID to open.


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

Parameters

Name	Type	Description	Notes
id	String	Variation ID to open.

Return type

Variation

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

variationPost

Response variationPost(id, item)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | Valid item id to bind variation to.

var item = new InventoryClient.Variation(); // Variation | Variation information.


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

Parameters

Name	Type	Description	Notes
id	String	Valid item id to bind variation to.
item	Variation	Variation information.

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

variationPut

Response variationPut(id, item)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var id = "id_example"; // String | variation id to update.

var item = new InventoryClient.Variation(); // Variation | New variation information.


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

Parameters

Name	Type	Description	Notes
id	String	variation id to update.
item	Variation	New variation information.

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

writeDelete

Response writeDelete(opts)

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var opts = { 
  'id': "id_example" // String | Will delete event attached to this serviceid
};

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

Parameters

Name	Type	Description	Notes
id	String	Will delete event attached to this serviceid	[optional]

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

writePost

Response writePost(eventRequest)

Will ovveride the current event of the specified service.

Example

var InventoryClient = require('InventoryClient');
var defaultClient = InventoryClient.ApiClient.default;

// 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 = '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 = 'Token';

var apiInstance = new InventoryClient.DefaultApi();

var eventRequest = new InventoryClient.EventRequest(); // EventRequest | Event to upload


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

Parameters

Name	Type	Description	Notes
eventRequest	EventRequest	Event to upload

Return type

Response

Authorization

APIKey, AccountID

HTTP request headers

Content-Type: Not defined
Accept: application/json

Files

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

InventoryClient.DefaultApi

allGet

Example

Parameters

Return type

Authorization

HTTP request headers

categoriesDelete

Example

Parameters

Return type

Authorization

HTTP request headers

categoriesPost

Example

Parameters

Return type

Authorization

HTTP request headers

categoriesPut

Example

Parameters

Return type

Authorization

HTTP request headers

itemAddPost

Example

Parameters

Return type

Authorization

HTTP request headers

itemAddbulkPost

Example

Parameters

Return type

Authorization

HTTP request headers

itemDelete

Example

Parameters

Return type

Authorization

HTTP request headers

itemGet

Example

Parameters

Return type

Authorization

HTTP request headers

itemMediaDelete

Example

Parameters

Return type

Authorization

HTTP request headers

itemMediaPost

Example

Parameters

Return type

Authorization

HTTP request headers

itemPut

Example

Parameters

Return type

Authorization

HTTP request headers

itemsCountPost

Example

Parameters

Return type

Authorization

HTTP request headers

itemsPost