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

Interface CustomerMaterialService

All Known Implementing Classes:

DefaultCustomerMaterialService

public interface CustomerMaterialService

This service enables external applications to integrate with read methods for processing customer materials in SAP S/4HANA Cloud. It enables you to retrieve customer material info records in an API call.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CUSTOMER_MATERIAL_SRV
API Version:	1
Communication Scenario:	Customer Material Info Record Integration (SAP_COM_0134)
Scope Items:	Sell from Stock (BD9)
Business Object:	CustomerMaterial

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
CustomerMaterialFluentHelper	getAllCustomerMaterial() Fetch multiple CustomerMaterial entities.
CustomerMaterialByKeyFluentHelper	getCustomerMaterialByKey(String salesOrganization, String distributionChannel, String customer, String material) Fetch a single CustomerMaterial entity using key fields.
CustomerMaterialService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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

CustomerMaterialService 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

getAllCustomerMaterial

@Nonnull
CustomerMaterialFluentHelper getAllCustomerMaterial()

Fetch multiple CustomerMaterial entities.

Returns:

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

getCustomerMaterialByKey

@Nonnull
CustomerMaterialByKeyFluentHelper getCustomerMaterialByKey(String salesOrganization,
                                                                     String distributionChannel,
                                                                     String customer,
                                                                     String material)

Fetch a single CustomerMaterial entity using key fields.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

distributionChannel - The way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales.

Constraints: Not nullable, Maximum length: 2

salesOrganization - An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims.

Constraints: Not nullable, Maximum length: 4

customer - The customer to whom the condition or the customer-material info record applies.

Constraints: Not nullable, Maximum length: 10

Returns:

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