CustomerReturnsDeliveryService (SAP S/4HANA Cloud SDK

All Known Implementing Classes:: DefaultCustomerReturnsDeliveryService

public interface CustomerReturnsDeliveryService

This service enables you to read, create, update, and delete customer returns 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_CUSTOMER_RETURNS_DELIVERY_SRV
API Version:	1
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)

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.
`ReturnsDeliveryHeaderCreateFluentHelper`	`createReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader)` Create a new `ReturnsDeliveryHeader` entity and save it to the S/4HANA system.
`ReturnsDeliveryHeaderDeleteFluentHelper`	`deleteReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader)` Deletes an existing `ReturnsDeliveryHeader` entity in the S/4HANA system.
`ReturnsDeliveryItemDeleteFluentHelper`	`deleteReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem)` Deletes an existing `ReturnsDeliveryItem` entity in the S/4HANA system.
`ReturnsDeliveryHeaderFluentHelper`	`getAllReturnsDeliveryHeader()` Fetch multiple `ReturnsDeliveryHeader` entities.
`ReturnsDeliveryItemFluentHelper`	`getAllReturnsDeliveryItem()` Fetch multiple `ReturnsDeliveryItem` entities.
`ReturnsDeliveryDocFlowByKeyFluentHelper`	`getReturnsDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory)` Fetch a single `ReturnsDeliveryDocFlow` entity using key fields.
`ReturnsDeliveryHeaderByKeyFluentHelper`	`getReturnsDeliveryHeaderByKey(String deliveryDocument)` Fetch a single `ReturnsDeliveryHeader` entity using key fields.
`ReturnsDeliveryItemByKeyFluentHelper`	`getReturnsDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem)` Fetch a single `ReturnsDeliveryItem` 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(LocalDateTime actualGoodsMovementDate, String deliveryDocument)` Creates a fluent helper for the ReverseGoodsReceipt OData function import.
`ReturnsDeliveryDocFlowUpdateFluentHelper`	`updateReturnsDeliveryDocFlow(ReturnsDeliveryDocFlow returnsDeliveryDocFlow)` Update an existing `ReturnsDeliveryDocFlow` entity and save it to the S/4HANA system.
`ReturnsDeliveryHeaderUpdateFluentHelper`	`updateReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader)` Update an existing `ReturnsDeliveryHeader` entity and save it to the S/4HANA system.
`ReturnsDeliveryItemUpdateFluentHelper`	`updateReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem)` Update an existing `ReturnsDeliveryItem` entity and save it to the S/4HANA system.

- Method Detail
  - getReturnsDeliveryDocFlowByKey
```
ReturnsDeliveryDocFlowByKeyFluentHelper getReturnsDeliveryDocFlowByKey(String precedingDocument,
                                                                       String precedingDocumentItem,
                                                                       String subsequentDocumentCategory)
```
    Fetch a single ReturnsDeliveryDocFlow 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 ReturnsDeliveryDocFlow 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.
  - updateReturnsDeliveryDocFlow
```
ReturnsDeliveryDocFlowUpdateFluentHelper updateReturnsDeliveryDocFlow(ReturnsDeliveryDocFlow returnsDeliveryDocFlow)
```
    Update an existing ReturnsDeliveryDocFlow entity and save it to the S/4HANA system.
    
    Parameters:
    
    returnsDeliveryDocFlow - ReturnsDeliveryDocFlow entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing ReturnsDeliveryDocFlow entity. To perform execution, call the execute method on the fluent helper object.
  - getAllReturnsDeliveryHeader
```
ReturnsDeliveryHeaderFluentHelper getAllReturnsDeliveryHeader()
```
    Fetch multiple ReturnsDeliveryHeader entities.
    
    Returns:
    
    A fluent helper to fetch multiple ReturnsDeliveryHeader 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.
  - getReturnsDeliveryHeaderByKey
```
ReturnsDeliveryHeaderByKeyFluentHelper getReturnsDeliveryHeaderByKey(String deliveryDocument)
```
    Fetch a single ReturnsDeliveryHeader 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 ReturnsDeliveryHeader 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.
  - createReturnsDeliveryHeader
```
ReturnsDeliveryHeaderCreateFluentHelper createReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader)
```
    Create a new ReturnsDeliveryHeader entity and save it to the S/4HANA system.
    
    Parameters:
    
    returnsDeliveryHeader - ReturnsDeliveryHeader entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new ReturnsDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.
  - updateReturnsDeliveryHeader
```
ReturnsDeliveryHeaderUpdateFluentHelper updateReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader)
```
    Update an existing ReturnsDeliveryHeader entity and save it to the S/4HANA system.
    
    Parameters:
    
    returnsDeliveryHeader - ReturnsDeliveryHeader entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing ReturnsDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.
  - deleteReturnsDeliveryHeader
```
ReturnsDeliveryHeaderDeleteFluentHelper deleteReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader)
```
    Deletes an existing ReturnsDeliveryHeader entity in the S/4HANA system.
    
    Parameters:
    
    returnsDeliveryHeader - ReturnsDeliveryHeader entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing ReturnsDeliveryHeader entity. To perform execution, call the execute method on the fluent helper object.
  - getAllReturnsDeliveryItem
```
ReturnsDeliveryItemFluentHelper getAllReturnsDeliveryItem()
```
    Fetch multiple ReturnsDeliveryItem entities.
    
    Returns:
    
    A fluent helper to fetch multiple ReturnsDeliveryItem 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.
  - getReturnsDeliveryItemByKey
```
ReturnsDeliveryItemByKeyFluentHelper getReturnsDeliveryItemByKey(String deliveryDocument,
                                                                 String deliveryDocumentItem)
```
    Fetch a single ReturnsDeliveryItem 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 ReturnsDeliveryItem 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.
  - updateReturnsDeliveryItem
```
ReturnsDeliveryItemUpdateFluentHelper updateReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem)
```
    Update an existing ReturnsDeliveryItem entity and save it to the S/4HANA system.
    
    Parameters:
    
    returnsDeliveryItem - ReturnsDeliveryItem entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing ReturnsDeliveryItem entity. To perform execution, call the execute method on the fluent helper object.
  - deleteReturnsDeliveryItem
```
ReturnsDeliveryItemDeleteFluentHelper deleteReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem)
```
    Deletes an existing ReturnsDeliveryItem entity in the S/4HANA system.
    
    Parameters:
    
    returnsDeliveryItem - ReturnsDeliveryItem entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing ReturnsDeliveryItem entity. To perform execution, call the execute method on the fluent helper object.
  - reverseGoodsReceipt
```
ReverseGoodsReceiptFluentHelper reverseGoodsReceipt(LocalDateTime actualGoodsMovementDate,
                                                    String deliveryDocument)
```
    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.
  - postGoodsReceipt
```
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.
  - confirmPutawayAllItems
```
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
```
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.
  - putawayAllItems
```
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
```
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.

Interface CustomerReturnsDeliveryService

Details:

Method Summary

Method Detail

getReturnsDeliveryDocFlowByKey

updateReturnsDeliveryDocFlow

getAllReturnsDeliveryHeader

getReturnsDeliveryHeaderByKey

createReturnsDeliveryHeader

updateReturnsDeliveryHeader

deleteReturnsDeliveryHeader

getAllReturnsDeliveryItem

getReturnsDeliveryItemByKey

updateReturnsDeliveryItem

deleteReturnsDeliveryItem

reverseGoodsReceipt

postGoodsReceipt

confirmPutawayAllItems

confirmPutawayOneItem

putawayAllItems

putawayOneItem