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

Class DefaultHandlingUnitService

java.lang.Object

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

All Implemented Interfaces:

BatchService<HandlingUnitServiceBatch>, HandlingUnitService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultHandlingUnitService")
public class DefaultHandlingUnitService
extends Object
implements HandlingUnitService

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.HandlingUnitService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultHandlingUnitService() Creates a service using HandlingUnitService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultHandlingUnitServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultHandlingUnitService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultHandlingUnitService

public DefaultHandlingUnitService()

Creates a service using HandlingUnitService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultHandlingUnitService withServicePath(@Nonnull
                                                           String servicePath)

Description copied from interface: HandlingUnitService

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

Specified by:

withServicePath in interface HandlingUnitService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultHandlingUnitServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<HandlingUnitServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllHandlingUnit

@Nonnull
public HandlingUnitFluentHelper getAllHandlingUnit()

Description copied from interface: HandlingUnitService

Fetch multiple HandlingUnit entities.

Specified by:

getAllHandlingUnit in interface HandlingUnitService

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
public HandlingUnitByKeyFluentHelper getHandlingUnitByKey(String handlingUnitExternalID,
                                                                   String warehouse)

Description copied from interface: HandlingUnitService

Fetch a single HandlingUnit entity using key fields.

Specified by:

getHandlingUnitByKey in interface HandlingUnitService

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
public HandlingUnitItemFluentHelper getAllHandlingUnitItem()

Description copied from interface: HandlingUnitService

Fetch multiple HandlingUnitItem entities.

Specified by:

getAllHandlingUnitItem in interface HandlingUnitService

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
public HandlingUnitItemByKeyFluentHelper getHandlingUnitItemByKey(String handlingUnitExternalID,
                                                                           String warehouse,
                                                                           UUID stockItemUUID)

Description copied from interface: HandlingUnitService

Fetch a single HandlingUnitItem entity using key fields.

Specified by:

getHandlingUnitItemByKey in interface HandlingUnitService

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

stockItemUUID - GUID Stock Item

Constraints: Not nullable

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.