Reference lists provide the set of options that employees select from the Reason fields for various actions in the InStore colleague app.
Reference lists define the available reasons employees can select when performing certain actions, such as cash transfers, price changes, or returns. For example, when an employee completes a cash transfer, they must select a reason from the list to indicate why the transfer was necessary. Most actions that require a reason involve opening a cash drawer or accepting a lower line-item price.
Default and custom reference lists
Each supported action includes a default reference list. If you use the default list provided at deployment, your setup will automatically inherit future commercetools updates to that list. Entries that inherit commercetools updates display a
(DEFAULT) suffix in the InStore Center.If you customize a reference list by adding, editing, or deleting entries, your changes are preserved and will not be overwritten by future updates. After customizing, you cannot revert to the default list. To receive updates, an administrator must manually adopt changes from release notes. Entries that require manual maintenance display a
(CUSTOM) suffix in the InStore Center.Manage reference lists
View and edit a reference list
- On the Reference Lists page, select the row for an action to view its reference list and settings.
- Click Edit to update the text. Ensure you translate changes for all supported locales.
- To add a new entry, click Add List Entry. On the Enter New List Entry page, provide the following:
- Entry code: a unique code that identifies the entry across locales, even if the text changes.
- [Locale]: the text employees see for this entry. Repeat for each supported locale.
- Click Create.
- In the Default Behavior field, select one of the following:
- Use Selected Default: the application uses the entry specified in Default Selection if the employee does not change the value.
- Default to First in List: the application uses the first entry as the default if the employee does not change the value.
- No Default—Require Selection: the application requires the employee to select a reason before proceeding.
- In the Default Selection field, choose the most common entry for this action.
- Click Save Changes.
Delete a reference list entry
You can delete any entry that should not be available to employees. Before deleting, update the Default Selection field if it references the entry. If you delete an entry after a location is live, historical references remain, but the entry is no longer selectable.
Reference list entry codes
| Code | Description |
|---|---|
| AMOUNTOFFLINEITEM | Reason for discounting a line item. |
| CASHCOUNT | Reason for performing a cash count. |
| CASHTRANSFER | Reason for transferring funds from a safe or cash drawer. |
| CHANGEPRICELINEITEM | Reason for changing the price of a line item. |
| LOCATIONTYPE | Allows administrators to define new types of stores. |
| MODIFYTRANSFER | Reason for changing the amount after a cash transfer was specified. |
| PAYIN | Reason for a cash-in action. |
| PAYOUT | Reason for a cash-out action. |
| PERCENTOFFLINEITEM | Reason for discounting a line item. |
| REJECTTRANSFER | Reason for not moving funds after a cash transfer was specified. |
| RETURNREASON | Reason for a customer return. |
| SAFEDEPOSIT | Reason for transferring funds to the safe. |
| SUSPENDREASON | Reason for suspending an in-progress cart. Displayed only if Suspend and Resume is enabled. |