Reference lists

Reference lists define the options employees see when providing a reason for various actions.

A reference list is the set of options that employees select in the Reason fields that are displayed for certain actions. For example, an employee who performs a cash transfer completes the Reason field to indicate why the transfer was necessary. Most triggering actions involve an open cash drawer or accepting a lower line-item price.

Default and custom reference list entries

We provide a default reference list for each supported action.

If you choose to use a default list that we provide upon deployment, then your setup will inherit any future updates that we make to that list. If a list entry is able to inherit our changes, a (DEFAULT) suffix is displayed after it in the InStore Center.

You can choose instead to customize a list by adding, editing, or deleting a list entry. In that case, your updates will be preserved whenever we update our list. You cannot revert to the default reference list after you make customizations. To get updates, your administrator would adopt updates into your reference list manually based on information in our release notes. If a list entry requires manual maintenance, a (CUSTOM) suffix is displayed after it in the InStore Center.

Customize a reference list

  1. On the Reference Lists page, click the row for an action to view its reference list entry and other settings.

  2. On the pane, click Edit to change the text. Take care to translate the change for all locales that you support.

  3. Click Add List Entry to create a new list entry for an action. On the Enter New List Entry page, complete the following information:

    • Entry code: provide a unique code that will identify this list entry across locales, even if the text changes.
    • [Locale]: provide the text that you want the location employees to see when they view this list entry. Repeat this step for each locale that you support.
  4. Click Create.

  5. In the Default Behavior field, you can make changes if appropriate:

    • Use Selected Default: the application presents the list entry that is specified in the Default Selection field. It is used if the employee does not change the value.
    • Default to First in List: the application presents the first list entry as the default. It is used if the employee does not change the value.
    • No Default--Require Selection: the application requires the employee to choose a list entry before proceeding with the action.
  6. In the Default Selection field, select the list entry that is the most common for this action.

  7. Click Save Changes.

Delete a reference list entry

You can delete any list entry that you do not want location employees to use. Before deleting an entry, change the Default Selection field if it specifies the entry. If you delete an entry after the location is live on InStore, old references to it will remain in history but the list entry itself will not be available for employees to select.

List of reference list entries

CodeDescription
AMOUNTOFFLINEITEMAllows the user to explain the reason for discounting a line item.
CASHCOUNTAllows the user to explain the reason for a cash count.
CASHTRANSFERAllows the user to explain the reason for transferring funds from a safe or cash drawer.
CHANGEPRICELINEITEMAllows the user to explain the reason for changing the price of a line item.
LOCATIONTYPEAllows retailer administrator to define new types of stores.
MODIFYTRANSFERAllows the user to explain the reason for a changed amount after a CASHTRANSFER was specified.
PAYINAllows the user to explain the reason for a cash-in action.
PAYOUTAllows the user to explain the reason for a cash-out action.
PERCENTOFFLINEITEMAllows the user to explain the reason for discounting a line item.
REJECTTRANSFERAllows the user to explain the reason for not moving funds after a CASHTRANSFER was specified.
RETURNREASONAllows the user to explain why the customer is returning an item.
SAFEDEPOSITAllows the user to explain the reason for a transfer to the safe.
SUSPENDREASONAllows the user to explain the reason for placing an in-progress cart into suspension. The prompt is displayed only if your organization uses the controlled feature Suspend and Resume.