Skip to content

be-lenka/sap_outbound-delivery

BranchesTags

Repository files navigation

OpenAPIClient-php

This service enables you to create, read, update and delete outbound 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\OutboundDelivery\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

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


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

Class Method HTTP request Description
BatchRequestsApi batchPost POST /$batch Send a group of requests
HandlingUnitHeadersApi aHandlingUnitHeaderDeliveryPost POST /A_HandlingUnitHeaderDelivery Creates handling unit headers.
HandlingUnitHeadersApi aOutbDeliveryHeaderDeliveryDocumentToHandlingUnitHeaderDeliveryGet GET /A_OutbDeliveryHeader('{DeliveryDocument}')/to_HandlingUnitHeaderDelivery Reads handling units headers of specific outbound delivery header.
HandlingUnitItemsApi aHandlingUnitItemDeliveryPost POST /A_HandlingUnitItemDelivery Creates handling unit items.
OutboundDeliveryDocumentFlowsApi aOutbDeliveryDocFlowPrecedingDocumentPrecedingDocumentPrecedingDocumentItemPrecedingDocumentItemSubsequentDocumentCategorySubsequentDocumentCategoryGet GET /A_OutbDeliveryDocFlow(PrecedingDocument='{PrecedingDocument}',PrecedingDocumentItem='{PrecedingDocumentItem}',SubsequentDocumentCategory='{SubsequentDocumentCategory}') Reads outbound delivery document flows by key.
OutboundDeliveryDocumentFlowsApi aOutbDeliveryDocFlowPrecedingDocumentPrecedingDocumentPrecedingDocumentItemPrecedingDocumentItemSubsequentDocumentCategorySubsequentDocumentCategoryPatch PATCH /A_OutbDeliveryDocFlow(PrecedingDocument='{PrecedingDocument}',PrecedingDocumentItem='{PrecedingDocumentItem}',SubsequentDocumentCategory='{SubsequentDocumentCategory}') Updates outbound delivery document flows.
OutboundDeliveryDocumentFlowsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToDocumentFlowGet GET /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_DocumentFlow Reads document flows of specific outbound delivery item.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderDeliveryDocumentDelete DELETE /A_OutbDeliveryHeader('{DeliveryDocument}') Deletes outbound deliveries.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderDeliveryDocumentGet GET /A_OutbDeliveryHeader('{DeliveryDocument}') Reads outbound delivery headers.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderDeliveryDocumentPatch PATCH /A_OutbDeliveryHeader('{DeliveryDocument}') Updates outbound delivery headers.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderDeliveryDocumentToDeliveryDocumentItemGet GET /A_OutbDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentItem Reads items of specific outbound delivery header.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderDeliveryDocumentToDeliveryDocumentPartnerGet GET /A_OutbDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentPartner Reads partners of specific outbound delivery header.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderDeliveryDocumentToDeliveryDocumentTextGet GET /A_OutbDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentText Reads texts of specific outbound delivery header.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderDeliveryDocumentToDeliveryDocumentTextPost POST /A_OutbDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentText Creates outbound delivery header texts.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderDeliveryDocumentToHandlingUnitHeaderDeliveryGet GET /A_OutbDeliveryHeader('{DeliveryDocument}')/to_HandlingUnitHeaderDelivery Reads handling units headers of specific outbound delivery header.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderGet GET /A_OutbDeliveryHeader Reads outbound delivery headers.
OutboundDeliveryHeadersApi aOutbDeliveryHeaderPost POST /A_OutbDeliveryHeader Creates outbound deliveries with reference to preceding document.
OutboundDeliveryHeadersApi addSerialNumberToDeliveryItemPost POST /AddSerialNumberToDeliveryItem Adds serial number to outbound delivery item.
OutboundDeliveryHeadersApi assignHandlingUnitToDeliveryPost POST /AssignHandlingUnitToDelivery Invoke action AssignHandlingUnitToDelivery
OutboundDeliveryHeadersApi confirmPickingAllItemsPost POST /ConfirmPickingAllItems Confirms picked quantity of outbound delivery items.
OutboundDeliveryHeadersApi confirmPickingOneItemPost POST /ConfirmPickingOneItem Confirms picked quantity of outbound delivery item.
OutboundDeliveryHeadersApi deleteAllHandlingUnitsFromDeliveryPost POST /DeleteAllHandlingUnitsFromDelivery Deletes all handling units from outbound delivery.
OutboundDeliveryHeadersApi deleteAllSerialNumbersFromDeliveryItemPost POST /DeleteAllSerialNumbersFromDeliveryItem Deletes all serial numbers from outbound delivery item.
OutboundDeliveryHeadersApi deleteSerialNumberFromDeliveryItemPost POST /DeleteSerialNumberFromDeliveryItem Deletes serial number from outbound delivery item.
OutboundDeliveryHeadersApi pickAllItemsPost POST /PickAllItems Takes over delivery quantity as picked quantity for all outbound delivery items.
OutboundDeliveryHeadersApi pickAndBatchSplitOneItemPost POST /PickAndBatchSplitOneItem Performs batch split and sets picked quantity.
OutboundDeliveryHeadersApi pickOneItemPost POST /PickOneItem Takes over delivery quantity as picked quantity for specified outbound delivery item.
OutboundDeliveryHeadersApi pickOneItemWithBaseQuantityPost POST /PickOneItemWithBaseQuantity Sets picked quantity and delivery quantity for outbound delivery item.
OutboundDeliveryHeadersApi pickOneItemWithSalesQuantityPost POST /PickOneItemWithSalesQuantity Sets picked quantity and delivery quantity for outbound delivery item.
OutboundDeliveryHeadersApi postGoodsIssuePost POST /PostGoodsIssue Posts goods issue for outbound delivery.
OutboundDeliveryHeadersApi reverseGoodsIssuePost POST /ReverseGoodsIssue Reverses goods issue for outbound delivery.
OutboundDeliveryHeadersApi setPickingQuantityWithBaseQuantityPost POST /SetPickingQuantityWithBaseQuantity Sets picked quantity in base unit of measure for delivery item.
OutboundDeliveryItemTextsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToDeliveryDocumentItemTextGet GET /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_DeliveryDocumentItemText Reads texts of specific outbound delivery item.
OutboundDeliveryItemTextsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToDeliveryDocumentItemTextPost POST /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_DeliveryDocumentItemText Creates outbound delivery item texts.
OutboundDeliveryItemTextsApi aOutbDeliveryItemTextDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemTextElementTextElementLanguageLanguageDelete DELETE /A_OutbDeliveryItemText(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}',TextElement='{TextElement}',Language='{Language}') Deletes outbound delivery item texts.
OutboundDeliveryItemTextsApi aOutbDeliveryItemTextDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemTextElementTextElementLanguageLanguagePatch PATCH /A_OutbDeliveryItemText(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}',TextElement='{TextElement}',Language='{Language}') Updates outbound delivery item texts.
OutboundDeliveryItemTextsApi aOutbDeliveryItemTextPost POST /A_OutbDeliveryItemText Creates outbound delivery item texts.
OutboundDeliveryItemsApi aOutbDeliveryHeaderDeliveryDocumentToDeliveryDocumentItemGet GET /A_OutbDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentItem Reads items of specific outbound delivery header.
OutboundDeliveryItemsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemDelete DELETE /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}') Deletes outbound delivery items.
OutboundDeliveryItemsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemGet GET /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}') Reads outbound delivery items.
OutboundDeliveryItemsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemPatch PATCH /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}') Updates outbound delivery items.
OutboundDeliveryItemsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToDeliveryDocumentItemTextGet GET /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_DeliveryDocumentItemText Reads texts of specific outbound delivery item.
OutboundDeliveryItemsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToDeliveryDocumentItemTextPost POST /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_DeliveryDocumentItemText Creates outbound delivery item texts.
OutboundDeliveryItemsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToDocumentFlowGet GET /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_DocumentFlow Reads document flows of specific outbound delivery item.
OutboundDeliveryItemsApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToSerialDeliveryItemGet GET /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_SerialDeliveryItem Reads maintenance item object list headers of specific outbound delivery item.
OutboundDeliveryItemsApi aOutbDeliveryItemGet GET /A_OutbDeliveryItem Reads outbound delivery items.
OutboundDeliveryItemsApi createBatchSplitItemPost POST /CreateBatchSplitItem Performs a batch split for the outbound delivery item.
OutboundDeliveryMaintenanceItemObjectListHeadersApi aOutbDeliveryItemDeliveryDocumentDeliveryDocumentDeliveryDocumentItemDeliveryDocumentItemToSerialDeliveryItemGet GET /A_OutbDeliveryItem(DeliveryDocument='{DeliveryDocument}',DeliveryDocumentItem='{DeliveryDocumentItem}')/to_SerialDeliveryItem Reads maintenance item object list headers of specific outbound delivery item.
OutboundDeliveryMaintenanceItemObjectListHeadersApi aSerialNmbrDeliveryMaintenanceItemObjectListToMaintenanceItemObjectGet GET /A_SerialNmbrDelivery({MaintenanceItemObjectList})/to_MaintenanceItemObject Reads maintenance item object lists of specific outbound delivery maintenance item object list header.
OutboundDeliveryMaintenanceItemObjectListsApi aSerialNmbrDeliveryMaintenanceItemObjectListToMaintenanceItemObjectGet GET /A_SerialNmbrDelivery({MaintenanceItemObjectList})/to_MaintenanceItemObject Reads maintenance item object lists of specific outbound delivery maintenance item object list header.
OutboundDeliveryPartnerAddressesApi aOutbDeliveryPartnerPartnerFunctionPartnerFunctionSDDocumentSDDocumentToAddressGet GET /A_OutbDeliveryPartner(PartnerFunction='{PartnerFunction}',SDDocument='{SDDocument}')/to_Address Reads addresses of specific outbound delivery partner.
OutboundDeliveryPartnerAddresses2Api aOutbDeliveryAddress2DeliveryDocumentDeliveryDocumentPartnerFunctionPartnerFunctionGet GET /A_OutbDeliveryAddress2(DeliveryDocument='{DeliveryDocument}',PartnerFunction='{PartnerFunction}') Reads outbound delivery partner addresses.
OutboundDeliveryPartnerAddresses2Api aOutbDeliveryAddress2DeliveryDocumentDeliveryDocumentPartnerFunctionPartnerFunctionPatch PATCH /A_OutbDeliveryAddress2(DeliveryDocument='{DeliveryDocument}',PartnerFunction='{PartnerFunction}') Updates outbound delivery partner addresses.
OutboundDeliveryPartnerAddresses2Api aOutbDeliveryAddress2Get GET /A_OutbDeliveryAddress2 Reads outbound delivery partner addresses.
OutboundDeliveryPartnerAddresses2Api aOutbDeliveryPartnerPartnerFunctionPartnerFunctionSDDocumentSDDocumentToAddress2Get GET /A_OutbDeliveryPartner(PartnerFunction='{PartnerFunction}',SDDocument='{SDDocument}')/to_Address2 Reads addresses of specific outbound delivery partner.
OutboundDeliveryPartnersApi aOutbDeliveryHeaderDeliveryDocumentToDeliveryDocumentPartnerGet GET /A_OutbDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentPartner Reads partners of specific outbound delivery header.
OutboundDeliveryPartnersApi aOutbDeliveryPartnerPartnerFunctionPartnerFunctionSDDocumentSDDocumentToAddress2Get GET /A_OutbDeliveryPartner(PartnerFunction='{PartnerFunction}',SDDocument='{SDDocument}')/to_Address2 Reads addresses of specific outbound delivery partner.
OutboundDeliveryPartnersApi aOutbDeliveryPartnerPartnerFunctionPartnerFunctionSDDocumentSDDocumentToAddressGet GET /A_OutbDeliveryPartner(PartnerFunction='{PartnerFunction}',SDDocument='{SDDocument}')/to_Address Reads addresses of specific outbound delivery partner.
OutboundDeliveryTextsApi aOutbDeliveryHeaderDeliveryDocumentToDeliveryDocumentTextGet GET /A_OutbDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentText Reads texts of specific outbound delivery header.
OutboundDeliveryTextsApi aOutbDeliveryHeaderDeliveryDocumentToDeliveryDocumentTextPost POST /A_OutbDeliveryHeader('{DeliveryDocument}')/to_DeliveryDocumentText Creates outbound delivery header texts.
OutboundDeliveryTextsApi aOutbDeliveryHeaderTextDeliveryDocumentDeliveryDocumentTextElementTextElementLanguageLanguageDelete DELETE /A_OutbDeliveryHeaderText(DeliveryDocument='{DeliveryDocument}',TextElement='{TextElement}',Language='{Language}') Deletes outbound delivery header texts.
OutboundDeliveryTextsApi aOutbDeliveryHeaderTextDeliveryDocumentDeliveryDocumentTextElementTextElementLanguageLanguagePatch PATCH /A_OutbDeliveryHeaderText(DeliveryDocument='{DeliveryDocument}',TextElement='{TextElement}',Language='{Language}') Updates outbound delivery header texts.
OutboundDeliveryTextsApi aOutbDeliveryHeaderTextPost POST /A_OutbDeliveryHeaderText Creates outbound delivery header texts.

Models

Authorization

Authentication schemes defined for the API:

OAuth2Auth

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://{host}:{port}
  • Scopes:
    • API_OUTBOUND_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