Interface HandlingUnitService

All Known Implementing Classes:
DefaultHandlingUnitService

@Deprecated public interface HandlingUnitService
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

The service contains handling unit header and item nodes, a serial number node, and a handling unit reference document node. With this API, you can carry out the following operations: - Retrieve information from handling units, for example, read all handling units for a plant, read all products packed in a specific handling unit, or read all serial numbers for handling units. In addition, you can retrieve reference documents for simple and cross-delivery handling units in Warehouse Management storage locations. - Create handling units without reference to a document. These non-assigned handling units are used, for example, when the physical creation of a handling unit is planned or when a handling unit already exists physically but is not yet entered in the system. - Pack products or handling units into handling units, or repack or unpack products or handling units, in Warehouse Management storage locations. - Post goods movement for handling units. You can move handling units to different storage locations and transfer handling units from an Inventory Management storage location to a Warehouse Management storage bin. - Delete handling units. Deleting a handling unit results in unpacking the materials included and deleting the corresponding handling unit itself..

Business Documentation

Reference: SAP Business Accelerator Hub

Details:

OData Service: HANDLINGUNIT_0001
API Version: 1.4.0
Minimum ERP Version: 2302
Communication Scenario: Handling Unit Integration(SAP_COM_0364)
Scope Items: Warehouse Outbound Processing(3BS), Handling Unit Management(4MM), Sell from Stock(BD9)
Authentication Methods: x509
Service Group Name: API_HANDLINGUNIT
Business Object: Handling Unit
  • Field Details

  • Method Details

    • withServicePath

      @Nonnull HandlingUnitService withServicePath(@Nonnull String servicePath)
      Deprecated.
      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.
    • batch

      @Nonnull BatchRequestBuilder batch()
      Deprecated.
      Creates a batch request builder object.
      Returns:
      A request builder to handle batch operation on this service. To perform execution, call the execute method on the request builder object.
    • getAllHandlingUnit

      @Nonnull GetAllRequestBuilder<HandlingUnit> getAllHandlingUnit()
      Deprecated.
      Fetch multiple HandlingUnit entities.
      Returns:
      A request builder to fetch multiple HandlingUnit entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countHandlingUnit

      @Nonnull CountRequestBuilder<HandlingUnit> countHandlingUnit()
      Deprecated.
      Fetch the number of entries from the HandlingUnit entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of HandlingUnit entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getHandlingUnitByKey

      @Nonnull GetByKeyRequestBuilder<HandlingUnit> getHandlingUnitByKey(String handlingUnitExternalID, String warehouse)
      Deprecated.
      Fetch a single HandlingUnit entity using key fields.
      Parameters:
      handlingUnitExternalID - External Handling Unit Identification

      Constraints: Not nullable, Maximum length: 20

      warehouse - Warehouse Number/Warehouse Complex

      Constraints: Not nullable, Maximum length: 4

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

      @Nonnull CreateRequestBuilder<HandlingUnit> createHandlingUnit(@Nonnull HandlingUnit handlingUnit)
      Deprecated.
      Create a new HandlingUnit entity and save it to the S/4HANA system.
      Parameters:
      handlingUnit - HandlingUnit entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new HandlingUnit entity. To perform execution, call the execute method on the request builder object.
    • updateHandlingUnit

      @Nonnull UpdateRequestBuilder<HandlingUnit> updateHandlingUnit(@Nonnull HandlingUnit handlingUnit)
      Deprecated.
      Update an existing HandlingUnit entity and save it to the S/4HANA system.
      Parameters:
      handlingUnit - HandlingUnit entity object that will be updated in the S/4HANA system.
      Returns:
      A request builder to update an existing HandlingUnit entity. To perform execution, call the execute method on the request builder object.
    • deleteHandlingUnit

      @Nonnull DeleteRequestBuilder<HandlingUnit> deleteHandlingUnit(@Nonnull HandlingUnit handlingUnit)
      Deprecated.
      Deletes an existing HandlingUnit entity in the S/4HANA system.
      Parameters:
      handlingUnit - HandlingUnit entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing HandlingUnit entity. To perform execution, call the execute method on the request builder object.
    • getAllHandlingUnitItem

      @Nonnull GetAllRequestBuilder<HandlingUnitItem> getAllHandlingUnitItem()
      Deprecated.
      Fetch multiple HandlingUnitItem entities.
      Returns:
      A request builder to fetch multiple HandlingUnitItem entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countHandlingUnitItem

      @Nonnull CountRequestBuilder<HandlingUnitItem> countHandlingUnitItem()
      Deprecated.
      Fetch the number of entries from the HandlingUnitItem entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of HandlingUnitItem entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getHandlingUnitItemByKey

      @Nonnull GetByKeyRequestBuilder<HandlingUnitItem> getHandlingUnitItemByKey(String handlingUnitExternalID, String warehouse, UUID stockItemUUID)
      Deprecated.
      Fetch a single HandlingUnitItem entity using key fields.
      Parameters:
      handlingUnitExternalID - External Handling Unit Identification

      Constraints: Not nullable, Maximum length: 20

      stockItemUUID - GUID Stock Item

      Constraints: Not nullable

      warehouse - Warehouse Number/Warehouse Complex

      Constraints: Not nullable, Maximum length: 4

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

      @Nonnull CreateRequestBuilder<HandlingUnitItem> createHandlingUnitItem(@Nonnull HandlingUnitItem handlingUnitItem)
      Deprecated.
      Create a new HandlingUnitItem entity and save it to the S/4HANA system.
      Parameters:
      handlingUnitItem - HandlingUnitItem entity object that will be created in the S/4HANA system.
      Returns:
      A request builder to create a new HandlingUnitItem entity. To perform execution, call the execute method on the request builder object.
    • deleteHandlingUnitItem

      @Nonnull DeleteRequestBuilder<HandlingUnitItem> deleteHandlingUnitItem(@Nonnull HandlingUnitItem handlingUnitItem)
      Deprecated.
      Deletes an existing HandlingUnitItem entity in the S/4HANA system.
      Parameters:
      handlingUnitItem - HandlingUnitItem entity object that will be deleted in the S/4HANA system.
      Returns:
      A request builder to delete an existing HandlingUnitItem entity. To perform execution, call the execute method on the request builder object.
    • getAllHandlingUnitReferenceDocument

      @Nonnull GetAllRequestBuilder<HandlingUnitReferenceDoc> getAllHandlingUnitReferenceDocument()
      Deprecated.
      Fetch multiple HandlingUnitReferenceDoc entities.
      Returns:
      A request builder to fetch multiple HandlingUnitReferenceDoc entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countHandlingUnitReferenceDocument

      @Nonnull CountRequestBuilder<HandlingUnitReferenceDoc> countHandlingUnitReferenceDocument()
      Deprecated.
      Fetch the number of entries from the HandlingUnitReferenceDoc entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of HandlingUnitReferenceDoc entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getHandlingUnitReferenceDocumentByKey

      @Nonnull GetByKeyRequestBuilder<HandlingUnitReferenceDoc> getHandlingUnitReferenceDocumentByKey(String warehouse, String handlingUnitExternalID, String handlingUnitReferenceDocument)
      Deprecated.
      Fetch a single HandlingUnitReferenceDoc entity using key fields.
      Parameters:
      handlingUnitExternalID - External Handling Unit Identification

      Constraints: Not nullable, Maximum length: 20

      handlingUnitReferenceDocument -

      Constraints: Not nullable, Maximum length: 20

      warehouse - Warehouse Number/Warehouse Complex

      Constraints: Not nullable, Maximum length: 4

      Returns:
      A request builder to fetch a single HandlingUnitReferenceDoc entity using key fields. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getAllHandlingUnitSerialNumber

      @Nonnull GetAllRequestBuilder<HandlingUnitSerialNumber> getAllHandlingUnitSerialNumber()
      Deprecated.
      Fetch multiple HandlingUnitSerialNumber entities.
      Returns:
      A request builder to fetch multiple HandlingUnitSerialNumber entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • countHandlingUnitSerialNumber

      @Nonnull CountRequestBuilder<HandlingUnitSerialNumber> countHandlingUnitSerialNumber()
      Deprecated.
      Fetch the number of entries from the HandlingUnitSerialNumber entity collection matching the filter and search expressions.
      Returns:
      A request builder to fetch the count of HandlingUnitSerialNumber entities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the request builder object.
    • getHandlingUnitSerialNumberByKey

      @Nonnull GetByKeyRequestBuilder<HandlingUnitSerialNumber> getHandlingUnitSerialNumberByKey(String handlingUnitItem, String handlingUnitExternalID, String warehouse, UUID stockItemUUID, String serialNumber)
      Deprecated.
      Fetch a single HandlingUnitSerialNumber entity using key fields.
      Parameters:
      handlingUnitExternalID - External Handling Unit Identification

      Constraints: Not nullable, Maximum length: 20

      serialNumber - Serial Number

      Constraints: Not nullable, Maximum length: 18

      handlingUnitItem - Handling Unit Item

      Constraints: Not nullable, Maximum length: 6

      stockItemUUID - GUID Stock Item

      Constraints: Not nullable

      warehouse - Warehouse Number/Warehouse Complex

      Constraints: Not nullable, Maximum length: 4

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