Skip to content

Latest commit

 

History

History
855 lines (611 loc) · 30.7 KB

ReplenishmentPlanApi.md

File metadata and controls

855 lines (611 loc) · 30.7 KB

Infoplus\ReplenishmentPlanApi

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

Method HTTP request Description
addReplenishmentPlan POST /beta/replenishmentPlan Create a replenishmentPlan
addReplenishmentPlanAudit PUT /beta/replenishmentPlan/{replenishmentPlanId}/audit/{replenishmentPlanAudit} Add new audit for a replenishmentPlan
addReplenishmentPlanFile POST /beta/replenishmentPlan/{replenishmentPlanId}/file/{fileName} Attach a file to a replenishmentPlan
addReplenishmentPlanFileByURL POST /beta/replenishmentPlan/{replenishmentPlanId}/file Attach a file to a replenishmentPlan by URL.
addReplenishmentPlanTag PUT /beta/replenishmentPlan/{replenishmentPlanId}/tag/{replenishmentPlanTag} Add new tags for a replenishmentPlan.
deleteReplenishmentPlan DELETE /beta/replenishmentPlan/{replenishmentPlanId} Delete a replenishmentPlan
deleteReplenishmentPlanFile DELETE /beta/replenishmentPlan/{replenishmentPlanId}/file/{fileId} Delete a file for a replenishmentPlan.
deleteReplenishmentPlanTag DELETE /beta/replenishmentPlan/{replenishmentPlanId}/tag/{replenishmentPlanTag} Delete a tag for a replenishmentPlan.
getDuplicateReplenishmentPlanById GET /beta/replenishmentPlan/duplicate/{replenishmentPlanId} Get a duplicated a replenishmentPlan by id
getReplenishmentPlanByFilter GET /beta/replenishmentPlan/search Search replenishmentPlans by filter
getReplenishmentPlanById GET /beta/replenishmentPlan/{replenishmentPlanId} Get a replenishmentPlan by id
getReplenishmentPlanFiles GET /beta/replenishmentPlan/{replenishmentPlanId}/file Get the files for a replenishmentPlan.
getReplenishmentPlanTags GET /beta/replenishmentPlan/{replenishmentPlanId}/tag Get the tags for a replenishmentPlan.
updateReplenishmentPlan PUT /beta/replenishmentPlan Update a replenishmentPlan
updateReplenishmentPlanCustomFields PUT /beta/replenishmentPlan/customFields Update a replenishmentPlan custom fields

addReplenishmentPlan

\Infoplus\Infoplus\Model\ReplenishmentPlan addReplenishmentPlan($body)

Create a replenishmentPlan

Inserts a new replenishmentPlan 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\ReplenishmentPlanApi(
    // 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\ReplenishmentPlan(); // \Infoplus\Infoplus\Model\ReplenishmentPlan | ReplenishmentPlan to be inserted.

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

Parameters

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

Return type

\Infoplus\Infoplus\Model\ReplenishmentPlan

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]

addReplenishmentPlanAudit

addReplenishmentPlanAudit($replenishment_plan_id, $replenishment_plan_audit)

Add new audit for a replenishmentPlan

Adds an audit to an existing replenishmentPlan.

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\ReplenishmentPlanApi(
    // 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
);
$replenishment_plan_id = 56; // int | Id of the replenishmentPlan to add an audit to
$replenishment_plan_audit = "replenishment_plan_audit_example"; // string | The audit to add

try {
    $apiInstance->addReplenishmentPlanAudit($replenishment_plan_id, $replenishment_plan_audit);
} catch (Exception $e) {
    echo 'Exception when calling ReplenishmentPlanApi->addReplenishmentPlanAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
replenishment_plan_id int Id of the replenishmentPlan to add an audit to
replenishment_plan_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]

addReplenishmentPlanFile

addReplenishmentPlanFile($replenishment_plan_id, $file_name)

Attach a file to a replenishmentPlan

Adds a file to an existing replenishmentPlan.

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

