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

Interface MaterialStockDisplayService

All Superinterfaces:

BatchService<MaterialStockDisplayServiceBatch>

All Known Implementing Classes:

DefaultMaterialStockDisplayService

public interface MaterialStockDisplayService
extends BatchService<MaterialStockDisplayServiceBatch>

This service enables you to retrieve material stock information using the OData protocol with filter data provided in the payload. It can be consumed by external warehouse applications..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_MATERIAL_STOCK_SRV
API Version:	1
Communication Scenario:	Material Stock Integration (SAP_COM_0164)
Scope Items:	Core Inventory Management (BMC), CORE Inventory Management (OMC)
Authentication Methods:	Basic, x509
Business Object:	MaterialStock

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
MaterialStockFluentHelper	getAllMaterialStock() Fetch multiple MaterialStock entities.
MatlStkInAcctModFluentHelper	getAllMatlStkInAcctMod() Fetch multiple MatlStkInAcctMod entities.
MaterialStockByKeyFluentHelper	getMaterialStockByKey(String material) Fetch a single MaterialStock entity using key fields.
MatlStkInAcctModByKeyFluentHelper	getMatlStkInAcctModByKey(String material, String plant, String storageLocation, String batch, String supplier, String customer, String wBSElementInternalID, String sDDocument, String sDDocumentItem, String inventorySpecialStockType, String inventoryStockType) Fetch a single MatlStkInAcctMod entity using key fields.
MaterialStockDisplayService	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
MaterialStockDisplayService 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.

getAllMaterialStock

@Nonnull
MaterialStockFluentHelper getAllMaterialStock()

Fetch multiple MaterialStock entities.

Returns:

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

getMaterialStockByKey

@Nonnull
MaterialStockByKeyFluentHelper getMaterialStockByKey(String material)

Fetch a single MaterialStock entity using key fields.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

Returns:

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

getAllMatlStkInAcctMod

@Nonnull
MatlStkInAcctModFluentHelper getAllMatlStkInAcctMod()

Fetch multiple MatlStkInAcctMod entities.

Returns:

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

getMatlStkInAcctModByKey

@Nonnull
MatlStkInAcctModByKeyFluentHelper getMatlStkInAcctModByKey(String material,
                                                                    String plant,
                                                                    String storageLocation,
                                                                    String batch,
                                                                    String supplier,
                                                                    String customer,
                                                                    String wBSElementInternalID,
                                                                    String sDDocument,
                                                                    String sDDocumentItem,
                                                                    String inventorySpecialStockType,
                                                                    String inventoryStockType)

Fetch a single MatlStkInAcctMod entity using key fields.

Parameters:

material - Material in respect of which the stock is managed.

Constraints: Not nullable, Maximum length: 40

wBSElementInternalID - Key that identifies the WBS element that is assigned to a sales order stock

Constraints: Not nullable, Maximum length: 24

inventorySpecialStockType - Special Stock Type

Constraints: Not nullable, Maximum length: 1

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

supplier - Specifies an alphanumeric key that uniquely identifies the supplier in the SAP system.

Constraints: Not nullable, Maximum length: 10

batch - Assigns a material that is manufactured in batches or production lots to a specific batch.

Constraints: Not nullable, Maximum length: 10

storageLocation - Number of the storage location in which the material is stored. A plant may contain one or more storage locations.

Constraints: Not nullable, Maximum length: 4

sDDocumentItem - Uniquely identifies an item in a sales order.

Constraints: Not nullable, Maximum length: 6

inventoryStockType - Unique stock type that identifies the purpose of the stock.

Constraints: Not nullable, Maximum length: 2

sDDocument - Uniquely identifies a sales order.

Constraints: Not nullable, Maximum length: 10

customer - Gives an alphanumeric key, which clearly identifies the customer or supplier in the SAP system.

Constraints: Not nullable, Maximum length: 10

Returns:

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