Skip to content

Latest commit

 

History

History
634 lines (454 loc) · 23 KB

InventorySnapshotApi.md

File metadata and controls

634 lines (454 loc) · 23 KB

Infoplus\InventorySnapshotApi

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

Method HTTP request Description
addInventorySnapshotAudit PUT /beta/inventorySnapshot/{inventorySnapshotId}/audit/{inventorySnapshotAudit} Add new audit for an inventorySnapshot
addInventorySnapshotFile POST /beta/inventorySnapshot/{inventorySnapshotId}/file/{fileName} Attach a file to an inventorySnapshot
addInventorySnapshotFileByURL POST /beta/inventorySnapshot/{inventorySnapshotId}/file Attach a file to an inventorySnapshot by URL.
addInventorySnapshotTag PUT /beta/inventorySnapshot/{inventorySnapshotId}/tag/{inventorySnapshotTag} Add new tags for an inventorySnapshot.
deleteInventorySnapshotFile DELETE /beta/inventorySnapshot/{inventorySnapshotId}/file/{fileId} Delete a file for an inventorySnapshot.
deleteInventorySnapshotTag DELETE /beta/inventorySnapshot/{inventorySnapshotId}/tag/{inventorySnapshotTag} Delete a tag for an inventorySnapshot.
getDuplicateInventorySnapshotById GET /beta/inventorySnapshot/duplicate/{inventorySnapshotId} Get a duplicated an inventorySnapshot by id
getInventorySnapshotByFilter GET /beta/inventorySnapshot/search Search inventorySnapshots by filter
getInventorySnapshotById GET /beta/inventorySnapshot/{inventorySnapshotId} Get an inventorySnapshot by id
getInventorySnapshotFiles GET /beta/inventorySnapshot/{inventorySnapshotId}/file Get the files for an inventorySnapshot.
getInventorySnapshotTags GET /beta/inventorySnapshot/{inventorySnapshotId}/tag Get the tags for an inventorySnapshot.

addInventorySnapshotAudit

addInventorySnapshotAudit($inventory_snapshot_id, $inventory_snapshot_audit)

Add new audit for an inventorySnapshot

Adds an audit to an existing inventorySnapshot.

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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to add an audit to
$inventory_snapshot_audit = "inventory_snapshot_audit_example"; // string | The audit to add

try {
    $apiInstance->addInventorySnapshotAudit($inventory_snapshot_id, $inventory_snapshot_audit);
} catch (Exception $e) {
    echo 'Exception when calling InventorySnapshotApi->addInventorySnapshotAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
inventory_snapshot_id int Id of the inventorySnapshot to add an audit to
inventory_snapshot_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]

addInventorySnapshotFile

addInventorySnapshotFile($inventory_snapshot_id, $file_name)

Attach a file to an inventorySnapshot

Adds a file to an existing inventorySnapshot.

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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to add a file to
$file_name = "file_name_example"; // string | Name of file

try {
    $apiInstance->addInventorySnapshotFile($inventory_snapshot_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling InventorySnapshotApi->addInventorySnapshotFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
inventory_snapshot_id int Id of the inventorySnapshot 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]

addInventorySnapshotFileByURL

addInventorySnapshotFileByURL($body, $inventory_snapshot_id)

Attach a file to an inventorySnapshot by URL.

Adds a file to an existing inventorySnapshot 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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to add an file to

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

Parameters

Name Type Description Notes
body \Infoplus\Infoplus\Model\RecordFile The url and optionly fileName to be used.
inventory_snapshot_id int Id of the inventorySnapshot 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]

addInventorySnapshotTag

addInventorySnapshotTag($inventory_snapshot_id, $inventory_snapshot_tag)

Add new tags for an inventorySnapshot.

Adds a tag to an existing inventorySnapshot.

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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to add a tag to
$inventory_snapshot_tag = "inventory_snapshot_tag_example"; // string | The tag to add