try {
    $apiInstance->addReplenishmentPlanFile($replenishment_plan_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling ReplenishmentPlanApi->addReplenishmentPlanFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

addReplenishmentPlanFileByURL

addReplenishmentPlanFileByURL($body, $replenishment_plan_id)

Attach a file to a replenishmentPlan by URL.

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

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

Parameters

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

addReplenishmentPlanTag

addReplenishmentPlanTag($replenishment_plan_id, $replenishment_plan_tag)

Add new tags for a replenishmentPlan.

Adds a tag to an existing replenishmentPlan.

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\ReplenishmentPlanApi(
    // 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
);
$replenishment_plan_id = 56; // int | Id of the replenishmentPlan to add a tag to
$replenishment_plan_tag = "replenishment_plan_tag_example"; // string | The tag to add

try {
    $apiInstance->addReplenishmentPlanTag($replenishment_plan_id, $replenishment_plan_tag);
} catch (Exception $e) {
    echo 'Exception when calling ReplenishmentPlanApi->addReplenishmentPlanTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
replenishment_plan_id int Id of the replenishmentPlan to add a tag to
replenishment_plan_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]

deleteReplenishmentPlan

deleteReplenishmentPlan($replenishment_plan_id)

Delete a replenishmentPlan

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

try {
    $apiInstance->deleteReplenishmentPlan($replenishment_plan_id);
} catch (Exception $e) {
    echo 'Exception when calling ReplenishmentPlanApi->deleteReplenishmentPlan: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

deleteReplenishmentPlanFile

deleteReplenishmentPlanFile($replenishment_plan_id, $file_id)

Delete a file for a replenishmentPlan.

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

try {
    $apiInstance->deleteReplenishmentPlanFile($replenishment_plan_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling ReplenishmentPlanApi->deleteReplenishmentPlanFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

deleteReplenishmentPlanTag

deleteReplenishmentPlanTag($replenishment_plan_id, $replenishment_plan_tag)

Delete a tag for a replenishmentPlan.

Deletes an existing replenishmentPlan 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\ReplenishmentPlanApi(
    // 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
);
$replenishment_plan_id = 56; // int | Id of the replenishmentPlan to remove tag from
$replenishment_plan_tag = "replenishment_plan_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteReplenishmentPlanTag($replenishment_plan_id, $replenishment_plan_tag);
} catch (Exception $e) {
    echo 'Exception when calling ReplenishmentPlanApi->deleteReplenishmentPlanTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
replenishment_plan_id int Id of the replenishmentPlan to remove tag from
replenishment_plan_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]

getDuplicateReplenishmentPlanById

\Infoplus\Infoplus\Model\ReplenishmentPlan getDuplicateReplenishmentPlanById($replenishment_plan_id)

Get a duplicated a replenishmentPlan by id

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

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

Parameters

Name Type Description Notes
replenishment_plan_id int Id of the replenishmentPlan to be duplicated.

Return type

\Infoplus\Infoplus\Model\ReplenishmentPlan

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]

getReplenishmentPlanByFilter

\Infoplus\Infoplus\Model\ReplenishmentPlan[] getReplenishmentPlanByFilter($filter, $page, $limit, $sort)

Search replenishmentPlans by filter

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

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]

getReplenishmentPlanById

\Infoplus\Infoplus\Model\ReplenishmentPlan getReplenishmentPlanById($replenishment_plan_id)

Get a replenishmentPlan by id

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

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

Parameters

Name Type Description Notes
replenishment_plan_id int Id of the replenishmentPlan to be returned.

Return type

\Infoplus\Infoplus\Model\ReplenishmentPlan

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]

getReplenishmentPlanFiles

getReplenishmentPlanFiles($replenishment_plan_id)

Get the files for a replenishmentPlan.

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

try {
    $apiInstance->getReplenishmentPlanFiles($replenishment_plan_id);
} catch (Exception $e) {
    echo 'Exception when calling ReplenishmentPlanApi->getReplenishmentPlanFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

getReplenishmentPlanTags

getReplenishmentPlanTags($replenishment_plan_id)

Get the tags for a replenishmentPlan.

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

try {
    $apiInstance->getReplenishmentPlanTags($replenishment_plan_id);
} catch (Exception $e) {
    echo 'Exception when calling ReplenishmentPlanApi->getReplenishmentPlanTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

updateReplenishmentPlan

updateReplenishmentPlan($body)

Update a replenishmentPlan

Updates an existing replenishmentPlan 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\ReplenishmentPlanApi(
    // 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\ReplenishmentPlan(); // \Infoplus\Infoplus\Model\ReplenishmentPlan | ReplenishmentPlan to be updated.

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

Parameters

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

updateReplenishmentPlanCustomFields

updateReplenishmentPlanCustomFields($body)

Update a replenishmentPlan custom fields

Updates an existing replenishmentPlan 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\ReplenishmentPlanApi(
    // 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\ReplenishmentPlan(); // \Infoplus\Infoplus\Model\ReplenishmentPlan | ReplenishmentPlan to be updated.

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

Parameters

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