Infoplus\ShipmentApi

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

Method	HTTP request	Description
addShipmentAudit	PUT /beta/shipment/{shipmentId}/audit/{shipmentAudit}	Add new audit for a shipment
addShipmentFile	POST /beta/shipment/{shipmentId}/file/{fileName}	Attach a file to a shipment
addShipmentFileByURL	POST /beta/shipment/{shipmentId}/file	Attach a file to a shipment by URL.
addShipmentTag	PUT /beta/shipment/{shipmentId}/tag/{shipmentTag}	Add new tags for a shipment.
deleteShipmentFile	DELETE /beta/shipment/{shipmentId}/file/{fileId}	Delete a file for a shipment.
deleteShipmentTag	DELETE /beta/shipment/{shipmentId}/tag/{shipmentTag}	Delete a tag for a shipment.
getDuplicateShipmentById	GET /beta/shipment/duplicate/{shipmentId}	Get a duplicated a shipment by id
getShipmentByFilter	GET /beta/shipment/search	Search shipments by filter
getShipmentById	GET /beta/shipment/{shipmentId}	Get a shipment by id
getShipmentFiles	GET /beta/shipment/{shipmentId}/file	Get the files for a shipment.
getShipmentTags	GET /beta/shipment/{shipmentId}/tag	Get the tags for a shipment.
updateShipmentCustomFields	PUT /beta/shipment/customFields	Update a shipment custom fields

addShipmentAudit

addShipmentAudit($shipment_id, $shipment_audit)

Add new audit for a shipment

Adds an audit to an existing shipment.

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\ShipmentApi(
    // 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
);
$shipment_id = 56; // int | Id of the shipment to add an audit to
$shipment_audit = "shipment_audit_example"; // string | The audit to add

try {
    $apiInstance->addShipmentAudit($shipment_id, $shipment_audit);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->addShipmentAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
shipment_id	int	Id of the shipment to add an audit to
shipment_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]

addShipmentFile

addShipmentFile($shipment_id, $file_name)

Attach a file to a shipment

Adds a file to an existing shipment.

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

try {
    $apiInstance->addShipmentFile($shipment_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->addShipmentFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

addShipmentFileByURL

addShipmentFileByURL($body, $shipment_id)

Attach a file to a shipment by URL.

Adds a file to an existing shipment 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\ShipmentApi(
    // 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.
$shipment_id = 56; // int | Id of the shipment to add an file to

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

Parameters

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

addShipmentTag

addShipmentTag($shipment_id, $shipment_tag)

Add new tags for a shipment.

Adds a tag to an existing shipment.

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\ShipmentApi(
    // 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
);
$shipment_id = 56; // int | Id of the shipment to add a tag to
$shipment_tag = "shipment_tag_example"; // string | The tag to add

try {
    $apiInstance->addShipmentTag($shipment_id, $shipment_tag);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->addShipmentTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
shipment_id	int	Id of the shipment to add a tag to
shipment_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]

deleteShipmentFile

deleteShipmentFile($shipment_id, $file_id)

Delete a file for a shipment.

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

try {
    $apiInstance->deleteShipmentFile($shipment_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->deleteShipmentFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

deleteShipmentTag

deleteShipmentTag($shipment_id, $shipment_tag)

Delete a tag for a shipment.

Deletes an existing shipment 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\ShipmentApi(
    // 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
);
$shipment_id = 56; // int | Id of the shipment to remove tag from
$shipment_tag = "shipment_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteShipmentTag($shipment_id, $shipment_tag);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->deleteShipmentTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
shipment_id	int	Id of the shipment to remove tag from
shipment_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]

getDuplicateShipmentById

\Infoplus\Infoplus\Model\Shipment getDuplicateShipmentById($shipment_id)

Get a duplicated a shipment by id

Returns a duplicated shipment 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\ShipmentApi(
    // 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
);
$shipment_id = 56; // int | Id of the shipment to be duplicated.

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

Parameters

Name	Type	Description	Notes
shipment_id	int	Id of the shipment to be duplicated.

Return type

\Infoplus\Infoplus\Model\Shipment

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]

getShipmentByFilter

\Infoplus\Infoplus\Model\Shipment[] getShipmentByFilter($filter, $page, $limit, $sort)

Search shipments by filter

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

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]

getShipmentById

\Infoplus\Infoplus\Model\Shipment getShipmentById($shipment_id)

Get a shipment by id

Returns the shipment 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\ShipmentApi(
    // 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
);
$shipment_id = 56; // int | Id of the shipment to be returned.

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

Parameters

Name	Type	Description	Notes
shipment_id	int	Id of the shipment to be returned.

Return type

\Infoplus\Infoplus\Model\Shipment

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]

getShipmentFiles

getShipmentFiles($shipment_id)

Get the files for a shipment.

Get all existing shipment 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\ShipmentApi(
    // 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
);
$shipment_id = 56; // int | Id of the shipment to get files for

try {
    $apiInstance->getShipmentFiles($shipment_id);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->getShipmentFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

getShipmentTags

getShipmentTags($shipment_id)

Get the tags for a shipment.

Get all existing shipment 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\ShipmentApi(
    // 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
);
$shipment_id = 56; // int | Id of the shipment to get tags for

try {
    $apiInstance->getShipmentTags($shipment_id);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->getShipmentTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

updateShipmentCustomFields

updateShipmentCustomFields($body)

Update a shipment custom fields

Updates an existing shipment 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\ShipmentApi(
    // 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\Shipment(); // \Infoplus\Infoplus\Model\Shipment | Shipment to be updated.

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

Parameters

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

ShipmentApi.md

Latest commit

History

ShipmentApi.md

File metadata and controls

Infoplus\ShipmentApi

addShipmentAudit

Example

Parameters

Return type

Authorization

HTTP request headers

addShipmentFile

Example

Parameters

Return type

Authorization

HTTP request headers

addShipmentFileByURL

Example

Parameters

Return type

Authorization

HTTP request headers

addShipmentTag

Example

Parameters

Return type

Authorization

HTTP request headers

deleteShipmentFile

Example

Parameters

Return type

Authorization

HTTP request headers

deleteShipmentTag

Example

Parameters

Return type

Authorization

HTTP request headers

getDuplicateShipmentById

Example

Parameters

Return type

Authorization

HTTP request headers

getShipmentByFilter

Example

Parameters

Return type

Authorization

HTTP request headers

getShipmentById

Example

Parameters

Return type

Authorization

HTTP request headers

getShipmentFiles

Example

Parameters

Return type

Authorization

HTTP request headers

getShipmentTags

Example

Parameters

Return type

Authorization

HTTP request headers

updateShipmentCustomFields

Example

Parameters

Return type

Authorization

HTTP request headers