Documentation

Store roles

Store roles determine the level of access an InStore colleague app user has to particular functionality.

At least one role for InStore colleague app users must be created in the InStore Center before:

  • an environment can be activated.
  • any user can log in to the InStore colleague app.

Each role is made up of permissions that determine the access to InStore colleague app functionality. Roles assigned to InStore colleague app users are read by the InStore API when determining whether a user can access a feature.

The roles you create are shared across all locations in an environment. You can create as many roles as needed for your locations.

Add or edit a store role

  1. In the InStore Center, select the Store Roles menu option to view the list of roles that have been created for this environment.
  2. Click the Edit icon to view or change details about a listed role, or click Add Store Role.
  3. On the Role Information pane, complete the following information:
    • Role Name: provide a unique name for this role. Use alphanumeric characters only. Do not include spaces, symbols, or non-English characters. For example, StoreManager or SalesAssociate.
    • Role Description: provide guidance that store managers can use when they assign this role to users, such as Has full permissions in the store or Can perform sales and refunds only.
  4. On the Permissions pane, you have the following columns:
    • Category: shows the feature set that the permission belongs to.
    • Function: shows the capability of each permission.

      Before selecting a permission for a role, read the descriptions carefully.

    • Permission: Select the permissions that you want to assign to this role. Click to toggle each permission to False or True. When a permission is set to True, a user who has been assigned this role can perform the action. Users with this role can access the application only if the role has at least one permission. To set up a new location, a user must have at least the DeviceManagement permission.

      Any changes to a role's permissions apply to all users currently assigned to it.

  5. Click Save Changes in the top pane.

  6. Remember to inform the developer who maintains the application that InStore now supports this role. It must be added to the retailer's integration server and API.

Delete a store role

If you delete a role that has users assigned to it, those users will lose access to all application features until they are assigned a new role. InStore does not check user assignments when deleting roles.

To delete a store role, follow these steps:

  1. Go to the Store Roles menu to view all roles.
  2. Click the Delete icon for the role you want to remove, and then confirm the deletion.

Store role permissions

The following permissions are available for store roles:

Cash management permissions

PermissionDescription
BankDepositTransfer cash from the store safe to the bank.
CashAuditReview cash positions and history for cash drawers.
CashCountCount and reset the cash balance for a cash drawer.
CashInReceive inbound cash.
CashOutPay out cash from the cash drawer.
SafeDepositTransfer cash from a drawer to the store safe.
TransferOutInitiate a cash transfer from one drawer to another.
TransferInComplete a cash transfer from one drawer to another.

Device management permissions

PermissionDescription
DeviceManagementCreate, edit, activate, and deactivate store devices.

General permissions

PermissionDescription
ReprintReprint receipts.

Payment permissions

PermissionDescription
PaymentTake payment for sales and order transactions.

Refund permissions

PermissionDescription
RefundProcess a return refund balance.

StoreFront permissions

PermissionDescription
AddCouponEnter a coupon code to apply to a cart.
DeleteLineItemOnPaymentDelete a line item from a cart during sales, order, or similar transactions.
DeleteLineItemOnRefundDelete a line item from a cart during refund, return, or similar transactions.
LineItemDiscountPercentApply a percent-off discount to a payment line item in the cart.
LineItemDiscountAmountApply an amount-off discount to a payment line item in the cart.
LineItemPriceChangeApply a reduced flat price to a payment line item in the cart.
OrderItemsAdd an item to the cart as an order rather than a take-with sale. The InStore colleague app displays the Add to Order option in the cart scan field, the customer's Wishlists tab, and the catalog detail view. It's visible when the user has the necessary permissions, and the relevant parameters are enabled.
ReceiptedReturnsSelect line items to return from a retrieved receipted transaction. The InStore colleague app displays the Add to Return option in Transaction Search results and on the customer's Orders tab. It's visible when the user has the necessary permissions, and the relevant parameters are enabled.
RemoveCartRemove the current cart and attached customer to prepare for the next customer's cart. The InStore colleague app displays the Remove Cart option in the cart header menu. It's visible when the user has the necessary permissions, and the relevant parameters are enabled.
ResumeCartRetrieve a cart that was suspended in this store for further processing.
Save_Cart_As_WishlistSave sale and order items in the cart as a wishlist to an attached customer account.
SaveItemToWishlistSave a sale or order item quantity to a new or existing wishlist on an attached customer account.
SellItemAdd an item to the cart for a sale or take-with transaction. The InStore colleague app displays the Add to Sale option in the cart scan field, the customer's Wishlists tab, and the catalog detail view. It's visible when the user has the necessary permissions, and the relevant parameters are enabled.
SuspendCartSet aside an in-progress cart for further processing in this store later, possibly at another workstation or by another user.
UnreceiptedReturnsAdd an item to the cart for an unreceipted return. The InStore colleague app displays the Add to Return option in the cart scan field and the catalog detail view. It's visible when the user has the necessary permissions, and the relevant parameters are enabled.