try {
    $apiInstance->addInventorySnapshotTag($inventory_snapshot_id, $inventory_snapshot_tag);
} catch (Exception $e) {
    echo 'Exception when calling InventorySnapshotApi->addInventorySnapshotTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
inventory_snapshot_id int Id of the inventorySnapshot to add a tag to
inventory_snapshot_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]

deleteInventorySnapshotFile

deleteInventorySnapshotFile($inventory_snapshot_id, $file_id)

Delete a file for an inventorySnapshot.

Deletes an existing inventorySnapshot 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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to remove file from
$file_id = 56; // int | Id of the file to delete

try {
    $apiInstance->deleteInventorySnapshotFile($inventory_snapshot_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling InventorySnapshotApi->deleteInventorySnapshotFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
inventory_snapshot_id int Id of the inventorySnapshot 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]

deleteInventorySnapshotTag

deleteInventorySnapshotTag($inventory_snapshot_id, $inventory_snapshot_tag)

Delete a tag for an inventorySnapshot.

Deletes an existing inventorySnapshot 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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to remove tag from
$inventory_snapshot_tag = "inventory_snapshot_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteInventorySnapshotTag($inventory_snapshot_id, $inventory_snapshot_tag);
} catch (Exception $e) {
    echo 'Exception when calling InventorySnapshotApi->deleteInventorySnapshotTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
inventory_snapshot_id int Id of the inventorySnapshot to remove tag from
inventory_snapshot_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]

getDuplicateInventorySnapshotById

\Infoplus\Infoplus\Model\InventorySnapshot getDuplicateInventorySnapshotById($inventory_snapshot_id)

Get a duplicated an inventorySnapshot by id

Returns a duplicated inventorySnapshot 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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to be duplicated.

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

Parameters

Name Type Description Notes
inventory_snapshot_id int Id of the inventorySnapshot to be duplicated.

Return type

\Infoplus\Infoplus\Model\InventorySnapshot

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]

getInventorySnapshotByFilter

\Infoplus\Infoplus\Model\InventorySnapshot[] getInventorySnapshotByFilter($filter, $page, $limit, $sort)

Search inventorySnapshots by filter

Returns the list of inventorySnapshots 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\InventorySnapshotApi(
    // 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->getInventorySnapshotByFilter($filter, $page, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InventorySnapshotApi->getInventorySnapshotByFilter: ', $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\InventorySnapshot[]

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]

getInventorySnapshotById

\Infoplus\Infoplus\Model\InventorySnapshot getInventorySnapshotById($inventory_snapshot_id)

Get an inventorySnapshot by id

Returns the inventorySnapshot 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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to be returned.

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

Parameters

Name Type Description Notes
inventory_snapshot_id int Id of the inventorySnapshot to be returned.

Return type

\Infoplus\Infoplus\Model\InventorySnapshot

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]

getInventorySnapshotFiles

getInventorySnapshotFiles($inventory_snapshot_id)

Get the files for an inventorySnapshot.

Get all existing inventorySnapshot 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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to get files for

try {
    $apiInstance->getInventorySnapshotFiles($inventory_snapshot_id);
} catch (Exception $e) {
    echo 'Exception when calling InventorySnapshotApi->getInventorySnapshotFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
inventory_snapshot_id int Id of the inventorySnapshot 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]

getInventorySnapshotTags

getInventorySnapshotTags($inventory_snapshot_id)

Get the tags for an inventorySnapshot.

Get all existing inventorySnapshot 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\InventorySnapshotApi(
    // 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_snapshot_id = 56; // int | Id of the inventorySnapshot to get tags for

try {
    $apiInstance->getInventorySnapshotTags($inventory_snapshot_id);
} catch (Exception $e) {
    echo 'Exception when calling InventorySnapshotApi->getInventorySnapshotTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
inventory_snapshot_id int Id of the inventorySnapshot 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]