Infoplus\InventoryAdjustmentApi

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

Method	HTTP request	Description
addInventoryAdjustmentAudit	PUT /beta/inventoryAdjustment/{inventoryAdjustmentId}/audit/{inventoryAdjustmentAudit}	Add new audit for an inventoryAdjustment
addInventoryAdjustmentFile	POST /beta/inventoryAdjustment/{inventoryAdjustmentId}/file/{fileName}	Attach a file to an inventoryAdjustment
addInventoryAdjustmentFileByURL	POST /beta/inventoryAdjustment/{inventoryAdjustmentId}/file	Attach a file to an inventoryAdjustment by URL.
addInventoryAdjustmentTag	PUT /beta/inventoryAdjustment/{inventoryAdjustmentId}/tag/{inventoryAdjustmentTag}	Add new tags for an inventoryAdjustment.
deleteInventoryAdjustmentFile	DELETE /beta/inventoryAdjustment/{inventoryAdjustmentId}/file/{fileId}	Delete a file for an inventoryAdjustment.
deleteInventoryAdjustmentTag	DELETE /beta/inventoryAdjustment/{inventoryAdjustmentId}/tag/{inventoryAdjustmentTag}	Delete a tag for an inventoryAdjustment.
getDuplicateInventoryAdjustmentById	GET /beta/inventoryAdjustment/duplicate/{inventoryAdjustmentId}	Get a duplicated an inventoryAdjustment by id
getInventoryAdjustmentByFilter	GET /beta/inventoryAdjustment/search	Search inventoryAdjustments by filter
getInventoryAdjustmentById	GET /beta/inventoryAdjustment/{inventoryAdjustmentId}	Get an inventoryAdjustment by id
getInventoryAdjustmentFiles	GET /beta/inventoryAdjustment/{inventoryAdjustmentId}/file	Get the files for an inventoryAdjustment.
getInventoryAdjustmentTags	GET /beta/inventoryAdjustment/{inventoryAdjustmentId}/tag	Get the tags for an inventoryAdjustment.
updateInventoryAdjustmentCustomFields	PUT /beta/inventoryAdjustment/customFields	Update an inventoryAdjustment custom fields

addInventoryAdjustmentAudit

addInventoryAdjustmentAudit($inventory_adjustment_id, $inventory_adjustment_audit)

Add new audit for an inventoryAdjustment

Adds an audit to an existing inventoryAdjustment.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to add an audit to
$inventory_adjustment_audit = "inventory_adjustment_audit_example"; // string | The audit to add

