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

Interface WarehousePhysicalInventoryService

All Superinterfaces:

BatchService<WarehousePhysicalInventoryServiceBatch>

All Known Implementing Classes:

DefaultWarehousePhysicalInventoryService

public interface WarehousePhysicalInventoryService
extends BatchService<WarehousePhysicalInventoryServiceBatch>

In every API call, you can make use of the following operations: - You can retrieve physical inventory (PI) items. - You can count PI items. - You can change counted PI items. - You can mark PI items as ***Deleted***. You can integrate this API with external applications. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_WHSE_PHYSINVENTORYITEM
API Version:	1
Communication Scenario:	Warehousing - Physical Inventory Integration (SAP_COM_0378)
Scope Items:	Warehouse Physical Inventory (3BX)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	WarehousePhysicalInventoryDoc

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
WhsePhysicalInventoryCountItemCreateFluentHelper	createWhsePhysicalInventoryCountItem(WhsePhysicalInventoryCountItem whsePhysicalInventoryCountItem) Create a new WhsePhysicalInventoryCountItem entity and save it to the S/4HANA system.
WhsePhysicalInventoryItemCreateFluentHelper	createWhsePhysicalInventoryItem(WhsePhysicalInventoryItem whsePhysicalInventoryItem) Create a new WhsePhysicalInventoryItem entity and save it to the S/4HANA system.
DeletePhysicalInventoryItemFluentHelper	deletePhysicalInventoryItem(UUID physicalInventoryDocumentUUID, String physicalInventoryItemNumber) Creates a fluent helper for the DeletePhysicalInventoryItem OData function import.
WhsePhysicalInventoryCountItemFluentHelper	getAllWhsePhysicalInventoryCountItem() Fetch multiple WhsePhysicalInventoryCountItem entities.
WhsePhysicalInventoryItemFluentHelper	getAllWhsePhysicalInventoryItem() Fetch multiple WhsePhysicalInventoryItem entities.
WhsePhysicalInventoryCountItemByKeyFluentHelper	getWhsePhysicalInventoryCountItemByKey(UUID physicalInventoryDocumentUUID, String physicalInventoryItemNumber, Integer lineIndexOfPInvItem, Integer pInvQuantitySequence) Fetch a single WhsePhysicalInventoryCountItem entity using key fields.
WhsePhysicalInventoryItemByKeyFluentHelper	getWhsePhysicalInventoryItemByKey(UUID physicalInventoryDocumentUUID, String physicalInventoryItemNumber) Fetch a single WhsePhysicalInventoryItem entity using key fields.
WhsePhysicalInventoryCountItemUpdateFluentHelper	updateWhsePhysicalInventoryCountItem(WhsePhysicalInventoryCountItem whsePhysicalInventoryCountItem) Update an existing WhsePhysicalInventoryCountItem entity and save it to the S/4HANA system.
WhsePhysicalInventoryItemUpdateFluentHelper	updateWhsePhysicalInventoryItem(WhsePhysicalInventoryItem whsePhysicalInventoryItem) Update an existing WhsePhysicalInventoryItem entity and save it to the S/4HANA system.
WarehousePhysicalInventoryService	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
WarehousePhysicalInventoryService 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.

getAllWhsePhysicalInventoryCountItem

@Nonnull
WhsePhysicalInventoryCountItemFluentHelper getAllWhsePhysicalInventoryCountItem()

Fetch multiple WhsePhysicalInventoryCountItem entities.

Returns:

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

getWhsePhysicalInventoryCountItemByKey

@Nonnull
WhsePhysicalInventoryCountItemByKeyFluentHelper getWhsePhysicalInventoryCountItemByKey(UUID physicalInventoryDocumentUUID,
                                                                                                String physicalInventoryItemNumber,
                                                                                                Integer lineIndexOfPInvItem,
                                                                                                Integer pInvQuantitySequence)

Fetch a single WhsePhysicalInventoryCountItem entity using key fields.

Parameters:

pInvQuantitySequence - Row number in a primary or secondary table index.

Constraints: Not nullable

lineIndexOfPInvItem - Row number in a primary or secondary table index.

