All URIs are relative to https://www.koronacloud.com/web/api/v3
| Method | HTTP request | Description |
|---|---|---|
| addInventories | POST /accounts/{koronaAccountId}/inventories | adds a batch of new inventories |
| addInventoryInventoryListItems | POST /accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items | adds inventory list items |
| deleteInventory | DELETE /accounts/{koronaAccountId}/inventories/{inventoryId} | deletes the single inventory (only allowed if hasBookedReceipts=false) |
| deleteInventoryInventoryListItem | DELETE /accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items/{productId} | deletes the single inventory list item |
| getInventories | GET /accounts/{koronaAccountId}/inventories | lists all inventories |
| getInventory | GET /accounts/{koronaAccountId}/inventories/{inventoryId} | returns the single inventory |
| getInventoryInventoryList | GET /accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId} | returns the single inventory list |
| getInventoryInventoryListItem | GET /accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items/{productId} | returns the single inventory list item |
| getInventoryInventoryListItems | GET /accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items | lists all inventory list items |
| getInventoryInventoryLists | GET /accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists | lists all inventory lists |
| updateInventory | PATCH /accounts/{koronaAccountId}/inventories/{inventoryId} | updates the single inventory |
| updateInventoryInventoryList | PATCH /accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId} | updates the single inventory list |
| updateInventoryInventoryListItem | PATCH /accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items/{productId} | updates the single inventory list item |
| updateInventoryInventoryListItems | PATCH /accounts/{koronaAccountId}/inventories/{inventoryId}/inventoryLists/{inventoryListId}/items | updates inventory list items (property [product] required)) |
[AddOrUpdateResult] addInventories(body, koronaAccountId)
adds a batch of new inventories
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var body = [new KoronacloudApiV3.Inventory()]; // [Inventory] | an array of new inventories
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.addInventories(body, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| body | [Inventory] | an array of new inventories | |
| koronaAccountId | String | account id of the korona.cloud account |
- Content-Type: application/json
- Accept: application/json
[AddOrUpdateResult] addInventoryInventoryListItems(inventoryId, inventoryListId, body, koronaAccountId)
adds inventory list items
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var inventoryListId = "inventoryListId_example"; // String | id of the related object (important: id should match the uuid-format)
var body = [new KoronacloudApiV3.InventoryListItem()]; // [InventoryListItem] | data to update
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.addInventoryInventoryListItems(inventoryId, inventoryListId, body, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| inventoryListId | String | id of the related object (important: id should match the uuid-format) | |
| body | [InventoryListItem] | data to update | |
| koronaAccountId | String | account id of the korona.cloud account |
- Content-Type: application/json
- Accept: application/json
deleteInventory(inventoryId, koronaAccountId)
deletes the single inventory (only allowed if hasBookedReceipts=false)
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.deleteInventory(inventoryId, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| koronaAccountId | String | account id of the korona.cloud account |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
deleteInventoryInventoryListItem(inventoryId, inventoryListId, productId, koronaAccountId)
deletes the single inventory list item
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var inventoryListId = "inventoryListId_example"; // String | id of the related object (important: id should match the uuid-format)
var productId = "productId_example"; // String | id of the related object (important: id should match the uuid-format)
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.deleteInventoryInventoryListItem(inventoryId, inventoryListId, productId, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| inventoryListId | String | id of the related object (important: id should match the uuid-format) | |
| productId | String | id of the related object (important: id should match the uuid-format) | |
| koronaAccountId | String | account id of the korona.cloud account |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
ResultListInventory getInventories(koronaAccountId, opts)
lists all inventories
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var opts = {
'page': 56, // Number | number of the page to fetch
'size': 56, // Number | amount of objects to return per page
'sort': "sort_example", // String | attribute to sort by (multiple separated by comma; max. 5)
'revision': 789, // Number | last revision number, objects with a greater revision than this will be returned
'includeDeleted': true // Boolean | indicates deleted objects should be loaded or not (default: false)
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getInventories(koronaAccountId, opts, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| koronaAccountId | String | account id of the korona.cloud account | |
| page | Number | number of the page to fetch | [optional] |
| size | Number | amount of objects to return per page | [optional] |
| sort | String | attribute to sort by (multiple separated by comma; max. 5) | [optional] |
| revision | Number | last revision number, objects with a greater revision than this will be returned | [optional] |
| includeDeleted | Boolean | indicates deleted objects should be loaded or not (default: false) | [optional] |
- Content-Type: application/json
- Accept: application/json
Inventory getInventory(inventoryId, koronaAccountId)
returns the single inventory
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getInventory(inventoryId, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| koronaAccountId | String | account id of the korona.cloud account |
- Content-Type: application/json
- Accept: application/json
InventoryList getInventoryInventoryList(inventoryId, inventoryListId, koronaAccountId)
returns the single inventory list
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var inventoryListId = "inventoryListId_example"; // String | id of the related object (important: id should match the uuid-format)
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getInventoryInventoryList(inventoryId, inventoryListId, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| inventoryListId | String | id of the related object (important: id should match the uuid-format) | |
| koronaAccountId | String | account id of the korona.cloud account |
- Content-Type: application/json
- Accept: application/json
InventoryListItem getInventoryInventoryListItem(inventoryId, inventoryListId, productId, koronaAccountId)
returns the single inventory list item
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var inventoryListId = "inventoryListId_example"; // String | id of the related object (important: id should match the uuid-format)
var productId = "productId_example"; // String | id of the related object (important: id should match the uuid-format)
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getInventoryInventoryListItem(inventoryId, inventoryListId, productId, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| inventoryListId | String | id of the related object (important: id should match the uuid-format) | |
| productId | String | id of the related object (important: id should match the uuid-format) | |
| koronaAccountId | String | account id of the korona.cloud account |
- Content-Type: application/json
- Accept: application/json
ResultListInventoryListItem getInventoryInventoryListItems(inventoryId, inventoryListId, koronaAccountId, opts)
lists all inventory list items
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var inventoryListId = "inventoryListId_example"; // String | id of the related object (important: id should match the uuid-format)
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var opts = {
'page': 56, // Number | number of the page to fetch
'size': 56, // Number | amount of objects to return per page
'sort': "sort_example", // String | attribute to sort by (multiple separated by comma; max. 5)
'revision': 789 // Number | last revision number, objects with a greater revision than this will be returned
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getInventoryInventoryListItems(inventoryId, inventoryListId, koronaAccountId, opts, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| inventoryListId | String | id of the related object (important: id should match the uuid-format) | |
| koronaAccountId | String | account id of the korona.cloud account | |
| page | Number | number of the page to fetch | [optional] |
| size | Number | amount of objects to return per page | [optional] |
| sort | String | attribute to sort by (multiple separated by comma; max. 5) | [optional] |
| revision | Number | last revision number, objects with a greater revision than this will be returned | [optional] |
- Content-Type: application/json
- Accept: application/json
ResultListInventoryList getInventoryInventoryLists(inventoryId, koronaAccountId, opts)
lists all inventory lists
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var opts = {
'page': 56, // Number | number of the page to fetch
'size': 56, // Number | amount of objects to return per page
'sort': "sort_example", // String | attribute to sort by (multiple separated by comma; max. 5)
'revision': 789, // Number | last revision number, objects with a greater revision than this will be returned
'includeDeleted': true, // Boolean | indicates deleted objects should be loaded or not (default: false)
'minCreateTime': new Date("2013-10-20T19:20:30+01:00"), // Date | min (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
'maxCreateTime': new Date("2013-10-20T19:20:30+01:00"), // Date | max (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
'minBookingTime': new Date("2013-10-20T19:20:30+01:00"), // Date | min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
'maxBookingTime': new Date("2013-10-20T19:20:30+01:00"), // Date | max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
'bookingStatus': "bookingStatus_example" // String | booking status (possible values: BOOKED, IN_PROGRESS)
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getInventoryInventoryLists(inventoryId, koronaAccountId, opts, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| koronaAccountId | String | account id of the korona.cloud account | |
| page | Number | number of the page to fetch | [optional] |
| size | Number | amount of objects to return per page | [optional] |
| sort | String | attribute to sort by (multiple separated by comma; max. 5) | [optional] |
| revision | Number | last revision number, objects with a greater revision than this will be returned | [optional] |
| includeDeleted | Boolean | indicates deleted objects should be loaded or not (default: false) | [optional] |
| minCreateTime | Date | min (inclusive) create time of the receipt (ISO 8601; date, time and timezone) | [optional] |
| maxCreateTime | Date | max (inclusive) create time of the receipt (ISO 8601; date, time and timezone) | [optional] |
| minBookingTime | Date | min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) | [optional] |
| maxBookingTime | Date | max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) | [optional] |
| bookingStatus | String | booking status (possible values: BOOKED, IN_PROGRESS) | [optional] |
- Content-Type: application/json
- Accept: application/json
updateInventory(inventoryId, body, koronaAccountId)
updates the single inventory
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var body = new KoronacloudApiV3.Inventory(); // Inventory | the properties to update of the inventory
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.updateInventory(inventoryId, body, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| body | Inventory | the properties to update of the inventory | |
| koronaAccountId | String | account id of the korona.cloud account |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
updateInventoryInventoryList(inventoryId, inventoryListId, body, koronaAccountId)
updates the single inventory list
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var inventoryListId = "inventoryListId_example"; // String | id of the related object (important: id should match the uuid-format)
var body = new KoronacloudApiV3.InventoryList(); // InventoryList | data to update
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.updateInventoryInventoryList(inventoryId, inventoryListId, body, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| inventoryListId | String | id of the related object (important: id should match the uuid-format) | |
| body | InventoryList | data to update | |
| koronaAccountId | String | account id of the korona.cloud account |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
updateInventoryInventoryListItem(inventoryId, inventoryListId, productId, body, koronaAccountId)
updates the single inventory list item
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var inventoryListId = "inventoryListId_example"; // String | id of the related object (important: id should match the uuid-format)
var productId = "productId_example"; // String | id of the related object (important: id should match the uuid-format)
var body = new KoronacloudApiV3.InventoryListItem(); // InventoryListItem | data to update
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.updateInventoryInventoryListItem(inventoryId, inventoryListId, productId, body, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| inventoryListId | String | id of the related object (important: id should match the uuid-format) | |
| productId | String | id of the related object (important: id should match the uuid-format) | |
| body | InventoryListItem | data to update | |
| koronaAccountId | String | account id of the korona.cloud account |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
[AddOrUpdateResult] updateInventoryInventoryListItems(inventoryId, inventoryListId, body, koronaAccountId)
updates inventory list items (property [product] required))
var KoronacloudApiV3 = require('cloud-api-v3-js-client');
var defaultClient = KoronacloudApiV3.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';
var apiInstance = new KoronacloudApiV3.InventoriesApi();
var inventoryId = "inventoryId_example"; // String | id of the related object (important: id should match the uuid-format)
var inventoryListId = "inventoryListId_example"; // String | id of the related object (important: id should match the uuid-format)
var body = [new KoronacloudApiV3.InventoryListItem()]; // [InventoryListItem] | an array of inventory list items to update
var koronaAccountId = "koronaAccountId_example"; // String | account id of the korona.cloud account
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.updateInventoryInventoryListItems(inventoryId, inventoryListId, body, koronaAccountId, callback);| Name | Type | Description | Notes |
|---|---|---|---|
| inventoryId | String | id of the related object (important: id should match the uuid-format) | |
| inventoryListId | String | id of the related object (important: id should match the uuid-format) | |
| body | [InventoryListItem] | an array of inventory list items to update | |
| koronaAccountId | String | account id of the korona.cloud account |
- Content-Type: application/json
- Accept: application/json