All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api
Method | HTTP request | Description |
---|---|---|
addOrderLineActivity | POST /beta/orderLineActivity | Create an orderLineActivity |
addOrderLineActivityAudit | PUT /beta/orderLineActivity/{orderLineActivityId}/audit/{orderLineActivityAudit} | Add new audit for an orderLineActivity |
addOrderLineActivityFile | POST /beta/orderLineActivity/{orderLineActivityId}/file/{fileName} | Attach a file to an orderLineActivity |
addOrderLineActivityFileByURL | POST /beta/orderLineActivity/{orderLineActivityId}/file | Attach a file to an orderLineActivity by URL. |
addOrderLineActivityTag | PUT /beta/orderLineActivity/{orderLineActivityId}/tag/{orderLineActivityTag} | Add new tags for an orderLineActivity. |
deleteOrderLineActivity | DELETE /beta/orderLineActivity/{orderLineActivityId} | Delete an orderLineActivity |
deleteOrderLineActivityFile | DELETE /beta/orderLineActivity/{orderLineActivityId}/file/{fileId} | Delete a file for an orderLineActivity. |
deleteOrderLineActivityTag | DELETE /beta/orderLineActivity/{orderLineActivityId}/tag/{orderLineActivityTag} | Delete a tag for an orderLineActivity. |
getDuplicateOrderLineActivityById | GET /beta/orderLineActivity/duplicate/{orderLineActivityId} | Get a duplicated an orderLineActivity by id |
getOrderLineActivityByFilter | GET /beta/orderLineActivity/search | Search orderLineActivitys by filter |
getOrderLineActivityById | GET /beta/orderLineActivity/{orderLineActivityId} | Get an orderLineActivity by id |
getOrderLineActivityFiles | GET /beta/orderLineActivity/{orderLineActivityId}/file | Get the files for an orderLineActivity. |
getOrderLineActivityTags | GET /beta/orderLineActivity/{orderLineActivityId}/tag | Get the tags for an orderLineActivity. |
updateOrderLineActivity | PUT /beta/orderLineActivity | Update an orderLineActivity |
\Infoplus\Infoplus\Model\OrderLineActivity addOrderLineActivity($body)
Create an orderLineActivity
Inserts a new orderLineActivity 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\OrderLineActivityApi(
// 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\OrderLineActivity(); // \Infoplus\Infoplus\Model\OrderLineActivity | OrderLineActivity to be inserted.
try {
$result = $apiInstance->addOrderLineActivity($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->addOrderLineActivity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\OrderLineActivity | OrderLineActivity to be inserted. |
\Infoplus\Infoplus\Model\OrderLineActivity
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addOrderLineActivityAudit($order_line_activity_id, $order_line_activity_audit)
Add new audit for an orderLineActivity
Adds an audit to an existing orderLineActivity.
<?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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to add an audit to
$order_line_activity_audit = "order_line_activity_audit_example"; // string | The audit to add
try {
$apiInstance->addOrderLineActivityAudit($order_line_activity_id, $order_line_activity_audit);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->addOrderLineActivityAudit: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity to add an audit to | |
order_line_activity_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]
addOrderLineActivityFile($order_line_activity_id, $file_name)
Attach a file to an orderLineActivity
Adds a file to an existing orderLineActivity.
<?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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to add a file to
$file_name = "file_name_example"; // string | Name of file
try {
$apiInstance->addOrderLineActivityFile($order_line_activity_id, $file_name);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->addOrderLineActivityFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity 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]
addOrderLineActivityFileByURL($body, $order_line_activity_id)
Attach a file to an orderLineActivity by URL.
Adds a file to an existing orderLineActivity 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\OrderLineActivityApi(
// 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.
$order_line_activity_id = 56; // int | Id of the orderLineActivity to add an file to
try {
$apiInstance->addOrderLineActivityFileByURL($body, $order_line_activity_id);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->addOrderLineActivityFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used. | |
order_line_activity_id | int | Id of the orderLineActivity 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]
addOrderLineActivityTag($order_line_activity_id, $order_line_activity_tag)
Add new tags for an orderLineActivity.
Adds a tag to an existing orderLineActivity.
<?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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to add a tag to
$order_line_activity_tag = "order_line_activity_tag_example"; // string | The tag to add
try {
$apiInstance->addOrderLineActivityTag($order_line_activity_id, $order_line_activity_tag);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->addOrderLineActivityTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity to add a tag to | |
order_line_activity_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]
deleteOrderLineActivity($order_line_activity_id)
Delete an orderLineActivity
Deletes the orderLineActivity 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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to be deleted.
try {
$apiInstance->deleteOrderLineActivity($order_line_activity_id);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->deleteOrderLineActivity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity 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]
deleteOrderLineActivityFile($order_line_activity_id, $file_id)
Delete a file for an orderLineActivity.
Deletes an existing orderLineActivity 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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to remove file from
$file_id = 56; // int | Id of the file to delete
try {
$apiInstance->deleteOrderLineActivityFile($order_line_activity_id, $file_id);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->deleteOrderLineActivityFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity 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]
deleteOrderLineActivityTag($order_line_activity_id, $order_line_activity_tag)
Delete a tag for an orderLineActivity.
Deletes an existing orderLineActivity 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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to remove tag from
$order_line_activity_tag = "order_line_activity_tag_example"; // string | The tag to delete
try {
$apiInstance->deleteOrderLineActivityTag($order_line_activity_id, $order_line_activity_tag);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->deleteOrderLineActivityTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity to remove tag from | |
order_line_activity_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\OrderLineActivity getDuplicateOrderLineActivityById($order_line_activity_id)
Get a duplicated an orderLineActivity by id
Returns a duplicated orderLineActivity 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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to be duplicated.
try {
$result = $apiInstance->getDuplicateOrderLineActivityById($order_line_activity_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->getDuplicateOrderLineActivityById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity to be duplicated. |
\Infoplus\Infoplus\Model\OrderLineActivity
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\OrderLineActivity[] getOrderLineActivityByFilter($filter, $page, $limit, $sort)
Search orderLineActivitys by filter
Returns the list of orderLineActivitys 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\OrderLineActivityApi(
// 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->getOrderLineActivityByFilter($filter, $page, $limit, $sort);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->getOrderLineActivityByFilter: ', $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\OrderLineActivity[]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\OrderLineActivity getOrderLineActivityById($order_line_activity_id)
Get an orderLineActivity by id
Returns the orderLineActivity 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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to be returned.
try {
$result = $apiInstance->getOrderLineActivityById($order_line_activity_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->getOrderLineActivityById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity to be returned. |
\Infoplus\Infoplus\Model\OrderLineActivity
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getOrderLineActivityFiles($order_line_activity_id)
Get the files for an orderLineActivity.
Get all existing orderLineActivity 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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to get files for
try {
$apiInstance->getOrderLineActivityFiles($order_line_activity_id);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->getOrderLineActivityFiles: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity 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]
getOrderLineActivityTags($order_line_activity_id)
Get the tags for an orderLineActivity.
Get all existing orderLineActivity 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\OrderLineActivityApi(
// 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
);
$order_line_activity_id = 56; // int | Id of the orderLineActivity to get tags for
try {
$apiInstance->getOrderLineActivityTags($order_line_activity_id);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->getOrderLineActivityTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
order_line_activity_id | int | Id of the orderLineActivity 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]
updateOrderLineActivity($body)
Update an orderLineActivity
Updates an existing orderLineActivity 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\OrderLineActivityApi(
// 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\OrderLineActivity(); // \Infoplus\Infoplus\Model\OrderLineActivity | OrderLineActivity to be updated.
try {
$apiInstance->updateOrderLineActivity($body);
} catch (Exception $e) {
echo 'Exception when calling OrderLineActivityApi->updateOrderLineActivity: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\OrderLineActivity | OrderLineActivity 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]