Interface CustomerReturnsDeliveryV2Service
- All Superinterfaces:
BatchService<CustomerReturnsDeliveryV2ServiceBatch>
- All Known Implementing Classes:
DefaultCustomerReturnsDeliveryV2Service
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 Business Accelerator Hub
Details:
| OData Service: | API_CUSTOMER_RETURNS_DELIVERY_SRV_0002 |
| API Version: | 2.1.0 |
| Minimum ERP Version: | 2302 |
| Communication Scenario: | Delivery Processing Integration(SAP_COM_0106) |
| Scope Items: | Direct Procurement with Inbound Delivery(2TX), Sell from Stock(BD9), Lean Customer Returns(BDD), Sell from Stock(OD9), Delivery Processing without Order Reference(1MI), Free of Charge Delivery(BDA), Customer Returns(BKP) |
| Authentication Methods: | x509 |
| Business Object: | Customer Returns Delivery |
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringDeprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint. -
Method Summary
Modifier and TypeMethodDescriptionconfirmPutawayAllItems(String deliveryDocument) Deprecated.Creates a fluent helper for the ConfirmPutawayAllItems OData function import.confirmPutawayOneItem(String deliveryDocumentItem, String deliveryDocument) Deprecated.Creates a fluent helper for the ConfirmPutawayOneItem OData function import.createBatchSplitItem(BigDecimal actualDeliveryQuantity, String batch, String deliveryDocument, String deliveryDocumentItem, String deliveryQuantityUnit, BigDecimal pickQuantityInSalesUOM, LocalDateTime manufactureDate, LocalDateTime shelfLifeExpirationDate) Deprecated.Creates a fluent helper for the CreateBatchSplitItem OData function import.createReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader) Deprecated.Create a newReturnsDeliveryHeaderentity and save it to the S/4HANA system.deleteReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader) Deprecated.Deletes an existingReturnsDeliveryHeaderentity in the S/4HANA system.deleteReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem) Deprecated.Deletes an existingReturnsDeliveryItementity in the S/4HANA system.Deprecated.Fetch multipleReturnsDeliveryHeaderentities.Deprecated.Fetch multipleReturnsDeliveryItementities.getReturnsDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory) Deprecated.Fetch a singleReturnsDeliveryDocFlowentity using key fields.getReturnsDeliveryHeaderByKey(String deliveryDocument) Deprecated.Fetch a singleReturnsDeliveryHeaderentity using key fields.getReturnsDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem) Deprecated.Fetch a singleReturnsDeliveryItementity using key fields.getReturnsDeliveryPartnerByKey(String partnerFunction, String sDDocument) Deprecated.Fetch a singleReturnsDeliveryPartnerentity using key fields.getReturnsDeliverySrlNmbrByKey(Long maintenanceItemObjectList) Deprecated.Fetch a singleReturnsDeliverySrlNmbrentity using key fields.postGoodsReceipt(String deliveryDocument) Deprecated.Creates a fluent helper for the PostGoodsReceipt OData function import.postGoodsReceipt(String deliveryDocument, LocalDateTime actualGoodsMovementDate) Deprecated.Creates a fluent helper for the PostGoodsReceipt OData function import.putawayAllItems(String deliveryDocument) Deprecated.Creates a fluent helper for the PutawayAllItems OData function import.putawayOneItem(String deliveryDocumentItem, String deliveryDocument) Deprecated.Creates a fluent helper for the PutawayOneItem OData function import.putawayOneItemWithBaseQuantity(String deliveryDocument, String baseUnit, BigDecimal actualDeliveredQtyInBaseUnit, String deliveryDocumentItem) Deprecated.Creates a fluent helper for the PutawayOneItemWithBaseQuantity OData function import.putawayOneItemWithSalesQuantity(BigDecimal actualDeliveryQuantity, String deliveryQuantityUnit, String deliveryDocumentItem, String deliveryDocument) Deprecated.Creates a fluent helper for the PutawayOneItemWithSalesQuantity OData function import.reverseGoodsReceipt(String deliveryDocument, LocalDateTime actualGoodsMovementDate) Deprecated.Creates a fluent helper for the ReverseGoodsReceipt OData function import.setPutawayQuantityWithBaseQuantity(String deliveryDocumentItem, String deliveryDocument, String baseUnit, BigDecimal actualDeliveredQtyInBaseUnit) Deprecated.Creates a fluent helper for the SetPutawayQuantityWithBaseQuantity OData function import.updateReturnsDeliveryDocFlow(ReturnsDeliveryDocFlow returnsDeliveryDocFlow) Deprecated.Update an existingReturnsDeliveryDocFlowentity and save it to the S/4HANA system.updateReturnsDeliveryHeader(ReturnsDeliveryHeader returnsDeliveryHeader) Deprecated.Update an existingReturnsDeliveryHeaderentity and save it to the S/4HANA system.updateReturnsDeliveryItem(ReturnsDeliveryItem returnsDeliveryItem) Deprecated.Update an existingReturnsDeliveryItementity and save it to the S/4HANA system.withServicePath(String servicePath) Deprecated.Overrides the default service path and returns a new service instance with the specified service path.Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService
batch
-
Field Details
-
DEFAULT_SERVICE_PATH
Deprecated.If no other path was provided via thewithServicePath(String)method, this is the default service path used to access the endpoint.- See Also:
-
-
Method Details
-
withServicePath
Deprecated.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.
-
getReturnsDeliveryDocFlowByKey
@Nonnull ReturnsDeliveryDocFlowByKeyFluentHelper getReturnsDeliveryDocFlowByKey(String precedingDocument, String precedingDocumentItem, String subsequentDocumentCategory) Deprecated.Fetch a singleReturnsDeliveryDocFlowentity using key fields.- Parameters:
precedingDocument- Preceding Doc.Constraints: Not nullable, Maximum length: 10
precedingDocumentItem- Preceding ItemConstraints: Not nullable, Maximum length: 6
subsequentDocumentCategory- Subs.Doc.Categ.Constraints: Not nullable, Maximum length: 4
- Returns:
- A fluent helper to fetch a single
ReturnsDeliveryDocFlowentity 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 theexecutemethod on the fluent helper object.
-
updateReturnsDeliveryDocFlow
@Nonnull ReturnsDeliveryDocFlowUpdateFluentHelper updateReturnsDeliveryDocFlow(@Nonnull ReturnsDeliveryDocFlow returnsDeliveryDocFlow) Deprecated.Update an existingReturnsDeliveryDocFlowentity and save it to the S/4HANA system.- Parameters:
returnsDeliveryDocFlow-ReturnsDeliveryDocFlowentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
ReturnsDeliveryDocFlowentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllReturnsDeliveryHeader
Deprecated.Fetch multipleReturnsDeliveryHeaderentities.- Returns:
- A fluent helper to fetch multiple
ReturnsDeliveryHeaderentities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getReturnsDeliveryHeaderByKey
@Nonnull ReturnsDeliveryHeaderByKeyFluentHelper getReturnsDeliveryHeaderByKey(String deliveryDocument) Deprecated.Fetch a singleReturnsDeliveryHeaderentity using key fields.- Parameters:
deliveryDocument- DeliveryConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
ReturnsDeliveryHeaderentity 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 theexecutemethod on the fluent helper object.
-
createReturnsDeliveryHeader
@Nonnull ReturnsDeliveryHeaderCreateFluentHelper createReturnsDeliveryHeader(@Nonnull ReturnsDeliveryHeader returnsDeliveryHeader) Deprecated.Create a newReturnsDeliveryHeaderentity and save it to the S/4HANA system.- Parameters:
returnsDeliveryHeader-ReturnsDeliveryHeaderentity object that will be created in the S/4HANA system.- Returns:
- A fluent helper to create a new
ReturnsDeliveryHeaderentity. To perform execution, call theexecutemethod on the fluent helper object.
-
updateReturnsDeliveryHeader
@Nonnull ReturnsDeliveryHeaderUpdateFluentHelper updateReturnsDeliveryHeader(@Nonnull ReturnsDeliveryHeader returnsDeliveryHeader) Deprecated.Update an existingReturnsDeliveryHeaderentity and save it to the S/4HANA system.- Parameters:
returnsDeliveryHeader-ReturnsDeliveryHeaderentity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
ReturnsDeliveryHeaderentity. To perform execution, call theexecutemethod on the fluent helper object.
-
deleteReturnsDeliveryHeader
@Nonnull ReturnsDeliveryHeaderDeleteFluentHelper deleteReturnsDeliveryHeader(@Nonnull ReturnsDeliveryHeader returnsDeliveryHeader) Deprecated.Deletes an existingReturnsDeliveryHeaderentity in the S/4HANA system.- Parameters:
returnsDeliveryHeader-ReturnsDeliveryHeaderentity object that will be deleted in the S/4HANA system.- Returns:
- A fluent helper to delete an existing
ReturnsDeliveryHeaderentity. To perform execution, call theexecutemethod on the fluent helper object.
-
getAllReturnsDeliveryItem
Deprecated.Fetch multipleReturnsDeliveryItementities.- Returns:
- A fluent helper to fetch multiple
ReturnsDeliveryItementities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call theexecutemethod on the fluent helper object.
-
getReturnsDeliveryItemByKey
@Nonnull ReturnsDeliveryItemByKeyFluentHelper getReturnsDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem) Deprecated.Fetch a singleReturnsDeliveryItementity using key fields.- Parameters:
deliveryDocument- DeliveryConstraints: Not nullable, Maximum length: 10
deliveryDocumentItem- ItemConstraints: Not nullable, Maximum length: 6
- Returns:
- A fluent helper to fetch a single
ReturnsDeliveryItementity 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 theexecutemethod on the fluent helper object.
-
updateReturnsDeliveryItem
@Nonnull ReturnsDeliveryItemUpdateFluentHelper updateReturnsDeliveryItem(@Nonnull ReturnsDeliveryItem returnsDeliveryItem) Deprecated.Update an existingReturnsDeliveryItementity and save it to the S/4HANA system.- Parameters:
returnsDeliveryItem-ReturnsDeliveryItementity object that will be updated in the S/4HANA system.- Returns:
- A fluent helper to update an existing
ReturnsDeliveryItementity. To perform execution, call theexecutemethod on the fluent helper object.
-
deleteReturnsDeliveryItem
@Nonnull ReturnsDeliveryItemDeleteFluentHelper deleteReturnsDeliveryItem(@Nonnull ReturnsDeliveryItem returnsDeliveryItem) Deprecated.Deletes an existingReturnsDeliveryItementity in the S/4HANA system.- Parameters:
returnsDeliveryItem-ReturnsDeliveryItementity object that will be deleted in the S/4HANA system.- Returns:
- A fluent helper to delete an existing
ReturnsDeliveryItementity. To perform execution, call theexecutemethod on the fluent helper object.
-
getReturnsDeliveryPartnerByKey
@Nonnull ReturnsDeliveryPartnerByKeyFluentHelper getReturnsDeliveryPartnerByKey(String partnerFunction, String sDDocument) Deprecated.Fetch a singleReturnsDeliveryPartnerentity using key fields.- Parameters:
partnerFunction- Partner FunctnConstraints: Not nullable, Maximum length: 2
sDDocument- SD DocumentConstraints: Not nullable, Maximum length: 10
- Returns:
- A fluent helper to fetch a single
ReturnsDeliveryPartnerentity 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 theexecutemethod on the fluent helper object.
-
getReturnsDeliverySrlNmbrByKey
@Nonnull ReturnsDeliverySrlNmbrByKeyFluentHelper getReturnsDeliverySrlNmbrByKey(Long maintenanceItemObjectList) Deprecated.Fetch a singleReturnsDeliverySrlNmbrentity using key fields.- Parameters:
maintenanceItemObjectList- Object listConstraints: Not nullable
- Returns:
- A fluent helper to fetch a single
ReturnsDeliverySrlNmbrentity 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 theexecutemethod on the fluent helper object.
-
reverseGoodsReceipt
@Nonnull ReverseGoodsReceiptFluentHelper reverseGoodsReceipt(@Nonnull String deliveryDocument, @Nonnull LocalDateTime actualGoodsMovementDate) Deprecated.Creates a fluent helper for the ReverseGoodsReceipt OData function import.
- Parameters:
deliveryDocument- DeliveryConstraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
actualGoodsMovementDate- Actual GI DateConstraints: 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
executemethod on the fluent helper object.
-
postGoodsReceipt
Deprecated.Creates a fluent helper for the PostGoodsReceipt OData function import.
- Parameters:
deliveryDocument- DeliveryConstraints: 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
executemethod on the fluent helper object.
-
postGoodsReceipt
@Nonnull PostGoodsReceiptFluentHelper postGoodsReceipt(@Nonnull String deliveryDocument, @Nullable LocalDateTime actualGoodsMovementDate) Deprecated.Creates a fluent helper for the PostGoodsReceipt OData function import.
- Parameters:
deliveryDocument- DeliveryConstraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
actualGoodsMovementDate- Actual GI DateConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: ActualGoodsMovementDate
- Returns:
- A fluent helper object that will execute the PostGoodsReceipt OData function import with the
provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
confirmPutawayAllItems
@Nonnull ConfirmPutawayAllItemsFluentHelper confirmPutawayAllItems(@Nonnull String deliveryDocument) Deprecated.Creates a fluent helper for the ConfirmPutawayAllItems OData function import.
- Parameters:
deliveryDocument- DeliveryConstraints: 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
executemethod on the fluent helper object.
-
confirmPutawayOneItem
@Nonnull ConfirmPutawayOneItemFluentHelper confirmPutawayOneItem(@Nonnull String deliveryDocumentItem, @Nonnull String deliveryDocument) Deprecated.Creates a fluent helper for the ConfirmPutawayOneItem OData function import.
- Parameters:
deliveryDocument- DeliveryConstraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
deliveryDocumentItem- ItemConstraints: 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
executemethod on the fluent helper object.
-
putawayAllItems
Deprecated.Creates a fluent helper for the PutawayAllItems OData function import.
- Parameters:
deliveryDocument- DeliveryConstraints: 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
executemethod on the fluent helper object.
-
putawayOneItem
@Nonnull PutawayOneItemFluentHelper putawayOneItem(@Nonnull String deliveryDocumentItem, @Nonnull String deliveryDocument) Deprecated.Creates a fluent helper for the PutawayOneItem OData function import.
- Parameters:
deliveryDocument- DeliveryConstraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
deliveryDocumentItem- ItemConstraints: 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
executemethod on the fluent helper object.
-
createBatchSplitItem
@Nonnull CreateBatchSplitItemFluentHelper createBatchSplitItem(@Nonnull BigDecimal actualDeliveryQuantity, @Nonnull String batch, @Nonnull String deliveryDocument, @Nonnull String deliveryDocumentItem, @Nonnull String deliveryQuantityUnit, @Nullable BigDecimal pickQuantityInSalesUOM, @Nullable LocalDateTime manufactureDate, @Nullable LocalDateTime shelfLifeExpirationDate) Deprecated.Creates a fluent helper for the CreateBatchSplitItem OData function import.
- Parameters:
shelfLifeExpirationDate- Time StampConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: ShelfLifeExpirationDate
deliveryDocument- Constraints: Not nullable, Maximum length: 10Original parameter name from the Odata EDM: DeliveryDocument
deliveryQuantityUnit- Constraints: Not nullable, Maximum length: 3Original parameter name from the Odata EDM: DeliveryQuantityUnit
pickQuantityInSalesUOM- Constraints: Nullable, Precision: 3, Scale: 3Original parameter name from the Odata EDM: PickQuantityInSalesUOM
batch- Constraints: Not nullable, Maximum length: 10Original parameter name from the Odata EDM: Batch
manufactureDate- Time StampConstraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: ManufactureDate
actualDeliveryQuantity- Constraints: Not nullable, Precision: 3, Scale: 3Original parameter name from the Odata EDM: ActualDeliveryQuantity
deliveryDocumentItem- Constraints: Not nullable, Maximum length: 6Original parameter name from the Odata EDM: DeliveryDocumentItem
- Returns:
- A fluent helper object that will execute the CreateBatchSplitItem OData function import with the
provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
setPutawayQuantityWithBaseQuantity
@Nonnull SetPutawayQuantityWithBaseQuantityFluentHelper setPutawayQuantityWithBaseQuantity(@Nonnull String deliveryDocumentItem, @Nonnull String deliveryDocument, @Nonnull String baseUnit, @Nonnull BigDecimal actualDeliveredQtyInBaseUnit) Deprecated.Creates a fluent helper for the SetPutawayQuantityWithBaseQuantity OData function import.
- Parameters:
baseUnit- Base UnitConstraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: BaseUnit
deliveryDocument- DeliveryConstraints: 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- ItemConstraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
- Returns:
- A fluent helper object that will execute the SetPutawayQuantityWithBaseQuantity OData function
import with the provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
putawayOneItemWithBaseQuantity
@Nonnull PutawayOneItemWithBaseQuantityFluentHelper putawayOneItemWithBaseQuantity(@Nonnull String deliveryDocument, @Nonnull String baseUnit, @Nonnull BigDecimal actualDeliveredQtyInBaseUnit, @Nonnull String deliveryDocumentItem) Deprecated.Creates a fluent helper for the PutawayOneItemWithBaseQuantity OData function import.
- Parameters:
baseUnit- Base UnitConstraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: BaseUnit
deliveryDocument- DeliveryConstraints: 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- ItemConstraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
- Returns:
- A fluent helper object that will execute the PutawayOneItemWithBaseQuantity OData function import
with the provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-
putawayOneItemWithSalesQuantity
@Nonnull PutawayOneItemWithSalesQuantityFluentHelper putawayOneItemWithSalesQuantity(@Nonnull BigDecimal actualDeliveryQuantity, @Nonnull String deliveryQuantityUnit, @Nonnull String deliveryDocumentItem, @Nonnull String deliveryDocument) Deprecated.Creates a fluent helper for the PutawayOneItemWithSalesQuantity OData function import.
- Parameters:
deliveryQuantityUnit- Sales UnitConstraints: Not nullable, Maximum length: 3
Original parameter name from the Odata EDM: DeliveryQuantityUnit
deliveryDocument- DeliveryConstraints: Not nullable, Maximum length: 10
Original parameter name from the Odata EDM: DeliveryDocument
actualDeliveryQuantity- Delivery qtyConstraints: Not nullable, Precision: 3, Scale: 3
Original parameter name from the Odata EDM: ActualDeliveryQuantity
deliveryDocumentItem- ItemConstraints: Not nullable, Maximum length: 6
Original parameter name from the Odata EDM: DeliveryDocumentItem
- Returns:
- A fluent helper object that will execute the PutawayOneItemWithSalesQuantity OData function import
with the provided parameters. To perform execution, call the
executemethod on the fluent helper object.
-