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

Interface PackingInstructionService

All Superinterfaces:

BatchService<PackingInstructionServiceBatch>

All Known Implementing Classes:

DefaultPackingInstructionService

public interface PackingInstructionService
extends BatchService<PackingInstructionServiceBatch>

In every API call, you can make use of the following operations: - Retrieve header information for a packing instruction. You can use filter criteria to retrieve information based on other selection criteria, for example, material number. - Retrieve component information for a packing instruction, which contains information about the products packed in the handling unit. - Retrieve texts in different languages for a packing instruction. You can apply the filters provided or retrieve all existing data. #.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PACKINGINSTRUCTION
API Version:	1
Communication Scenario:	Packing Instruction Integration (SAP_COM_0399)
Scope Items:	Handling Unit Management (4MM)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	PackingInstruction

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
PackingInstructionComponentFluentHelper	getAllPackingInstructionComponent() Fetch multiple PackingInstructionComponent entities.
PackingInstructionHeaderFluentHelper	getAllPackingInstructionHeader() Fetch multiple PackingInstructionHeader entities.
PackingInstructionTextFluentHelper	getAllPackingInstructionText() Fetch multiple PackingInstructionText entities.
PackingInstructionComponentByKeyFluentHelper	getPackingInstructionComponentByKey(UUID packingInstructionItemSystUUID) Fetch a single PackingInstructionComponent entity using key fields.
PackingInstructionHeaderByKeyFluentHelper	getPackingInstructionHeaderByKey(UUID packingInstructionSystemUUID) Fetch a single PackingInstructionHeader entity using key fields.
PackingInstructionTextByKeyFluentHelper	getPackingInstructionTextByKey(String language, UUID packingInstructionSystemUUID) Fetch a single PackingInstructionText entity using key fields.
PackingInstructionService	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
PackingInstructionService 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.

getAllPackingInstructionComponent

@Nonnull
PackingInstructionComponentFluentHelper getAllPackingInstructionComponent()

Fetch multiple PackingInstructionComponent entities.

Returns:

A fluent helper to fetch multiple PackingInstructionComponent 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.

getPackingInstructionComponentByKey

@Nonnull
PackingInstructionComponentByKeyFluentHelper getPackingInstructionComponentByKey(UUID packingInstructionItemSystUUID)

Fetch a single PackingInstructionComponent entity using key fields.

Parameters:

packingInstructionItemSystUUID - Packing Instruction Component

Constraints: Not nullable

Returns:

A fluent helper to fetch a single PackingInstructionComponent 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.

getAllPackingInstructionHeader

@Nonnull
PackingInstructionHeaderFluentHelper getAllPackingInstructionHeader()

Fetch multiple PackingInstructionHeader entities.

Returns:

A fluent helper to fetch multiple PackingInstructionHeader 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.

getPackingInstructionHeaderByKey

@Nonnull
PackingInstructionHeaderByKeyFluentHelper getPackingInstructionHeaderByKey(UUID packingInstructionSystemUUID)

Fetch a single PackingInstructionHeader entity using key fields.

Parameters:

packingInstructionSystemUUID - Packing Instruction Number

Constraints: Not nullable

Returns:

A fluent helper to fetch a single PackingInstructionHeader 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.

getAllPackingInstructionText

@Nonnull
PackingInstructionTextFluentHelper getAllPackingInstructionText()

Fetch multiple PackingInstructionText entities.

Returns:

A fluent helper to fetch multiple PackingInstructionText 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.

getPackingInstructionTextByKey

@Nonnull
PackingInstructionTextByKeyFluentHelper getPackingInstructionTextByKey(String language,
                                                                                UUID packingInstructionSystemUUID)

Fetch a single PackingInstructionText entity using key fields.

Parameters:

packingInstructionSystemUUID - Packing Instruction Number

Constraints: Not nullable

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single PackingInstructionText 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.