Skip to content

CustomerReturnOverviewStatusApi.md

Latest commit

 

History

History
219 lines (153 loc) · 10.5 KB

CustomerReturnOverviewStatusApi.md

File metadata and controls

219 lines (153 loc) · 10.5 KB

BeLenka\SAP\CustomerReturn\CustomerReturnOverviewStatusApi

All URIs are relative to https://:/sap/opu/odata/sap/API_CUSTOMER_RETURN_SRV, except if the operation defines another base path.

Method HTTP request Description
aCustomerReturnCustomerReturnToCustomerReturnOverviewStatusGet() GET /A_CustomerReturn('{CustomerReturn}')/to_CustomerReturnOverviewStatus Reads the customer return overview statuses of a specific returns order.
aCustomerReturnOverviewStatusGet() GET /A_CustomerReturnOverviewStatus Reads all customer return overview statuses.
aCustomerReturnOverviewStatusRetsMgmtProcessGet() GET /A_CustomerReturnOverviewStatus('{RetsMgmtProcess}') Reads the specific customer return overview statuses.

aCustomerReturnCustomerReturnToCustomerReturnOverviewStatusGet()

aCustomerReturnCustomerReturnToCustomerReturnOverviewStatusGet($customer_return, $select): \BeLenka\SAP\CustomerReturn\Model\ACustomerReturnOverviewStatusType

Reads the customer return overview statuses of a specific returns order.

Reads the processing status, logistical status, and refunding status from the header of a specific returns order, which the consumer specifies by passing the returns order number.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\CustomerReturn\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\CustomerReturn\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\CustomerReturn\Api\CustomerReturnOverviewStatusApi(
    // 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
);
$customer_return = 'customer_return_example'; // string | Customer Return
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aCustomerReturnCustomerReturnToCustomerReturnOverviewStatusGet($customer_return, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerReturnOverviewStatusApi->aCustomerReturnCustomerReturnToCustomerReturnOverviewStatusGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
customer_return string Customer Return
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\CustomerReturn\Model\ACustomerReturnOverviewStatusType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aCustomerReturnOverviewStatusGet()

aCustomerReturnOverviewStatusGet($top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\CustomerReturn\Model\Wrapper13

Reads all customer return overview statuses.

Reads the processing status, logistical status, and refunding status from the headers of all returns orders in the system.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\CustomerReturn\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\CustomerReturn\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\CustomerReturn\Api\CustomerReturnOverviewStatusApi(
    // 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
);
$top = 50; // int | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)
$inlinecount = 'inlinecount_example'; // string | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aCustomerReturnOverviewStatusGet($top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerReturnOverviewStatusApi->aCustomerReturnOverviewStatusGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
top int Show only the first n items, see Paging - Top [optional]
skip int Skip the first n items, see Paging - Skip [optional]
filter string Filter items by property values, see Filtering [optional]
inlinecount string Include count of items, see Inlinecount [optional]
orderby string[] Order items by property values, see Sorting [optional]
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\CustomerReturn\Model\Wrapper13

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

aCustomerReturnOverviewStatusRetsMgmtProcessGet()

aCustomerReturnOverviewStatusRetsMgmtProcessGet($rets_mgmt_process, $select): \BeLenka\SAP\CustomerReturn\Model\ACustomerReturnOverviewStatusType

Reads the specific customer return overview statuses.

Reads the processing status, logistical status, and refunding status from a specific customer return process, which the consumer specifies by passing the process ID.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\CustomerReturn\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\CustomerReturn\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\CustomerReturn\Api\CustomerReturnOverviewStatusApi(
    // 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
);
$rets_mgmt_process = 'rets_mgmt_process_example'; // string | Process Identification Number
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aCustomerReturnOverviewStatusRetsMgmtProcessGet($rets_mgmt_process, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerReturnOverviewStatusApi->aCustomerReturnOverviewStatusRetsMgmtProcessGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
rets_mgmt_process string Process Identification Number
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\CustomerReturn\Model\ACustomerReturnOverviewStatusType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]