Skip to content

be-lenka/sap_customer-returns-delivery

BranchesTags

Repository files navigation

OpenAPIClient-php

This synchronous inbound service enables you to read, create, update, and delete customer returns deliveries. It can be consumed in Fiori apps and on other user interfaces.

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\CustomerReturnsDelivery\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

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


$apiInstance = new BeLenka\SAP\CustomerReturnsDelivery\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_RETURNS_DELIVERY_SRV;v=0002

Class Method HTTP request Description
BatchRequestsApi batchPost POST /$batch Send a group of requests
CustomerReturnsDeliveryDocumentFlowsApi aReturnsDeliveryDocFlowPrecedingDocumentPrecedingDocumentPrecedingDocumentItemPrecedingDocumentItemSubsequentDocumentCategorySubsequentDocumentCategoryGet GET /A_ReturnsDeliveryDocFlow(PrecedingDocument='{PrecedingDocument}',PrecedingDocumentItem='{PrecedingDocumentItem}',SubsequentDocumentCategory='{SubsequentDocumentCategory}') Reads customer returns delivery document flows by key.
CustomerReturnsDeliveryDocumentFlowsApi aReturnsDeliveryDocFlowPrecedingDocumentPrecedingDocumentPrecedingDocumentItemPrecedingDocumentItemSubsequentDocumentCategorySubsequentDocumentCategoryPatch PATCH /A_ReturnsDeliveryDocFlow(PrecedingDocument='{PrecedingDocument}',PrecedingDocumentItem='{PrecedingDocumentItem}',SubsequentDocumentCategory='{SubsequentDocumentCategory}') Updates customer returns delivery document flows.
CustomerReturnsDeliveryDocumentFlowsApi aReturnsDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToDocumentFlowGet GET /A_ReturnsDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_DocumentFlow Reads document flows of specific customer returns delivery item.
CustomerReturnsDeliveryHeadersApi aReturnsDeliveryHeaderDeliveryDocumentDelete DELETE /A_ReturnsDeliveryHeader('{DeliveryDocument}') Deletes customer returns deliveries.
CustomerReturnsDeliveryHeadersApi aReturnsDeliveryHeaderDeliveryDocumentGet GET /A_ReturnsDeliveryHeader('{DeliveryDocument}') Reads customer returns delivery headers.
CustomerReturnsDeliveryHeadersApi aReturnsDeliveryHeaderDeliveryDocumentPatch PATCH /A_ReturnsDeliveryHeader('{DeliveryDocument}') Updates customer returns delivery headers.
CustomerReturnsDeliveryHeadersApi aReturnsDeliveryHeaderDeliveryDocumentToDeliveryDocumentItemGet GET /A_ReturnsDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentItem Reads items of specific customer returns delivery header.
CustomerReturnsDeliveryHeadersApi aReturnsDeliveryHeaderDeliveryDocumentToDeliveryDocumentPartnerGet GET /A_ReturnsDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentPartner Reads partners of specific customer returns delivery header.
CustomerReturnsDeliveryHeadersApi aReturnsDeliveryHeaderGet GET /A_ReturnsDeliveryHeader Reads customer returns delivery headers.
CustomerReturnsDeliveryHeadersApi aReturnsDeliveryHeaderPost POST /A_ReturnsDeliveryHeader Creates customer returns deliveries with reference to preceding document.
CustomerReturnsDeliveryHeadersApi confirmPutawayAllItemsPost POST /ConfirmPutawayAllItems Confirms putaway quantity of customer returns delivery items.
CustomerReturnsDeliveryHeadersApi confirmPutawayOneItemPost POST /ConfirmPutawayOneItem Confirms putaway quantity of customer returns delivery item.
CustomerReturnsDeliveryHeadersApi postGoodsReceiptPost POST /PostGoodsReceipt Posts goods receipt for customer returns delivery.
CustomerReturnsDeliveryHeadersApi putawayAllItemsPost POST /PutawayAllItems Takes over delivery quantity as putaway quantity for all customer returns delivery items.
CustomerReturnsDeliveryHeadersApi putawayOneItemPost POST /PutawayOneItem Takes over delivery quantity as putaway quantity for specified customer returns delivery item.
CustomerReturnsDeliveryHeadersApi putawayOneItemWithBaseQuantityPost POST /PutawayOneItemWithBaseQuantity Sets putaway quantity and delivery quantity for customer returns delivery item.
CustomerReturnsDeliveryHeadersApi putawayOneItemWithSalesQuantityPost POST /PutawayOneItemWithSalesQuantity Sets putaway quantity and delivery quantity for customer returns delivery item.
CustomerReturnsDeliveryHeadersApi reverseGoodsReceiptPost POST /ReverseGoodsReceipt Reverses goods receipt for customer returns delivery.
CustomerReturnsDeliveryHeadersApi setPutawayQuantityWithBaseQuantityPost POST /SetPutawayQuantityWithBaseQuantity Sets putaway quantity in base unit of measure for delivery item.
CustomerReturnsDeliveryItemsApi aReturnsDeliveryHeaderDeliveryDocumentToDeliveryDocumentItemGet GET /A_ReturnsDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentItem Reads items of specific customer returns delivery header.
CustomerReturnsDeliveryItemsApi aReturnsDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemDelete DELETE /A_ReturnsDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}') Deletes customer returns delivery items.
CustomerReturnsDeliveryItemsApi aReturnsDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemGet GET /A_ReturnsDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}') Reads customer returns delivery items.
CustomerReturnsDeliveryItemsApi aReturnsDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemPatch PATCH /A_ReturnsDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}') Updates customer returns delivery items.
CustomerReturnsDeliveryItemsApi aReturnsDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToDocumentFlowGet GET /A_ReturnsDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_DocumentFlow Reads document flows of specific customer returns delivery item.
CustomerReturnsDeliveryItemsApi aReturnsDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToSerialDeliveryItemGet GET /A_ReturnsDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_SerialDeliveryItem Reads maintenance item object lists of specific customer returns delivery item.
CustomerReturnsDeliveryItemsApi aReturnsDeliveryItemGet GET /A_ReturnsDeliveryItem Reads customer returns delivery items.
CustomerReturnsDeliveryItemsApi createBatchSplitItemPost POST /CreateBatchSplitItem Creates an additional batch split item for an customer returns delivery item.
CustomerReturnsDeliveryMaintenanceItemObjectListsApi aReturnsDeliverySrlNmbrMaintenanceItemObjectListToMaintenanceItemObjectGet GET /A_ReturnsDeliverySrlNmbr({MaintenanceItemObjectList})/to_MaintenanceItemObject Reads maintenance item objects of specific customer returns delivery maintenance item object list.
CustomerReturnsDeliveryPartnerAddressesApi aReturnsDeliveryPartnerPartnerFunctionPartnerFunctionSDDocumentSDDocumentToAddressGet GET /A_ReturnsDeliveryPartner(PartnerFunction='{PartnerFunction}',SDDocument='{SDDocument}')/to_Address Reads addresses of specific customer returns delivery partner.
CustomerReturnsDeliveryPartnersApi aReturnsDeliveryHeaderDeliveryDocumentToDeliveryDocumentPartnerGet GET /A_ReturnsDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentPartner Reads partners of specific customer returns delivery header.
CustomerReturnsDeliveryPartnersApi aReturnsDeliveryPartnerPartnerFunctionPartnerFunctionSDDocumentSDDocumentToAddressGet GET /A_ReturnsDeliveryPartner(PartnerFunction='{PartnerFunction}',SDDocument='{SDDocument}')/to_Address Reads addresses of specific customer returns delivery partner.
CustomerReturnsDlvryMaintenanceItemObjectListHeadersApi aReturnsDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToSerialDeliveryItemGet GET /A_ReturnsDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_SerialDeliveryItem Reads maintenance item object lists of specific customer returns delivery item.
CustomerReturnsDlvryMaintenanceItemObjectListHeadersApi aReturnsDeliverySrlNmbrMaintenanceItemObjectListToMaintenanceItemObjectGet GET /A_ReturnsDeliverySrlNmbr({MaintenanceItemObjectList})/to_MaintenanceItemObject Reads maintenance item objects of specific customer returns delivery maintenance item object list.

Models

Authorization

Authentication schemes defined for the API:

OAuth2Auth

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

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: 2.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

No packages published

Languages