All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api
Method | HTTP request | Description |
---|---|---|
addParcelInvoiceLineAudit | PUT /beta/parcelInvoiceLine/{parcelInvoiceLineId}/audit/{parcelInvoiceLineAudit} | Add new audit for a parcelInvoiceLine |
addParcelInvoiceLineFile | POST /beta/parcelInvoiceLine/{parcelInvoiceLineId}/file/{fileName} | Attach a file to a parcelInvoiceLine |
addParcelInvoiceLineFileByURL | POST /beta/parcelInvoiceLine/{parcelInvoiceLineId}/file | Attach a file to a parcelInvoiceLine by URL. |
addParcelInvoiceLineTag | PUT /beta/parcelInvoiceLine/{parcelInvoiceLineId}/tag/{parcelInvoiceLineTag} | Add new tags for a parcelInvoiceLine. |
deleteParcelInvoiceLineFile | DELETE /beta/parcelInvoiceLine/{parcelInvoiceLineId}/file/{fileId} | Delete a file for a parcelInvoiceLine. |
deleteParcelInvoiceLineTag | DELETE /beta/parcelInvoiceLine/{parcelInvoiceLineId}/tag/{parcelInvoiceLineTag} | Delete a tag for a parcelInvoiceLine. |
getDuplicateParcelInvoiceLineById | GET /beta/parcelInvoiceLine/duplicate/{parcelInvoiceLineId} | Get a duplicated a parcelInvoiceLine by id |
getParcelInvoiceLineByFilter | GET /beta/parcelInvoiceLine/search | Search parcelInvoiceLines by filter |
getParcelInvoiceLineById | GET /beta/parcelInvoiceLine/{parcelInvoiceLineId} | Get a parcelInvoiceLine by id |
getParcelInvoiceLineFiles | GET /beta/parcelInvoiceLine/{parcelInvoiceLineId}/file | Get the files for a parcelInvoiceLine. |
getParcelInvoiceLineTags | GET /beta/parcelInvoiceLine/{parcelInvoiceLineId}/tag | Get the tags for a parcelInvoiceLine. |
updateParcelInvoiceLine | PUT /beta/parcelInvoiceLine | Update a parcelInvoiceLine |
addParcelInvoiceLineAudit($parcel_invoice_line_id, $parcel_invoice_line_audit)
Add new audit for a parcelInvoiceLine
Adds an audit to an existing parcelInvoiceLine.
<?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\ParcelInvoiceLineApi(
// 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
);
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to add an audit to
$parcel_invoice_line_audit = "parcel_invoice_line_audit_example"; // string | The audit to add
try {
$apiInstance->addParcelInvoiceLineAudit($parcel_invoice_line_id, $parcel_invoice_line_audit);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->addParcelInvoiceLineAudit: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
parcel_invoice_line_id | int | Id of the parcelInvoiceLine to add an audit to | |
parcel_invoice_line_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]
addParcelInvoiceLineFile($parcel_invoice_line_id, $file_name)
Attach a file to a parcelInvoiceLine
Adds a file to an existing parcelInvoiceLine.
<?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\ParcelInvoiceLineApi(
// 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
);
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to add a file to
$file_name = "file_name_example"; // string | Name of file
try {
$apiInstance->addParcelInvoiceLineFile($parcel_invoice_line_id, $file_name);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->addParcelInvoiceLineFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
parcel_invoice_line_id | int | Id of the parcelInvoiceLine 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]
addParcelInvoiceLineFileByURL($body, $parcel_invoice_line_id)
Attach a file to a parcelInvoiceLine by URL.
Adds a file to an existing parcelInvoiceLine 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\ParcelInvoiceLineApi(
// 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.
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to add an file to
try {
$apiInstance->addParcelInvoiceLineFileByURL($body, $parcel_invoice_line_id);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->addParcelInvoiceLineFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used. | |
parcel_invoice_line_id | int | Id of the parcelInvoiceLine 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]
addParcelInvoiceLineTag($parcel_invoice_line_id, $parcel_invoice_line_tag)
Add new tags for a parcelInvoiceLine.
Adds a tag to an existing parcelInvoiceLine.
<?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\ParcelInvoiceLineApi(
// 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
);
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to add a tag to
$parcel_invoice_line_tag = "parcel_invoice_line_tag_example"; // string | The tag to add
try {
$apiInstance->addParcelInvoiceLineTag($parcel_invoice_line_id, $parcel_invoice_line_tag);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->addParcelInvoiceLineTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
parcel_invoice_line_id | int | Id of the parcelInvoiceLine to add a tag to | |
parcel_invoice_line_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]
deleteParcelInvoiceLineFile($parcel_invoice_line_id, $file_id)
Delete a file for a parcelInvoiceLine.
Deletes an existing parcelInvoiceLine 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\ParcelInvoiceLineApi(
// 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
);
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to remove file from
$file_id = 56; // int | Id of the file to delete
try {
$apiInstance->deleteParcelInvoiceLineFile($parcel_invoice_line_id, $file_id);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->deleteParcelInvoiceLineFile: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
parcel_invoice_line_id | int | Id of the parcelInvoiceLine 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]
deleteParcelInvoiceLineTag($parcel_invoice_line_id, $parcel_invoice_line_tag)
Delete a tag for a parcelInvoiceLine.
Deletes an existing parcelInvoiceLine 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\ParcelInvoiceLineApi(
// 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
);
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to remove tag from
$parcel_invoice_line_tag = "parcel_invoice_line_tag_example"; // string | The tag to delete
try {
$apiInstance->deleteParcelInvoiceLineTag($parcel_invoice_line_id, $parcel_invoice_line_tag);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->deleteParcelInvoiceLineTag: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
parcel_invoice_line_id | int | Id of the parcelInvoiceLine to remove tag from | |
parcel_invoice_line_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\ParcelInvoiceLine getDuplicateParcelInvoiceLineById($parcel_invoice_line_id)
Get a duplicated a parcelInvoiceLine by id
Returns a duplicated parcelInvoiceLine 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\ParcelInvoiceLineApi(
// 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
);
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to be duplicated.
try {
$result = $apiInstance->getDuplicateParcelInvoiceLineById($parcel_invoice_line_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->getDuplicateParcelInvoiceLineById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
parcel_invoice_line_id | int | Id of the parcelInvoiceLine to be duplicated. |
\Infoplus\Infoplus\Model\ParcelInvoiceLine
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\ParcelInvoiceLine[] getParcelInvoiceLineByFilter($filter, $page, $limit, $sort)
Search parcelInvoiceLines by filter
Returns the list of parcelInvoiceLines 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\ParcelInvoiceLineApi(
// 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->getParcelInvoiceLineByFilter($filter, $page, $limit, $sort);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->getParcelInvoiceLineByFilter: ', $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\ParcelInvoiceLine[]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Infoplus\Infoplus\Model\ParcelInvoiceLine getParcelInvoiceLineById($parcel_invoice_line_id)
Get a parcelInvoiceLine by id
Returns the parcelInvoiceLine 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\ParcelInvoiceLineApi(
// 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
);
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to be returned.
try {
$result = $apiInstance->getParcelInvoiceLineById($parcel_invoice_line_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->getParcelInvoiceLineById: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
parcel_invoice_line_id | int | Id of the parcelInvoiceLine to be returned. |
\Infoplus\Infoplus\Model\ParcelInvoiceLine
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getParcelInvoiceLineFiles($parcel_invoice_line_id)
Get the files for a parcelInvoiceLine.
Get all existing parcelInvoiceLine 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\ParcelInvoiceLineApi(
// 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
);
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to get files for
try {
$apiInstance->getParcelInvoiceLineFiles($parcel_invoice_line_id);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->getParcelInvoiceLineFiles: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
parcel_invoice_line_id | int | Id of the parcelInvoiceLine 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]
getParcelInvoiceLineTags($parcel_invoice_line_id)
Get the tags for a parcelInvoiceLine.
Get all existing parcelInvoiceLine 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\ParcelInvoiceLineApi(
// 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
);
$parcel_invoice_line_id = 56; // int | Id of the parcelInvoiceLine to get tags for
try {
$apiInstance->getParcelInvoiceLineTags($parcel_invoice_line_id);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->getParcelInvoiceLineTags: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
parcel_invoice_line_id | int | Id of the parcelInvoiceLine 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]
updateParcelInvoiceLine($body)
Update a parcelInvoiceLine
Updates an existing parcelInvoiceLine 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\ParcelInvoiceLineApi(
// 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\ParcelInvoiceLine(); // \Infoplus\Infoplus\Model\ParcelInvoiceLine | ParcelInvoiceLine to be updated.
try {
$apiInstance->updateParcelInvoiceLine($body);
} catch (Exception $e) {
echo 'Exception when calling ParcelInvoiceLineApi->updateParcelInvoiceLine: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \Infoplus\Infoplus\Model\ParcelInvoiceLine | ParcelInvoiceLine 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]