Skip to content

Latest commit

 

History

History
855 lines (611 loc) · 27.2 KB

CartonApi.md

File metadata and controls

855 lines (611 loc) · 27.2 KB

Infoplus\CartonApi

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

Method HTTP request Description
addCarton POST /beta/carton Create a carton
addCartonAudit PUT /beta/carton/{cartonId}/audit/{cartonAudit} Add new audit for a carton
addCartonFile POST /beta/carton/{cartonId}/file/{fileName} Attach a file to a carton
addCartonFileByURL POST /beta/carton/{cartonId}/file Attach a file to a carton by URL.
addCartonTag PUT /beta/carton/{cartonId}/tag/{cartonTag} Add new tags for a carton.
deleteCarton DELETE /beta/carton/{cartonId} Delete a carton
deleteCartonFile DELETE /beta/carton/{cartonId}/file/{fileId} Delete a file for a carton.
deleteCartonTag DELETE /beta/carton/{cartonId}/tag/{cartonTag} Delete a tag for a carton.
getCartonByFilter GET /beta/carton/search Search cartons by filter
getCartonById GET /beta/carton/{cartonId} Get a carton by id
getCartonFiles GET /beta/carton/{cartonId}/file Get the files for a carton.
getCartonTags GET /beta/carton/{cartonId}/tag Get the tags for a carton.
getDuplicateCartonById GET /beta/carton/duplicate/{cartonId} Get a duplicated a carton by id
updateCarton PUT /beta/carton Update a carton
updateCartonCustomFields PUT /beta/carton/customFields Update a carton custom fields

addCarton

\Infoplus\Infoplus\Model\Carton addCarton($body)

Create a carton

Inserts a new carton 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\CartonApi(
    // 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\Carton(); // \Infoplus\Infoplus\Model\Carton | Carton to be inserted.

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

Parameters

Name Type Description Notes
body \Infoplus\Infoplus\Model\Carton Carton to be inserted.

Return type

\Infoplus\Infoplus\Model\Carton

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]

addCartonAudit

addCartonAudit($carton_id, $carton_audit)

Add new audit for a carton

Adds an audit to an existing carton.

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\CartonApi(
    // 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
);
$carton_id = 56; // int | Id of the carton to add an audit to
$carton_audit = "carton_audit_example"; // string | The audit to add

try {
    $apiInstance->addCartonAudit($carton_id, $carton_audit);
} catch (Exception $e) {
    echo 'Exception when calling CartonApi->addCartonAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
carton_id int Id of the carton to add an audit to
carton_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]

addCartonFile

addCartonFile($carton_id, $file_name)

Attach a file to a carton

Adds a file to an existing carton.

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

try {
    $apiInstance->addCartonFile($carton_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling CartonApi->addCartonFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

addCartonFileByURL

addCartonFileByURL($body, $carton_id)

Attach a file to a carton by URL.

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

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

Parameters

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

addCartonTag

addCartonTag($carton_id, $carton_tag)

Add new tags for a carton.

Adds a tag to an existing carton.

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\CartonApi(
    // 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
);
$carton_id = 56; // int | Id of the carton to add a tag to
$carton_tag = "carton_tag_example"; // string | The tag to add

try {
    $apiInstance->addCartonTag($carton_id, $carton_tag);
} catch (Exception $e) {
    echo 'Exception when calling CartonApi->addCartonTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
carton_id int Id of the carton to add a tag to
carton_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]

deleteCarton

deleteCarton($carton_id)

Delete a carton

Deletes the carton 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\CartonApi(
    // 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
);
$carton_id = 56; // int | Id of the carton to be deleted.

try {
    $apiInstance->deleteCarton($carton_id);
} catch (Exception $e) {
    echo 'Exception when calling CartonApi->deleteCarton: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
carton_id int Id of the carton to be deleted.

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]

deleteCartonFile

deleteCartonFile($carton_id, $file_id)

Delete a file for a carton.

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

try {
    $apiInstance->deleteCartonFile($carton_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling CartonApi->deleteCartonFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

deleteCartonTag

deleteCartonTag($carton_id, $carton_tag)

Delete a tag for a carton.

Deletes an existing carton 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\CartonApi(
    // 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
);
$carton_id = 56; // int | Id of the carton to remove tag from
$carton_tag = "carton_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteCartonTag($carton_id, $carton_tag);
} catch (Exception $e) {
    echo 'Exception when calling CartonApi->deleteCartonTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
carton_id int Id of the carton to remove tag from
carton_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]

getCartonByFilter

\Infoplus\Infoplus\Model\Carton[] getCartonByFilter($filter, $page, $limit, $sort)

Search cartons by filter

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

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]

getCartonById

\Infoplus\Infoplus\Model\Carton getCartonById($carton_id)

Get a carton by id

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

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

Parameters

Name Type Description Notes
carton_id int Id of the carton to be returned.

Return type

\Infoplus\Infoplus\Model\Carton

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]

getCartonFiles

getCartonFiles($carton_id)

Get the files for a carton.

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

try {
    $apiInstance->getCartonFiles($carton_id);
} catch (Exception $e) {
    echo 'Exception when calling CartonApi->getCartonFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

getCartonTags

getCartonTags($carton_id)

Get the tags for a carton.

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

try {
    $apiInstance->getCartonTags($carton_id);
} catch (Exception $e) {
    echo 'Exception when calling CartonApi->getCartonTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

getDuplicateCartonById

\Infoplus\Infoplus\Model\Carton getDuplicateCartonById($carton_id)

Get a duplicated a carton by id

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

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

Parameters

Name Type Description Notes
carton_id int Id of the carton to be duplicated.

Return type

\Infoplus\Infoplus\Model\Carton

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]

updateCarton

updateCarton($body)

Update a carton

Updates an existing carton 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\CartonApi(
    // 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\Carton(); // \Infoplus\Infoplus\Model\Carton | Carton to be updated.

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

Parameters

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

updateCartonCustomFields

updateCartonCustomFields($body)

Update a carton custom fields

Updates an existing carton 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\CartonApi(
    // 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\Carton(); // \Infoplus\Infoplus\Model\Carton | Carton to be updated.

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

Parameters

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