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

Interface SalesOrderService

All Known Implementing Classes:

DefaultSalesOrderService

public interface SalesOrderService

You can use this service to integrate external applications with sales order processing in SAP S/4HANA Cloud. In every API call, you can make use of the following operations: - You can retrieve sales orders. Apply any of the filters provided or retrieve all existing data. - You can create sales orders. Note that you must use “deep insert” requests (a header plus the following entities: header partner, header pricing element, item, item partner, and item pricing element). You cannot create entities without including any related entities. - For existing sales orders, you can create new items. Note that you must use “deep insert” requests (with the following entities: item partner and item pricing element). You cannot create entities without including any related entities. - For existing sales orders, you can update the header, header partner, header pricing element, item, item partner, and item pricing element. - For existing sales orders, you can delete the header, header partner, header pricing element, item, item partner, and item pricing element..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_SALES_ORDER_SRV
API Version:	1
Communication Scenario:	Sales Order Integration (SAP_COM_0109)
Scope Items:	Sell from Stock (BD9), Integration with Third-Party Sales Force Automation System (1QI)
Authentication Methods:	Basic, x509
Business Object:	SalesOrder

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
SalesOrderCreateFluentHelper	createSalesOrder(SalesOrder salesOrder) Create a new SalesOrder entity and save it to the S/4HANA system.
SalesOrderItemCreateFluentHelper	createSalesOrderItem(SalesOrderItem salesOrderItem) Create a new SalesOrderItem entity and save it to the S/4HANA system.
SalesOrderDeleteFluentHelper	deleteSalesOrder(SalesOrder salesOrder) Deletes an existing SalesOrder entity in the S/4HANA system.
SalesOrderHeaderPartnerDeleteFluentHelper	deleteSalesOrderHeaderPartner(SalesOrderHeaderPartner salesOrderHeaderPartner) Deletes an existing SalesOrderHeaderPartner entity in the S/4HANA system.
SalesOrderHeaderPrElementDeleteFluentHelper	deleteSalesOrderHeaderPrElement(SalesOrderHeaderPrElement salesOrderHeaderPrElement) Deletes an existing SalesOrderHeaderPrElement entity in the S/4HANA system.
SalesOrderItemDeleteFluentHelper	deleteSalesOrderItem(SalesOrderItem salesOrderItem) Deletes an existing SalesOrderItem entity in the S/4HANA system.
SalesOrderItemPartnerDeleteFluentHelper	deleteSalesOrderItemPartner(SalesOrderItemPartner salesOrderItemPartner) Deletes an existing SalesOrderItemPartner entity in the S/4HANA system.
SalesOrderItemPrElementDeleteFluentHelper	deleteSalesOrderItemPrElement(SalesOrderItemPrElement salesOrderItemPrElement) Deletes an existing SalesOrderItemPrElement entity in the S/4HANA system.
SalesOrderFluentHelper	getAllSalesOrder() Fetch multiple SalesOrder entities.
SalesOrderHeaderPartnerFluentHelper	getAllSalesOrderHeaderPartner() Fetch multiple SalesOrderHeaderPartner entities.
SalesOrderHeaderPrElementFluentHelper	getAllSalesOrderHeaderPrElement() Fetch multiple SalesOrderHeaderPrElement entities.
SalesOrderItemFluentHelper	getAllSalesOrderItem() Fetch multiple SalesOrderItem entities.
SalesOrderItemPartnerFluentHelper	getAllSalesOrderItemPartner() Fetch multiple SalesOrderItemPartner entities.
SalesOrderItemPrElementFluentHelper	getAllSalesOrderItemPrElement() Fetch multiple SalesOrderItemPrElement entities.
SalesOrderScheduleLineFluentHelper	getAllSalesOrderScheduleLine() Fetch multiple SalesOrderScheduleLine entities.
SalesOrderByKeyFluentHelper	getSalesOrderByKey(String salesOrder) Fetch a single SalesOrder entity using key fields.
SalesOrderHeaderPartnerByKeyFluentHelper	getSalesOrderHeaderPartnerByKey(String salesOrder, String partnerFunction) Fetch a single SalesOrderHeaderPartner entity using key fields.
SalesOrderHeaderPrElementByKeyFluentHelper	getSalesOrderHeaderPrElementByKey(String salesOrder, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single SalesOrderHeaderPrElement entity using key fields.
SalesOrderItemByKeyFluentHelper	getSalesOrderItemByKey(String salesOrder, String salesOrderItem) Fetch a single SalesOrderItem entity using key fields.
SalesOrderItemPartnerByKeyFluentHelper	getSalesOrderItemPartnerByKey(String salesOrder, String salesOrderItem, String partnerFunction) Fetch a single SalesOrderItemPartner entity using key fields.
SalesOrderItemPrElementByKeyFluentHelper	getSalesOrderItemPrElementByKey(String salesOrder, String salesOrderItem, String pricingProcedureStep, String pricingProcedureCounter) Fetch a single SalesOrderItemPrElement entity using key fields.
SalesOrderScheduleLineByKeyFluentHelper	getSalesOrderScheduleLineByKey(String salesOrder, String salesOrderItem, String scheduleLine) Fetch a single SalesOrderScheduleLine entity using key fields.
SalesOrderUpdateFluentHelper	updateSalesOrder(SalesOrder salesOrder) Update an existing SalesOrder entity and save it to the S/4HANA system.
SalesOrderHeaderPartnerUpdateFluentHelper	updateSalesOrderHeaderPartner(SalesOrderHeaderPartner salesOrderHeaderPartner) Update an existing SalesOrderHeaderPartner entity and save it to the S/4HANA system.
SalesOrderHeaderPrElementUpdateFluentHelper	updateSalesOrderHeaderPrElement(SalesOrderHeaderPrElement salesOrderHeaderPrElement) Update an existing SalesOrderHeaderPrElement entity and save it to the S/4HANA system.
SalesOrderItemUpdateFluentHelper	updateSalesOrderItem(SalesOrderItem salesOrderItem) Update an existing SalesOrderItem entity and save it to the S/4HANA system.
SalesOrderItemPartnerUpdateFluentHelper	updateSalesOrderItemPartner(SalesOrderItemPartner salesOrderItemPartner) Update an existing SalesOrderItemPartner entity and save it to the S/4HANA system.
SalesOrderItemPrElementUpdateFluentHelper	updateSalesOrderItemPrElement(SalesOrderItemPrElement salesOrderItemPrElement) Update an existing SalesOrderItemPrElement entity and save it to the S/4HANA system.
SalesOrderService	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

SalesOrderService 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

getAllSalesOrder

@Nonnull
SalesOrderFluentHelper getAllSalesOrder()

Fetch multiple SalesOrder entities.

Returns:

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

getSalesOrderByKey

@Nonnull
SalesOrderByKeyFluentHelper getSalesOrderByKey(String salesOrder)

Fetch a single SalesOrder entity using key fields.

Parameters:

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

createSalesOrder

@Nonnull
SalesOrderCreateFluentHelper createSalesOrder(@Nonnull
                                                       SalesOrder salesOrder)

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

Parameters:

salesOrder - SalesOrder entity object that will be created in the S/4HANA system.

Returns:

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

updateSalesOrder

@Nonnull
SalesOrderUpdateFluentHelper updateSalesOrder(@Nonnull
                                                       SalesOrder salesOrder)

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

Parameters:

salesOrder - SalesOrder entity object that will be updated in the S/4HANA system.

Returns:

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

deleteSalesOrder

@Nonnull
SalesOrderDeleteFluentHelper deleteSalesOrder(@Nonnull
                                                       SalesOrder salesOrder)

Deletes an existing SalesOrder entity in the S/4HANA system.

Parameters:

salesOrder - SalesOrder entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllSalesOrderHeaderPartner

@Nonnull
SalesOrderHeaderPartnerFluentHelper getAllSalesOrderHeaderPartner()

Fetch multiple SalesOrderHeaderPartner entities.

Returns:

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

getSalesOrderHeaderPartnerByKey

@Nonnull
SalesOrderHeaderPartnerByKeyFluentHelper getSalesOrderHeaderPartnerByKey(String salesOrder,
                                                                                  String partnerFunction)

Fetch a single SalesOrderHeaderPartner entity using key fields.

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

Constraints: Not nullable, Maximum length: 2

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

updateSalesOrderHeaderPartner

@Nonnull
SalesOrderHeaderPartnerUpdateFluentHelper updateSalesOrderHeaderPartner(@Nonnull
                                                                                 SalesOrderHeaderPartner salesOrderHeaderPartner)

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

Parameters:

salesOrderHeaderPartner - SalesOrderHeaderPartner entity object that will be updated in the S/4HANA system.

Returns:

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

deleteSalesOrderHeaderPartner

@Nonnull
SalesOrderHeaderPartnerDeleteFluentHelper deleteSalesOrderHeaderPartner(@Nonnull
                                                                                 SalesOrderHeaderPartner salesOrderHeaderPartner)

Deletes an existing SalesOrderHeaderPartner entity in the S/4HANA system.

Parameters:

salesOrderHeaderPartner - SalesOrderHeaderPartner entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllSalesOrderHeaderPrElement

@Nonnull
SalesOrderHeaderPrElementFluentHelper getAllSalesOrderHeaderPrElement()

Fetch multiple SalesOrderHeaderPrElement entities.

Returns:

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

getSalesOrderHeaderPrElementByKey

@Nonnull
SalesOrderHeaderPrElementByKeyFluentHelper getSalesOrderHeaderPrElementByKey(String salesOrder,
                                                                                      String pricingProcedureStep,
                                                                                      String pricingProcedureCounter)

Fetch a single SalesOrderHeaderPrElement entity using key fields.

Parameters:

pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.

Constraints: Not nullable, Maximum length: 3

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Number that determines the sequence of the condition within a procedure.

Constraints: Not nullable, Maximum length: 3

Returns:

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

updateSalesOrderHeaderPrElement

@Nonnull
SalesOrderHeaderPrElementUpdateFluentHelper updateSalesOrderHeaderPrElement(@Nonnull
                                                                                     SalesOrderHeaderPrElement salesOrderHeaderPrElement)

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

Parameters:

salesOrderHeaderPrElement - SalesOrderHeaderPrElement entity object that will be updated in the S/4HANA system.

Returns:

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

deleteSalesOrderHeaderPrElement

@Nonnull
SalesOrderHeaderPrElementDeleteFluentHelper deleteSalesOrderHeaderPrElement(@Nonnull
                                                                                     SalesOrderHeaderPrElement salesOrderHeaderPrElement)

Deletes an existing SalesOrderHeaderPrElement entity in the S/4HANA system.

Parameters:

salesOrderHeaderPrElement - SalesOrderHeaderPrElement entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllSalesOrderItem

@Nonnull
SalesOrderItemFluentHelper getAllSalesOrderItem()

Fetch multiple SalesOrderItem entities.

Returns:

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

getSalesOrderItemByKey

@Nonnull
SalesOrderItemByKeyFluentHelper getSalesOrderItemByKey(String salesOrder,
                                                                String salesOrderItem)

Fetch a single SalesOrderItem entity using key fields.

Parameters:

salesOrderItem - Sales Order Item

Constraints: Not nullable, Maximum length: 6

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

createSalesOrderItem

@Nonnull
SalesOrderItemCreateFluentHelper createSalesOrderItem(@Nonnull
                                                               SalesOrderItem salesOrderItem)

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

Parameters:

salesOrderItem - SalesOrderItem entity object that will be created in the S/4HANA system.

Returns:

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

updateSalesOrderItem

@Nonnull
SalesOrderItemUpdateFluentHelper updateSalesOrderItem(@Nonnull
                                                               SalesOrderItem salesOrderItem)

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

Parameters:

salesOrderItem - SalesOrderItem entity object that will be updated in the S/4HANA system.

Returns:

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

deleteSalesOrderItem

@Nonnull
SalesOrderItemDeleteFluentHelper deleteSalesOrderItem(@Nonnull
                                                               SalesOrderItem salesOrderItem)

Deletes an existing SalesOrderItem entity in the S/4HANA system.

Parameters:

salesOrderItem - SalesOrderItem entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllSalesOrderItemPartner

@Nonnull
SalesOrderItemPartnerFluentHelper getAllSalesOrderItemPartner()

Fetch multiple SalesOrderItemPartner entities.

Returns:

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

getSalesOrderItemPartnerByKey

@Nonnull
SalesOrderItemPartnerByKeyFluentHelper getSalesOrderItemPartnerByKey(String salesOrder,
                                                                              String salesOrderItem,
                                                                              String partnerFunction)

Fetch a single SalesOrderItemPartner entity using key fields.

Parameters:

partnerFunction - The abbreviated form of the name that identifies the partner function.

Constraints: Not nullable, Maximum length: 2

salesOrderItem - Sales Order Item

Constraints: Not nullable, Maximum length: 6

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

Returns:

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

updateSalesOrderItemPartner

@Nonnull
SalesOrderItemPartnerUpdateFluentHelper updateSalesOrderItemPartner(@Nonnull
                                                                             SalesOrderItemPartner salesOrderItemPartner)

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

Parameters:

salesOrderItemPartner - SalesOrderItemPartner entity object that will be updated in the S/4HANA system.

Returns:

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

deleteSalesOrderItemPartner

@Nonnull
SalesOrderItemPartnerDeleteFluentHelper deleteSalesOrderItemPartner(@Nonnull
                                                                             SalesOrderItemPartner salesOrderItemPartner)

Deletes an existing SalesOrderItemPartner entity in the S/4HANA system.

Parameters:

salesOrderItemPartner - SalesOrderItemPartner entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllSalesOrderItemPrElement

@Nonnull
SalesOrderItemPrElementFluentHelper getAllSalesOrderItemPrElement()

Fetch multiple SalesOrderItemPrElement entities.

Returns:

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

getSalesOrderItemPrElementByKey

@Nonnull
SalesOrderItemPrElementByKeyFluentHelper getSalesOrderItemPrElementByKey(String salesOrder,
                                                                                  String salesOrderItem,
                                                                                  String pricingProcedureStep,
                                                                                  String pricingProcedureCounter)

Fetch a single SalesOrderItemPrElement entity using key fields.

Parameters:

salesOrderItem - Sales Order Item

Constraints: Not nullable, Maximum length: 6

pricingProcedureCounter - Access number of the conditions within a step in the pricing procedure.

Constraints: Not nullable, Maximum length: 3

salesOrder - Sales Order

Constraints: Not nullable, Maximum length: 10

pricingProcedureStep - Number that determines the sequence of the condition within a procedure.

Constraints: Not nullable, Maximum length: 3

Returns:

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

updateSalesOrderItemPrElement

@Nonnull
SalesOrderItemPrElementUpdateFluentHelper updateSalesOrderItemPrElement(@Nonnull
                                                                                 SalesOrderItemPrElement salesOrderItemPrElement)

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

Parameters:

salesOrderItemPrElement - SalesOrderItemPrElement entity object that will be updated in the S/4HANA system.

Returns:

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

deleteSalesOrderItemPrElement

@Nonnull
SalesOrderItemPrElementDeleteFluentHelper deleteSalesOrderItemPrElement(@Nonnull
                                                                                 SalesOrderItemPrElement salesOrderItemPrElement)

Deletes an existing SalesOrderItemPrElement entity in the S/4HANA system.

Parameters:

salesOrderItemPrElement - SalesOrderItemPrElement entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllSalesOrderScheduleLine

@Nonnull
SalesOrderScheduleLineFluentHelper getAllSalesOrderScheduleLine()

Fetch multiple SalesOrderScheduleLine entities.

Returns:

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

getSalesOrderScheduleLineByKey

@Nonnull
SalesOrderScheduleLineByKeyFluentHelper getSalesOrderScheduleLineByKey(String salesOrder,
                                                                                String salesOrderItem,
                                                                                String scheduleLine)

Fetch a single SalesOrderScheduleLine entity using key fields.

Parameters:

salesOrderItem - The number that uniquely identifies the item in the sales document.

Constraints: Not nullable, Maximum length: 6

scheduleLine - The number that uniquely identifies the schedule line in the sales document.

Constraints: Not nullable, Maximum length: 4

salesOrder - The number that uniquely identifies the sales document.

Constraints: Not nullable, Maximum length: 10

Returns:

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