InboundDeliveryService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultInboundDeliveryService

public interface InboundDeliveryService

This service enables you to read, create, update, and delete inbound 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_INBOUND_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:	InboundDelivery

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
`ConfirmPutawayAllItemsFluentHelper`	`confirmPutawayAllItems(String deliveryDocument)` Creates a fluent helper for the ConfirmPutawayAllItems OData function import.
`ConfirmPutawayOneItemFluentHelper`	`confirmPutawayOneItem(String deliveryDocument, String deliveryDocumentItem)` Creates a fluent helper for the ConfirmPutawayOneItem OData function import.
`InbDeliveryHeaderCreateFluentHelper`	`createInbDeliveryHeader(InbDeliveryHeader inbDeliveryHeader)` Create a new `InbDeliveryHeader` entity and save it to the S/4HANA system.
`InbDeliveryHeaderDeleteFluentHelper`	`deleteInbDeliveryHeader(InbDeliveryHeader inbDeliveryHeader)` Deletes an existing `InbDeliveryHeader` entity in the S/4HANA system.
`InbDeliveryItemDeleteFluentHelper`	`deleteInbDeliveryItem(InbDeliveryItem inbDeliveryItem)` Deletes an existing `InbDeliveryItem` entity in the S/4HANA system.
`InbDeliveryHeaderFluentHelper`	`getAllInbDeliveryHeader()` Fetch multiple `InbDeliveryHeader` entities.
`InbDeliveryItemFluentHelper`	`getAllInbDeliveryItem()` Fetch multiple `InbDeliveryItem` entities.
`InbDeliveryDocFlowByKeyFluentHelper`	`getInbDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory)` Fetch a single `InbDeliveryDocFlow` entity using key fields.
`InbDeliveryHeaderByKeyFluentHelper`	`getInbDeliveryHeaderByKey(String deliveryDocument)` Fetch a single `InbDeliveryHeader` entity using key fields.
`InbDeliveryItemByKeyFluentHelper`	`getInbDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem)` Fetch a single `InbDeliveryItem` entity using key fields.
`PostGoodsReceiptFluentHelper`	`postGoodsReceipt(String deliveryDocument)` Creates a fluent helper for the PostGoodsReceipt OData function import.
`PutawayAllItemsFluentHelper`	`putawayAllItems(String deliveryDocument)` Creates a fluent helper for the PutawayAllItems OData function import.
`PutawayOneItemFluentHelper`	`putawayOneItem(String deliveryDocument, String deliveryDocumentItem)` Creates a fluent helper for the PutawayOneItem OData function import.
`ReverseGoodsReceiptFluentHelper`	`reverseGoodsReceipt(String deliveryDocument, LocalDateTime actualGoodsMovementDate)` Creates a fluent helper for the ReverseGoodsReceipt OData function import.
`InbDeliveryDocFlowUpdateFluentHelper`	`updateInbDeliveryDocFlow(InbDeliveryDocFlow inbDeliveryDocFlow)` Update an existing `InbDeliveryDocFlow` entity and save it to the S/4HANA system.
`InbDeliveryHeaderUpdateFluentHelper`	`updateInbDeliveryHeader(InbDeliveryHeader inbDeliveryHeader)` Update an existing `InbDeliveryHeader` entity and save it to the S/4HANA system.
`InbDeliveryItemUpdateFluentHelper`	`updateInbDeliveryItem(InbDeliveryItem inbDeliveryItem)` Update an existing `InbDeliveryItem` entity and save it to the S/4HANA system.
`InboundDeliveryService`	`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
```
InboundDeliveryService 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
  - getInbDeliveryDocFlowByKey
```
@Nonnull
InbDeliveryDocFlowByKeyFluentHelper getInbDeliveryDocFlowByKey(String precedingDocument,
                                                                        String precedingDocumentItem,
                                                                        String subsequentDocumentCategory)
```
    Fetch a single InbDeliveryDocFlow 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 InbDeliveryDocFlow 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.
  - updateInbDeliveryDocFlow
```
@Nonnull
InbDeliveryDocFlowUpdateFluentHelper updateInbDeliveryDocFlow(@Nonnull
                                                                       InbDeliveryDocFlow inbDeliveryDocFlow)
```
    Update an existing InbDeliveryDocFlow entity and save it to the S/4HANA system.
    
    Parameters:
    
    inbDeliveryDocFlow - InbDeliveryDocFlow entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing InbDeliveryDocFlow entity. To perform execution, call the execute method on the fluent helper object.
  - getAllInbDeliveryHeader
```
@Nonnull
InbDeliveryHeaderFluentHelper getAllInbDeliveryHeader()
```
    Fetch multiple InbDeliveryHeader entities.
    
    Returns:
    
    A fluent helper to fetch multiple InbDeliveryHeader 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.
  - getInbDeliveryHeaderByKey
```
@Nonnull
InbDeliveryHeaderByKeyFluentHelper getInbDeliveryHeaderByKey(String deliveryDocument)
```
    Fetch a single InbDeliveryHeader 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 InbDeliveryHeader 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.
  - createInbDeliveryHeader
