Skip to content

Latest commit

 

History

History
510 lines (351 loc) · 13.8 KB

WarehouseApi.md

File metadata and controls

510 lines (351 loc) · 13.8 KB
Raw

infoplus.WarehouseApi

All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api

Method HTTP request Description
addWarehouseAudit PUT /beta/warehouse/{warehouseId}/audit/{warehouseAudit} Add new audit for a warehouse
addWarehouseTag PUT /beta/warehouse/{warehouseId}/tag/{warehouseTag} Add new tags for a warehouse.
deleteWarehouseTag DELETE /beta/warehouse/{warehouseId}/tag/{warehouseTag} Delete a tag for a warehouse.
getDuplicateWarehouseById GET /beta/warehouse/duplicate/{warehouseId} Get a duplicated a warehouse by id
getWarehouseByFilter GET /beta/warehouse/search Search warehouses by filter
getWarehouseById GET /beta/warehouse/{warehouseId} Get a warehouse by id
getWarehouseTags GET /beta/warehouse/{warehouseId}/tag Get the tags for a warehouse.
updateWarehouse PUT /beta/warehouse Update a warehouse
updateWarehouseCustomFields PUT /beta/warehouse/customFields Update a warehouse custom fields

addWarehouseAudit

addWarehouseAudit(warehouseId, warehouseAudit)

Add new audit for a warehouse

Adds an audit to an existing warehouse.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

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

var apiInstance = new infoplus.WarehouseApi()

var warehouseId = 56; // {Integer} Id of the warehouse to add an audit to

var warehouseAudit = "warehouseAudit_example"; // {String} The audit to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addWarehouseAudit(warehouseId, warehouseAudit, callback);

Parameters

Name Type Description Notes
warehouseId Integer Id of the warehouse to add an audit to
warehouseAudit String The audit to add

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

  • Content-Type: application/json
  • Accept: application/json

addWarehouseTag

addWarehouseTag(warehouseId, warehouseTag)

Add new tags for a warehouse.

Adds a tag to an existing warehouse.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

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

var apiInstance = new infoplus.WarehouseApi()

var warehouseId = 56; // {Integer} Id of the warehouse to add a tag to

var warehouseTag = "warehouseTag_example"; // {String} The tag to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addWarehouseTag(warehouseId, warehouseTag, callback);

Parameters

Name Type Description Notes
warehouseId Integer Id of the warehouse to add a tag to
warehouseTag String The tag to add

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

  • Content-Type: application/json
  • Accept: application/json

deleteWarehouseTag

deleteWarehouseTag(warehouseId, warehouseTag)

Delete a tag for a warehouse.

Deletes an existing warehouse tag using the specified data.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

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

var apiInstance = new infoplus.WarehouseApi()

var warehouseId = 56; // {Integer} Id of the warehouse to remove tag from

var warehouseTag = "warehouseTag_example"; // {String} The tag to delete


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteWarehouseTag(warehouseId, warehouseTag, callback);

Parameters

Name Type Description Notes
warehouseId Integer Id of the warehouse to remove tag from
warehouseTag String The tag to delete

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getDuplicateWarehouseById

Warehouse getDuplicateWarehouseById(warehouseId)

Get a duplicated a warehouse by id

Returns a duplicated warehouse identified by the specified id.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

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

var apiInstance = new infoplus.WarehouseApi()

var warehouseId = 56; // {Integer} Id of the warehouse to be duplicated.


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

Parameters

Name Type Description Notes
warehouseId Integer Id of the warehouse to be duplicated.

Return type

Warehouse

Authorization

api_key

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getWarehouseByFilter

[Warehouse] getWarehouseByFilter(opts)

Search warehouses by filter

Returns the list of warehouses that match the given filter.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

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

var apiInstance = new infoplus.WarehouseApi()

var opts = { 
  'filter': "filter_example", // {String} Query string, used to filter results.
  'page': 56, // {Integer} Result page number.  Defaults to 1.
  'limit': 56, // {Integer} Maximum results per page.  Defaults to 20.  Max allowed value is 250.
  'sort': "sort_example" // {String} Sort results by specified field.
};

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

Parameters

Name Type Description Notes
filter String Query string, used to filter results. [optional]
page Integer Result page number. Defaults to 1. [optional]
limit Integer Maximum results per page. Defaults to 20. Max allowed value is 250. [optional]
sort String Sort results by specified field. [optional]

Return type

[Warehouse]

Authorization

api_key

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getWarehouseById

Warehouse getWarehouseById(warehouseId)

Get a warehouse by id

Returns the warehouse identified by the specified id.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

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

var apiInstance = new infoplus.WarehouseApi()

var warehouseId = 56; // {Integer} Id of the warehouse to be returned.


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

Parameters

Name Type Description Notes
warehouseId Integer Id of the warehouse to be returned.

Return type

Warehouse

Authorization

api_key

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

getWarehouseTags

getWarehouseTags(warehouseId)

Get the tags for a warehouse.

Get all existing warehouse tags.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

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

var apiInstance = new infoplus.WarehouseApi()

var warehouseId = 56; // {Integer} Id of the warehouse to get tags for


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getWarehouseTags(warehouseId, callback);

Parameters

Name Type Description Notes
warehouseId Integer Id of the warehouse to get tags for

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

  • Content-Type: Not defined
  • Accept: application/json

updateWarehouse

updateWarehouse(body)

Update a warehouse

Updates an existing warehouse using the specified data.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

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

var apiInstance = new infoplus.WarehouseApi()

var body = new infoplus.Warehouse(); // {Warehouse} Warehouse to be updated.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateWarehouse(body, callback);

Parameters

Name Type Description Notes
body Warehouse Warehouse to be updated.

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

  • Content-Type: application/json
  • Accept: application/json

updateWarehouseCustomFields

updateWarehouseCustomFields(body)

Update a warehouse custom fields

Updates an existing warehouse custom fields using the specified data.

Example

var infoplus = require('infoplus-javascript-client');
var defaultClient = infoplus.ApiClient.default;

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

var apiInstance = new infoplus.WarehouseApi()

var body = new infoplus.Warehouse(); // {Warehouse} Warehouse to be updated.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateWarehouseCustomFields(body, callback);

Parameters

Name Type Description Notes
body Warehouse Warehouse to be updated.

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

  • Content-Type: application/json
  • Accept: application/json