public interface CustomerReturnsDeliveryV2Service extends BatchService<CustomerReturnsDeliveryV2ServiceBatch>
This synchronous inbound service enables you to read, create, update, and delete customer returns deliveries. It can be consumed in Fiori apps and on other user interfaces.
Reference: SAP API Business Hub
OData Service: | API_CUSTOMER_RETURNS_DELIVERY_SRV_0002 |
API Version: | 2 |
Communication Scenario: | Delivery Processing Integration (SAP_COM_0106) |
Scope Items: | Delivery Processing without Order Reference (1MI), Direct Procurement with Inbound Delivery (2TX), Sell from Stock (BD9), Free of Charge Delivery (BDA), Customer Returns (BDD), Accelerated Customer Returns (BKP) |
Authentication Methods: | Basic, x509 |
Business Object: | CustomerReturnsDelivery |
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. |
Modifier and Type | Method and Description |
---|---|
ConfirmPutawayAllItemsFluentHelper |
confirmPutawayAllItems(String deliveryDocument)
Creates a fluent helper for the ConfirmPutawayAllItems OData function import.
|
ConfirmPutawayOneItemFluentHelper |
confirmPutawayOneItem(String deliveryDocumentItem,
String deliveryDocument)
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. |
ReturnsDeliveryPartnerByKeyFluentHelper |
getReturnsDeliveryPartnerByKey(String partnerFunction,
String sDDocument)
Fetch a single
ReturnsDeliveryPartner entity using key fields. |
ReturnsDeliverySrlNmbrByKeyFluentHelper |
getReturnsDeliverySrlNmbrByKey(Long maintenanceItemObjectList)
Fetch a single
ReturnsDeliverySrlNmbr 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 deliveryDocumentItem,
String deliveryDocument)
Creates a fluent helper for the PutawayOneItem OData function import.
|
PutawayOneItemWithBaseQuantityFluentHelper |
putawayOneItemWithBaseQuantity(String deliveryDocument,
String baseUnit,
BigDecimal actualDeliveredQtyInBaseUnit,
String deliveryDocumentItem)
Creates a fluent helper for the PutawayOneItemWithBaseQuantity OData function import.
|
PutawayOneItemWithSalesQuantityFluentHelper |
putawayOneItemWithSalesQuantity(BigDecimal actualDeliveryQuantity,
String deliveryQuantityUnit,
String deliveryDocumentItem,
String deliveryDocument)
Creates a fluent helper for the PutawayOneItemWithSalesQuantity OData function import.
|
ReverseGoodsReceiptFluentHelper |
reverseGoodsReceipt(String deliveryDocument,
LocalDateTime actualGoodsMovementDate)
Creates a fluent helper for the ReverseGoodsReceipt OData function import.
|
SetPutawayQuantityWithBaseQuantityFluentHelper |
setPutawayQuantityWithBaseQuantity(String deliveryDocumentItem,
String deliveryDocument,
String baseUnit,
BigDecimal actualDeliveredQtyInBaseUnit)
Creates a fluent helper for the SetPutawayQuantityWithBaseQuantity 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. |
CustomerReturnsDeliveryV2Service |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull CustomerReturnsDeliveryV2Service withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull ReturnsDeliveryDocFlowByKeyFluentHelper getReturnsDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory)
ReturnsDeliveryDocFlow
entity using key fields.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
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.@Nonnull ReturnsDeliveryDocFlowUpdateFluentHelper updateReturnsDeliveryDocFlow(@Nonnull ReturnsDeliveryDocFlow returnsDeliveryDocFlow)
ReturnsDeliveryDocFlow
entity and save it to the S/4HANA system.returnsDeliveryDocFlow
- ReturnsDeliveryDocFlow
entity object that will be updated in the S/4HANA system.ReturnsDeliveryDocFlow
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ReturnsDeliveryHeaderFluentHelper getAllReturnsDeliveryHeader()
ReturnsDeliveryHeader
entities.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.@Nonnull ReturnsDeliveryHeaderByKeyFluentHelper getReturnsDeliveryHeaderByKey(String deliveryDocument)
ReturnsDeliveryHeader
entity using key fields.deliveryDocument
- The number that uniquely identifies the delivery.
Constraints: Not nullable, Maximum length: 10
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.@Nonnull ReturnsDeliveryHeaderCreateFluentHelper createReturnsDeliveryHeader(@Nonnull ReturnsDeliveryHeader returnsDeliveryHeader)
ReturnsDeliveryHeader
entity and save it to the S/4HANA system.returnsDeliveryHeader
- ReturnsDeliveryHeader
entity object that will be created in the S/4HANA system.ReturnsDeliveryHeader
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ReturnsDeliveryHeaderUpdateFluentHelper updateReturnsDeliveryHeader(@Nonnull ReturnsDeliveryHeader returnsDeliveryHeader)
ReturnsDeliveryHeader
entity and save it to the S/4HANA system.returnsDeliveryHeader
- ReturnsDeliveryHeader
entity object that will be updated in the S/4HANA system.ReturnsDeliveryHeader
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ReturnsDeliveryHeaderDeleteFluentHelper deleteReturnsDeliveryHeader(@Nonnull ReturnsDeliveryHeader returnsDeliveryHeader)
ReturnsDeliveryHeader
entity in the S/4HANA system.returnsDeliveryHeader
- ReturnsDeliveryHeader
entity object that will be deleted in the S/4HANA system.ReturnsDeliveryHeader
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ReturnsDeliveryItemFluentHelper getAllReturnsDeliveryItem()
ReturnsDeliveryItem
entities.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.@Nonnull ReturnsDeliveryItemByKeyFluentHelper getReturnsDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem)
ReturnsDeliveryItem
entity using key fields.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
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.@Nonnull ReturnsDeliveryItemUpdateFluentHelper updateReturnsDeliveryItem(@Nonnull ReturnsDeliveryItem returnsDeliveryItem)
ReturnsDeliveryItem
entity and save it to the S/4HANA system.returnsDeliveryItem
- ReturnsDeliveryItem
entity object that will be updated in the S/4HANA system.ReturnsDeliveryItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ReturnsDeliveryItemDeleteFluentHelper deleteReturnsDeliveryItem(@Nonnull ReturnsDeliveryItem returnsDeliveryItem)
ReturnsDeliveryItem
entity in the S/4HANA system.returnsDeliveryItem
- ReturnsDeliveryItem
entity object that will be deleted in the S/4HANA system.ReturnsDeliveryItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull ReturnsDeliveryPartnerByKeyFluentHelper getReturnsDeliveryPartnerByKey(String partnerFunction, String sDDocument)
ReturnsDeliveryPartner
entity using key fields.partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
sDDocument
- The number that uniquely identifies the sales, delivery, or billing document.
Constraints: Not nullable, Maximum length: 10
ReturnsDeliveryPartner
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 ReturnsDeliverySrlNmbrByKeyFluentHelper getReturnsDeliverySrlNmbrByKey(Long maintenanceItemObjectList)
ReturnsDeliverySrlNmbr
entity using key fields.maintenanceItemObjectList
- Number identifying the object list
Constraints: Not nullable
ReturnsDeliverySrlNmbr
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 ReverseGoodsReceiptFluentHelper reverseGoodsReceipt(String deliveryDocument, LocalDateTime actualGoodsMovementDate)
Creates a fluent helper for the ReverseGoodsReceipt OData function import.
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
execute
method on the fluent helper object.@Nonnull PostGoodsReceiptFluentHelper postGoodsReceipt(String deliveryDocument)
Creates a fluent helper for the PostGoodsReceipt OData function import.
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.@Nonnull ConfirmPutawayAllItemsFluentHelper confirmPutawayAllItems(String deliveryDocument)
Creates a fluent helper for the ConfirmPutawayAllItems OData function import.
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.@Nonnull ConfirmPutawayOneItemFluentHelper confirmPutawayOneItem(String deliveryDocumentItem, String deliveryDocument)
Creates a fluent helper for the ConfirmPutawayOneItem OData function import.
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 PutawayAllItemsFluentHelper putawayAllItems(String deliveryDocument)
Creates a fluent helper for the PutawayAllItems OData function import.
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
execute
method on the fluent helper object.@Nonnull PutawayOneItemFluentHelper putawayOneItem(String deliveryDocumentItem, String deliveryDocument)
Creates a fluent helper for the PutawayOneItem OData function import.
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 SetPutawayQuantityWithBaseQuantityFluentHelper setPutawayQuantityWithBaseQuantity(String deliveryDocumentItem, String deliveryDocument, String baseUnit, BigDecimal actualDeliveredQtyInBaseUnit)
Creates a fluent helper for the SetPutawayQuantityWithBaseQuantity OData function import.
baseUnit
- Base Unit
Constraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: BaseUnit
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
actualDeliveredQtyInBaseUnit
- Qty (stckp.unt)
Constraints: Not nullable, Precision: 3, Scale: 3
Original parameter name from the Odata EDM: ActualDeliveredQtyInBaseUnit
deliveryDocumentItem
- Item
Constraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
execute
method on the fluent helper object.@Nonnull PutawayOneItemWithBaseQuantityFluentHelper putawayOneItemWithBaseQuantity(String deliveryDocument, String baseUnit, BigDecimal actualDeliveredQtyInBaseUnit, String deliveryDocumentItem)
Creates a fluent helper for the PutawayOneItemWithBaseQuantity OData function import.
baseUnit
- Base Unit
Constraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: BaseUnit
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
actualDeliveredQtyInBaseUnit
- Qty (stckp.unt)
Constraints: Not nullable, Precision: 3, Scale: 3
Original parameter name from the Odata EDM: ActualDeliveredQtyInBaseUnit
deliveryDocumentItem
- Item
Constraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
execute
method on the fluent helper object.@Nonnull PutawayOneItemWithSalesQuantityFluentHelper putawayOneItemWithSalesQuantity(BigDecimal actualDeliveryQuantity, String deliveryQuantityUnit, String deliveryDocumentItem, String deliveryDocument)
Creates a fluent helper for the PutawayOneItemWithSalesQuantity OData function import.
deliveryQuantityUnit
- Sales Unit
Constraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: DeliveryQuantityUnit
deliveryDocument
- Delivery
Constraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
actualDeliveryQuantity
- Delivery qty
Constraints: Not nullable, Precision: 3, Scale: 3
Original parameter name from the Odata EDM: ActualDeliveryQuantity
deliveryDocumentItem
- Item
Constraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.