```
@Nonnull
InbDeliveryHeaderCreateFluentHelper createInbDeliveryHeader(@Nonnull
                                                                     InbDeliveryHeader inbDeliveryHeader)
```
    Create a new InbDeliveryHeader entity and save it to the S/4HANA system.
    
    Parameters:
    
    inbDeliveryHeader - InbDeliveryHeader entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new InbDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.
  - updateInbDeliveryHeader
```
@Nonnull
InbDeliveryHeaderUpdateFluentHelper updateInbDeliveryHeader(@Nonnull
                                                                     InbDeliveryHeader inbDeliveryHeader)
```
    Update an existing InbDeliveryHeader entity and save it to the S/4HANA system.
    
    Parameters:
    
    inbDeliveryHeader - InbDeliveryHeader entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing InbDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.
  - deleteInbDeliveryHeader
```
@Nonnull
InbDeliveryHeaderDeleteFluentHelper deleteInbDeliveryHeader(@Nonnull
                                                                     InbDeliveryHeader inbDeliveryHeader)
```
    Deletes an existing InbDeliveryHeader entity in the S/4HANA system.
    
    Parameters:
    
    inbDeliveryHeader - InbDeliveryHeader entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing InbDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.
  - getAllInbDeliveryItem
```
@Nonnull
InbDeliveryItemFluentHelper getAllInbDeliveryItem()
```
    Fetch multiple InbDeliveryItem entities.
    
    Returns:
    
    A fluent helper to fetch multiple InbDeliveryItem 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.
  - getInbDeliveryItemByKey
```
@Nonnull
InbDeliveryItemByKeyFluentHelper getInbDeliveryItemByKey(String deliveryDocument,
                                                                  String deliveryDocumentItem)
```
    Fetch a single InbDeliveryItem 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 InbDeliveryItem 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.
  - updateInbDeliveryItem
```
@Nonnull
InbDeliveryItemUpdateFluentHelper updateInbDeliveryItem(@Nonnull
                                                                 InbDeliveryItem inbDeliveryItem)
```
    Update an existing InbDeliveryItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    inbDeliveryItem - InbDeliveryItem entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing InbDeliveryItem entity. To perform execution, call the execute method on the fluent helper object.
  - deleteInbDeliveryItem
```
@Nonnull
InbDeliveryItemDeleteFluentHelper deleteInbDeliveryItem(@Nonnull
                                                                 InbDeliveryItem inbDeliveryItem)
```
    Deletes an existing InbDeliveryItem entity in the S/4HANA system.
    
    Parameters:
    
    inbDeliveryItem - InbDeliveryItem entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing InbDeliveryItem entity. To perform execution, call the execute method on the fluent helper object.
  - confirmPutawayAllItems
```
@Nonnull
ConfirmPutawayAllItemsFluentHelper confirmPutawayAllItems(String deliveryDocument)
```
    Creates a fluent helper for the ConfirmPutawayAllItems 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 ConfirmPutawayAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - confirmPutawayOneItem
```
@Nonnull
ConfirmPutawayOneItemFluentHelper confirmPutawayOneItem(String deliveryDocument,
                                                                 String deliveryDocumentItem)
```
    Creates a fluent helper for the ConfirmPutawayOneItem 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 ConfirmPutawayOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - postGoodsReceipt
```
@Nonnull
PostGoodsReceiptFluentHelper postGoodsReceipt(String deliveryDocument)
```
    Creates a fluent helper for the PostGoodsReceipt 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 PostGoodsReceipt OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - putawayAllItems
```
@Nonnull
PutawayAllItemsFluentHelper putawayAllItems(String deliveryDocument)
```
    Creates a fluent helper for the PutawayAllItems 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 PutawayAllItems OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - putawayOneItem
```
@Nonnull
PutawayOneItemFluentHelper putawayOneItem(String deliveryDocument,
                                                   String deliveryDocumentItem)
```
    Creates a fluent helper for the PutawayOneItem 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 PutawayOneItem OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.
  - reverseGoodsReceipt
```
@Nonnull
ReverseGoodsReceiptFluentHelper reverseGoodsReceipt(String deliveryDocument,
                                                             LocalDateTime actualGoodsMovementDate)
```
    Creates a fluent helper for the ReverseGoodsReceipt 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 ReverseGoodsReceipt OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.

Interface InboundDeliveryService

Details:

Field Summary

Method Summary

Field Detail

DEFAULT_SERVICE_PATH

Method Detail

withServicePath

getInbDeliveryDocFlowByKey

updateInbDeliveryDocFlow

getAllInbDeliveryHeader

getInbDeliveryHeaderByKey

createInbDeliveryHeader

updateInbDeliveryHeader

deleteInbDeliveryHeader

getAllInbDeliveryItem

getInbDeliveryItemByKey

updateInbDeliveryItem

deleteInbDeliveryItem

confirmPutawayAllItems

confirmPutawayOneItem

postGoodsReceipt

putawayAllItems

putawayOneItem

reverseGoodsReceipt