All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api
Method | HTTP request | Description |
---|---|---|
addLineOfBusiness | POST /beta/lineOfBusiness | Create a lineOfBusiness |
addLineOfBusinessAudit | PUT /beta/lineOfBusiness/{lineOfBusinessId}/audit/{lineOfBusinessAudit} | Add new audit for a lineOfBusiness |
addLineOfBusinessFile | POST /beta/lineOfBusiness/{lineOfBusinessId}/file/{fileName} | Attach a file to a lineOfBusiness |
addLineOfBusinessFileByURL | POST /beta/lineOfBusiness/{lineOfBusinessId}/file | Attach a file to a lineOfBusiness by URL. |
addLineOfBusinessTag | PUT /beta/lineOfBusiness/{lineOfBusinessId}/tag/{lineOfBusinessTag} | Add new tags for a lineOfBusiness. |
deleteLineOfBusinessFile | DELETE /beta/lineOfBusiness/{lineOfBusinessId}/file/{fileId} | Delete a file for a lineOfBusiness. |
deleteLineOfBusinessTag | DELETE /beta/lineOfBusiness/{lineOfBusinessId}/tag/{lineOfBusinessTag} | Delete a tag for a lineOfBusiness. |
getDuplicateLineOfBusinessById | GET /beta/lineOfBusiness/duplicate/{lineOfBusinessId} | Get a duplicated a lineOfBusiness by id |
getLineOfBusinessByFilter | GET /beta/lineOfBusiness/search | Search lineOfBusinesses by filter |
getLineOfBusinessById | GET /beta/lineOfBusiness/{lineOfBusinessId} | Get a lineOfBusiness by id |
getLineOfBusinessFiles | GET /beta/lineOfBusiness/{lineOfBusinessId}/file | Get the files for a lineOfBusiness. |
getLineOfBusinessTags | GET /beta/lineOfBusiness/{lineOfBusinessId}/tag | Get the tags for a lineOfBusiness. |
updateLineOfBusiness | PUT /beta/lineOfBusiness | Update a lineOfBusiness |
updateLineOfBusinessCustomFields | PUT /beta/lineOfBusiness/customFields | Update a lineOfBusiness custom fields |
\Infoplus\Infoplus\Model\LineOfBusiness addLineOfBusiness($body)
Create a lineOfBusiness
Inserts a new lineOfBusiness 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\LineOfBusinessApi(
// 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\LineOfBusiness(); // \Infoplus\Infoplus\Model\LineOfBusiness | LineOfBusiness to be inserted.
try {
$result = $apiInstance->addLineOfBusiness($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->addLineOfBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\LineOfBusiness | LineOfBusiness to be inserted. |
\Infoplus\Infoplus\Model\LineOfBusiness
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
addLineOfBusinessAudit($line_of_business_id, $line_of_business_audit)
Add new audit for a lineOfBusiness
Adds an audit to an existing lineOfBusiness.
<?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\LineOfBusinessApi(
// 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
);
$line_of_business_id = 56; // int | Id of the lineOfBusiness to add an audit to
$line_of_business_audit = "line_of_business_audit_example"; // string | The audit to add
try {
$apiInstance->addLineOfBusinessAudit($line_of_business_id, $line_of_business_audit);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->addLineOfBusinessAudit: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
line_of_business_id | int | Id of the lineOfBusiness to add an audit to | |
line_of_business_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]
addLineOfBusinessFile($line_of_business_id, $file_name)
Attach a file to a lineOfBusiness
Adds a file to an existing lineOfBusiness.
<?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\LineOfBusinessApi(
// 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
);
$line_of_business_id = 56; // int | Id of the lineOfBusiness to add a file to
$file_name = "file_name_example"; // string | Name of file
try {
$apiInstance->addLineOfBusinessFile($line_of_business_id, $file_name);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->addLineOfBusinessFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
line_of_business_id | int | Id of the lineOfBusiness 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]
addLineOfBusinessFileByURL($body, $line_of_business_id)
Attach a file to a lineOfBusiness by URL.
Adds a file to an existing lineOfBusiness 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\LineOfBusinessApi(
// 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.
$line_of_business_id = 56; // int | Id of the lineOfBusiness to add an file to
try {
$apiInstance->addLineOfBusinessFileByURL($body, $line_of_business_id);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->addLineOfBusinessFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used. | |
line_of_business_id | int | Id of the lineOfBusiness 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]
addLineOfBusinessTag($line_of_business_id, $line_of_business_tag)
Add new tags for a lineOfBusiness.
Adds a tag to an existing lineOfBusiness.
<?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\LineOfBusinessApi(
// 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
);
$line_of_business_id = 56; // int | Id of the lineOfBusiness to add a tag to
$line_of_business_tag = "line_of_business_tag_example"; // string | The tag to add
try {
$apiInstance->addLineOfBusinessTag($line_of_business_id, $line_of_business_tag);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->addLineOfBusinessTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
line_of_business_id | int | Id of the lineOfBusiness to add a tag to | |
line_of_business_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]
deleteLineOfBusinessFile($line_of_business_id, $file_id)
Delete a file for a lineOfBusiness.
Deletes an existing lineOfBusiness 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\LineOfBusinessApi(
// 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
);
$line_of_business_id = 56; // int | Id of the lineOfBusiness to remove file from
$file_id = 56; // int | Id of the file to delete
try {
$apiInstance->deleteLineOfBusinessFile($line_of_business_id, $file_id);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->deleteLineOfBusinessFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
line_of_business_id | int | Id of the lineOfBusiness 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]
deleteLineOfBusinessTag($line_of_business_id, $line_of_business_tag)
Delete a tag for a lineOfBusiness.
Deletes an existing lineOfBusiness 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\LineOfBusinessApi(
// 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
);
$line_of_business_id = 56; // int | Id of the lineOfBusiness to remove tag from
$line_of_business_tag = "line_of_business_tag_example"; // string | The tag to delete
try {
$apiInstance->deleteLineOfBusinessTag($line_of_business_id, $line_of_business_tag);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->deleteLineOfBusinessTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
line_of_business_id | int | Id of the lineOfBusiness to remove tag from | |
line_of_business_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\LineOfBusiness getDuplicateLineOfBusinessById($line_of_business_id)
Get a duplicated a lineOfBusiness by id
Returns a duplicated lineOfBusiness 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\LineOfBusinessApi(
// 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
);
$line_of_business_id = 56; // int | Id of the lineOfBusiness to be duplicated.
try {
$result = $apiInstance->getDuplicateLineOfBusinessById($line_of_business_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->getDuplicateLineOfBusinessById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
line_of_business_id | int | Id of the lineOfBusiness to be duplicated. |
\Infoplus\Infoplus\Model\LineOfBusiness
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\LineOfBusiness[] getLineOfBusinessByFilter($filter, $page, $limit, $sort)
Search lineOfBusinesses by filter
Returns the list of lineOfBusinesses 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\LineOfBusinessApi(
// 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->getLineOfBusinessByFilter($filter, $page, $limit, $sort);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->getLineOfBusinessByFilter: ', $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\LineOfBusiness[]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\LineOfBusiness getLineOfBusinessById($line_of_business_id)
Get a lineOfBusiness by id
Returns the lineOfBusiness 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\LineOfBusinessApi(
// 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
);
$line_of_business_id = 56; // int | Id of the lineOfBusiness to be returned.
try {
$result = $apiInstance->getLineOfBusinessById($line_of_business_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->getLineOfBusinessById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
line_of_business_id | int | Id of the lineOfBusiness to be returned. |
\Infoplus\Infoplus\Model\LineOfBusiness
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getLineOfBusinessFiles($line_of_business_id)
Get the files for a lineOfBusiness.
Get all existing lineOfBusiness 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\LineOfBusinessApi(
// 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
);
$line_of_business_id = 56; // int | Id of the lineOfBusiness to get files for
try {
$apiInstance->getLineOfBusinessFiles($line_of_business_id);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->getLineOfBusinessFiles: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
line_of_business_id | int | Id of the lineOfBusiness 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]
getLineOfBusinessTags($line_of_business_id)
Get the tags for a lineOfBusiness.
Get all existing lineOfBusiness 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\LineOfBusinessApi(
// 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
);
$line_of_business_id = 56; // int | Id of the lineOfBusiness to get tags for
try {
$apiInstance->getLineOfBusinessTags($line_of_business_id);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->getLineOfBusinessTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
line_of_business_id | int | Id of the lineOfBusiness 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]
updateLineOfBusiness($body)
Update a lineOfBusiness
Updates an existing lineOfBusiness 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\LineOfBusinessApi(
// 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\LineOfBusiness(); // \Infoplus\Infoplus\Model\LineOfBusiness | LineOfBusiness to be updated.
try {
$apiInstance->updateLineOfBusiness($body);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->updateLineOfBusiness: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\LineOfBusiness | LineOfBusiness 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]
updateLineOfBusinessCustomFields($body)
Update a lineOfBusiness custom fields
Updates an existing lineOfBusiness 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\LineOfBusinessApi(
// 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\LineOfBusiness(); // \Infoplus\Infoplus\Model\LineOfBusiness | LineOfBusiness to be updated.
try {
$apiInstance->updateLineOfBusinessCustomFields($body);
} catch (Exception $e) {
echo 'Exception when calling LineOfBusinessApi->updateLineOfBusinessCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\LineOfBusiness | LineOfBusiness 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]