Skip to content

SerialNumberApi.md

Latest commit

 

History

History
235 lines (169 loc) · 13.2 KB

SerialNumberApi.md

File metadata and controls

235 lines (169 loc) · 13.2 KB

BeLenka\SAP\CustomerReturn\SerialNumberApi

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
aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToSerialNumberGet() GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_SerialNumber Reads the serial numbers of a specific item.
aCustomerReturnSerialNumberCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSerialNumberSerialNumberGet() GET /A_CustomerReturnSerialNumber(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',SerialNumber='{SerialNumber}') Reads a specific serial number.
aCustomerReturnSerialNumberGet() GET /A_CustomerReturnSerialNumber Reads all serial numbers.

aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToSerialNumberGet()

aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToSerialNumberGet($customer_return, $customer_return_item, $top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\CustomerReturn\Model\Wrapper11

Reads the serial numbers of a specific item.

Reads the serial numbers that are assigned to the individual products of a specific returns order item. Consumer must pass the following key fields: returns order number and item 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\SerialNumberApi(
    // 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
$customer_return_item = 'customer_return_item_example'; // string | Customer Return Item
$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->aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToSerialNumberGet($customer_return, $customer_return_item, $top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SerialNumberApi->aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToSerialNumberGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
customer_return string Customer Return
customer_return_item string Customer Return Item
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\Wrapper11

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]

aCustomerReturnSerialNumberCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSerialNumberSerialNumberGet()

aCustomerReturnSerialNumberCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSerialNumberSerialNumberGet($customer_return, $customer_return_item, $serial_number, $select): \BeLenka\SAP\CustomerReturn\Model\ACustomerReturnSerialNumberType

Reads a specific serial number.

Reads a specific serial number, which the consumer specifies by passing the returns order number, item number, and serial 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\SerialNumberApi(
    // 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 | Sales Document
$customer_return_item = 'customer_return_item_example'; // string | Sales Document Item
$serial_number = 'serial_number_example'; // string | Serial 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->aCustomerReturnSerialNumberCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSerialNumberSerialNumberGet($customer_return, $customer_return_item, $serial_number, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SerialNumberApi->aCustomerReturnSerialNumberCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSerialNumberSerialNumberGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
customer_return string Sales Document
customer_return_item string Sales Document Item
serial_number string Serial Number
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\CustomerReturn\Model\ACustomerReturnSerialNumberType

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]

aCustomerReturnSerialNumberGet()

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

Reads all serial numbers.

Reads the serial numbers that are assigned to the individual products of all returns order items.

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\SerialNumberApi(
    // 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->aCustomerReturnSerialNumberGet($top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SerialNumberApi->aCustomerReturnSerialNumberGet: ', $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\Wrapper11

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]