High- Level Specification

Functional Overview

This Functional Specification describes the

outbound delivery interface between SAP S/4HANA and

Third-Party Logistics providers (3PLs), using SAP Integration Suite (CPI) and the standard OData service API

_OUTBOUND_DELIVERY_SRV_0002.

The purpose of this interface is to transmit outbound delivery data from SAP S/4HANA to external 3PL systems to support warehouse execution activities such as picking, packing, and goods issue processing.

Not all outbound deliveries are transmitted; only deliveries that meet specific business criteria are in scope. These criteria are defined through configuration and business rules, such as shipping point, delivery type, and 3PL assignment.

Outbound deliveries may be transmitted to the 3PL even if they are not yet ready for picking. In scenarios where batch determination has not been completed, the outbound delivery is sent with a shipment block indicator. This allows the 3PL to receive early visibility of the delivery while clearly indicating that the delivery is not yet released for picking activities.

Once batch assignment is completed in SAP S/4HANA, the shipment block is removed. A subsequent update of the outbound delivery is then transmitted to the 3PL, informing that the delivery is now released and can be processed for picking. This approach ensures alignment between SAP and the 3PL on delivery readiness while enabling early planning and coordination.

Scope and Objectives

The interface covers all outbound deliveries created or updated in S/4HANA that are relevant for transmission to 3PL systems.

Process Flow Diagram

Image Added

Assumptions

N/A

Dependencies

Security, Integrity and Controls

Configuration Requirements

Special Requirements

Design Rationale

APIs  to be consumed: 

API_OUTBOUND_DELIVERY_SRV_0002 – Outbound Delivery (OData service)

Security, Integrity and Controls

Outbound interface triggered by a standard SAP event. The process that triggers the interface will take care of access control.

Configuration Requirements

The following custom configuration tables are required for this interface. Both tables are maintained exclusively by the technical team via transport requests.

Business users have read-only visibility through SAP Custom Business Configuration.

Table 1 — 3PL Interface Activation and Assignment

This table determines whether the delivery interface is active for a given shipping point and identifies the assigned 3PL. It is evaluated prior to event publication to ensure that the transmission is relevant and authorized.

Table 2 — DELIVERIES_3PL

This table defines the delivery types, events, and APIs relevant for transmission per shipping point.

Special Requirements

N/A

Design Rationale

Outbound deliveries will be relevant for transmission only for specific shipping points (the ones related to a 3PL), delivery types and at certain eventevents. This criteria may change between 3PLs so a custom table is configuration tables are needed to save this store these parameters and should be checked by Event Mesh before publishing the event for consumption.

Parameter table structure:

API Use

The table structures are defined in the Configuration Requirements section.

The following standard events are triggered whenever there are changes in Outbound Delivery as documented in Event References:

• Outbound delivery created

• Outbound delivery changed

• Outbound delivery deleted

• Outbound delivery block changed

• Outbound delivery picking status changed

• Outbound delivery packing status changed

• Outbound delivery GI status changed

• Outbound delivery Item Created

• Outbound delivery Item Changed

• Outbound delivery Item Deleted

For customer returns (API_CUSTOMER_RETURNS_DELIVERY_SRV_0002

) the following events are triggered:

• Customer returns delivery created

• Customer returns delivery changed

• Customer returns delivery deleted

Since derived events and metadata extension is either not possible or not useful for the requirement, the following events will be consumed in S/4HANA through Business Event Consumption with the custom filter logic and a custom event will be published to Event Mesh with additional information. 

The event triggering the interface should be included in the data sent to the 3PL. 

The event triggering the interface should be included in the data sent to the 3PL. The event is included at header level. If the event is triggered by an item-level change, the event is also included at item level for the affected item.

API Use

The API to be consumed for each delivery is determined by the configuration table DELIVERIES_3PL (see Configuration Requirements). The API field in the table specifies which OData service is used to extract the delivery data.

The following information should be retrieved for the document (LIKP-VBELN) using the following services:

The following information shall be retrieved from S/4HANA for the outbound delivery document using

API_OUTBOUND_DELIVERY_SRV_0002:

Example:

GET <host>/sap/opu/odata/sap/API_OUTBOUND_DELIVERY_SRV;v=2/A_OutbDeliveryHeader(DeliveryDocument='80000001')?$expand=to_DeliveryDocumentItem HTTP/1.1

