Infoplus\OrderLineApi

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

Method	HTTP request	Description
addOrderLineAudit	PUT /beta/orderLine/{orderLineId}/audit/{orderLineAudit}	Add new audit for an orderLine
addOrderLineFile	POST /beta/orderLine/{orderLineId}/file/{fileName}	Attach a file to an orderLine
addOrderLineFileByURL	POST /beta/orderLine/{orderLineId}/file	Attach a file to an orderLine by URL.
addOrderLineTag	PUT /beta/orderLine/{orderLineId}/tag/{orderLineTag}	Add new tags for an orderLine.
deleteOrderLineFile	DELETE /beta/orderLine/{orderLineId}/file/{fileId}	Delete a file for an orderLine.
deleteOrderLineTag	DELETE /beta/orderLine/{orderLineId}/tag/{orderLineTag}	Delete a tag for an orderLine.
getDuplicateOrderLineById	GET /beta/orderLine/duplicate/{orderLineId}	Get a duplicated an orderLine by id
getOrderLineByFilter	GET /beta/orderLine/search	Search orderLines by filter
getOrderLineById	GET /beta/orderLine/{orderLineId}	Get an orderLine by id
getOrderLineFiles	GET /beta/orderLine/{orderLineId}/file	Get the files for an orderLine.
getOrderLineTags	GET /beta/orderLine/{orderLineId}/tag	Get the tags for an orderLine.
updateOrderLineCustomFields	PUT /beta/orderLine/customFields	Update an orderLine custom fields

addOrderLineAudit

addOrderLineAudit($order_line_id, $order_line_audit)

Add new audit for an orderLine

Adds an audit to an existing orderLine.

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\OrderLineApi(
    // 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_id = 56; // int | Id of the orderLine to add an audit to
$order_line_audit = "order_line_audit_example"; // string | The audit to add

try {
    $apiInstance->addOrderLineAudit($order_line_id, $order_line_audit);
} catch (Exception $e) {
    echo 'Exception when calling OrderLineApi->addOrderLineAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
order_line_id	int	Id of the orderLine to add an audit to
order_line_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]

addOrderLineFile

addOrderLineFile($order_line_id, $file_name)

Attach a file to an orderLine

Adds a file to an existing orderLine.

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

try {
    $apiInstance->addOrderLineFile($order_line_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling OrderLineApi->addOrderLineFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

addOrderLineFileByURL

addOrderLineFileByURL($body, $order_line_id)

Attach a file to an orderLine by URL.

Adds a file to an existing orderLine 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\OrderLineApi(
    // 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_id = 56; // int | Id of the orderLine to add an file to

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

Parameters

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

addOrderLineTag

addOrderLineTag($order_line_id, $order_line_tag)

Add new tags for an orderLine.

Adds a tag to an existing orderLine.

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\OrderLineApi(
    // 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_id = 56; // int | Id of the orderLine to add a tag to
$order_line_tag = "order_line_tag_example"; // string | The tag to add

try {
    $apiInstance->addOrderLineTag($order_line_id, $order_line_tag);
} catch (Exception $e) {
    echo 'Exception when calling OrderLineApi->addOrderLineTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
order_line_id	int	Id of the orderLine to add a tag to
order_line_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]

deleteOrderLineFile

deleteOrderLineFile($order_line_id, $file_id)

Delete a file for an orderLine.

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

try {
    $apiInstance->deleteOrderLineFile($order_line_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling OrderLineApi->deleteOrderLineFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

deleteOrderLineTag

deleteOrderLineTag($order_line_id, $order_line_tag)

Delete a tag for an orderLine.

Deletes an existing orderLine 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\OrderLineApi(
    // 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_id = 56; // int | Id of the orderLine to remove tag from
$order_line_tag = "order_line_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteOrderLineTag($order_line_id, $order_line_tag);
} catch (Exception $e) {
    echo 'Exception when calling OrderLineApi->deleteOrderLineTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
order_line_id	int	Id of the orderLine to remove tag from
order_line_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]

getDuplicateOrderLineById

\Infoplus\Infoplus\Model\OrderLine getDuplicateOrderLineById($order_line_id)

Get a duplicated an orderLine by id

Returns a duplicated orderLine 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\OrderLineApi(
    // 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_id = 56; // int | Id of the orderLine to be duplicated.

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

Parameters

Name	Type	Description	Notes
order_line_id	int	Id of the orderLine to be duplicated.

Return type

\Infoplus\Infoplus\Model\OrderLine

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]

getOrderLineByFilter

\Infoplus\Infoplus\Model\OrderLine[] getOrderLineByFilter($filter, $page, $limit, $sort)

Search orderLines by filter

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

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]

getOrderLineById

\Infoplus\Infoplus\Model\OrderLine getOrderLineById($order_line_id)

Get an orderLine by id

Returns the orderLine 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\OrderLineApi(
    // 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_id = 56; // int | Id of the orderLine to be returned.

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

Parameters

Name	Type	Description	Notes
order_line_id	int	Id of the orderLine to be returned.

Return type

\Infoplus\Infoplus\Model\OrderLine

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]

getOrderLineFiles

getOrderLineFiles($order_line_id)

Get the files for an orderLine.

Get all existing orderLine 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\OrderLineApi(
    // 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_id = 56; // int | Id of the orderLine to get files for

try {
    $apiInstance->getOrderLineFiles($order_line_id);
} catch (Exception $e) {
    echo 'Exception when calling OrderLineApi->getOrderLineFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

getOrderLineTags

getOrderLineTags($order_line_id)

Get the tags for an orderLine.

Get all existing orderLine 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\OrderLineApi(
    // 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_id = 56; // int | Id of the orderLine to get tags for

try {
    $apiInstance->getOrderLineTags($order_line_id);
} catch (Exception $e) {
    echo 'Exception when calling OrderLineApi->getOrderLineTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

updateOrderLineCustomFields

updateOrderLineCustomFields($body)

Update an orderLine custom fields

Updates an existing orderLine 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\OrderLineApi(
    // 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\OrderLine(); // \Infoplus\Infoplus\Model\OrderLine | OrderLine to be updated.

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

Parameters

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

Files

OrderLineApi.md

Latest commit

History

OrderLineApi.md

File metadata and controls

Infoplus\OrderLineApi

addOrderLineAudit

Example

Parameters

Return type

Authorization

HTTP request headers

addOrderLineFile

Example

Parameters

Return type

Authorization

HTTP request headers

addOrderLineFileByURL

Example

Parameters

Return type

Authorization

HTTP request headers

addOrderLineTag

Example

Parameters

Return type

Authorization

HTTP request headers

deleteOrderLineFile

Example

Parameters

Return type

Authorization

HTTP request headers

deleteOrderLineTag

Example

Parameters

Return type

Authorization

HTTP request headers

getDuplicateOrderLineById

Example

Parameters

Return type

Authorization

HTTP request headers

getOrderLineByFilter

Example

Parameters

Return type

Authorization

HTTP request headers

getOrderLineById

Example

Parameters

Return type

Authorization

HTTP request headers

getOrderLineFiles

Example

Parameters

Return type

Authorization

HTTP request headers

getOrderLineTags

Example

Parameters

Return type

Authorization

HTTP request headers

updateOrderLineCustomFields

Example

Parameters

Return type

Authorization

HTTP request headers