All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api
Method | HTTP request | Description |
---|---|---|
addCartonContent | POST /beta/cartonContent | Create a cartonContent |
addCartonContentAudit | PUT /beta/cartonContent/{cartonContentId}/audit/{cartonContentAudit} | Add new audit for a cartonContent |
addCartonContentFile | POST /beta/cartonContent/{cartonContentId}/file/{fileName} | Attach a file to a cartonContent |
addCartonContentFileByURL | POST /beta/cartonContent/{cartonContentId}/file | Attach a file to a cartonContent by URL. |
addCartonContentTag | PUT /beta/cartonContent/{cartonContentId}/tag/{cartonContentTag} | Add new tags for a cartonContent. |
deleteCartonContent | DELETE /beta/cartonContent/{cartonContentId} | Delete a cartonContent |
deleteCartonContentFile | DELETE /beta/cartonContent/{cartonContentId}/file/{fileId} | Delete a file for a cartonContent. |
deleteCartonContentTag | DELETE /beta/cartonContent/{cartonContentId}/tag/{cartonContentTag} | Delete a tag for a cartonContent. |
getCartonContentByFilter | GET /beta/cartonContent/search | Search cartonContents by filter |
getCartonContentById | GET /beta/cartonContent/{cartonContentId} | Get a cartonContent by id |
getCartonContentFiles | GET /beta/cartonContent/{cartonContentId}/file | Get the files for a cartonContent. |
getCartonContentTags | GET /beta/cartonContent/{cartonContentId}/tag | Get the tags for a cartonContent. |
getDuplicateCartonContentById | GET /beta/cartonContent/duplicate/{cartonContentId} | Get a duplicated a cartonContent by id |
updateCartonContent | PUT /beta/cartonContent | Update a cartonContent |
updateCartonContentCustomFields | PUT /beta/cartonContent/customFields | Update a cartonContent custom fields |
\Infoplus\Infoplus\Model\CartonContent addCartonContent($body)
Create a cartonContent
Inserts a new cartonContent using the specified data.
<?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\CartonContentApi(
// 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\CartonContent(); // \Infoplus\Infoplus\Model\CartonContent | CartonContent to be inserted.
try {
$result = $apiInstance->addCartonContent($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->addCartonContent: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\CartonContent | CartonContent to be inserted. |
\Infoplus\Infoplus\Model\CartonContent
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addCartonContentAudit($carton_content_id, $carton_content_audit)
Add new audit for a cartonContent
Adds an audit to an existing cartonContent.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to add an audit to
$carton_content_audit = "carton_content_audit_example"; // string | The audit to add
try {
$apiInstance->addCartonContentAudit($carton_content_id, $carton_content_audit);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->addCartonContentAudit: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to add an audit to | |
carton_content_audit | string | The audit to add |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addCartonContentFile($carton_content_id, $file_name)
Attach a file to a cartonContent
Adds a file to an existing cartonContent.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to add a file to
$file_name = "file_name_example"; // string | Name of file
try {
$apiInstance->addCartonContentFile($carton_content_id, $file_name);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->addCartonContentFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to add a file to | |
file_name | string | Name of file |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addCartonContentFileByURL($body, $carton_content_id)
Attach a file to a cartonContent by URL.
Adds a file to an existing cartonContent by URL.
<?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\CartonContentApi(
// 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.
$carton_content_id = 56; // int | Id of the cartonContent to add an file to
try {
$apiInstance->addCartonContentFileByURL($body, $carton_content_id);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->addCartonContentFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used. | |
carton_content_id | int | Id of the cartonContent to add an file to |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addCartonContentTag($carton_content_id, $carton_content_tag)
Add new tags for a cartonContent.
Adds a tag to an existing cartonContent.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to add a tag to
$carton_content_tag = "carton_content_tag_example"; // string | The tag to add
try {
$apiInstance->addCartonContentTag($carton_content_id, $carton_content_tag);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->addCartonContentTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to add a tag to | |
carton_content_tag | string | The tag to add |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteCartonContent($carton_content_id)
Delete a cartonContent
Deletes the cartonContent identified by the specified id.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to be deleted.
try {
$apiInstance->deleteCartonContent($carton_content_id);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->deleteCartonContent: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to be deleted. |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteCartonContentFile($carton_content_id, $file_id)
Delete a file for a cartonContent.
Deletes an existing cartonContent file using the specified data.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to remove file from
$file_id = 56; // int | Id of the file to delete
try {
$apiInstance->deleteCartonContentFile($carton_content_id, $file_id);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->deleteCartonContentFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to remove file from | |
file_id | int | Id of the file to delete |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteCartonContentTag($carton_content_id, $carton_content_tag)
Delete a tag for a cartonContent.
Deletes an existing cartonContent tag using the specified data.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to remove tag from
$carton_content_tag = "carton_content_tag_example"; // string | The tag to delete
try {
$apiInstance->deleteCartonContentTag($carton_content_id, $carton_content_tag);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->deleteCartonContentTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to remove tag from | |
carton_content_tag | string | The tag to delete |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\CartonContent[] getCartonContentByFilter($filter, $page, $limit, $sort)
Search cartonContents by filter
Returns the list of cartonContents that match the given filter.
<?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\CartonContentApi(
// 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->getCartonContentByFilter($filter, $page, $limit, $sort);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->getCartonContentByFilter: ', $e->getMessage(), PHP_EOL;
}
?>
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] |
\Infoplus\Infoplus\Model\CartonContent[]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\CartonContent getCartonContentById($carton_content_id)
Get a cartonContent by id
Returns the cartonContent identified by the specified id.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to be returned.
try {
$result = $apiInstance->getCartonContentById($carton_content_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->getCartonContentById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to be returned. |
\Infoplus\Infoplus\Model\CartonContent
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getCartonContentFiles($carton_content_id)
Get the files for a cartonContent.
Get all existing cartonContent files.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to get files for
try {
$apiInstance->getCartonContentFiles($carton_content_id);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->getCartonContentFiles: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to get files for |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getCartonContentTags($carton_content_id)
Get the tags for a cartonContent.
Get all existing cartonContent tags.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to get tags for
try {
$apiInstance->getCartonContentTags($carton_content_id);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->getCartonContentTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to get tags for |
void (empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\CartonContent getDuplicateCartonContentById($carton_content_id)
Get a duplicated a cartonContent by id
Returns a duplicated cartonContent identified by the specified id.
<?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\CartonContentApi(
// 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
);
$carton_content_id = 56; // int | Id of the cartonContent to be duplicated.
try {
$result = $apiInstance->getDuplicateCartonContentById($carton_content_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->getDuplicateCartonContentById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
carton_content_id | int | Id of the cartonContent to be duplicated. |
\Infoplus\Infoplus\Model\CartonContent
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateCartonContent($body)
Update a cartonContent
Updates an existing cartonContent using the specified data.
<?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\CartonContentApi(
// 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\CartonContent(); // \Infoplus\Infoplus\Model\CartonContent | CartonContent to be updated.
try {
$apiInstance->updateCartonContent($body);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->updateCartonContent: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\CartonContent | CartonContent to be updated. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
updateCartonContentCustomFields($body)
Update a cartonContent custom fields
Updates an existing cartonContent custom fields using the specified data.
<?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\CartonContentApi(
// 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\CartonContent(); // \Infoplus\Infoplus\Model\CartonContent | CartonContent to be updated.
try {
$apiInstance->updateCartonContentCustomFields($body);
} catch (Exception $e) {
echo 'Exception when calling CartonContentApi->updateCartonContentCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\CartonContent | CartonContent to be updated. |
void (empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]