ballerinax/sap.s4hana.api_customer_returns_delivery_srv_0002 Ballerina library

Overview

SAP S/4HANA is a robust enterprise resource planning (ERP) solution, designed for large-scale enterprises by SAP SE. It covers core business processes such as finance, procurement, sales, and materials management, including delivery processing.

WSO2 SAP S/4HANA Customer Returns Delivery provides a way to interact with the Customer Returns Delivery (A2X) API. The service allows to create, read, update and delete customer returns deliveries with their items, partners and document flow, and to put away items and post or reverse the goods receipt.

Key Features

• Create, read, update and delete customer returns deliveries and their items
• Read delivery partners with their addresses, document flow and serial numbers
• Put away one or all items, split batches, and post or reverse the goods receipt

Setup guide

This connector uses Basic Authentication with an SAP S/4HANA Cloud communication user. Each S/4HANA API is exposed through a communication scenario, so the user must be assigned to a communication arrangement for the Delivery Processing Integration (SAP_COM_0106) scenario before the connector can call it.

All the apps used below are in the Communication Management group of the SAP Fiori launchpad.

Step 1: Create a communication user

1. Sign in to your SAP S/4HANA Cloud system as an administrator.
2. Open the Maintain Communication Users app and choose New.
3. Enter a user name and a description, set a password, and choose Create.

Note the user name and password. These are the credentials the connector uses.

Step 2: Create a communication system

1. Open the Communication Systems app and choose New.

2. Enter a system ID and a system name, and choose Create.

   

3. Under General > Technical Data, enter a host name and a Logical System (an uppercase ID of up to 10 characters, for example, INTEGRATOR). Some scenarios refuse to activate when the logical system is empty.

4. Under Users for Inbound Communication, add the communication user from Step 1 with the User Name and Password authentication method.

   

5. Choose Save.

Step 3: Create a communication arrangement

1. Open the Communication Arrangements app and choose New.

2. In the Scenario value help, search for Delivery Processing Integration and select SAP_COM_0106. This is the scenario that exposes API_CUSTOMER_RETURNS_DELIVERY_SRV_0002, the service this connector calls.

   

3. Enter a unique name for the arrangement and choose Create.

   

4. Select the communication system from Step 2. The communication user from Step 1 is filled in as the inbound user. If the scenario lists outbound services that the integration does not need, clear their Active check boxes so that no outbound user is required.

   

5. Choose Save.

Step 4: Note the hostname

Open the saved arrangement. The API-URL next to Own SAP Cloud System shows the hostname (<unique id>-api.s4hana.cloud.sap).

You now have everything the connector needs:

• hostname - the API hostname, for example, my123456-api.s4hana.cloud.sap
• username - the communication user name
• password - the communication user password

Quickstart

To use the sap.s4hana.api_customer_returns_delivery_srv_0002 connector in your Ballerina application, modify the .bal file as follows:

Step 1: Import the module

Import the sap.s4hana.api_customer_returns_delivery_srv_0002 module.

import ballerinax/sap.s4hana.api_customer_returns_delivery_srv_0002 as returnDel;

Step 2: Instantiate a new connector

Use the hostname and credentials to initiate a client.

configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

returnDel:Client returnDelClient = check new (
    {
      auth: {
        username,
        password
      }
    },
    hostname
);

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

returnDel:CollectionOfA_ReturnsDeliveryItemWrapper listReturnsDeliveryItems = check returnDelClient->listA_ReturnsDeliveryItems();

Step 4: Run the Ballerina application

bal run