Interface PackingInstructionService
- All Superinterfaces:
BatchService<PackingInstructionServiceBatch>
- All Known Implementing Classes:
DefaultPackingInstructionService
Packing instructions serve as templates for the creation of handling units. With this API, you can carry out the following operations: - Create a packing instruction comprising packaging material and material to be packed. - Create a packing instruction including packaging material and reference material. The reference material enables you to reuse one packing instruction for several materials. - Create a packing instruction including subordinated packing instructions (multi-level packing instructions). - Retrieve header information for a packing instruction. You can use filter criteria to retrieve information based on other selection criteria, for example, material numbers. - Retrieve component information for a packing instruction, which contains information about the packaging material and the material to be packed in the handling unit. - Retrieve texts in different languages for a packing instruction. Note The following operations are available on the ***API Reference*** tab but are not supported by the API: - <TT>POST /PackingInstructionHeader(guid'{PackingInstructionSystemUUID}')/to_PackingInstructionComponent</TT> - <TT>POST /PackingInstructionHeader(guid'{PackingInstructionSystemUUID}')/to_PackingInstructionText</TT> .
Reference: SAP Business Accelerator Hub
Details:
| OData Service: | API_PACKINGINSTRUCTION |
| API Version: | 1.1.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Packing Instruction Integration(SAP_COM_0399) |
| Scope Items: | Handling Unit Management(4MM) |
| Authentication Methods: | x509 |
| Business Object: | Packing Instruction |
-
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 TypeMethodDescriptioncreatePackingInstructionHeader(PackingInstructionHeader packingInstructionHeader) Deprecated.Create a newPackingInstructionHeaderentity and save it to the S/4HANA system.Deprecated.Fetch multiplePackingInstructionComponententities.Deprecated.Fetch multiplePackingInstructionHeaderentities.Deprecated.Fetch multiplePackingInstructionTextentities.getPackingInstructionComponentByKey(UUID packingInstructionItemSystUUID) Deprecated.Fetch a singlePackingInstructionComponententity using key fields.getPackingInstructionHeaderByKey(UUID packingInstructionSystemUUID) Deprecated.Fetch a singlePackingInstructionHeaderentity using key fields.getPackingInstructionTextByKey(String language, UUID packingInstructionSystemUUID) Deprecated.Fetch a singlePackingInstructionTextentity using key fields.withServicePath(String servicePath) Deprecated.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 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.
-
getAllPackingInstructionComponent
Deprecated.Fetch multiplePackingInstructionComponententities.- Returns:
- A fluent helper to fetch multiple
PackingInstructionComponententities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getPackingInstructionComponentByKey
@Nonnull PackingInstructionComponentByKeyFluentHelper getPackingInstructionComponentByKey(UUID packingInstructionItemSystUUID) Deprecated.Fetch a singlePackingInstructionComponententity using key fields.- Parameters:
packingInstructionItemSystUUID- Packing Instruction ComponentConstraints: Not nullable
- Returns:
- A fluent helper to fetch a single
PackingInstructionComponententity 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 theexecutemethod on the fluent helper object.
-
getAllPackingInstructionHeader
Deprecated.Fetch multiplePackingInstructionHeaderentities.- Returns:
- A fluent helper to fetch multiple
PackingInstructionHeaderentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getPackingInstructionHeaderByKey
@Nonnull PackingInstructionHeaderByKeyFluentHelper getPackingInstructionHeaderByKey(UUID packingInstructionSystemUUID) Deprecated.Fetch a singlePackingInstructionHeaderentity using key fields.- Parameters:
packingInstructionSystemUUID- Unique internal packing object numberConstraints: Not nullable
- Returns:
- A fluent helper to fetch a single
PackingInstructionHeaderentity 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 theexecutemethod on the fluent helper object.
-
createPackingInstructionHeader
@Nonnull PackingInstructionHeaderCreateFluentHelper createPackingInstructionHeader(@Nonnull PackingInstructionHeader packingInstructionHeader) Deprecated.Create a newPackingInstructionHeaderentity and save it to the S/4HANA system.- Parameters:
packingInstructionHeader-PackingInstructionHeaderentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
PackingInstructionHeaderentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllPackingInstructionText
Deprecated.Fetch multiplePackingInstructionTextentities.- Returns:
- A fluent helper to fetch multiple
PackingInstructionTextentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getPackingInstructionTextByKey
@Nonnull PackingInstructionTextByKeyFluentHelper getPackingInstructionTextByKey(String language, UUID packingInstructionSystemUUID) Deprecated.Fetch a singlePackingInstructionTextentity using key fields.- Parameters:
packingInstructionSystemUUID- Packing Instruction NumberConstraints: Not nullable
language- Language KeyConstraints: Not nullable, Maximum length: 2
- Returns:
- A fluent helper to fetch a single
PackingInstructionTextentity 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 theexecutemethod on the fluent helper object.
-