Skip to content

be-lenka/sap_customer-return

BranchesTags

Repository files navigation

OpenAPIClient-php

You can use this service to integrate external applications with customer return processing in SAP S/4HANA Cloud. In every API call, you can make use of the following operations:

  • You can retrieve returns orders. Apply any of the filters provided or retrieve all existing data.
  • You can create returns orders. Note that you must use “deep insert” requests (a header plus the following entities: header partner, header pricing element, item, item partner, and item pricing element). You cannot create headers without including any related entities.
  • For existing returns orders, you can create new items. Note that you must use “deep insert” requests (with the following entities: item partner and item pricing element). You cannot create items without including any related entities.
  • For existing returns orders, you can add additional business partners at header and item levels.
  • For existing returns orders, you can update the header, header partner, header pricing element, item, item partner, and item pricing element.
  • For existing returns orders, you can delete the header, header partner, header pricing element, item, item partner, and item pricing element.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?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\BatchRequestsApi(
    // 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
);

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

API Endpoints

All URIs are relative to https://:/sap/opu/odata/sap/API_CUSTOMER_RETURN_SRV

Class Method HTTP request Description
BatchRequestsApi batchPost POST /$batch Send a group of requests
CustomerReturnOverviewStatusApi aCustomerReturnCustomerReturnToCustomerReturnOverviewStatusGet GET /A_CustomerReturn('{CustomerReturn}')/to_CustomerReturnOverviewStatus Reads the customer return overview statuses of a specific returns order.
CustomerReturnOverviewStatusApi aCustomerReturnOverviewStatusGet GET /A_CustomerReturnOverviewStatus Reads all customer return overview statuses.
CustomerReturnOverviewStatusApi aCustomerReturnOverviewStatusRetsMgmtProcessGet GET /A_CustomerReturnOverviewStatus('{RetsMgmtProcess}') Reads the specific customer return overview statuses.
HeaderPartnerApi aCustomerReturnCustomerReturnToPartnerGet GET /A_CustomerReturn('{CustomerReturn}')/to_Partner Reads the header-level business partners of a specific returns order.
HeaderPartnerApi aCustomerReturnCustomerReturnToPartnerPost POST /A_CustomerReturn('{CustomerReturn}')/to_Partner Creates a header partner for a returns order.
HeaderPartnerApi aCustomerReturnPartnerCustomerReturnCustomerReturnPartnerFunctionPartnerFunctionDelete DELETE /A_CustomerReturnPartner(CustomerReturn='{CustomerReturn}',PartnerFunction='{PartnerFunction}') Deletes a specific header-level business partner.
HeaderPartnerApi aCustomerReturnPartnerCustomerReturnCustomerReturnPartnerFunctionPartnerFunctionGet GET /A_CustomerReturnPartner(CustomerReturn='{CustomerReturn}',PartnerFunction='{PartnerFunction}') Reads a specific header-level business partner.
HeaderPartnerApi aCustomerReturnPartnerCustomerReturnCustomerReturnPartnerFunctionPartnerFunctionPatch PATCH /A_CustomerReturnPartner(CustomerReturn='{CustomerReturn}',PartnerFunction='{PartnerFunction}') Updates a specific header-level business partner.
HeaderPartnerApi aCustomerReturnPartnerCustomerReturnCustomerReturnPartnerFunctionPartnerFunctionToCustomerReturnGet GET /A_CustomerReturnPartner(CustomerReturn='{CustomerReturn}',PartnerFunction='{PartnerFunction}')/to_CustomerReturn Reads the returns order header for a specific header-level business partner.
HeaderPartnerApi aCustomerReturnPartnerGet GET /A_CustomerReturnPartner Reads all header-level business partners.
HeaderPartnerApi aCustomerReturnPartnerPost POST /A_CustomerReturnPartner Creates a header partner for a specific returns order with a specific partner function.
HeaderPricingElementApi aCustomerReturnCustomerReturnToPricingElementGet GET /A_CustomerReturn('{CustomerReturn}')/to_PricingElement Reads the header-level pricing elements of a specific returns order.
HeaderPricingElementApi aCustomerReturnPrcgElmntCustomerReturnCustomerReturnPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterDelete DELETE /A_CustomerReturnPrcgElmnt(CustomerReturn='{CustomerReturn}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}') Deletes a specific header-level pricing element.
HeaderPricingElementApi aCustomerReturnPrcgElmntCustomerReturnCustomerReturnPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterGet GET /A_CustomerReturnPrcgElmnt(CustomerReturn='{CustomerReturn}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}') Reads a specific header-level pricing element.
HeaderPricingElementApi aCustomerReturnPrcgElmntCustomerReturnCustomerReturnPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterPatch PATCH /A_CustomerReturnPrcgElmnt(CustomerReturn='{CustomerReturn}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}') Updates a specific header-level pricing element.
HeaderPricingElementApi aCustomerReturnPrcgElmntCustomerReturnCustomerReturnPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToCustomerReturnGet GET /A_CustomerReturnPrcgElmnt(CustomerReturn='{CustomerReturn}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_CustomerReturn Reads the returns order header for a specific header-level pricing element.
HeaderPricingElementApi aCustomerReturnPrcgElmntGet GET /A_CustomerReturnPrcgElmnt Reads all header-level pricing elements.
HeaderRelatedObjectApi aCustomerReturnCustomerReturnToRelatedObjectGet GET /A_CustomerReturn('{CustomerReturn}')/to_RelatedObject Reads the related objects from a returns order header.
HeaderRelatedObjectApi aCustomerReturnCustomerReturnToRelatedObjectPost POST /A_CustomerReturn('{CustomerReturn}')/to_RelatedObject Creates related objects for a returns order header.
HeaderRelatedObjectApi aCustomerReturnRelatedObjectCustomerReturnCustomerReturnSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrDelete DELETE /A_CustomerReturnRelatedObject(CustomerReturn='{CustomerReturn}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}') Deletes a specific related object from a returns order header.
HeaderRelatedObjectApi aCustomerReturnRelatedObjectCustomerReturnCustomerReturnSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrGet GET /A_CustomerReturnRelatedObject(CustomerReturn='{CustomerReturn}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}') Reads a specific related object from a returns order header.
HeaderRelatedObjectApi aCustomerReturnRelatedObjectCustomerReturnCustomerReturnSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrToCustomerReturnGet GET /A_CustomerReturnRelatedObject(CustomerReturn='{CustomerReturn}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}')/to_CustomerReturn Reads the returns order header for a specific related object.
HeaderRelatedObjectApi aCustomerReturnRelatedObjectGet GET /A_CustomerReturnRelatedObject Reads the related objects from the headers of all returns orders.
HeaderRelatedObjectApi aCustomerReturnRelatedObjectPost POST /A_CustomerReturnRelatedObject Creates a specific related object for a returns order header.
HeaderTextApi aCustomerReturnCustomerReturnToTextGet GET /A_CustomerReturn('{CustomerReturn}')/to_Text Reads the header-level texts of a specific returns order.
HeaderTextApi aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDDelete DELETE /A_CustomerReturnText(CustomerReturn='{CustomerReturn}',Language='{Language}',LongTextID='{LongTextID}') Deletes a specific piece of header-level text.
HeaderTextApi aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDGet GET /A_CustomerReturnText(CustomerReturn='{CustomerReturn}',Language='{Language}',LongTextID='{LongTextID}') Reads a specific piece of header-level text.
HeaderTextApi aCustomerReturnTextCustomerReturnCustomerReturnLanguageLanguageLongTextIDLongTextIDPatch PATCH /A_CustomerReturnText(CustomerReturn='{CustomerReturn}',Language='{Language}',LongTextID='{LongTextID}') Updates a specific piece of header-level text.
HeaderTextApi 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.
HeaderTextApi aCustomerReturnTextGet GET /A_CustomerReturnText Reads all header-level texts.
ItemPartnerApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToPartnerGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_Partner Reads the item-level business partners of a specific item.
ItemPartnerApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToPartnerPost POST /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_Partner Creates a header partner for a returns order.
ItemPartnerApi aCustomerReturnItemPartnerCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPartnerFunctionPartnerFunctionDelete DELETE /A_CustomerReturnItemPartner(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PartnerFunction='{PartnerFunction}') Deletes a specific item-level business partner.
ItemPartnerApi aCustomerReturnItemPartnerCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPartnerFunctionPartnerFunctionGet GET /A_CustomerReturnItemPartner(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PartnerFunction='{PartnerFunction}') Reads a specific item-level business partner.
ItemPartnerApi aCustomerReturnItemPartnerCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPartnerFunctionPartnerFunctionPatch PATCH /A_CustomerReturnItemPartner(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PartnerFunction='{PartnerFunction}') Updates a specific item-level business partner.
ItemPartnerApi aCustomerReturnItemPartnerCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPartnerFunctionPartnerFunctionToCustomerReturnGet GET /A_CustomerReturnItemPartner(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PartnerFunction='{PartnerFunction}')/to_CustomerReturn Reads the returns order header for a specific item-level business partner.
ItemPartnerApi aCustomerReturnItemPartnerCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPartnerFunctionPartnerFunctionToCustomerReturnItemGet GET /A_CustomerReturnItemPartner(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PartnerFunction='{PartnerFunction}')/to_CustomerReturnItem Reads the returns order item for a specific item-level business partner.
ItemPartnerApi aCustomerReturnItemPartnerGet GET /A_CustomerReturnItemPartner Reads all item-level business partners.
ItemPartnerApi aCustomerReturnItemPartnerPost POST /A_CustomerReturnItemPartner Creates a partner for a returns order item with a specific partner function.
ItemPricingElementApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToPricingElementGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_PricingElement Reads the item-level pricing elements of a specific item.
ItemPricingElementApi aCustomerReturnItemPrcgElmntCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterDelete DELETE /A_CustomerReturnItemPrcgElmnt(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}') Deletes a specific item-level pricing element.
ItemPricingElementApi aCustomerReturnItemPrcgElmntCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterGet GET /A_CustomerReturnItemPrcgElmnt(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}') Reads a specific item-level pricing element.
ItemPricingElementApi aCustomerReturnItemPrcgElmntCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterPatch PATCH /A_CustomerReturnItemPrcgElmnt(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}') Updates a specific item-level pricing element.
ItemPricingElementApi aCustomerReturnItemPrcgElmntCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToCustomerReturnGet GET /A_CustomerReturnItemPrcgElmnt(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_CustomerReturn Reads the returns order header for a specific item-level pricing element.
ItemPricingElementApi aCustomerReturnItemPrcgElmntCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToCustomerReturnItemGet GET /A_CustomerReturnItemPrcgElmnt(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_CustomerReturnItem Reads the returns order item for a specific item-level pricing element.
ItemPricingElementApi aCustomerReturnItemPrcgElmntGet GET /A_CustomerReturnItemPrcgElmnt Reads all item-level pricing elements.
ItemRelatedObjectApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToRelatedObjectGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_RelatedObject Reads the related objects of a specific returns order item.
ItemRelatedObjectApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToRelatedObjectPost POST /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_RelatedObject Creates related objects for a specific returns order item.
ItemRelatedObjectApi aCustomerReturnItemRelatedObjCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrDelete DELETE /A_CustomerReturnItemRelatedObj(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}') Deletes a specific related object from a specific returns order item.
ItemRelatedObjectApi aCustomerReturnItemRelatedObjCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrGet GET /A_CustomerReturnItemRelatedObj(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}') Reads a specific related object of a specific returns order item.
ItemRelatedObjectApi aCustomerReturnItemRelatedObjCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrToCustomerReturnGet GET /A_CustomerReturnItemRelatedObj(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}')/to_CustomerReturn Reads the returns order header for a specific item-level related object.
ItemRelatedObjectApi aCustomerReturnItemRelatedObjCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrToCustomerReturnItemGet GET /A_CustomerReturnItemRelatedObj(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}')/to_CustomerReturnItem Reads the returns order item for a specific related object.
ItemRelatedObjectApi aCustomerReturnItemRelatedObjGet GET /A_CustomerReturnItemRelatedObj Reads the related objects of all returns order items.
ItemRelatedObjectApi aCustomerReturnItemRelatedObjPost POST /A_CustomerReturnItemRelatedObj Creates a specific related object for a specific returns order item.
ItemTextApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToTextGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_Text Reads the item-level texts of a specific item.
ItemTextApi aCustomerReturnItemTextCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemLanguageLanguageLongTextIDLongTextIDDelete DELETE /A_CustomerReturnItemText(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',Language='{Language}',LongTextID='{LongTextID}') Deletes a specific piece of item-level text.
ItemTextApi aCustomerReturnItemTextCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemLanguageLanguageLongTextIDLongTextIDGet GET /A_CustomerReturnItemText(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',Language='{Language}',LongTextID='{LongTextID}') Reads a specific piece of item-level text.
ItemTextApi aCustomerReturnItemTextCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemLanguageLanguageLongTextIDLongTextIDPatch PATCH /A_CustomerReturnItemText(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',Language='{Language}',LongTextID='{LongTextID}') Updates a specific piece of item-level text.
ItemTextApi aCustomerReturnItemTextCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet GET /A_CustomerReturnItemText(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',Language='{Language}',LongTextID='{LongTextID}')/to_CustomerReturn Reads the returns order header for a specific piece of item-level text.
ItemTextApi aCustomerReturnItemTextCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemLanguageLanguageLongTextIDLongTextIDToCustomerReturnItemGet GET /A_CustomerReturnItemText(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',Language='{Language}',LongTextID='{LongTextID}')/to_CustomerReturnItem Reads the returns order item for a specific piece of item-level text.
ItemTextApi aCustomerReturnItemTextGet GET /A_CustomerReturnItemText Reads all item-level texts.
ReturnProcessStepApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToProcessStepGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_ProcessStep Reads the advanced returns process steps of a specific item.
ReturnProcessStepApi aCustomerReturnProcessStepGet GET /A_CustomerReturnProcessStep Reads all advanced returns process steps.
ReturnProcessStepApi aCustomerReturnProcessStepRetsMgmtProcessRetsMgmtProcessRetsMgmtProcessItemRetsMgmtProcessItemRetsMgmtProcItmQtySplitRetsMgmtProcItmQtySplitRetsMgmtProcessStepRetsMgmtProcessStepReturnsDocumentTypeReturnsDocumentTypeReturnsDocumentReturnsDocumentReturnsDocumentItemReturnsDocumentItemGet GET /A_CustomerReturnProcessStep(RetsMgmtProcess='{RetsMgmtProcess}',RetsMgmtProcessItem='{RetsMgmtProcessItem}',RetsMgmtProcItmQtySplit='{RetsMgmtProcItmQtySplit}',RetsMgmtProcessStep='{RetsMgmtProcessStep}',ReturnsDocumentType='{ReturnsDocumentType}',ReturnsDocument='{ReturnsDocument}',ReturnsDocumentItem='{ReturnsDocumentItem}') Reads a specific advanced returns process step.
ReturnProcessStepApi aCustomerReturnProcessStepRetsMgmtProcessRetsMgmtProcessRetsMgmtProcessItemRetsMgmtProcessItemRetsMgmtProcItmQtySplitRetsMgmtProcItmQtySplitRetsMgmtProcessStepRetsMgmtProcessStepReturnsDocumentTypeReturnsDocumentTypeReturnsDocumentReturnsDocumentReturnsDocumentItemReturnsDocumentItemToCustomerReturnGet GET /A_CustomerReturnProcessStep(RetsMgmtProcess='{RetsMgmtProcess}',RetsMgmtProcessItem='{RetsMgmtProcessItem}',RetsMgmtProcItmQtySplit='{RetsMgmtProcItmQtySplit}',RetsMgmtProcessStep='{RetsMgmtProcessStep}',ReturnsDocumentType='{ReturnsDocumentType}',ReturnsDocument='{ReturnsDocument}',ReturnsDocumentItem='{ReturnsDocumentItem}')/to_CustomerReturn Reads the returns order header for a specific advanced returns process step.
ReturnProcessStepApi aCustomerReturnProcessStepRetsMgmtProcessRetsMgmtProcessRetsMgmtProcessItemRetsMgmtProcessItemRetsMgmtProcItmQtySplitRetsMgmtProcItmQtySplitRetsMgmtProcessStepRetsMgmtProcessStepReturnsDocumentTypeReturnsDocumentTypeReturnsDocumentReturnsDocumentReturnsDocumentItemReturnsDocumentItemToCustomerReturnItemGet GET /A_CustomerReturnProcessStep(RetsMgmtProcess='{RetsMgmtProcess}',RetsMgmtProcessItem='{RetsMgmtProcessItem}',RetsMgmtProcItmQtySplit='{RetsMgmtProcItmQtySplit}',RetsMgmtProcessStep='{RetsMgmtProcessStep}',ReturnsDocumentType='{ReturnsDocumentType}',ReturnsDocument='{ReturnsDocument}',ReturnsDocumentItem='{ReturnsDocumentItem}')/to_CustomerReturnItem Reads the returns order item for a specific advanced returns process step.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnDelete DELETE /A_CustomerReturn('{CustomerReturn}') Deletes a specific returns order.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnGet GET /A_CustomerReturn('{CustomerReturn}') Reads the header of a specific returns order.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnPatch PATCH /A_CustomerReturn('{CustomerReturn}') Updates the header of a specific returns order.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnToCustomerReturnOverviewStatusGet GET /A_CustomerReturn('{CustomerReturn}')/to_CustomerReturnOverviewStatus Reads the customer return overview statuses of a specific returns order.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnToItemGet GET /A_CustomerReturn('{CustomerReturn}')/to_Item Reads all items of a specific returns order.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnToItemPost POST /A_CustomerReturn('{CustomerReturn}')/to_Item Creates one or more items for a specific returns order.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnToPartnerGet GET /A_CustomerReturn('{CustomerReturn}')/to_Partner Reads the header-level business partners of a specific returns order.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnToPartnerPost POST /A_CustomerReturn('{CustomerReturn}')/to_Partner Creates a header partner for a returns order.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnToPricingElementGet GET /A_CustomerReturn('{CustomerReturn}')/to_PricingElement Reads the header-level pricing elements of a specific returns order.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnToRelatedObjectGet GET /A_CustomerReturn('{CustomerReturn}')/to_RelatedObject Reads the related objects from a returns order header.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnToRelatedObjectPost POST /A_CustomerReturn('{CustomerReturn}')/to_RelatedObject Creates related objects for a returns order header.
ReturnsOrderHeaderApi aCustomerReturnCustomerReturnToTextGet GET /A_CustomerReturn('{CustomerReturn}')/to_Text Reads the header-level texts of a specific returns order.
ReturnsOrderHeaderApi aCustomerReturnGet GET /A_CustomerReturn Reads all returns order headers.
ReturnsOrderHeaderApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToCustomerReturnGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_CustomerReturn Reads the returns order header for a specific item.
ReturnsOrderHeaderApi aCustomerReturnItemPartnerCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPartnerFunctionPartnerFunctionToCustomerReturnGet GET /A_CustomerReturnItemPartner(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PartnerFunction='{PartnerFunction}')/to_CustomerReturn Reads the returns order header for a specific item-level business partner.
ReturnsOrderHeaderApi aCustomerReturnItemPrcgElmntCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToCustomerReturnGet GET /A_CustomerReturnItemPrcgElmnt(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_CustomerReturn Reads the returns order header for a specific item-level pricing element.
ReturnsOrderHeaderApi aCustomerReturnItemRelatedObjCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrToCustomerReturnGet GET /A_CustomerReturnItemRelatedObj(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}')/to_CustomerReturn Reads the returns order header for a specific item-level related object.
ReturnsOrderHeaderApi aCustomerReturnItemTextCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemLanguageLanguageLongTextIDLongTextIDToCustomerReturnGet GET /A_CustomerReturnItemText(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',Language='{Language}',LongTextID='{LongTextID}')/to_CustomerReturn Reads the returns order header for a specific piece of item-level text.
ReturnsOrderHeaderApi aCustomerReturnPartnerCustomerReturnCustomerReturnPartnerFunctionPartnerFunctionToCustomerReturnGet GET /A_CustomerReturnPartner(CustomerReturn='{CustomerReturn}',PartnerFunction='{PartnerFunction}')/to_CustomerReturn Reads the returns order header for a specific header-level business partner.
ReturnsOrderHeaderApi aCustomerReturnPost POST /A_CustomerReturn Creates one or more returns order headers.
ReturnsOrderHeaderApi aCustomerReturnPrcgElmntCustomerReturnCustomerReturnPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToCustomerReturnGet GET /A_CustomerReturnPrcgElmnt(CustomerReturn='{CustomerReturn}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_CustomerReturn Reads the returns order header for a specific header-level pricing element.
ReturnsOrderHeaderApi aCustomerReturnProcessStepRetsMgmtProcessRetsMgmtProcessRetsMgmtProcessItemRetsMgmtProcessItemRetsMgmtProcItmQtySplitRetsMgmtProcItmQtySplitRetsMgmtProcessStepRetsMgmtProcessStepReturnsDocumentTypeReturnsDocumentTypeReturnsDocumentReturnsDocumentReturnsDocumentItemReturnsDocumentItemToCustomerReturnGet GET /A_CustomerReturnProcessStep(RetsMgmtProcess='{RetsMgmtProcess}',RetsMgmtProcessItem='{RetsMgmtProcessItem}',RetsMgmtProcItmQtySplit='{RetsMgmtProcItmQtySplit}',RetsMgmtProcessStep='{RetsMgmtProcessStep}',ReturnsDocumentType='{ReturnsDocumentType}',ReturnsDocument='{ReturnsDocument}',ReturnsDocumentItem='{ReturnsDocumentItem}')/to_CustomerReturn Reads the returns order header for a specific advanced returns process step.
ReturnsOrderHeaderApi aCustomerReturnRelatedObjectCustomerReturnCustomerReturnSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrToCustomerReturnGet GET /A_CustomerReturnRelatedObject(CustomerReturn='{CustomerReturn}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}')/to_CustomerReturn Reads the returns order header for a specific related object.
ReturnsOrderHeaderApi aCustomerReturnScheduleLineCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemScheduleLineScheduleLineToCustomerReturnGet GET /A_CustomerReturnScheduleLine(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',ScheduleLine='{ScheduleLine}')/to_CustomerReturn Reads the returns order header for a specific schedule line.
ReturnsOrderHeaderApi 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.
ReturnsOrderItemApi aCustomerReturnCustomerReturnToItemGet GET /A_CustomerReturn('{CustomerReturn}')/to_Item Reads all items of a specific returns order.
ReturnsOrderItemApi aCustomerReturnCustomerReturnToItemPost POST /A_CustomerReturn('{CustomerReturn}')/to_Item Creates one or more items for a specific returns order.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemDelete DELETE /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}') Deletes a specific returns order item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}') Reads a specific returns order item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPatch PATCH /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}') Update a specific returns order item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToCustomerReturnGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_CustomerReturn Reads the returns order header for a specific item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToPartnerGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_Partner Reads the item-level business partners of a specific item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToPartnerPost POST /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_Partner Creates a header partner for a returns order.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToPricingElementGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_PricingElement Reads the item-level pricing elements of a specific item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToProcessStepGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_ProcessStep Reads the advanced returns process steps of a specific item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToRelatedObjectGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_RelatedObject Reads the related objects of a specific returns order item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToRelatedObjectPost POST /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_RelatedObject Creates related objects for a specific returns order item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToScheduleLineGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_ScheduleLine Reads the schedule lines of a specific item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToSerialNumberGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_SerialNumber Reads the serial numbers of a specific item.
ReturnsOrderItemApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToTextGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_Text Reads the item-level texts of a specific item.
ReturnsOrderItemApi aCustomerReturnItemGet GET /A_CustomerReturnItem Reads all returns order items.
ReturnsOrderItemApi aCustomerReturnItemPartnerCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPartnerFunctionPartnerFunctionToCustomerReturnItemGet GET /A_CustomerReturnItemPartner(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PartnerFunction='{PartnerFunction}')/to_CustomerReturnItem Reads the returns order item for a specific item-level business partner.
ReturnsOrderItemApi aCustomerReturnItemPost POST /A_CustomerReturnItem Creates one or more returns order items.
ReturnsOrderItemApi aCustomerReturnItemPrcgElmntCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToCustomerReturnItemGet GET /A_CustomerReturnItemPrcgElmnt(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_CustomerReturnItem Reads the returns order item for a specific item-level pricing element.
ReturnsOrderItemApi aCustomerReturnItemRelatedObjCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSDDocRelatedObjectSequenceNmbrSDDocRelatedObjectSequenceNmbrToCustomerReturnItemGet GET /A_CustomerReturnItemRelatedObj(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',SDDocRelatedObjectSequenceNmbr='{SDDocRelatedObjectSequenceNmbr}')/to_CustomerReturnItem Reads the returns order item for a specific related object.
ReturnsOrderItemApi aCustomerReturnItemTextCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemLanguageLanguageLongTextIDLongTextIDToCustomerReturnItemGet GET /A_CustomerReturnItemText(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',Language='{Language}',LongTextID='{LongTextID}')/to_CustomerReturnItem Reads the returns order item for a specific piece of item-level text.
ReturnsOrderItemApi aCustomerReturnProcessStepRetsMgmtProcessRetsMgmtProcessRetsMgmtProcessItemRetsMgmtProcessItemRetsMgmtProcItmQtySplitRetsMgmtProcItmQtySplitRetsMgmtProcessStepRetsMgmtProcessStepReturnsDocumentTypeReturnsDocumentTypeReturnsDocumentReturnsDocumentReturnsDocumentItemReturnsDocumentItemToCustomerReturnItemGet GET /A_CustomerReturnProcessStep(RetsMgmtProcess='{RetsMgmtProcess}',RetsMgmtProcessItem='{RetsMgmtProcessItem}',RetsMgmtProcItmQtySplit='{RetsMgmtProcItmQtySplit}',RetsMgmtProcessStep='{RetsMgmtProcessStep}',ReturnsDocumentType='{ReturnsDocumentType}',ReturnsDocument='{ReturnsDocument}',ReturnsDocumentItem='{ReturnsDocumentItem}')/to_CustomerReturnItem Reads the returns order item for a specific advanced returns process step.
ReturnsOrderItemApi aCustomerReturnScheduleLineCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemScheduleLineScheduleLineToCustomerReturnItemGet GET /A_CustomerReturnScheduleLine(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',ScheduleLine='{ScheduleLine}')/to_CustomerReturnItem Reads the returns order item for a specific schedule line.
ScheduleLineApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToScheduleLineGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_ScheduleLine Reads the schedule lines of a specific item.
ScheduleLineApi aCustomerReturnScheduleLineCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemScheduleLineScheduleLineGet GET /A_CustomerReturnScheduleLine(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',ScheduleLine='{ScheduleLine}') Reads a specific schedule line.
ScheduleLineApi aCustomerReturnScheduleLineCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemScheduleLineScheduleLineToCustomerReturnGet GET /A_CustomerReturnScheduleLine(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',ScheduleLine='{ScheduleLine}')/to_CustomerReturn Reads the returns order header for a specific schedule line.
ScheduleLineApi aCustomerReturnScheduleLineCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemScheduleLineScheduleLineToCustomerReturnItemGet GET /A_CustomerReturnScheduleLine(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',ScheduleLine='{ScheduleLine}')/to_CustomerReturnItem Reads the returns order item for a specific schedule line.
ScheduleLineApi aCustomerReturnScheduleLineGet GET /A_CustomerReturnScheduleLine Reads all schedule lines.
SerialNumberApi aCustomerReturnItemCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemToSerialNumberGet GET /A_CustomerReturnItem(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}')/to_SerialNumber Reads the serial numbers of a specific item.
SerialNumberApi aCustomerReturnSerialNumberCustomerReturnCustomerReturnCustomerReturnItemCustomerReturnItemSerialNumberSerialNumberGet GET /A_CustomerReturnSerialNumber(CustomerReturn='{CustomerReturn}',CustomerReturnItem='{CustomerReturnItem}',SerialNumber='{SerialNumber}') Reads a specific serial number.
SerialNumberApi aCustomerReturnSerialNumberGet GET /A_CustomerReturnSerialNumber Reads all serial numbers.
ServiceOperationsApi rejectApprovalRequestPost POST /rejectApprovalRequest Rejects a specific returns order.
ServiceOperationsApi releaseApprovalRequestPost POST /releaseApprovalRequest Approves a specific returns order.

Models

Authorization

Authentication schemes defined for the API:

OAuth2Auth

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://{host}:{port}
  • Scopes:
    • API_CUSTOMER_RETURN_SRV_0001:

BasicAuth

  • Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages