Skip to content

Latest commit

 

History

History
618 lines (425 loc) · 19.4 KB

OrderSourceReservationApi.md

File metadata and controls

618 lines (425 loc) · 19.4 KB
Raw

infoplus.OrderSourceReservationApi

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

Method HTTP request Description
addOrderSourceReservation POST /beta/orderSourceReservation Create an orderSourceReservation
addOrderSourceReservationAudit PUT /beta/orderSourceReservation/{orderSourceReservationId}/audit/{orderSourceReservationAudit} Add new audit for an orderSourceReservation
addOrderSourceReservationTag PUT /beta/orderSourceReservation/{orderSourceReservationId}/tag/{orderSourceReservationTag} Add new tags for an orderSourceReservation.
deleteOrderSourceReservation DELETE /beta/orderSourceReservation/{orderSourceReservationId} Delete an orderSourceReservation
deleteOrderSourceReservationTag DELETE /beta/orderSourceReservation/{orderSourceReservationId}/tag/{orderSourceReservationTag} Delete a tag for an orderSourceReservation.
getDuplicateOrderSourceReservationById GET /beta/orderSourceReservation/duplicate/{orderSourceReservationId} Get a duplicated an orderSourceReservation by id
getOrderSourceReservationByFilter GET /beta/orderSourceReservation/search Search orderSourceReservations by filter
getOrderSourceReservationById GET /beta/orderSourceReservation/{orderSourceReservationId} Get an orderSourceReservation by id
getOrderSourceReservationTags GET /beta/orderSourceReservation/{orderSourceReservationId}/tag Get the tags for an orderSourceReservation.
updateOrderSourceReservation PUT /beta/orderSourceReservation Update an orderSourceReservation
updateOrderSourceReservationCustomFields PUT /beta/orderSourceReservation/customFields Update an orderSourceReservation custom fields

addOrderSourceReservation

OrderSourceReservation addOrderSourceReservation(body)

Create an orderSourceReservation

Inserts a new orderSourceReservation 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.OrderSourceReservationApi()

var body = new infoplus.OrderSourceReservation(); // {OrderSourceReservation} OrderSourceReservation to be inserted.


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

Parameters

Name Type Description Notes
body OrderSourceReservation OrderSourceReservation to be inserted.

Return type

OrderSourceReservation

Authorization

api_key

HTTP reuqest headers

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

addOrderSourceReservationAudit

addOrderSourceReservationAudit(orderSourceReservationId, orderSourceReservationAudit)

Add new audit for an orderSourceReservation

Adds an audit to an existing orderSourceReservation.

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.OrderSourceReservationApi()

var orderSourceReservationId = 56; // {Integer} Id of the orderSourceReservation to add an audit to

var orderSourceReservationAudit = "orderSourceReservationAudit_example"; // {String} The audit to add


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

Parameters

Name Type Description Notes
orderSourceReservationId Integer Id of the orderSourceReservation to add an audit to
orderSourceReservationAudit String The audit to add

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

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

addOrderSourceReservationTag

addOrderSourceReservationTag(orderSourceReservationId, orderSourceReservationTag)

Add new tags for an orderSourceReservation.

Adds a tag to an existing orderSourceReservation.

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.OrderSourceReservationApi()

var orderSourceReservationId = 56; // {Integer} Id of the orderSourceReservation to add a tag to

var orderSourceReservationTag = "orderSourceReservationTag_example"; // {String} The tag to add


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

Parameters

Name Type Description Notes
orderSourceReservationId Integer Id of the orderSourceReservation to add a tag to
orderSourceReservationTag String The tag to add

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

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

deleteOrderSourceReservation

deleteOrderSourceReservation(orderSourceReservationId)

Delete an orderSourceReservation

Deletes the orderSourceReservation 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.OrderSourceReservationApi()

var orderSourceReservationId = 56; // {Integer} Id of the orderSourceReservation to be deleted.


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

Parameters

Name Type Description Notes
orderSourceReservationId Integer Id of the orderSourceReservation to be deleted.

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

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

deleteOrderSourceReservationTag

deleteOrderSourceReservationTag(orderSourceReservationId, orderSourceReservationTag)

Delete a tag for an orderSourceReservation.

Deletes an existing orderSourceReservation 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.OrderSourceReservationApi()

var orderSourceReservationId = 56; // {Integer} Id of the orderSourceReservation to remove tag from

var orderSourceReservationTag = "orderSourceReservationTag_example"; // {String} The tag to delete


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

Parameters

Name Type Description Notes
orderSourceReservationId Integer Id of the orderSourceReservation to remove tag from
orderSourceReservationTag String The tag to delete

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

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

getDuplicateOrderSourceReservationById

OrderSourceReservation getDuplicateOrderSourceReservationById(orderSourceReservationId)

Get a duplicated an orderSourceReservation by id

Returns a duplicated orderSourceReservation 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.OrderSourceReservationApi()

var orderSourceReservationId = 56; // {Integer} Id of the orderSourceReservation to be duplicated.


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

Parameters

Name Type Description Notes
orderSourceReservationId Integer Id of the orderSourceReservation to be duplicated.

Return type

OrderSourceReservation

Authorization

api_key

HTTP reuqest headers

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

getOrderSourceReservationByFilter

[OrderSourceReservation] getOrderSourceReservationByFilter(opts)

Search orderSourceReservations by filter

Returns the list of orderSourceReservations 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.OrderSourceReservationApi()

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.getOrderSourceReservationByFilter(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

[OrderSourceReservation]

Authorization

api_key

HTTP reuqest headers

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

getOrderSourceReservationById

OrderSourceReservation getOrderSourceReservationById(orderSourceReservationId)

Get an orderSourceReservation by id

Returns the orderSourceReservation 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.OrderSourceReservationApi()

var orderSourceReservationId = 56; // {Integer} Id of the orderSourceReservation to be returned.


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

Parameters

Name Type Description Notes
orderSourceReservationId Integer Id of the orderSourceReservation to be returned.

Return type

OrderSourceReservation

Authorization

api_key

HTTP reuqest headers

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

getOrderSourceReservationTags

getOrderSourceReservationTags(orderSourceReservationId)

Get the tags for an orderSourceReservation.

Get all existing orderSourceReservation 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.OrderSourceReservationApi()

var orderSourceReservationId = 56; // {Integer} Id of the orderSourceReservation to get tags for


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

Parameters

Name Type Description Notes
orderSourceReservationId Integer Id of the orderSourceReservation to get tags for

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

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

updateOrderSourceReservation

updateOrderSourceReservation(body)

Update an orderSourceReservation

Updates an existing orderSourceReservation 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.OrderSourceReservationApi()

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


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

Parameters

Name Type Description Notes
body OrderSourceReservation OrderSourceReservation to be updated.

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

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

updateOrderSourceReservationCustomFields

updateOrderSourceReservationCustomFields(body)

Update an orderSourceReservation custom fields

Updates an existing orderSourceReservation 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.OrderSourceReservationApi()

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


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

Parameters

Name Type Description Notes
body OrderSourceReservation OrderSourceReservation to be updated.

Return type

null (empty response body)

Authorization

api_key

HTTP reuqest headers

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