try {
    $apiInstance->addInventoryAdjustmentAudit($inventory_adjustment_id, $inventory_adjustment_audit);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->addInventoryAdjustmentAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
inventory_adjustment_id	int	Id of the inventoryAdjustment to add an audit to
inventory_adjustment_audit	string	The audit to add

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addInventoryAdjustmentFile

addInventoryAdjustmentFile($inventory_adjustment_id, $file_name)

Attach a file to an inventoryAdjustment

Adds a file to an existing inventoryAdjustment.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to add a file to
$file_name = "file_name_example"; // string | Name of file

try {
    $apiInstance->addInventoryAdjustmentFile($inventory_adjustment_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->addInventoryAdjustmentFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
inventory_adjustment_id	int	Id of the inventoryAdjustment to add a file to
file_name	string	Name of file

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addInventoryAdjustmentFileByURL

addInventoryAdjustmentFileByURL($body, $inventory_adjustment_id)

Attach a file to an inventoryAdjustment by URL.

Adds a file to an existing inventoryAdjustment by URL.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Infoplus\Infoplus\Model\RecordFile(); // \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used.
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to add an file to

try {
    $apiInstance->addInventoryAdjustmentFileByURL($body, $inventory_adjustment_id);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->addInventoryAdjustmentFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\RecordFile	The url and optionly fileName to be used.
inventory_adjustment_id	int	Id of the inventoryAdjustment to add an file to

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addInventoryAdjustmentTag

addInventoryAdjustmentTag($inventory_adjustment_id, $inventory_adjustment_tag)

Add new tags for an inventoryAdjustment.

Adds a tag to an existing inventoryAdjustment.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to add a tag to
$inventory_adjustment_tag = "inventory_adjustment_tag_example"; // string | The tag to add

try {
    $apiInstance->addInventoryAdjustmentTag($inventory_adjustment_id, $inventory_adjustment_tag);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->addInventoryAdjustmentTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
inventory_adjustment_id	int	Id of the inventoryAdjustment to add a tag to
inventory_adjustment_tag	string	The tag to add

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteInventoryAdjustmentFile

deleteInventoryAdjustmentFile($inventory_adjustment_id, $file_id)

Delete a file for an inventoryAdjustment.

Deletes an existing inventoryAdjustment file using the specified data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to remove file from
$file_id = 56; // int | Id of the file to delete

try {
    $apiInstance->deleteInventoryAdjustmentFile($inventory_adjustment_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->deleteInventoryAdjustmentFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
inventory_adjustment_id	int	Id of the inventoryAdjustment to remove file from
file_id	int	Id of the file to delete

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteInventoryAdjustmentTag

deleteInventoryAdjustmentTag($inventory_adjustment_id, $inventory_adjustment_tag)

Delete a tag for an inventoryAdjustment.

Deletes an existing inventoryAdjustment tag using the specified data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to remove tag from
$inventory_adjustment_tag = "inventory_adjustment_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteInventoryAdjustmentTag($inventory_adjustment_id, $inventory_adjustment_tag);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->deleteInventoryAdjustmentTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
inventory_adjustment_id	int	Id of the inventoryAdjustment to remove tag from
inventory_adjustment_tag	string	The tag to delete

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDuplicateInventoryAdjustmentById

\Infoplus\Infoplus\Model\InventoryAdjustment getDuplicateInventoryAdjustmentById($inventory_adjustment_id)

Get a duplicated an inventoryAdjustment by id

Returns a duplicated inventoryAdjustment identified by the specified id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to be duplicated.

try {
    $result = $apiInstance->getDuplicateInventoryAdjustmentById($inventory_adjustment_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->getDuplicateInventoryAdjustmentById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
inventory_adjustment_id	int	Id of the inventoryAdjustment to be duplicated.

Return type

\Infoplus\Infoplus\Model\InventoryAdjustment

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInventoryAdjustmentByFilter

\Infoplus\Infoplus\Model\InventoryAdjustment[] getInventoryAdjustmentByFilter($filter, $page, $limit, $sort)

Search inventoryAdjustments by filter

Returns the list of inventoryAdjustments that match the given filter.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$filter = "filter_example"; // string | Query string, used to filter results.
$page = 56; // int | Result page number.  Defaults to 1.
$limit = 56; // int | Maximum results per page.  Defaults to 20.  Max allowed value is 250.
$sort = "sort_example"; // string | Sort results by specified field.

try {
    $result = $apiInstance->getInventoryAdjustmentByFilter($filter, $page, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->getInventoryAdjustmentByFilter: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\Infoplus\Infoplus\Model\InventoryAdjustment[]

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInventoryAdjustmentById

\Infoplus\Infoplus\Model\InventoryAdjustment getInventoryAdjustmentById($inventory_adjustment_id)

Get an inventoryAdjustment by id

Returns the inventoryAdjustment identified by the specified id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to be returned.

try {
    $result = $apiInstance->getInventoryAdjustmentById($inventory_adjustment_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->getInventoryAdjustmentById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
inventory_adjustment_id	int	Id of the inventoryAdjustment to be returned.

Return type

\Infoplus\Infoplus\Model\InventoryAdjustment

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInventoryAdjustmentFiles

getInventoryAdjustmentFiles($inventory_adjustment_id)

Get the files for an inventoryAdjustment.

Get all existing inventoryAdjustment files.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to get files for

try {
    $apiInstance->getInventoryAdjustmentFiles($inventory_adjustment_id);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->getInventoryAdjustmentFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
inventory_adjustment_id	int	Id of the inventoryAdjustment to get files for

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getInventoryAdjustmentTags

getInventoryAdjustmentTags($inventory_adjustment_id)

Get the tags for an inventoryAdjustment.

Get all existing inventoryAdjustment tags.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$inventory_adjustment_id = 56; // int | Id of the inventoryAdjustment to get tags for

try {
    $apiInstance->getInventoryAdjustmentTags($inventory_adjustment_id);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->getInventoryAdjustmentTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
inventory_adjustment_id	int	Id of the inventoryAdjustment to get tags for

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateInventoryAdjustmentCustomFields

updateInventoryAdjustmentCustomFields($body)

Update an inventoryAdjustment custom fields

Updates an existing inventoryAdjustment custom fields using the specified data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\InventoryAdjustmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Infoplus\Infoplus\Model\InventoryAdjustment(); // \Infoplus\Infoplus\Model\InventoryAdjustment | InventoryAdjustment to be updated.

try {
    $apiInstance->updateInventoryAdjustmentCustomFields($body);
} catch (Exception $e) {
    echo 'Exception when calling InventoryAdjustmentApi->updateInventoryAdjustmentCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\InventoryAdjustment	InventoryAdjustment to be updated.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

InventoryAdjustmentApi.md

Latest commit

History

InventoryAdjustmentApi.md

File metadata and controls

Infoplus\InventoryAdjustmentApi

addInventoryAdjustmentAudit

Example

Parameters

Return type

Authorization

HTTP request headers

addInventoryAdjustmentFile

Example

Parameters

Return type

Authorization

HTTP request headers

addInventoryAdjustmentFileByURL

Example

Parameters

Return type

Authorization

HTTP request headers

addInventoryAdjustmentTag

Example

Parameters

Return type

Authorization

HTTP request headers

deleteInventoryAdjustmentFile

Example

Parameters

Return type

Authorization

HTTP request headers

deleteInventoryAdjustmentTag

Example

Parameters

Return type

Authorization

HTTP request headers

getDuplicateInventoryAdjustmentById

Example

Parameters

Return type

Authorization

HTTP request headers

getInventoryAdjustmentByFilter

Example

Parameters

Return type

Authorization

HTTP request headers

getInventoryAdjustmentById

Example

Parameters

Return type

Authorization

HTTP request headers

getInventoryAdjustmentFiles

Example

Parameters

Return type

Authorization

HTTP request headers

getInventoryAdjustmentTags

Example

Parameters

Return type

Authorization

HTTP request headers

updateInventoryAdjustmentCustomFields

Example

Parameters

Return type

Authorization

HTTP request headers