Constraints: Not nullable

physicalInventoryItemNumber - Item

Constraints: Not nullable, Maximum length: 6

physicalInventoryDocumentUUID - GUID for Physical Inventory Document

Constraints: Not nullable

Returns:

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

createWhsePhysicalInventoryCountItem

@Nonnull
WhsePhysicalInventoryCountItemCreateFluentHelper createWhsePhysicalInventoryCountItem(@Nonnull
                                                                                               WhsePhysicalInventoryCountItem whsePhysicalInventoryCountItem)

Create a new WhsePhysicalInventoryCountItem entity and save it to the S/4HANA system.

Parameters:

whsePhysicalInventoryCountItem - WhsePhysicalInventoryCountItem entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new WhsePhysicalInventoryCountItem entity. To perform execution, call the execute method on the fluent helper object.

updateWhsePhysicalInventoryCountItem

@Nonnull
WhsePhysicalInventoryCountItemUpdateFluentHelper updateWhsePhysicalInventoryCountItem(@Nonnull
                                                                                               WhsePhysicalInventoryCountItem whsePhysicalInventoryCountItem)

Update an existing WhsePhysicalInventoryCountItem entity and save it to the S/4HANA system.

Parameters:

whsePhysicalInventoryCountItem - WhsePhysicalInventoryCountItem entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing WhsePhysicalInventoryCountItem entity. To perform execution, call the execute method on the fluent helper object.

getAllWhsePhysicalInventoryItem

@Nonnull
WhsePhysicalInventoryItemFluentHelper getAllWhsePhysicalInventoryItem()

Fetch multiple WhsePhysicalInventoryItem entities.

Returns:

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

getWhsePhysicalInventoryItemByKey

@Nonnull
WhsePhysicalInventoryItemByKeyFluentHelper getWhsePhysicalInventoryItemByKey(UUID physicalInventoryDocumentUUID,
                                                                                      String physicalInventoryItemNumber)

Fetch a single WhsePhysicalInventoryItem entity using key fields.

Parameters:

physicalInventoryItemNumber - Item

Constraints: Not nullable, Maximum length: 6

physicalInventoryDocumentUUID - GUID for Physical Inventory Document

Constraints: Not nullable

Returns:

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

createWhsePhysicalInventoryItem

@Nonnull
WhsePhysicalInventoryItemCreateFluentHelper createWhsePhysicalInventoryItem(@Nonnull
                                                                                     WhsePhysicalInventoryItem whsePhysicalInventoryItem)

Create a new WhsePhysicalInventoryItem entity and save it to the S/4HANA system.

Parameters:

whsePhysicalInventoryItem - WhsePhysicalInventoryItem entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new WhsePhysicalInventoryItem entity. To perform execution, call the execute method on the fluent helper object.

updateWhsePhysicalInventoryItem

@Nonnull
WhsePhysicalInventoryItemUpdateFluentHelper updateWhsePhysicalInventoryItem(@Nonnull
                                                                                     WhsePhysicalInventoryItem whsePhysicalInventoryItem)

Update an existing WhsePhysicalInventoryItem entity and save it to the S/4HANA system.

Parameters:

whsePhysicalInventoryItem - WhsePhysicalInventoryItem entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing WhsePhysicalInventoryItem entity. To perform execution, call the execute method on the fluent helper object.

deletePhysicalInventoryItem

@Nonnull
DeletePhysicalInventoryItemFluentHelper deletePhysicalInventoryItem(UUID physicalInventoryDocumentUUID,
                                                                             String physicalInventoryItemNumber)

Creates a fluent helper for the DeletePhysicalInventoryItem OData function import.

Parameters:

physicalInventoryItemNumber - Item

Constraints: Not nullable, Maximum length: 6

Original parameter name from the Odata EDM: PhysicalInventoryItemNumber

physicalInventoryDocumentUUID - GUID

Constraints: none

Original parameter name from the Odata EDM: PhysicalInventoryDocumentUUID

Returns:

A fluent helper object that will execute the DeletePhysicalInventoryItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.