OutboundDeliveryService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultOutboundDeliveryService

public interface 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.

Business Documentation

Reference: SAP API Business Hub

Details:

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

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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.
`OutboundDeliveryService`	`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
```
@Nonnull
OutboundDeliveryService 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.
  - getAllOutbDeliveryItem
```
@Nonnull
OutbDeliveryItemFluentHelper getAllOutbDeliveryItem()
```
    Fetch multiple OutbDeliveryItem entities.
    
    Returns:
    
    A fluent helper to fetch multiple 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.
  - getOutbDeliveryItemByKey
```
@Nonnull
OutbDeliveryItemByKeyFluentHelper getOutbDeliveryItemByKey(String deliveryDocument,
                                                                    String deliveryDocumentItem)
```
    Fetch a single OutbDeliveryItem entity using key fields.
    
    Parameters:
    
    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
    
    Returns:
    
    A fluent helper to fetch a single 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.
  - updateOutbDeliveryItem
```
@Nonnull
OutbDeliveryItemUpdateFluentHelper updateOutbDeliveryItem(@Nonnull
                                                                   OutbDeliveryItem outbDeliveryItem)
```
    Update an existing OutbDeliveryItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    outbDeliveryItem - OutbDeliveryItem entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing OutbDeliveryItem entity. To perform execution, call the execute method on the fluent helper object.
  - deleteOutbDeliveryItem
```
@Nonnull
OutbDeliveryItemDeleteFluentHelper deleteOutbDeliveryItem(@Nonnull
                                                                   OutbDeliveryItem outbDeliveryItem)
```
    Deletes an existing OutbDeliveryItem entity in the S/4HANA system.
    
    Parameters:
    
    outbDeliveryItem - OutbDeliveryItem entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing OutbDeliveryItem entity. To perform execution, call the execute method on the fluent helper object.
  - getAllOutbDeliveryHeader
```
@Nonnull
OutbDeliveryHeaderFluentHelper getAllOutbDeliveryHeader()
```
    Fetch multiple OutbDeliveryHeader entities.
    
    Returns:
    
    A fluent helper to fetch multiple 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.
  - getOutbDeliveryHeaderByKey
```
@Nonnull
OutbDeliveryHeaderByKeyFluentHelper getOutbDeliveryHeaderByKey(String deliveryDocument)
```
    Fetch a single OutbDeliveryHeader entity using key fields.
    
    Parameters:
    
    deliveryDocument - The number that uniquely identifies the delivery.
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single 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.
  - createOutbDeliveryHeader
```
@Nonnull
OutbDeliveryHeaderCreateFluentHelper createOutbDeliveryHeader(@Nonnull
                                                                       OutbDeliveryHeader outbDeliveryHeader)
```
    Create a new OutbDeliveryHeader entity and save it to the S/4HANA system.
    
    Parameters:
    
    outbDeliveryHeader - OutbDeliveryHeader entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new OutbDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.
  - updateOutbDeliveryHeader
```
@Nonnull
OutbDeliveryHeaderUpdateFluentHelper updateOutbDeliveryHeader(@Nonnull
                                                                       OutbDeliveryHeader outbDeliveryHeader)
```
    Update an existing OutbDeliveryHeader entity and save it to the S/4HANA system.
    
    Parameters:
    
    outbDeliveryHeader - OutbDeliveryHeader entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing OutbDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.
  - deleteOutbDeliveryHeader
```
@Nonnull
OutbDeliveryHeaderDeleteFluentHelper deleteOutbDeliveryHeader(@Nonnull
                                                                       OutbDeliveryHeader outbDeliveryHeader)
```
    Deletes an existing OutbDeliveryHeader entity in the S/4HANA system.
    
    Parameters:
    
    outbDeliveryHeader - OutbDeliveryHeader entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing OutbDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.
  - getOutbDeliveryDocFlowByKey
```
@Nonnull
OutbDeliveryDocFlowByKeyFluentHelper getOutbDeliveryDocFlowByKey(String precedingDocument,
                                                                          String precedingDocumentItem,
                                                                          String subsequentDocumentCategory)
```
    Fetch a single OutbDeliveryDocFlow entity using key fields.
    
    Parameters:
    
    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
    
    Returns:
    
    A fluent helper to fetch a single 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.
  - updateOutbDeliveryDocFlow
```
@Nonnull
OutbDeliveryDocFlowUpdateFluentHelper updateOutbDeliveryDocFlow(@Nonnull
                                                                         OutbDeliveryDocFlow outbDeliveryDocFlow)
```
    Update an existing OutbDeliveryDocFlow entity and save it to the S/4HANA system.
    
    Parameters:
    
    outbDeliveryDocFlow - OutbDeliveryDocFlow entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing OutbDeliveryDocFlow entity. To perform execution, call the execute method on the fluent helper object.
  - getSerialNmbrDeliveryByKey
```
@Nonnull
SerialNmbrDeliveryByKeyFluentHelper getSerialNmbrDeliveryByKey(Long maintenanceItemObjectList)
```
    Fetch a single SerialNmbrDelivery entity using key fields.
    
    Parameters:
    
    maintenanceItemObjectList - Number identifying the object list
    Constraints: Not nullable
    
    Returns:
    
    A fluent helper to fetch a single 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.
  - pickAndBatchSplitOneItem
```
@Nonnull
PickAndBatchSplitOneItemFluentHelper pickAndBatchSplitOneItem(String splitQuantityUnit,
                                                                       BigDecimal splitQuantity,
                                                                       String batch,
                                                                       String deliveryDocumentItem,
                                                                       String deliveryDocument)
```
    Creates a fluent helper for the PickAndBatchSplitOneItem OData function import.
    
    Parameters:
    
    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
    
    deliveryDocument - Delivery
    
    Constraints: Not nullable, Maximum length: 10
    
    Original parameter name from the Odata EDM: DeliveryDocument
    
    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
    
    Returns:
    
    A fluent helper object that will execute the PickAndBatchSplitOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - postGoodsIssue
