@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultOutboundDeliveryService") public class DefaultOutboundDeliveryService extends Object implements OutboundDeliveryService
This service enables you to read, create, update and delete outbound deliveries in an API call. It can be consumed in Fiori apps and on other user interfaces.
Reference: SAP API Business Hub
OData Service: | API_OUTBOUND_DELIVERY_SRV |
API Version: | 2 |
Communication Scenario: | Delivery Processing Integration (SAP_COM_0106) |
Scope Items: | Delivery Processing without Order Reference (1MI), Sell from Stock (BD9), Free of Charge Delivery (BDA), Accelerated Customer Returns (BKP), Procurement of Direct Materials (J45) |
Authentication Methods: | Basic, x509 |
Business Object: | OutboundDelivery |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultOutboundDeliveryService()
Creates a service using
OutboundDeliveryService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultOutboundDeliveryServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
ConfirmPickingAllItemsFluentHelper |
confirmPickingAllItems(String deliveryDocument)
Creates a fluent helper for the ConfirmPickingAllItems OData function import.
|
ConfirmPickingOneItemFluentHelper |
confirmPickingOneItem(String deliveryDocument,
String deliveryDocumentItem)
Creates a fluent helper for the ConfirmPickingOneItem OData function import.
|
OutbDeliveryHeaderCreateFluentHelper |
createOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader)
Create a new
OutbDeliveryHeader entity and save it to the S/4HANA system. |
OutbDeliveryHeaderDeleteFluentHelper |
deleteOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader)
Deletes an existing
OutbDeliveryHeader entity in the S/4HANA system. |
OutbDeliveryItemDeleteFluentHelper |
deleteOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem)
Deletes an existing
OutbDeliveryItem entity in the S/4HANA system. |
OutbDeliveryHeaderFluentHelper |
getAllOutbDeliveryHeader()
Fetch multiple
OutbDeliveryHeader entities. |
OutbDeliveryItemFluentHelper |
getAllOutbDeliveryItem()
Fetch multiple
OutbDeliveryItem entities. |
OutbDeliveryDocFlowByKeyFluentHelper |
getOutbDeliveryDocFlowByKey(String precedingDocument,
String precedingDocumentItem,
String subsequentDocumentCategory)
Fetch a single
OutbDeliveryDocFlow entity using key fields. |
OutbDeliveryHeaderByKeyFluentHelper |
getOutbDeliveryHeaderByKey(String deliveryDocument)
Fetch a single
OutbDeliveryHeader entity using key fields. |
OutbDeliveryItemByKeyFluentHelper |
getOutbDeliveryItemByKey(String deliveryDocument,
String deliveryDocumentItem)
Fetch a single
OutbDeliveryItem entity using key fields. |
SerialNmbrDeliveryByKeyFluentHelper |
getSerialNmbrDeliveryByKey(Long maintenanceItemObjectList)
Fetch a single
SerialNmbrDelivery entity using key fields. |
PickAllItemsFluentHelper |
pickAllItems(String deliveryDocument)
Creates a fluent helper for the PickAllItems OData function import.
|
PickAndBatchSplitOneItemFluentHelper |
pickAndBatchSplitOneItem(String splitQuantityUnit,
BigDecimal splitQuantity,
String batch,
String deliveryDocumentItem,
String deliveryDocument)
Creates a fluent helper for the PickAndBatchSplitOneItem OData function import.
|
PickOneItemFluentHelper |
pickOneItem(String deliveryDocumentItem,
String deliveryDocument)
Creates a fluent helper for the PickOneItem OData function import.
|
PickOneItemWithBaseQuantityFluentHelper |
pickOneItemWithBaseQuantity(String baseUnit,
BigDecimal actualDeliveredQtyInBaseUnit,
String deliveryDocumentItem,
String deliveryDocument)
Creates a fluent helper for the PickOneItemWithBaseQuantity OData function import.
|
PickOneItemWithSalesQuantityFluentHelper |
pickOneItemWithSalesQuantity(String deliveryQuantityUnit,
String deliveryDocumentItem,
String deliveryDocument,
BigDecimal actualDeliveryQuantity)
Creates a fluent helper for the PickOneItemWithSalesQuantity OData function import.
|
PostGoodsIssueFluentHelper |
postGoodsIssue(String deliveryDocument)
Creates a fluent helper for the PostGoodsIssue OData function import.
|
ReverseGoodsIssueFluentHelper |
reverseGoodsIssue(LocalDateTime actualGoodsMovementDate,
String deliveryDocument)
Creates a fluent helper for the ReverseGoodsIssue OData function import.
|
OutbDeliveryDocFlowUpdateFluentHelper |
updateOutbDeliveryDocFlow(OutbDeliveryDocFlow outbDeliveryDocFlow)
Update an existing
OutbDeliveryDocFlow entity and save it to the S/4HANA system. |
OutbDeliveryHeaderUpdateFluentHelper |
updateOutbDeliveryHeader(OutbDeliveryHeader outbDeliveryHeader)
Update an existing
OutbDeliveryHeader entity and save it to the S/4HANA system. |
OutbDeliveryItemUpdateFluentHelper |
updateOutbDeliveryItem(OutbDeliveryItem outbDeliveryItem)
Update an existing
OutbDeliveryItem entity and save it to the S/4HANA system. |
DefaultOutboundDeliveryService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultOutboundDeliveryService()
OutboundDeliveryService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultOutboundDeliveryService withServicePath(@Nonnull String servicePath)
OutboundDeliveryService
withServicePath
in interface OutboundDeliveryService
servicePath
- Service path that will override the default.@Nonnull public DefaultOutboundDeliveryServiceBatch batch()
batch
in interface BatchService<OutboundDeliveryServiceBatch>
@Nonnull public OutbDeliveryItemFluentHelper getAllOutbDeliveryItem()
OutboundDeliveryService
OutbDeliveryItem
entities.getAllOutbDeliveryItem
in interface OutboundDeliveryService
OutbDeliveryItem
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 public OutbDeliveryItemByKeyFluentHelper getOutbDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem)
OutboundDeliveryService
OutbDeliveryItem
entity using key fields.getOutbDeliveryItemByKey
in interface OutboundDeliveryService
deliveryDocument
- The number that uniquely identifies the delivery.
Constraints: Not nullable, Maximum length: 10
deliveryDocumentItem
- The number that uniquely identifies the item in a delivery.
Constraints: Not nullable, Maximum length: 6
OutbDeliveryItem
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 public OutbDeliveryItemUpdateFluentHelper updateOutbDeliveryItem(@Nonnull OutbDeliveryItem outbDeliveryItem)
OutboundDeliveryService
OutbDeliveryItem
entity and save it to the S/4HANA system.updateOutbDeliveryItem
in interface OutboundDeliveryService
outbDeliveryItem
- OutbDeliveryItem
entity object that will be updated in the S/4HANA system.OutbDeliveryItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public OutbDeliveryItemDeleteFluentHelper deleteOutbDeliveryItem(@Nonnull OutbDeliveryItem outbDeliveryItem)
OutboundDeliveryService
OutbDeliveryItem
entity in the S/4HANA system.deleteOutbDeliveryItem
in interface OutboundDeliveryService
outbDeliveryItem
- OutbDeliveryItem
entity object that will be deleted in the S/4HANA system.OutbDeliveryItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public OutbDeliveryHeaderFluentHelper getAllOutbDeliveryHeader()
OutboundDeliveryService
OutbDeliveryHeader
entities.getAllOutbDeliveryHeader
in interface OutboundDeliveryService
OutbDeliveryHeader
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 public OutbDeliveryHeaderByKeyFluentHelper getOutbDeliveryHeaderByKey(String deliveryDocument)
OutboundDeliveryService
OutbDeliveryHeader
entity using key fields.getOutbDeliveryHeaderByKey
in interface OutboundDeliveryService
deliveryDocument
- The number that uniquely identifies the delivery.
Constraints: Not nullable, Maximum length: 10
OutbDeliveryHeader
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 public OutbDeliveryHeaderCreateFluentHelper createOutbDeliveryHeader(@Nonnull OutbDeliveryHeader outbDeliveryHeader)
OutboundDeliveryService
OutbDeliveryHeader
entity and save it to the S/4HANA system.createOutbDeliveryHeader
in interface OutboundDeliveryService
outbDeliveryHeader
- OutbDeliveryHeader
entity object that will be created in the S/4HANA system.OutbDeliveryHeader
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public OutbDeliveryHeaderUpdateFluentHelper updateOutbDeliveryHeader(@Nonnull OutbDeliveryHeader outbDeliveryHeader)
OutboundDeliveryService
OutbDeliveryHeader
entity and save it to the S/4HANA system.updateOutbDeliveryHeader
in interface OutboundDeliveryService
outbDeliveryHeader
- OutbDeliveryHeader
entity object that will be updated in the S/4HANA system.OutbDeliveryHeader
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public OutbDeliveryHeaderDeleteFluentHelper deleteOutbDeliveryHeader(@Nonnull OutbDeliveryHeader outbDeliveryHeader)
OutboundDeliveryService
OutbDeliveryHeader
entity in the S/4HANA system.deleteOutbDeliveryHeader
in interface OutboundDeliveryService
outbDeliveryHeader
- OutbDeliveryHeader
entity object that will be deleted in the S/4HANA system.OutbDeliveryHeader
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public OutbDeliveryDocFlowByKeyFluentHelper getOutbDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory)
OutboundDeliveryService
OutbDeliveryDocFlow
entity using key fields.getOutbDeliveryDocFlowByKey
in interface OutboundDeliveryService
precedingDocument
- Number that uniquely identifies the preceding sales, delivery, or billing document (for example, the
quotation from which you created a sales order).
Constraints: Not nullable, Maximum length: 10
precedingDocumentItem
- Preceding Item of an SD Document
Constraints: Not nullable, Maximum length: 6
subsequentDocumentCategory
- The document category of the sales document that you have created from a preceding document (for
example, a delivery note that has been created from a sales order).
Constraints: Not nullable, Maximum length: 4
OutbDeliveryDocFlow
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 public OutbDeliveryDocFlowUpdateFluentHelper updateOutbDeliveryDocFlow(@Nonnull OutbDeliveryDocFlow outbDeliveryDocFlow)
OutboundDeliveryService
OutbDeliveryDocFlow
entity and save it to the S/4HANA system.updateOutbDeliveryDocFlow
in interface OutboundDeliveryService
outbDeliveryDocFlow
- OutbDeliveryDocFlow
entity object that will be updated in the S/4HANA system.OutbDeliveryDocFlow
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public SerialNmbrDeliveryByKeyFluentHelper getSerialNmbrDeliveryByKey(Long maintenanceItemObjectList)
OutboundDeliveryService
SerialNmbrDelivery
entity using key fields.getSerialNmbrDeliveryByKey
in interface OutboundDeliveryService
maintenanceItemObjectList
- Number identifying the object list
Constraints: Not nullable
SerialNmbrDelivery
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 public PickAndBatchSplitOneItemFluentHelper pickAndBatchSplitOneItem(String splitQuantityUnit, BigDecimal splitQuantity, String batch, String deliveryDocumentItem, String deliveryDocument)
OutboundDeliveryService
Creates a fluent helper for the PickAndBatchSplitOneItem OData function import.
pickAndBatchSplitOneItem
in interface OutboundDeliveryService
splitQuantityUnit
- Base Unit
Constraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: SplitQuantityUnit
splitQuantity
- Qty (stckp.unt)
Constraints: Not nullable, Precision: 3, Scale: 3
Original parameter name from the Odata EDM: SplitQuantity
batch
- Batch
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: Batch
deliveryDocumentItem
- Item
Constraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.@Nonnull public PostGoodsIssueFluentHelper postGoodsIssue(String deliveryDocument)
OutboundDeliveryService
Creates a fluent helper for the PostGoodsIssue OData function import.
postGoodsIssue
in interface OutboundDeliveryService
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.@Nonnull public ReverseGoodsIssueFluentHelper reverseGoodsIssue(LocalDateTime actualGoodsMovementDate, String deliveryDocument)
OutboundDeliveryService
Creates a fluent helper for the ReverseGoodsIssue OData function import.
reverseGoodsIssue
in interface OutboundDeliveryService
actualGoodsMovementDate
- Actual GI Date
Constraints: Not nullable, Precision: 0
Original parameter name from the Odata EDM: ActualGoodsMovementDate
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.@Nonnull public ConfirmPickingAllItemsFluentHelper confirmPickingAllItems(String deliveryDocument)
OutboundDeliveryService
Creates a fluent helper for the ConfirmPickingAllItems OData function import.
confirmPickingAllItems
in interface OutboundDeliveryService
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.@Nonnull public ConfirmPickingOneItemFluentHelper confirmPickingOneItem(String deliveryDocument, String deliveryDocumentItem)
OutboundDeliveryService
Creates a fluent helper for the ConfirmPickingOneItem OData function import.
confirmPickingOneItem
in interface OutboundDeliveryService
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
deliveryDocumentItem
- Item
Constraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
execute
method on the fluent helper object.@Nonnull public PickAllItemsFluentHelper pickAllItems(String deliveryDocument)
OutboundDeliveryService
Creates a fluent helper for the PickAllItems OData function import.
pickAllItems
in interface OutboundDeliveryService
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.@Nonnull public PickOneItemFluentHelper pickOneItem(String deliveryDocumentItem, String deliveryDocument)
OutboundDeliveryService
Creates a fluent helper for the PickOneItem OData function import.
pickOneItem
in interface OutboundDeliveryService
deliveryDocumentItem
- Item
Constraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.@Nonnull public PickOneItemWithSalesQuantityFluentHelper pickOneItemWithSalesQuantity(String deliveryQuantityUnit, String deliveryDocumentItem, String deliveryDocument, BigDecimal actualDeliveryQuantity)
OutboundDeliveryService
Creates a fluent helper for the PickOneItemWithSalesQuantity OData function import.
pickOneItemWithSalesQuantity
in interface OutboundDeliveryService
deliveryQuantityUnit
- Constraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: DeliveryQuantityUnit
deliveryDocumentItem
- Valuation type
Constraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
deliveryDocument
- Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
actualDeliveryQuantity
- Constraints: Not nullable, Precision: 3, Scale: 3
Original parameter name from the Odata EDM: ActualDeliveryQuantity
execute
method on the fluent helper object.@Nonnull public PickOneItemWithBaseQuantityFluentHelper pickOneItemWithBaseQuantity(String baseUnit, BigDecimal actualDeliveredQtyInBaseUnit, String deliveryDocumentItem, String deliveryDocument)
OutboundDeliveryService
Creates a fluent helper for the PickOneItemWithBaseQuantity OData function import.
pickOneItemWithBaseQuantity
in interface OutboundDeliveryService
baseUnit
- Constraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: BaseUnit
actualDeliveredQtyInBaseUnit
- Constraints: Not nullable, Precision: 3, Scale: 3
Original parameter name from the Odata EDM: ActualDeliveredQtyInBaseUnit
deliveryDocumentItem
- Constraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
deliveryDocument
- Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.Copyright © 2019 SAP SE. All rights reserved.