Skip to content

Latest commit

 

History

History
689 lines (493 loc) · 25 KB

WarehouseDocumentApi.md

File metadata and controls

689 lines (493 loc) · 25 KB

Infoplus\WarehouseDocumentApi

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

Method HTTP request Description
addWarehouseDocumentAudit PUT /beta/warehouseDocument/{warehouseDocumentId}/audit/{warehouseDocumentAudit} Add new audit for a warehouseDocument
addWarehouseDocumentFile POST /beta/warehouseDocument/{warehouseDocumentId}/file/{fileName} Attach a file to a warehouseDocument
addWarehouseDocumentFileByURL POST /beta/warehouseDocument/{warehouseDocumentId}/file Attach a file to a warehouseDocument by URL.
addWarehouseDocumentTag PUT /beta/warehouseDocument/{warehouseDocumentId}/tag/{warehouseDocumentTag} Add new tags for a warehouseDocument.
deleteWarehouseDocumentFile DELETE /beta/warehouseDocument/{warehouseDocumentId}/file/{fileId} Delete a file for a warehouseDocument.
deleteWarehouseDocumentTag DELETE /beta/warehouseDocument/{warehouseDocumentId}/tag/{warehouseDocumentTag} Delete a tag for a warehouseDocument.
getDuplicateWarehouseDocumentById GET /beta/warehouseDocument/duplicate/{warehouseDocumentId} Get a duplicated a warehouseDocument by id
getWarehouseDocumentByFilter GET /beta/warehouseDocument/search Search warehouseDocuments by filter
getWarehouseDocumentById GET /beta/warehouseDocument/{warehouseDocumentId} Get a warehouseDocument by id
getWarehouseDocumentFiles GET /beta/warehouseDocument/{warehouseDocumentId}/file Get the files for a warehouseDocument.
getWarehouseDocumentTags GET /beta/warehouseDocument/{warehouseDocumentId}/tag Get the tags for a warehouseDocument.
updateWarehouseDocumentCustomFields PUT /beta/warehouseDocument/customFields Update a warehouseDocument custom fields

addWarehouseDocumentAudit

addWarehouseDocumentAudit($warehouse_document_id, $warehouse_document_audit)

Add new audit for a warehouseDocument

Adds an audit to an existing warehouseDocument.

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\WarehouseDocumentApi(
    // 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
);
$warehouse_document_id = 56; // int | Id of the warehouseDocument to add an audit to
$warehouse_document_audit = "warehouse_document_audit_example"; // string | The audit to add

try {
    $apiInstance->addWarehouseDocumentAudit($warehouse_document_id, $warehouse_document_audit);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseDocumentApi->addWarehouseDocumentAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
warehouse_document_id int Id of the warehouseDocument to add an audit to
warehouse_document_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]

addWarehouseDocumentFile

addWarehouseDocumentFile($warehouse_document_id, $file_name)

Attach a file to a warehouseDocument

Adds a file to an existing warehouseDocument.

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

