Areas and Stores

With the Areas and Stores feature, you can create campaigns targeting specific markets or shops within one project. You can create areas representing your regional structure and stores representing your points of sale. Additionally, you can manage your team and assign permissions to store or area managers. This way, they can run campaigns independently without the risk of affecting campaigns assigned to other areas or stores.

Contents

1. Basic Principles
2. Roles and Permissions
3. Managing Areas and Stores
4. Managing Restricted Users and API Keys
5. Visibility
6. Managing Resources in Areas and Stores
7. Example

Basic Principles

Area

An area can be used to limit and, in this way, make it easier to manage your promotional activities. An area can include stores and you can assign users as well as API keys to manage campaigns by assigning them to the area.

All stores

The All Stores option can be used to further refine your promotional activities within a specific area. All stores include all the stores and you can assign users as well as API keys to manage campaigns by assigning them to All Stores. The users assigned to all stores can also manage campaigns in individual stores. However, the users assigned to all stores within one area can only manage campaigns in that area’s stores, but not the campaigns assigned to the area itself. A campaign assigned to All Stores can be also used within the area’s individual stores, including those that are created later on.

Store

A store further narrows down the possibilities of managing campaigns. You can assign users as well as API keys to a store. However, the users assigned only to one store cannot manage other stores' campaigns within the area. Similarly, campaigns assigned to only one store cannot be used by users assigned to another store.

User

A user is a person who can manage campaigns in a store or a whole area. There are several user roles that can manage areas and stores with different permissions:

• Admin
• User
• Restricted user

You can create specific API keys to a user restricted role, which can be assigned to areas and/or stores. Restricted users can see and manage the campaigns that are assigned to their areas or stores

API Keys

An API key can be assigned to a user restricted role and to areas and stores. This API key ensures that a system can access campaigns only within specific areas and stores, and perform campaign-related actions there, like redeeming a voucher. This way, the API key cannot be used to access the campaigns that are assigned to other areas or stores or perform related activities.

Campaign

A campaign is a standard Voucherify campaign. You can assign all types of campaigns to an area, store, or all stores.

How it is all tied together

You can represent your regions, e-commerce, and particular points of sale where you run promotional activities by creating areas and stores. You can also add your team members and, if necessary, create roles or custom roles with separate API keys. This way, your team members who are, for example, store managers can run individual campaigns assigned to their store without affecting campaigns that other store managers run. Also, you can have area managers who supervise campaigns run throughout the whole area, all area stores, or within individual stores.

All this is possible within one Voucherify project, so you do not have to create multiple projects with the same metadata configuration, validation rules, etc., to recreate your regional structure.

Roles and Permissions

The following roles have different permissions and management options in Areas and Stores. 

Areas and Stores Permissions

The following permissions govern what a role can or cannot do with areas and stores:

• Join areas and stores – the role can be assigned to areas and stores
• Manage areas – the role can create, edit, and delete areas and stores as well as assign team members to them.
• Read areas – the role can assign campaigns to areas and stores.

Use these permissions if you want to create custom roles that will be used to manage areas and stores.

Account Owner

The account owner is not a separate role as such. However, the account owner has an admin role by default.

The Voucherify account owner can manage team members and assign them the restricted user role. The rest of permissions depend on the account owner’s role they have in the project.

Admin

This is a default Voucherify role or any custom role with the following permissions in the context of areas and stores:

• Modify base Project Details,
• Manage areas,
• Read areas
• Campaign permissions

The user with an Admin role can:

• Add a restricted user to an area or a store,

• Create API keys with a restricted user role and assign them to an area or a store,
• Create, edit, and delete areas and stores,

• Create, edit, and delete campaigns and optionally assign them to an area or a store.

User

This is a default Voucherify role or any custom role with the following permissions in the context of areas and stores:

• Read areas
• Campaign permissions

The user with a User role can:

• Create, edit, and delete campaigns and optionally assign them to an area or a store.

Restricted User

This is a default Voucherify role or any custom role with the Join areas and stores permission. In the case of API keys with the User Restricted role, the scope of visibility and activities is the same.

The user with a restricted user role can:

• Create and edit campaigns and assign them to an area, store, or all stores to which the restricted user is assigned, as well as delete campaigns there,
• Be assigned to an area, store, or all stores by an admin,
• See only the campaigns within the assigned areas, stores, or all stores,
• Perform campaign-related activities only within the assigned areas, stores, or all stores, for example:
  • code publication,
  • validation rule assignment,
  • validation,
  • redemption,
  • qualification,
  • rollback.

Role Comparison

Managing Areas, Stores, and Restricted Users

You can create up to 100 areas per project and 100 stores per area.

To create a new area:

1. In the Home section, go to Project Settings.
2. Go to the Areas & Stores tab.
3. Click Add area.
4. Name the area.
5. Click Save.

To add a store:

1. In the Areas & Stores tab, click on an area to display the area details.
2. Click Add area store.
3. Name the store.
4. Click Create.

In the area detail view, you can:

• View the area details, its stores, and assigned users,
• Edit area details – its name,
• Add stores,
• Edit stores – their names,
• Delete stores,
• Delete the area only if it does not have any stores.

Managing Restricted Users and API Keys

To add a new Restricted User:

1. Go to Team Settings.
2. Go to the Team tab.
3. Select the team member you want to edit.
4. Assign the User Restricted role to them in the respective project.

To add or remove a restricted user from an area or store:

1. In the Home section, go to Project Settings.
2. In the General tab, scroll down to the Project Members section.
3. Click Edit assignments next to the project member with a USER_RESTRICTED role.
4. Click Edit access list.
5. Select or deselect areas, stores, and all stores to which the restricted user will be assigned.
6. Click Save.

You can also create API keys with user restricted permissions:

1. In the Home section, go to Project Settings.
2. In the General tab, scroll down to Application Keys.
3. Click the plus button.
4. Enter the channel name and select the User Restricted role.
5. Click Edit access list to assign areas, stores, or all stores.

The users with this Application ID and Secret Key can manage campaigns and perform other activities through the API within the areas and/or stores assigned to this channel. The visibility works the same way as for the restricted user who is a project member.

You can change the assignments by clicking the three-dot menu next to the channel and selecting Edit.

A Restricted User or Restricted User API key can have up to 100 assignments to areas or stores.

Visibility and Activities

Administrators and Users can view and use all the resources in all areas and stores. However, a restricted user has limited access to some of the resources, which is defined by area and store assignments. The resources, like campaigns, whose assignments do not overlap with the restricted user’s assignments, will not be visible to them and they will not be able to perform activities like qualification, validation, or redemption, or even see created redemptions.

Restricted Users can view the following resources only within the area or store to which they are assigned:

• Campaigns
• Vouchers
• Redemptions
• Validations
• Promotion tiers
• Combined promotions

The restricted user and platforms with the restricted user API keys can always perform the following activities on the visible campaigns:

• Qualification
• Validation
• Redemption

The restricted user can see the following resources regardless of the area and store assignments:

• Customers
• Validation Rules
• Orders
• Products
• Rewards
• Locations
• Categories
• Distributions

Managing Resources in Areas and Stores

Administrators and Users can manage all resources in all areas and stores. However, Restricted Users have limited access to some of the resources and, as a result, have limited management possibilities.

Managing Campaigns in Areas and Stores

Voucherify campaigns can be assigned to particular stores or whole areas. To assign a campaign to an area or store:

1. In the campaign editor, go to the Access settings step.
2. Click Edit access list.
3. Select areas and/or stores to which the campaign will be assigned. You can use the search field to find particular areas or stores.
4. If you need to unassign the campaign from an area or store, click the X button next to the name of the area or store.
5. Save the campaign.

A campaign can have up to 100 assignments.

Managing Resources as a Restricted User

Restricted Users can manage, like edit or delete, the following resources or perform actions within the area or store to which they are assigned:

• Campaigns
• Vouchers
• Redemptions
• Validations
• Publications
• Qualifications
• Promotion tiers
• Combined promotions

This means that Restricted Users cannot access and manage campaigns and associated resources, such as vouchers or redemptions, that are not assigned to a Restricted User’s area or store. When a Restricted User creates a new campaign, they must assign it to any of their areas or stores.

The restricted user can edit or delete a campaign only if the restricted user’s assignments include all of the campaign assignments.

Restricted Users can perform activities, like creating, editing, or deleting, on the following resources regardless of the area or store to which they are assigned:

• Customers
• Validation Rules
• Orders
• Products
• Rewards
• Locations
• Categories
• Distributions

You can further limit what Restricted Users can do by creating a custom role with the Join areas and stores permission.

Example

The project has three areas, France, Germany, and Poland. Each area has three stores:

• France area: Lyon, Marseille, and Paris.
• Germany area: Berlin, Hamburg, Munich.
• Poland area: Katowice, Kraków, Warsaw.

The restricted user has the following assignments:

• France area only
• All Stores in Germany, which includes Berlin, Hamburg, Munich, but not the Germany area itself.
• Katowice, Kraków, Warsaw in the Poland area, but neither the Poland area itself nor the all stores option.

There are five campaigns with the following assignments:

• Lyon-Coupons: Lyon
• Hamburg-Munich-Coupons: Hamburg and Munich
• Germany-Area-Coupons: the Germany area only
• France-Area-and-Lyon-Coupons: the France area and Lyon
• Poland-All-Stores-Coupons: all stores in the Poland area, but not the Poland area itself

The restricted user can interact with the campaigns as follows; see also the table summary below:

• Lyon-Coupons: The restricted user cannot see the campaign, because the restricted user is assigned to France only. The assignments between the restricted user and the campaign do not overlap in any way. As a result, the restricted user cannot use qualification, validation, or redemption for the campaign vouchers or promotions.
• Hamburg-Munich-Coupons: The restricted user can see, edit, and delete the campaign, because the restricted user’s assignments include all the assignments of the campaign, which are Hamburg and Munich. The restricted user can also use qualification, validations, and redemptions for that campaign.
• Germany-Area-Coupons: The restricted user cannot see the campaign, because the restricted user is assigned to all stores in Germany, which are Berlin, Hamburg, Munich, but not to the Germany area itself, while the campaign is assigned to Germany and no other store within the area. Again, the assignments between the restricted user and the campaign do not overlap in any way. As a result, the restricted user cannot use qualification, validation, or redemption for the campaign vouchers or promotions.
• France-Area-and-Lyon-Coupons: The restricted user can see the campaign, because the restricted user’s and the campaign assignments partially overlap. As a result, they can also use qualification, validations, and redemptions for that campaign. However, because the assignments overlap only partially – the campaign is assigned to France and Lyon, while the restricted user is assigned to France only – the restricted user cannot edit or delete the campaign.
• Poland-All-Stores-Coupons: The restricted user can see the campaign and use qualification, validation, or redemption for the campaign vouchers or promotions. However, the restricted user cannot edit the campaign, as the assignments do not fully overlap. Even though the restricted user’s assignments include all of the stores that are currently in the Poland area, the campaign is also assigned to all stores in Poland. This means that if a new store, for example Gdynia, is added to the Poland area, the campaign will be automatically assigned to the Gdynia store, but the restricted user will still be assigned to Katowice, Kraków, and Warsaw only.

In the table, “Use” means using qualification, validation, and redemption. The restricted user’s assignments are shown in separate columns.