com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface HandlingUnitService

All Superinterfaces:

BatchService<HandlingUnitServiceBatch>

All Known Implementing Classes:

DefaultHandlingUnitService

public interface HandlingUnitService
extends BatchService<HandlingUnitServiceBatch>

In every API call, you can make use of the following operations: - Retrieve header information for a handling unit. For handling units processed in warehouse management, warehouse number plus handling unit number must be used as a key. For handling units not relevant for warehouse management, the handling unit number is used as a key. You can use filter criteria to retrieve information based on other selection criteria, for example, delivery reference. - Retrieve item information for a handling unit, which contains information about the products packed in the handling unit. You can apply the filters provided or retrieve all existing data..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_HANDLING_UNIT
API Version:	1
Communication Scenario:	Delivery Insights Replication App Integration (SAP_COM_0571), Handling Unit Integration (SAP_COM_0364)
Scope Items:	Delivery Insights (4IH), Warehouse Outbound Processing (3BS), Sell from Stock (BD9)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	HandlingUnit

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
HandlingUnitFluentHelper	getAllHandlingUnit() Fetch multiple HandlingUnit entities.
HandlingUnitItemFluentHelper	getAllHandlingUnitItem() Fetch multiple HandlingUnitItem entities.
HandlingUnitByKeyFluentHelper	getHandlingUnitByKey(String handlingUnitExternalID, String warehouse) Fetch a single HandlingUnit entity using key fields.
HandlingUnitItemByKeyFluentHelper	getHandlingUnitItemByKey(String handlingUnitExternalID, String warehouse, UUID stockItemUUID) Fetch a single HandlingUnitItem entity using key fields.
HandlingUnitService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
HandlingUnitService withServicePath(@Nonnull
                                             String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllHandlingUnit

@Nonnull
HandlingUnitFluentHelper getAllHandlingUnit()

Fetch multiple HandlingUnit entities.

Returns:

A fluent helper to fetch multiple HandlingUnit entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getHandlingUnitByKey

@Nonnull
HandlingUnitByKeyFluentHelper getHandlingUnitByKey(String handlingUnitExternalID,
                                                            String warehouse)

Fetch a single HandlingUnit entity using key fields.

Parameters:

handlingUnitExternalID - Specifies an external identifier for the handling unit.

Constraints: Not nullable, Maximum length: 20

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single HandlingUnit entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getAllHandlingUnitItem

@Nonnull
HandlingUnitItemFluentHelper getAllHandlingUnitItem()

Fetch multiple HandlingUnitItem entities.

Returns:

A fluent helper to fetch multiple HandlingUnitItem entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getHandlingUnitItemByKey

@Nonnull
HandlingUnitItemByKeyFluentHelper getHandlingUnitItemByKey(String handlingUnitExternalID,
                                                                    String warehouse,
                                                                    UUID stockItemUUID)

Fetch a single HandlingUnitItem entity using key fields.

Parameters:

handlingUnitExternalID - Specifies an external identifier for the handling unit.

Constraints: Not nullable, Maximum length: 20

stockItemUUID - GUID Stock Item

Constraints: Not nullable

warehouse - Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single HandlingUnitItem entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.