try {
    $apiInstance->addWarehouseDocumentFile($warehouse_document_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseDocumentApi->addWarehouseDocumentFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

addWarehouseDocumentFileByURL

addWarehouseDocumentFileByURL($body, $warehouse_document_id)

Attach a file to a warehouseDocument by URL.

Adds a file to an existing warehouseDocument 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\WarehouseDocumentApi(
    // 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.
$warehouse_document_id = 56; // int | Id of the warehouseDocument to add an file to

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

Parameters

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

addWarehouseDocumentTag

addWarehouseDocumentTag($warehouse_document_id, $warehouse_document_tag)

Add new tags for a warehouseDocument.

Adds a tag to an existing warehouseDocument.

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\WarehouseDocumentApi(
    // 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
);
$warehouse_document_id = 56; // int | Id of the warehouseDocument to add a tag to
$warehouse_document_tag = "warehouse_document_tag_example"; // string | The tag to add

try {
    $apiInstance->addWarehouseDocumentTag($warehouse_document_id, $warehouse_document_tag);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseDocumentApi->addWarehouseDocumentTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
warehouse_document_id int Id of the warehouseDocument to add a tag to
warehouse_document_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]

deleteWarehouseDocumentFile

deleteWarehouseDocumentFile($warehouse_document_id, $file_id)

Delete a file for a warehouseDocument.

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

try {
    $apiInstance->deleteWarehouseDocumentFile($warehouse_document_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseDocumentApi->deleteWarehouseDocumentFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

deleteWarehouseDocumentTag

deleteWarehouseDocumentTag($warehouse_document_id, $warehouse_document_tag)

Delete a tag for a warehouseDocument.

Deletes an existing warehouseDocument 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\WarehouseDocumentApi(
    // 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
);
$warehouse_document_id = 56; // int | Id of the warehouseDocument to remove tag from
$warehouse_document_tag = "warehouse_document_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteWarehouseDocumentTag($warehouse_document_id, $warehouse_document_tag);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseDocumentApi->deleteWarehouseDocumentTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
warehouse_document_id int Id of the warehouseDocument to remove tag from
warehouse_document_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]

getDuplicateWarehouseDocumentById

\Infoplus\Infoplus\Model\WarehouseDocument getDuplicateWarehouseDocumentById($warehouse_document_id)

Get a duplicated a warehouseDocument by id

Returns a duplicated warehouseDocument 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\WarehouseDocumentApi(
    // 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
);
$warehouse_document_id = 56; // int | Id of the warehouseDocument to be duplicated.

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

Parameters

Name Type Description Notes
warehouse_document_id int Id of the warehouseDocument to be duplicated.

Return type

\Infoplus\Infoplus\Model\WarehouseDocument

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]

getWarehouseDocumentByFilter

\Infoplus\Infoplus\Model\WarehouseDocument[] getWarehouseDocumentByFilter($filter, $page, $limit, $sort)

Search warehouseDocuments by filter

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

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]

getWarehouseDocumentById

\Infoplus\Infoplus\Model\WarehouseDocument getWarehouseDocumentById($warehouse_document_id)

Get a warehouseDocument by id

Returns the warehouseDocument 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\WarehouseDocumentApi(
    // 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
);
$warehouse_document_id = 56; // int | Id of the warehouseDocument to be returned.

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

Parameters

Name Type Description Notes
warehouse_document_id int Id of the warehouseDocument to be returned.

Return type

\Infoplus\Infoplus\Model\WarehouseDocument

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]

getWarehouseDocumentFiles

getWarehouseDocumentFiles($warehouse_document_id)

Get the files for a warehouseDocument.

Get all existing warehouseDocument 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\WarehouseDocumentApi(
    // 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
);
$warehouse_document_id = 56; // int | Id of the warehouseDocument to get files for

try {
    $apiInstance->getWarehouseDocumentFiles($warehouse_document_id);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseDocumentApi->getWarehouseDocumentFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

getWarehouseDocumentTags

getWarehouseDocumentTags($warehouse_document_id)

Get the tags for a warehouseDocument.

Get all existing warehouseDocument 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\WarehouseDocumentApi(
    // 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
);
$warehouse_document_id = 56; // int | Id of the warehouseDocument to get tags for

try {
    $apiInstance->getWarehouseDocumentTags($warehouse_document_id);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseDocumentApi->getWarehouseDocumentTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

updateWarehouseDocumentCustomFields

updateWarehouseDocumentCustomFields($body)

Update a warehouseDocument custom fields

Updates an existing warehouseDocument 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\WarehouseDocumentApi(
    // 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\WarehouseDocument(); // \Infoplus\Infoplus\Model\WarehouseDocument | WarehouseDocument to be updated.

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

Parameters

Name Type Description Notes
body \Infoplus\Infoplus\Model\WarehouseDocument WarehouseDocument 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]