• API_CUSTOMER_RETURNS_DELIVERY_SRV_0002: Retrieve a single customer returns delivery including all customer returns delivery items:

Example: 

The following information shall be retrieved from S/4HANA for the customer returns delivery document using

API_CUSTOMER_RETURNS_DELIVERY_SRV

_0002:

Data Structure

Fields from the standard API will be used.

The event triggering the interface should be included in the data sent to the 3PL. The event is included at header level. If the event is triggered by an item-level change, the event is also included at item level for the affected item.

Processing Logic

1) Relevance and activation checks

For each outbound delivery considered for transmission, the system evaluates whether the delivery is relevant for a 3PL interface based on configuration and business rules.

The following checks are performed sequentially:

Data Structure

The following fields will be used to provide the required data structure of the interface:

Processing Logic

1) Every time a new event is raised from a Delivery document, it the event is consumed via business event consumption and a subsequence event should be published for transmission if the following criteria is met:

• • • Interface

      is activated: Check 3PL assignment table included in

      Jira
      server Syensqo's Jira serverId d8efc1ef-48bd-3b4e-8714-ad827f4f059b key ERP-845

      with ORG_TYPE = VSTEL, ORG_VALUE

      activation and 3PL assignment: The system checks the 3PL Interface Activation and Assignment table (see Configuration Requirements) with VSTEL = LIKP-VSTEL and DOC_TYPE =

      "

      'DELIVERY

      "

      '.

If

an entry

exists and the field

Activation = 'X

', the delivery is considered relevant for transmission and the assigned 3PL is determined.
If no active entry is found, the delivery is considered not relevant for transmission and no further processing is performed.

• • • Delivery type and event validation: The configuration table DELIVERIES_3PL (see Configuration Requirements) is validated using: Shipping point (LIKP-VSTEL), Delivery type (LIKP-LFART), Event type.

If a matching entry exists, the delivery is eligible for transmission and the API specified in the configuration entry is used to extract the outbound delivery data.

If no entry is found, the delivery is not transmitted.

2) Monitoring and traceability

If the delivery is successfully identified as relevant for transmission, an entry is created or updated in the outbound monitoring table to ensure traceability of the transmission to the 3PL. The monitoring table structure is defined 2) If previous step is successful, an entry should be logged into the monitoring table to trace the correct transmission to the 3PL. This table is detailed in

DOC_TYPE=DELIVERY

DOC_ID= LIKP-VBELN

DATE_SENT = System date

TIME_SENT = System time

If an entry already exists for the same DOC_TYPE , it should be and DOC_ID, the record is updated with the current DATE_SENT and TIME_SENT to reflect the latest transmission.

Interface Alert & Monitoring

DELIVERIES_3PL table should be included in the Configuration Dashboard Monitoring will be handled by

Language Requirements

N/A

User Interface Requirements

Language Requirements

Document texts will be in the language of the source document.

User Interface Requirements

Users should be able to display the configuration tables defined in the Configuration Requirements section through SAP Custom Business Configuration. Modification of table entries is restricted to the technical team via transport requests.
 

Sequencing

N/A

Volumetrics

Average: 85 documents per day

Performance Consideration

N/A

Error Handling

Error handling

is managed through SAP Application Interface Framework (AIF) and SAP Integration Suite (CPI) to ensure reliable transmission of outbound delivery data to the 3PL.

If an error occurs during data extraction or transmission to CPI or the 3PL, the interface execution is marked as failed and the error is visible in AIF and/or CPI monitoring. The interface must support retriggering.

Configuration or relevance errors result in the delivery being treated as not relevant for transmission and no message being sent.

Retransmission requirement (dependency):
Where the 3PL rejects a message due to functional reasons on the 3PL side (e.g. missing/invalid master data), a controlled mechanism must exist to retransmit the inbound delivery after correction (either via AIF retriggering and/or CPI reprocessing, depending on the operational design). The chosen approach and responsibilities (SAP vs CPI vs 3PL) must be confirmed with the technical team.

How to Test

Test Conditions and Expected Results

Test Considerations/Dependencies

The solution must be tested in conjunction with the developments listed in the Dependencies section.

End-to-end validation will include the participation of the relevant 3PL partners to ensure the completeness of the outbound delivery transmission flow across ERP, middleware, and target logistics platforms.

Other Information

Development Details

Package

Other Development Objects

Appendix

See also

Change log