BeLenka\SAP\CustomerReturn\HeaderTextApi

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
aCustomerReturnCustomerReturnToTextGet()	GET /A_CustomerReturn('{CustomerReturn}')/to_Text	Reads the header-level texts of a specific returns order.
aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDDelete()	DELETE /A_CustomerReturnText(CustomerReturn='{CustomerReturn}',Language='{Language}',LongTextID='{LongTextID}')	Deletes a specific piece of header-level text.
aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDGet()	GET /A_CustomerReturnText(CustomerReturn='{CustomerReturn}',Language='{Language}',LongTextID='{LongTextID}')	Reads a specific piece of header-level text.
aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDPatch()	PATCH /A_CustomerReturnText(CustomerReturn='{CustomerReturn}',Language='{Language}',LongTextID='{LongTextID}')	Updates a specific piece of header-level text.
aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet()	GET /A_CustomerReturnText(CustomerReturn='{CustomerReturn}',Language='{Language}',LongTextID='{LongTextID}')/to_CustomerReturn	Reads the returns order header for a specific piece of header-level text.
aCustomerReturnTextGet()	GET /A_CustomerReturnText	Reads all header-level texts.

`aCustomerReturnCustomerReturnToTextGet()`

aCustomerReturnCustomerReturnToTextGet($customer_return, $top, $skip, $filter, $inlinecount, $orderby, $select, $expand): \BeLenka\SAP\CustomerReturn\Model\Wrapper5

Reads the header-level texts of a specific returns order.

Reads texts data 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\HeaderTextApi(
    // 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
$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)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)

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

Parameters

Name	Type	Description	Notes
customer_return	string	Customer Return
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]
expand	string[]	Expand related entities, see Expand	[optional]

Return type

\BeLenka\SAP\CustomerReturn\Model\Wrapper5

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]

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDDelete()`

aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDDelete($customer_return, $language, $long_text_id)

Deletes a specific piece of header-level text.

Deletes a specific piece of text at the returns order header level, which the consumer specifies by passing the returns order number, language key, and text 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\HeaderTextApi(
    // 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
$language = 'language_example'; // string | Language Key
$long_text_id = 'long_text_id_example'; // string | Text ID

try {
    $apiInstance->aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDDelete($customer_return, $language, $long_text_id);
} catch (Exception $e) {
    echo 'Exception when calling HeaderTextApi->aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
customer_return	string	Customer Return
language	string	Language Key
long_text_id	string	Text ID

Return type

void (empty response body)

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]

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDGet()`

aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDGet($customer_return, $language, $long_text_id, $select, $expand): \BeLenka\SAP\CustomerReturn\Model\ACustomerReturnTextType

Reads a specific piece of header-level text.

Reads a specific piece of text at the returns order header level, which the consumer specifies by passing the returns order number, language key, and text 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\HeaderTextApi(
    // 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
$language = 'language_example'; // string | Language Key
$long_text_id = 'long_text_id_example'; // string | Text ID
$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)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)

try {
    $result = $apiInstance->aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDGet($customer_return, $language, $long_text_id, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HeaderTextApi->aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customer_return	string	Customer Return
language	string	Language Key
long_text_id	string	Text ID
select	string[]	Select properties to be returned, see Select	[optional]
expand	string[]	Expand related entities, see Expand	[optional]

Return type

\BeLenka\SAP\CustomerReturn\Model\ACustomerReturnTextType

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]

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDPatch()`

aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDPatch($customer_return, $language, $long_text_id, $modified_a_customer_return_text_type)

Updates a specific piece of header-level text.

Updates a specific piece of text at the returns order header level, which the consumer specifies by passing the returns order number, language key, and text 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\HeaderTextApi(
    // 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
$language = 'language_example'; // string | Language Key
$long_text_id = 'long_text_id_example'; // string | Text ID
$modified_a_customer_return_text_type = new \BeLenka\SAP\CustomerReturn\Model\ModifiedACustomerReturnTextType(); // \BeLenka\SAP\CustomerReturn\Model\ModifiedACustomerReturnTextType | New property values

try {
    $apiInstance->aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDPatch($customer_return, $language, $long_text_id, $modified_a_customer_return_text_type);
} catch (Exception $e) {
    echo 'Exception when calling HeaderTextApi->aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
customer_return	string	Customer Return
language	string	Language Key
long_text_id	string	Text ID
modified_a_customer_return_text_type	\BeLenka\SAP\CustomerReturn\Model\ModifiedACustomerReturnTextType	New property values

Return type

void (empty response body)

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet()`

aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet($customer_return, $language, $long_text_id, $select, $expand): \BeLenka\SAP\CustomerReturn\Model\ACustomerReturnType

Reads the returns order header for a specific piece of header-level text.

Reads returns order header fields for a specific piece of header-level text.Consumers must pass the returns order number, language key, and text 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\HeaderTextApi(
    // 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
$language = 'language_example'; // string | Language Key
$long_text_id = 'long_text_id_example'; // string | Text ID
$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)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)

try {
    $result = $apiInstance->aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet($customer_return, $language, $long_text_id, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HeaderTextApi->aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customer_return	string	Customer Return
language	string	Language Key
long_text_id	string	Text ID
select	string[]	Select properties to be returned, see Select	[optional]
expand	string[]	Expand related entities, see Expand	[optional]

Return type

\BeLenka\SAP\CustomerReturn\Model\ACustomerReturnType

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]

`aCustomerReturnTextGet()`

aCustomerReturnTextGet($top, $skip, $filter, $inlinecount, $orderby, $select, $expand): \BeLenka\SAP\CustomerReturn\Model\Wrapper5

Reads all header-level texts.

Reads text data from the headers of all returns orders in the system. The data includes text ID, actual text, language, and more.

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\HeaderTextApi(
    // 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)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)

try {
    $result = $apiInstance->aCustomerReturnTextGet($top, $skip, $filter, $inlinecount, $orderby, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HeaderTextApi->aCustomerReturnTextGet: ', $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]
expand	string[]	Expand related entities, see Expand	[optional]

Return type

\BeLenka\SAP\CustomerReturn\Model\Wrapper5

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]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BeLenka\SAP\CustomerReturn\HeaderTextApi

`aCustomerReturnCustomerReturnToTextGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDDelete()`

Example

Parameters

Return type

Authorization

HTTP request headers

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDPatch()`

Example

Parameters

Return type

Authorization

HTTP request headers

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`aCustomerReturnTextGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

HeaderTextApi.md

Latest commit

History

HeaderTextApi.md

File metadata and controls

BeLenka\SAP\CustomerReturn\HeaderTextApi

aCustomerReturnCustomerReturnToTextGet()

Example

Parameters

Return type

Authorization

HTTP request headers

aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDGet()

Example

Parameters

Return type

Authorization

HTTP request headers

aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet()

Example

Parameters

Return type

Authorization

HTTP request headers

aCustomerReturnTextGet()

Example

Parameters

Return type

Authorization

HTTP request headers

`aCustomerReturnCustomerReturnToTextGet()`

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDDelete()`

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDGet()`

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDPatch()`

`aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet()`

`aCustomerReturnTextGet()`