```
@Nonnull
PostGoodsIssueFluentHelper postGoodsIssue(String deliveryDocument)
```
    Creates a fluent helper for the PostGoodsIssue OData function import.
    
    Parameters:
    
    deliveryDocument - Delivery
    
    Constraints: Not nullable, Maximum length: 10
    
    Original parameter name from the Odata EDM: DeliveryDocument
    
    Returns:
    
    A fluent helper object that will execute the PostGoodsIssue OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - reverseGoodsIssue
```
@Nonnull
ReverseGoodsIssueFluentHelper reverseGoodsIssue(LocalDateTime actualGoodsMovementDate,
                                                         String deliveryDocument)
```
    Creates a fluent helper for the ReverseGoodsIssue OData function import.
    
    Parameters:
    
    deliveryDocument - Delivery
    
    Constraints: Not nullable, Maximum length: 10
    
    Original parameter name from the Odata EDM: DeliveryDocument
    
    actualGoodsMovementDate - Actual GI Date
    
    Constraints: Not nullable, Precision: 0
    
    Original parameter name from the Odata EDM: ActualGoodsMovementDate
    
    Returns:
    
    A fluent helper object that will execute the ReverseGoodsIssue OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - confirmPickingAllItems
```
@Nonnull
ConfirmPickingAllItemsFluentHelper confirmPickingAllItems(String deliveryDocument)
```
    Creates a fluent helper for the ConfirmPickingAllItems OData function import.
    
    Parameters:
    
    deliveryDocument - Delivery
    
    Constraints: Not nullable, Maximum length: 10
    
    Original parameter name from the Odata EDM: DeliveryDocument
    
    Returns:
    
    A fluent helper object that will execute the ConfirmPickingAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - confirmPickingOneItem
```
@Nonnull
ConfirmPickingOneItemFluentHelper confirmPickingOneItem(String deliveryDocument,
                                                                 String deliveryDocumentItem)
```
    Creates a fluent helper for the ConfirmPickingOneItem OData function import.
    
    Parameters:
    
    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
    
    Returns:
    
    A fluent helper object that will execute the ConfirmPickingOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - pickAllItems
```
@Nonnull
PickAllItemsFluentHelper pickAllItems(String deliveryDocument)
```
    Creates a fluent helper for the PickAllItems OData function import.
    
    Parameters:
    
    deliveryDocument - Delivery
    
    Constraints: Not nullable, Maximum length: 10
    
    Original parameter name from the Odata EDM: DeliveryDocument
    
    Returns:
    
    A fluent helper object that will execute the PickAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - pickOneItem
```
@Nonnull
PickOneItemFluentHelper pickOneItem(String deliveryDocumentItem,
                                             String deliveryDocument)
```
    Creates a fluent helper for the PickOneItem OData function import.
    
    Parameters:
    
    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
    
    Returns:
    
    A fluent helper object that will execute the PickOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - pickOneItemWithSalesQuantity
```
@Nonnull
PickOneItemWithSalesQuantityFluentHelper pickOneItemWithSalesQuantity(String deliveryQuantityUnit,
                                                                               String deliveryDocumentItem,
                                                                               String deliveryDocument,
                                                                               BigDecimal actualDeliveryQuantity)
```
    Creates a fluent helper for the PickOneItemWithSalesQuantity OData function import.
    
    Parameters:
    
    deliveryQuantityUnit - Constraints: Not nullable, Maximum length: 3
    Original parameter name from the Odata EDM: DeliveryQuantityUnit
    
    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
    
    deliveryDocumentItem - Valuation type
    
    Constraints: Not nullable, Maximum length: 6
    
    Original parameter name from the Odata EDM: DeliveryDocumentItem
    
    Returns:
    
    A fluent helper object that will execute the PickOneItemWithSalesQuantity OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - pickOneItemWithBaseQuantity
```
@Nonnull
PickOneItemWithBaseQuantityFluentHelper pickOneItemWithBaseQuantity(String baseUnit,
                                                                             BigDecimal actualDeliveredQtyInBaseUnit,
                                                                             String deliveryDocumentItem,
                                                                             String deliveryDocument)
```
    Creates a fluent helper for the PickOneItemWithBaseQuantity OData function import.
    
    Parameters:
    
    baseUnit - Constraints: Not nullable, Maximum length: 3
    Original parameter name from the Odata EDM: BaseUnit
    
    deliveryDocument - Constraints: Not nullable, Maximum length: 10
    Original parameter name from the Odata EDM: DeliveryDocument
    
    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
    
    Returns:
    
    A fluent helper object that will execute the PickOneItemWithBaseQuantity OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

Interface OutboundDeliveryService

Details:

Field Summary

Method Summary

Field Detail

DEFAULT_SERVICE_PATH

Method Detail

withServicePath

getAllOutbDeliveryItem

getOutbDeliveryItemByKey

updateOutbDeliveryItem

deleteOutbDeliveryItem

getAllOutbDeliveryHeader

getOutbDeliveryHeaderByKey

createOutbDeliveryHeader

updateOutbDeliveryHeader

deleteOutbDeliveryHeader

getOutbDeliveryDocFlowByKey

updateOutbDeliveryDocFlow

getSerialNmbrDeliveryByKey

pickAndBatchSplitOneItem

postGoodsIssue

reverseGoodsIssue

confirmPickingAllItems

confirmPickingOneItem

pickAllItems

pickOneItem

pickOneItemWithSalesQuantity

pickOneItemWithBaseQuantity