public interface CustomerReturnService extends BatchService<CustomerReturnServiceBatch>
You can use this service to integrate external applications with customer return processing in SAP S/4HANA Cloud. In every API call, you can make use of the following operations: - You can retrieve customer returns. Apply any of the filters provided or retrieve all existing data. - You can create customer returns. Note that you must use “deep insert” requests (a header plus the following entities: header partner, header pricing element, item, item partner, and item pricing element). You cannot create entities without including any related entities. - For existing customer returns, you can create new items. Note that you must use “deep insert” requests (with the following entities: item partner and item pricing element). You cannot create entities without including any related entities. - For existing customer returns, you can update the header, header partner, header pricing element, item, item partner, and item pricing element. - For existing customer returns, you can delete the header, header partner, header pricing element, item, item partner, and item pricing element..
Reference: SAP API Business Hub
OData Service: | API_CUSTOMER_RETURN_SRV |
API Version: | 1 |
Communication Scenario: | Customer Return Integration (SAP_COM_0157) |
Scope Items: | Accelerated Third-Party Returns (1Z3), Accelerated Customer Returns (BKP) |
Authentication Methods: | Basic, x509 |
Business Object: | CustomerReturn |
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. |
batch
static final String DEFAULT_SERVICE_PATH
withServicePath(String)
method, this is the default service path
used to access the endpoint.@Nonnull CustomerReturnService withServicePath(@Nonnull String servicePath)
servicePath
- Service path that will override the default.@Nonnull CustomerReturnFluentHelper getAllCustomerReturn()
CustomerReturn
entities.CustomerReturn
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 CustomerReturnByKeyFluentHelper getCustomerReturnByKey(String customerReturn)
CustomerReturn
entity using key fields.customerReturn
- Customer Return
Constraints: Not nullable, Maximum length: 10
CustomerReturn
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 CustomerReturnCreateFluentHelper createCustomerReturn(@Nonnull CustomerReturn customerReturn)
CustomerReturn
entity and save it to the S/4HANA system.customerReturn
- CustomerReturn
entity object that will be created in the S/4HANA system.CustomerReturn
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnUpdateFluentHelper updateCustomerReturn(@Nonnull CustomerReturn customerReturn)
CustomerReturn
entity and save it to the S/4HANA system.customerReturn
- CustomerReturn
entity object that will be updated in the S/4HANA system.CustomerReturn
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnDeleteFluentHelper deleteCustomerReturn(@Nonnull CustomerReturn customerReturn)
CustomerReturn
entity in the S/4HANA system.customerReturn
- CustomerReturn
entity object that will be deleted in the S/4HANA system.CustomerReturn
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnItemFluentHelper getAllCustomerReturnItem()
CustomerReturnItem
entities.CustomerReturnItem
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 CustomerReturnItemByKeyFluentHelper getCustomerReturnItemByKey(String customerReturn, String customerReturnItem)
CustomerReturnItem
entity using key fields.customerReturnItem
- Customer Return Item
Constraints: Not nullable, Maximum length: 6
customerReturn
- Customer Return
Constraints: Not nullable, Maximum length: 10
CustomerReturnItem
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 CustomerReturnItemCreateFluentHelper createCustomerReturnItem(@Nonnull CustomerReturnItem customerReturnItem)
CustomerReturnItem
entity and save it to the S/4HANA system.customerReturnItem
- CustomerReturnItem
entity object that will be created in the S/4HANA system.CustomerReturnItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnItemUpdateFluentHelper updateCustomerReturnItem(@Nonnull CustomerReturnItem customerReturnItem)
CustomerReturnItem
entity and save it to the S/4HANA system.customerReturnItem
- CustomerReturnItem
entity object that will be updated in the S/4HANA system.CustomerReturnItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnItemDeleteFluentHelper deleteCustomerReturnItem(@Nonnull CustomerReturnItem customerReturnItem)
CustomerReturnItem
entity in the S/4HANA system.customerReturnItem
- CustomerReturnItem
entity object that will be deleted in the S/4HANA system.CustomerReturnItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnItemPartnerFluentHelper getAllCustomerReturnItemPartner()
CustomerReturnItemPartner
entities.CustomerReturnItemPartner
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 CustomerReturnItemPartnerByKeyFluentHelper getCustomerReturnItemPartnerByKey(String customerReturn, String customerReturnItem, String partnerFunction)
CustomerReturnItemPartner
entity using key fields.partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
customerReturnItem
- The number that uniquely identifies the item in the sales, shipping, or billing document.
Constraints: Not nullable, Maximum length: 6
customerReturn
- The number that uniquely identifies the sales, delivery, or billing document.
Constraints: Not nullable, Maximum length: 10
CustomerReturnItemPartner
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 CustomerReturnItemPartnerUpdateFluentHelper updateCustomerReturnItemPartner(@Nonnull CustomerReturnItemPartner customerReturnItemPartner)
CustomerReturnItemPartner
entity and save it to the S/4HANA system.customerReturnItemPartner
- CustomerReturnItemPartner
entity object that will be updated in the S/4HANA system.CustomerReturnItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnItemPartnerDeleteFluentHelper deleteCustomerReturnItemPartner(@Nonnull CustomerReturnItemPartner customerReturnItemPartner)
CustomerReturnItemPartner
entity in the S/4HANA system.customerReturnItemPartner
- CustomerReturnItemPartner
entity object that will be deleted in the S/4HANA system.CustomerReturnItemPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnItemPrcgElmntFluentHelper getAllCustomerReturnItemPrcgElmnt()
CustomerReturnItemPrcgElmnt
entities.CustomerReturnItemPrcgElmnt
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 CustomerReturnItemPrcgElmntByKeyFluentHelper getCustomerReturnItemPrcgElmntByKey(String customerReturn, String customerReturnItem, String pricingProcedureStep, String pricingProcedureCounter)
CustomerReturnItemPrcgElmnt
entity using key fields.customerReturnItem
- The number that uniquely identifies the condition item.
Constraints: Not nullable, Maximum length: 6
pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
customerReturn
- The number that uniquely identifies the sales document.
Constraints: Not nullable, Maximum length: 10
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
CustomerReturnItemPrcgElmnt
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 CustomerReturnItemPrcgElmntUpdateFluentHelper updateCustomerReturnItemPrcgElmnt(@Nonnull CustomerReturnItemPrcgElmnt customerReturnItemPrcgElmnt)
CustomerReturnItemPrcgElmnt
entity and save it to the S/4HANA system.customerReturnItemPrcgElmnt
- CustomerReturnItemPrcgElmnt
entity object that will be updated in the S/4HANA system.CustomerReturnItemPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnItemPrcgElmntDeleteFluentHelper deleteCustomerReturnItemPrcgElmnt(@Nonnull CustomerReturnItemPrcgElmnt customerReturnItemPrcgElmnt)
CustomerReturnItemPrcgElmnt
entity in the S/4HANA system.customerReturnItemPrcgElmnt
- CustomerReturnItemPrcgElmnt
entity object that will be deleted in the S/4HANA system.CustomerReturnItemPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnPartnerFluentHelper getAllCustomerReturnPartner()
CustomerReturnPartner
entities.CustomerReturnPartner
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 CustomerReturnPartnerByKeyFluentHelper getCustomerReturnPartnerByKey(String customerReturn, String partnerFunction)
CustomerReturnPartner
entity using key fields.partnerFunction
- The abbreviated form of the name that identifies the partner function.
Constraints: Not nullable, Maximum length: 2
customerReturn
- The number that uniquely identifies the sales, delivery, or billing document.
Constraints: Not nullable, Maximum length: 10
CustomerReturnPartner
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 CustomerReturnPartnerUpdateFluentHelper updateCustomerReturnPartner(@Nonnull CustomerReturnPartner customerReturnPartner)
CustomerReturnPartner
entity and save it to the S/4HANA system.customerReturnPartner
- CustomerReturnPartner
entity object that will be updated in the S/4HANA system.CustomerReturnPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnPartnerDeleteFluentHelper deleteCustomerReturnPartner(@Nonnull CustomerReturnPartner customerReturnPartner)
CustomerReturnPartner
entity in the S/4HANA system.customerReturnPartner
- CustomerReturnPartner
entity object that will be deleted in the S/4HANA system.CustomerReturnPartner
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnPrcgElmntFluentHelper getAllCustomerReturnPrcgElmnt()
CustomerReturnPrcgElmnt
entities.CustomerReturnPrcgElmnt
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 CustomerReturnPrcgElmntByKeyFluentHelper getCustomerReturnPrcgElmntByKey(String customerReturn, String pricingProcedureStep, String pricingProcedureCounter)
CustomerReturnPrcgElmnt
entity using key fields.pricingProcedureCounter
- Access number of the conditions within a step in the pricing procedure.
Constraints: Not nullable, Maximum length: 3
customerReturn
- The number that uniquely identifies the sales document.
Constraints: Not nullable, Maximum length: 10
pricingProcedureStep
- Number that determines the sequence of the condition within a procedure.
Constraints: Not nullable, Maximum length: 3
CustomerReturnPrcgElmnt
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 CustomerReturnPrcgElmntUpdateFluentHelper updateCustomerReturnPrcgElmnt(@Nonnull CustomerReturnPrcgElmnt customerReturnPrcgElmnt)
CustomerReturnPrcgElmnt
entity and save it to the S/4HANA system.customerReturnPrcgElmnt
- CustomerReturnPrcgElmnt
entity object that will be updated in the S/4HANA system.CustomerReturnPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnPrcgElmntDeleteFluentHelper deleteCustomerReturnPrcgElmnt(@Nonnull CustomerReturnPrcgElmnt customerReturnPrcgElmnt)
CustomerReturnPrcgElmnt
entity in the S/4HANA system.customerReturnPrcgElmnt
- CustomerReturnPrcgElmnt
entity object that will be deleted in the S/4HANA system.CustomerReturnPrcgElmnt
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull CustomerReturnProcessStepFluentHelper getAllCustomerReturnProcessStep()
CustomerReturnProcessStep
entities.CustomerReturnProcessStep
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 CustomerReturnProcessStepByKeyFluentHelper getCustomerReturnProcessStepByKey(String retsMgmtProcess, String retsMgmtProcessItem, String retsMgmtProcItmQtySplit, String retsMgmtProcessStep, String returnsDocumentType, String returnsDocument, String returnsDocumentItem)
CustomerReturnProcessStep
entity using key fields.returnsDocumentType
- Specifies the returns document type, such as a returns order, goods movement, or credit memo.
Constraints: Not nullable, Maximum length: 2
retsMgmtProcessStep
- Describes a given document, such as a returns order, an inbound delivery, or a purchase order, in the
advanced returns process. Table MSR_I_STEP contains all valid step IDs.
Constraints: Not nullable, Maximum length: 4
returnsDocumentItem
- Specifies an item of the displayed document.
Constraints: Not nullable, Maximum length: 10
retsMgmtProcess
- Specifies the unique identifier of the advanced returns process.
Constraints: Not nullable, Maximum length: 10
retsMgmtProcessItem
- Specifies an item in the start document of a returns process. This can be a returns order, a returns
purchase order, or a returns stock transport order.
Constraints: Not nullable, Maximum length: 6
retsMgmtProcItmQtySplit
- Identifies partial qantities of a specific returns item.
Constraints: Not nullable, Maximum length: 3
returnsDocument
- Specifies the document number of a returns document.
Constraints: Not nullable, Maximum length: 30
CustomerReturnProcessStep
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 CustomerReturnScheduleLineFluentHelper getAllCustomerReturnScheduleLine()
CustomerReturnScheduleLine
entities.CustomerReturnScheduleLine
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 CustomerReturnScheduleLineByKeyFluentHelper getCustomerReturnScheduleLineByKey(String customerReturn, String customerReturnItem, String scheduleLine)
CustomerReturnScheduleLine
entity using key fields.customerReturnItem
- The number that uniquely identifies the item in the sales document.
Constraints: Not nullable, Maximum length: 6
scheduleLine
- The number that uniquely identifies the schedule line in the sales document.
Constraints: Not nullable, Maximum length: 4
customerReturn
- The number that uniquely identifies the sales document.
Constraints: Not nullable, Maximum length: 10
CustomerReturnScheduleLine
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 RejectApprovalRequestFluentHelper rejectApprovalRequest(String customerReturn)
Creates a fluent helper for the rejectApprovalRequest OData function import.
customerReturn
- Constraints: Not nullable, Maximum length: 11
Original parameter name from the Odata EDM: CustomerReturn
execute
method on the fluent helper object.@Nonnull ReleaseApprovalRequestFluentHelper releaseApprovalRequest(String customerReturn)
Creates a fluent helper for the releaseApprovalRequest OData function import.
customerReturn
- Constraints: Not nullable, Maximum length: 11
Original parameter name from the Odata EDM: CustomerReturn
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.