The InStore_Refund module provides functionality to process returns.
Ask about this Page
Copy for LLM
View as Markdown
InStore_Refund is a product or core module that acts as a modifiable wrapper for the InStore core application. To learn more about module configurability, contact the InStore support team.
This module processes previously prepared return Carts. To create a return Cart, use the InStore_Cart module.
Capabilities
The InStore_Refund module handles the following InStore functions:
- Receives a Cart of returned items for a refund.
- Connects to Composable Commerce to determine if items are eligible for return. Eligibility is based on factors such as activity since the original purchase, elapsed time, and other criteria.
- Sends and retrieves data about a consolidated exchange Cart when the value of the returned item is more than the value of the replacement item.
- Analyzes the distribution of tenders used in the original purchase and calculates their respective percentages for a refund.
- Reviews administrative parameters to understand the your business policies for refunds.
- For refunds where the original payment used:
- Cash: queries the user to determine if the cash drawer has sufficient funds; if not, issues a voucher.
- Credit or debit card: checks with the payment provider if the original card can accept refunds.
- Gift card or voucher: issues a voucher with the refund amount.
- Instructs the user on the amount of cash to refund, if applicable.
- Sends tender types and totals information to the receipt builder.
- Sends return information to the original Order record in Composable Commerce.
- Retrieves, formats, displays, and prints refund receipt information.
The actions that a user can perform depend on their given role and the parameters settings that you define in the InStore Center.
GitHub location
The source code for the InStore_Refund module is available on GitHub.
Because this is an InStore core module, the code available on GitHub is a wrapper only.
Administration parameters
You can modify the behavior of this module by setting the following administration parameters in the InStore Center:
Refund parameters
Cash_Refund_ThresholdGift_Receipt_Refund_OptionsMax_Gift_Receipted_Cash_RefundMax_Unreceipted_Cash_RefundReceipted_Refund_OptionsUnreceipted_Refund_Options
Store Front parameters
Automatic_Logout_After_Financial_TransactionConsolidate_Exchange_Cart
User interface
This module affects the Refund screen on the InStore colleague app UI.