public interface SalesOrderService extends BatchService<SalesOrderServiceBatch>
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, header text, payment details, item, item partner, item pricing element, and item text). 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, item pricing element, and item text). You cannot create entities without including any related entities. - For existing sales orders, you can update the header, header partner, header pricing element, header text, payment details, item, item partner, item pricing element, and item text. - For existing sales orders, you can delete the header, header partner, header pricing element, header text, payment details, item, item partner, item pricing element, and item text. - You can accept or deny approval requests for sales orders that cannot be processed without the consent of an approver..
Reference: SAP API Business Hub
OData Service: | API_SALES_ORDER_SRV |
API Version: | 1 |
Communication Scenario: | Sales Order Integration (SAP_COM_0109), Delivery Insights Replication App Integration (SAP_COM_0571) |
Scope Items: | Opportunity-to-Order with Third-Party Sales Force Automation Apps (1QI), Sell from Stock (BD9), Delivery Insights (4IH) |
Authentication Methods: | Basic, x509, OAuth2 |
Business Object: | SalesOrder |
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. |
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull SalesOrderService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull SalesOrderFluentHelper getAllSalesOrder()
SalesOrder
entities.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.@Nonnull SalesOrderByKeyFluentHelper getSalesOrderByKey(String salesOrder)
SalesOrder
entity using key fields.salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
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.@Nonnull SalesOrderCreateFluentHelper createSalesOrder(@Nonnull SalesOrder salesOrder)
SalesOrder
entity
and save it to the S/4HANA system.salesOrder
- SalesOrder
entity
object that will be created in the S/4HANA system.SalesOrder
entity. To
perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderUpdateFluentHelper updateSalesOrder(@Nonnull SalesOrder salesOrder)
SalesOrder
entity and save it to the S/4HANA system.salesOrder
- SalesOrder
entity
object that will be updated in the S/4HANA system.SalesOrder
entity. To
perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderDeleteFluentHelper deleteSalesOrder(@Nonnull SalesOrder salesOrder)
SalesOrder
entity in the S/4HANA system.salesOrder
- SalesOrder
entity
object that will be deleted in the S/4HANA system.SalesOrder
entity. To
perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderHeaderPartnerFluentHelper getAllSalesOrderHeaderPartner()
SalesOrderHeaderPartner
entities.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.@Nonnull SalesOrderHeaderPartnerByKeyFluentHelper getSalesOrderHeaderPartnerByKey(String salesOrder, String partnerFunction)
SalesOrderHeaderPartner
entity using key fields.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
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.@Nonnull SalesOrderHeaderPartnerUpdateFluentHelper updateSalesOrderHeaderPartner(@Nonnull SalesOrderHeaderPartner salesOrderHeaderPartner)
SalesOrderHeaderPartner
entity and save it to the S/4HANA system.salesOrderHeaderPartner
- SalesOrderHeaderPartner
entity object that will be updated in the S/4HANA system.SalesOrderHeaderPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderHeaderPartnerDeleteFluentHelper deleteSalesOrderHeaderPartner(@Nonnull SalesOrderHeaderPartner salesOrderHeaderPartner)
SalesOrderHeaderPartner
entity in the S/4HANA system.salesOrderHeaderPartner
- SalesOrderHeaderPartner
entity object that will be deleted in the S/4HANA system.SalesOrderHeaderPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderHeaderPrElementFluentHelper getAllSalesOrderHeaderPrElement()
SalesOrderHeaderPrElement
entities.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.@Nonnull SalesOrderHeaderPrElementByKeyFluentHelper getSalesOrderHeaderPrElementByKey(String salesOrder, String pricingProcedureStep, String pricingProcedureCounter)
SalesOrderHeaderPrElement
entity using key fields.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
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.@Nonnull SalesOrderHeaderPrElementUpdateFluentHelper updateSalesOrderHeaderPrElement(@Nonnull SalesOrderHeaderPrElement salesOrderHeaderPrElement)
SalesOrderHeaderPrElement
entity and save it to the S/4HANA system.salesOrderHeaderPrElement
- SalesOrderHeaderPrElement
entity object that will be updated in the S/4HANA system.SalesOrderHeaderPrElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderHeaderPrElementDeleteFluentHelper deleteSalesOrderHeaderPrElement(@Nonnull SalesOrderHeaderPrElement salesOrderHeaderPrElement)
SalesOrderHeaderPrElement
entity in the S/4HANA system.salesOrderHeaderPrElement
- SalesOrderHeaderPrElement
entity object that will be deleted in the S/4HANA system.SalesOrderHeaderPrElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderItemFluentHelper getAllSalesOrderItem()
SalesOrderItem
entities.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.@Nonnull SalesOrderItemByKeyFluentHelper getSalesOrderItemByKey(String salesOrder, String salesOrderItem)
SalesOrderItem
entity using key fields.salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
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.@Nonnull SalesOrderItemCreateFluentHelper createSalesOrderItem(@Nonnull SalesOrderItem salesOrderItem)
SalesOrderItem
entity and save it to the S/4HANA system.salesOrderItem
- SalesOrderItem
entity object that will be created in the S/4HANA system.SalesOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderItemUpdateFluentHelper updateSalesOrderItem(@Nonnull SalesOrderItem salesOrderItem)
SalesOrderItem
entity and save it to the S/4HANA system.salesOrderItem
- SalesOrderItem
entity object that will be updated in the S/4HANA system.SalesOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderItemDeleteFluentHelper deleteSalesOrderItem(@Nonnull SalesOrderItem salesOrderItem)
SalesOrderItem
entity in the S/4HANA system.salesOrderItem
- SalesOrderItem
entity object that will be deleted in the S/4HANA system.SalesOrderItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderItemPartnerFluentHelper getAllSalesOrderItemPartner()
SalesOrderItemPartner
entities.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.@Nonnull SalesOrderItemPartnerByKeyFluentHelper getSalesOrderItemPartnerByKey(String salesOrder, String salesOrderItem, String partnerFunction)
SalesOrderItemPartner
entity using key fields.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
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.@Nonnull SalesOrderItemPartnerUpdateFluentHelper updateSalesOrderItemPartner(@Nonnull SalesOrderItemPartner salesOrderItemPartner)
SalesOrderItemPartner
entity and save it to the S/4HANA system.salesOrderItemPartner
- SalesOrderItemPartner
entity object that will be updated in the S/4HANA system.SalesOrderItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderItemPartnerDeleteFluentHelper deleteSalesOrderItemPartner(@Nonnull SalesOrderItemPartner salesOrderItemPartner)
SalesOrderItemPartner
entity in the S/4HANA system.salesOrderItemPartner
- SalesOrderItemPartner
entity object that will be deleted in the S/4HANA system.SalesOrderItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderItemPrElementFluentHelper getAllSalesOrderItemPrElement()
SalesOrderItemPrElement
entities.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.@Nonnull SalesOrderItemPrElementByKeyFluentHelper getSalesOrderItemPrElementByKey(String salesOrder, String salesOrderItem, String pricingProcedureStep, String pricingProcedureCounter)
SalesOrderItemPrElement
entity using key fields.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
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.@Nonnull SalesOrderItemPrElementUpdateFluentHelper updateSalesOrderItemPrElement(@Nonnull SalesOrderItemPrElement salesOrderItemPrElement)
SalesOrderItemPrElement
entity and save it to the S/4HANA system.salesOrderItemPrElement
- SalesOrderItemPrElement
entity object that will be updated in the S/4HANA system.SalesOrderItemPrElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderItemPrElementDeleteFluentHelper deleteSalesOrderItemPrElement(@Nonnull SalesOrderItemPrElement salesOrderItemPrElement)
SalesOrderItemPrElement
entity in the S/4HANA system.salesOrderItemPrElement
- SalesOrderItemPrElement
entity object that will be deleted in the S/4HANA system.SalesOrderItemPrElement
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderItemTextFluentHelper getAllSalesOrderItemText()
SalesOrderItemText
entities.SalesOrderItemText
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.@Nonnull SalesOrderItemTextByKeyFluentHelper getSalesOrderItemTextByKey(String salesOrder, String salesOrderItem, String language, String longTextID)
SalesOrderItemText
entity using key fields.salesOrderItem
- Sales Order Item
Constraints: Not nullable, Maximum length: 6
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
Constraints: Not nullable, Maximum length: 4
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
SalesOrderItemText
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.@Nonnull SalesOrderItemTextUpdateFluentHelper updateSalesOrderItemText(@Nonnull SalesOrderItemText salesOrderItemText)
SalesOrderItemText
entity and save it to the S/4HANA system.salesOrderItemText
- SalesOrderItemText
entity object that will be updated in the S/4HANA system.SalesOrderItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderItemTextDeleteFluentHelper deleteSalesOrderItemText(@Nonnull SalesOrderItemText salesOrderItemText)
SalesOrderItemText
entity in the S/4HANA system.salesOrderItemText
- SalesOrderItemText
entity object that will be deleted in the S/4HANA system.SalesOrderItemText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderScheduleLineFluentHelper getAllSalesOrderScheduleLine()
SalesOrderScheduleLine
entities.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.@Nonnull SalesOrderScheduleLineByKeyFluentHelper getSalesOrderScheduleLineByKey(String salesOrder, String salesOrderItem, String scheduleLine)
SalesOrderScheduleLine
entity using key fields.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
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.@Nonnull SalesOrderTextFluentHelper getAllSalesOrderText()
SalesOrderText
entities.SalesOrderText
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.@Nonnull SalesOrderTextByKeyFluentHelper getSalesOrderTextByKey(String salesOrder, String language, String longTextID)
SalesOrderText
entity using key fields.language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
longTextID
- The text ID defines the various types of texts related to a text object. For example, the object
"TEXT" (standard texts) can have the following text IDs:
Constraints: Not nullable, Maximum length: 4
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
SalesOrderText
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.@Nonnull SalesOrderTextUpdateFluentHelper updateSalesOrderText(@Nonnull SalesOrderText salesOrderText)
SalesOrderText
entity and save it to the S/4HANA system.salesOrderText
- SalesOrderText
entity object that will be updated in the S/4HANA system.SalesOrderText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SalesOrderTextDeleteFluentHelper deleteSalesOrderText(@Nonnull SalesOrderText salesOrderText)
SalesOrderText
entity in the S/4HANA system.salesOrderText
- SalesOrderText
entity object that will be deleted in the S/4HANA system.SalesOrderText
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SlsOrdPaymentPlanItemDetailsFluentHelper getAllSlsOrdPaymentPlanItemDetails()
SlsOrdPaymentPlanItemDetails
entities.SlsOrdPaymentPlanItemDetails
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.@Nonnull SlsOrdPaymentPlanItemDetailsByKeyFluentHelper getSlsOrdPaymentPlanItemDetailsByKey(String salesOrder, String paymentPlanItem)
SlsOrdPaymentPlanItemDetails
entity using key fields.paymentPlanItem
- Item for billing plan/invoice plan/payment cards
Constraints: Not nullable, Maximum length: 6
salesOrder
- Sales Order
Constraints: Not nullable, Maximum length: 10
SlsOrdPaymentPlanItemDetails
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.@Nonnull SlsOrdPaymentPlanItemDetailsUpdateFluentHelper updateSlsOrdPaymentPlanItemDetails(@Nonnull SlsOrdPaymentPlanItemDetails slsOrdPaymentPlanItemDetails)
SlsOrdPaymentPlanItemDetails
entity and save it to the S/4HANA system.slsOrdPaymentPlanItemDetails
- SlsOrdPaymentPlanItemDetails
entity object that will be updated in the S/4HANA system.SlsOrdPaymentPlanItemDetails
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull SlsOrdPaymentPlanItemDetailsDeleteFluentHelper deleteSlsOrdPaymentPlanItemDetails(@Nonnull SlsOrdPaymentPlanItemDetails slsOrdPaymentPlanItemDetails)
SlsOrdPaymentPlanItemDetails
entity in the S/4HANA system.slsOrdPaymentPlanItemDetails
- SlsOrdPaymentPlanItemDetails
entity object that will be deleted in the S/4HANA system.SlsOrdPaymentPlanItemDetails
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull RejectApprovalRequestFluentHelper rejectApprovalRequest(String salesOrder)
Creates a fluent helper for the rejectApprovalRequest OData function import.
salesOrder
- Constraints: Not nullable, Maximum length: 11000
Original parameter name from the Odata EDM: SalesOrder
execute
method on the fluent helper object.@Nonnull ReleaseApprovalRequestFluentHelper releaseApprovalRequest(String salesOrder)
Creates a fluent helper for the releaseApprovalRequest OData function import.
salesOrder
- Constraints: Not nullable, Maximum length: 11000
Original parameter name from the Odata EDM: SalesOrder
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.