Interface CustomerReturnsDeliveryV2Service

All Superinterfaces:
BatchService<CustomerReturnsDeliveryV2ServiceBatch>
All Known Implementing Classes:
DefaultCustomerReturnsDeliveryV2Service

@Deprecated public interface CustomerReturnsDeliveryV2Service extends BatchService<CustomerReturnsDeliveryV2ServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

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.

Business Documentation

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 Details

  • Method Details

    • withServicePath

      @Nonnull CustomerReturnsDeliveryV2Service withServicePath(@Nonnull String servicePath)
      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 single ReturnsDeliveryDocFlow entity using key fields.
      Parameters:
      precedingDocument - Preceding Doc.

      Constraints: Not nullable, Maximum length: 10

      precedingDocumentItem - Preceding Item

      Constraints: Not nullable, Maximum length: 6

      subsequentDocumentCategory - Subs.Doc.Categ.

      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

      @Nonnull ReturnsDeliveryDocFlowUpdateFluentHelper updateReturnsDeliveryDocFlow(@Nonnull ReturnsDeliveryDocFlow returnsDeliveryDocFlow)
      Deprecated.
      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

      @Nonnull ReturnsDeliveryHeaderFluentHelper getAllReturnsDeliveryHeader()
      Deprecated.
      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

      @Nonnull ReturnsDeliveryHeaderByKeyFluentHelper getReturnsDeliveryHeaderByKey(String deliveryDocument)
      Deprecated.
      Fetch a single ReturnsDeliveryHeader entity using key fields.
      Parameters:
      deliveryDocument - 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

      @Nonnull ReturnsDeliveryHeaderCreateFluentHelper createReturnsDeliveryHeader(@Nonnull ReturnsDeliveryHeader returnsDeliveryHeader)
      Deprecated.
      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

      @Nonnull ReturnsDeliveryHeaderUpdateFluentHelper updateReturnsDeliveryHeader(@Nonnull ReturnsDeliveryHeader returnsDeliveryHeader)
      Deprecated.
      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

      @Nonnull ReturnsDeliveryHeaderDeleteFluentHelper deleteReturnsDeliveryHeader(@Nonnull ReturnsDeliveryHeader returnsDeliveryHeader)
      Deprecated.
      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

      @Nonnull ReturnsDeliveryItemFluentHelper getAllReturnsDeliveryItem()
      Deprecated.
      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

      @Nonnull ReturnsDeliveryItemByKeyFluentHelper getReturnsDeliveryItemByKey(String deliveryDocument, String deliveryDocumentItem)
      Deprecated.
      Fetch a single ReturnsDeliveryItem entity using key fields.
      Parameters:
      deliveryDocument - Delivery

      Constraints: Not nullable, Maximum length: 10

      deliveryDocumentItem - Item

      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

      @Nonnull ReturnsDeliveryItemUpdateFluentHelper updateReturnsDeliveryItem(@Nonnull ReturnsDeliveryItem returnsDeliveryItem)
      Deprecated.
      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

      @Nonnull ReturnsDeliveryItemDeleteFluentHelper deleteReturnsDeliveryItem(@Nonnull ReturnsDeliveryItem returnsDeliveryItem)
      Deprecated.
      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.
    • getReturnsDeliveryPartnerByKey

      @Nonnull ReturnsDeliveryPartnerByKeyFluentHelper getReturnsDeliveryPartnerByKey(String partnerFunction, String sDDocument)
      Deprecated.
      Fetch a single ReturnsDeliveryPartner entity using key fields.
      Parameters:
      partnerFunction - Partner Functn

      Constraints: Not nullable, Maximum length: 2

      sDDocument - SD Document

      Constraints: Not nullable, Maximum length: 10

      Returns:
      A fluent helper to fetch a single 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.
    • getReturnsDeliverySrlNmbrByKey

      @Nonnull ReturnsDeliverySrlNmbrByKeyFluentHelper getReturnsDeliverySrlNmbrByKey(Long maintenanceItemObjectList)
      Deprecated.
      Fetch a single ReturnsDeliverySrlNmbr entity using key fields.
      Parameters:
      maintenanceItemObjectList - Object list

      Constraints: Not nullable

      Returns:
      A fluent helper to fetch a single 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.
    • reverseGoodsReceipt

      @Nonnull ReverseGoodsReceiptFluentHelper reverseGoodsReceipt(@Nonnull String deliveryDocument, @Nonnull LocalDateTime actualGoodsMovementDate)
      Deprecated.

      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

      @Nonnull PostGoodsReceiptFluentHelper postGoodsReceipt(@Nonnull String deliveryDocument)
      Deprecated.

      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.
    • postGoodsReceipt

      @Nonnull PostGoodsReceiptFluentHelper postGoodsReceipt(@Nonnull String deliveryDocument, @Nullable LocalDateTime actualGoodsMovementDate)
      Deprecated.

      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

      actualGoodsMovementDate - Actual GI Date

      Constraints: 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 execute method 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 - 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(@Nonnull String deliveryDocumentItem, @Nonnull String deliveryDocument)
      Deprecated.

      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

      @Nonnull PutawayAllItemsFluentHelper putawayAllItems(@Nonnull String deliveryDocument)
      Deprecated.

      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(@Nonnull String deliveryDocumentItem, @Nonnull String deliveryDocument)
      Deprecated.

      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.
    • 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 Stamp

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: ShelfLifeExpirationDate

      deliveryDocument - Constraints: Not nullable, Maximum length: 10

      Original parameter name from the Odata EDM: DeliveryDocument

      deliveryQuantityUnit - Constraints: Not nullable, Maximum length: 3

      Original parameter name from the Odata EDM: DeliveryQuantityUnit

      pickQuantityInSalesUOM - Constraints: Nullable, Precision: 3, Scale: 3

      Original parameter name from the Odata EDM: PickQuantityInSalesUOM

      batch - Constraints: Not nullable, Maximum length: 10

      Original parameter name from the Odata EDM: Batch

      manufactureDate - Time Stamp

      Constraints: Nullable, Precision: 0

      Original parameter name from the Odata EDM: ManufactureDate

      actualDeliveryQuantity - Constraints: Not nullable, Precision: 3, Scale: 3

      Original parameter name from the Odata EDM: ActualDeliveryQuantity

      deliveryDocumentItem - Constraints: Not nullable, Maximum length: 6

      Original 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 execute method 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 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

      Returns:
      A fluent helper object that will execute the SetPutawayQuantityWithBaseQuantity OData function import with the provided parameters. To perform execution, call the execute method 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 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

      Returns:
      A fluent helper object that will execute the PutawayOneItemWithBaseQuantity OData function import with the provided parameters. To perform execution, call the execute method 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 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

      Returns:
      A fluent helper object that will execute the PutawayOneItemWithSalesQuantity OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.