Interface HandlingUnitService
- All Known Implementing Classes:
DefaultHandlingUnitService
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..
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionbatch()Deprecated.Creates a batch request builder object.Deprecated.Fetch the number of entries from theHandlingUnitentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theHandlingUnitItementity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theHandlingUnitReferenceDocentity collection matching the filter and search expressions.Deprecated.Fetch the number of entries from theHandlingUnitSerialNumberentity collection matching the filter and search expressions.createHandlingUnit(HandlingUnit handlingUnit) Deprecated.Create a newHandlingUnitentity and save it to the S/4HANA system.createHandlingUnitItem(HandlingUnitItem handlingUnitItem) Deprecated.Create a newHandlingUnitItementity and save it to the S/4HANA system.deleteHandlingUnit(HandlingUnit handlingUnit) Deprecated.Deletes an existingHandlingUnitentity in the S/4HANA system.deleteHandlingUnitItem(HandlingUnitItem handlingUnitItem) Deprecated.Deletes an existingHandlingUnitItementity in the S/4HANA system.Deprecated.Fetch multipleHandlingUnitentities.Deprecated.Fetch multipleHandlingUnitItementities.Deprecated.Fetch multipleHandlingUnitReferenceDocentities.Deprecated.Fetch multipleHandlingUnitSerialNumberentities.getHandlingUnitByKey(String handlingUnitExternalID, String warehouse) Deprecated.Fetch a singleHandlingUnitentity using key fields.getHandlingUnitItemByKey(String handlingUnitExternalID, String warehouse, UUID stockItemUUID) Deprecated.Fetch a singleHandlingUnitItementity using key fields.getHandlingUnitReferenceDocumentByKey(String warehouse, String handlingUnitExternalID, String handlingUnitReferenceDocument) Deprecated.Fetch a singleHandlingUnitReferenceDocentity using key fields.getHandlingUnitSerialNumberByKey(String handlingUnitItem, String handlingUnitExternalID, String warehouse, UUID stockItemUUID, String serialNumber) Deprecated.Fetch a singleHandlingUnitSerialNumberentity using key fields.updateHandlingUnit(HandlingUnit handlingUnit) Deprecated.Update an existingHandlingUnitentity and save it to the S/4HANA system.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
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
Deprecated.Creates a batch request builder object.- Returns:
- A request builder to handle batch operation on this service. To perform execution, call the
executemethod on the request builder object.
-
getAllHandlingUnit
Deprecated.Fetch multipleHandlingUnitentities.- Returns:
- A request builder to fetch multiple
HandlingUnitentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countHandlingUnit
Deprecated.Fetch the number of entries from theHandlingUnitentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
HandlingUnitentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getHandlingUnitByKey
@Nonnull GetByKeyRequestBuilder<HandlingUnit> getHandlingUnitByKey(String handlingUnitExternalID, String warehouse) Deprecated.Fetch a singleHandlingUnitentity using key fields.- Parameters:
handlingUnitExternalID- External Handling Unit IdentificationConstraints: Not nullable, Maximum length: 20
warehouse- Warehouse Number/Warehouse ComplexConstraints: Not nullable, Maximum length: 4
- Returns:
- A request builder to fetch a single
HandlingUnitentity 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 theexecutemethod on the request builder object.
-
createHandlingUnit
Deprecated.Create a newHandlingUnitentity and save it to the S/4HANA system.- Parameters:
handlingUnit-HandlingUnitentity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
HandlingUnitentity. To perform execution, call theexecutemethod on the request builder object.
-
updateHandlingUnit
Deprecated.Update an existingHandlingUnitentity and save it to the S/4HANA system.- Parameters:
handlingUnit-HandlingUnitentity object that will be updated in the S/4HANA system.- Returns:
- A request builder to update an existing
HandlingUnitentity. To perform execution, call theexecutemethod on the request builder object.
-
deleteHandlingUnit
Deprecated.Deletes an existingHandlingUnitentity in the S/4HANA system.- Parameters:
handlingUnit-HandlingUnitentity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
HandlingUnitentity. To perform execution, call theexecutemethod on the request builder object.
-
getAllHandlingUnitItem
Deprecated.Fetch multipleHandlingUnitItementities.- Returns:
- A request builder to fetch multiple
HandlingUnitItementities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countHandlingUnitItem
Deprecated.Fetch the number of entries from theHandlingUnitItementity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
HandlingUnitItementities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getHandlingUnitItemByKey
@Nonnull GetByKeyRequestBuilder<HandlingUnitItem> getHandlingUnitItemByKey(String handlingUnitExternalID, String warehouse, UUID stockItemUUID) Deprecated.Fetch a singleHandlingUnitItementity using key fields.- Parameters:
handlingUnitExternalID- External Handling Unit IdentificationConstraints: Not nullable, Maximum length: 20
stockItemUUID- GUID Stock ItemConstraints: Not nullable
warehouse- Warehouse Number/Warehouse ComplexConstraints: Not nullable, Maximum length: 4
- Returns:
- A request builder to fetch a single
HandlingUnitItementity 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 theexecutemethod on the request builder object.
-
createHandlingUnitItem
@Nonnull CreateRequestBuilder<HandlingUnitItem> createHandlingUnitItem(@Nonnull HandlingUnitItem handlingUnitItem) Deprecated.Create a newHandlingUnitItementity and save it to the S/4HANA system.- Parameters:
handlingUnitItem-HandlingUnitItementity object that will be created in the S/4HANA system.- Returns:
- A request builder to create a new
HandlingUnitItementity. To perform execution, call theexecutemethod on the request builder object.
-
deleteHandlingUnitItem
@Nonnull DeleteRequestBuilder<HandlingUnitItem> deleteHandlingUnitItem(@Nonnull HandlingUnitItem handlingUnitItem) Deprecated.Deletes an existingHandlingUnitItementity in the S/4HANA system.- Parameters:
handlingUnitItem-HandlingUnitItementity object that will be deleted in the S/4HANA system.- Returns:
- A request builder to delete an existing
HandlingUnitItementity. To perform execution, call theexecutemethod on the request builder object.
-
getAllHandlingUnitReferenceDocument
Deprecated.Fetch multipleHandlingUnitReferenceDocentities.- Returns:
- A request builder to fetch multiple
HandlingUnitReferenceDocentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countHandlingUnitReferenceDocument
Deprecated.Fetch the number of entries from theHandlingUnitReferenceDocentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
HandlingUnitReferenceDocentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getHandlingUnitReferenceDocumentByKey
@Nonnull GetByKeyRequestBuilder<HandlingUnitReferenceDoc> getHandlingUnitReferenceDocumentByKey(String warehouse, String handlingUnitExternalID, String handlingUnitReferenceDocument) Deprecated.Fetch a singleHandlingUnitReferenceDocentity using key fields.- Parameters:
handlingUnitExternalID- External Handling Unit IdentificationConstraints: Not nullable, Maximum length: 20
handlingUnitReferenceDocument-Constraints: Not nullable, Maximum length: 20
warehouse- Warehouse Number/Warehouse ComplexConstraints: Not nullable, Maximum length: 4
- Returns:
- A request builder to fetch a single
HandlingUnitReferenceDocentity 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 theexecutemethod on the request builder object.
-
getAllHandlingUnitSerialNumber
Deprecated.Fetch multipleHandlingUnitSerialNumberentities.- Returns:
- A request builder to fetch multiple
HandlingUnitSerialNumberentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
countHandlingUnitSerialNumber
Deprecated.Fetch the number of entries from theHandlingUnitSerialNumberentity collection matching the filter and search expressions.- Returns:
- A request builder to fetch the count of
HandlingUnitSerialNumberentities. This request builder allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the request builder object.
-
getHandlingUnitSerialNumberByKey
@Nonnull GetByKeyRequestBuilder<HandlingUnitSerialNumber> getHandlingUnitSerialNumberByKey(String handlingUnitItem, String handlingUnitExternalID, String warehouse, UUID stockItemUUID, String serialNumber) Deprecated.Fetch a singleHandlingUnitSerialNumberentity using key fields.- Parameters:
handlingUnitExternalID- External Handling Unit IdentificationConstraints: Not nullable, Maximum length: 20
serialNumber- Serial NumberConstraints: Not nullable, Maximum length: 18
handlingUnitItem- Handling Unit ItemConstraints: Not nullable, Maximum length: 6
stockItemUUID- GUID Stock ItemConstraints: Not nullable
warehouse- Warehouse Number/Warehouse ComplexConstraints: Not nullable, Maximum length: 4
- Returns:
- A request builder to fetch a single
HandlingUnitSerialNumberentity 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 theexecutemethod on the request builder object.
-