Before you begin, read the Areas and stores reference guide, which explains the structure, roles, and visibility rules.This guide focuses only on configuration.
- Creating and managing areas and stores.
- Assigning Restricted users and API keys to specific areas, stores, and all stores.
- Assigning campaigns to specific areas, stores, and all stores.
Create and manage areas and stores
Only an Admin can create, edit, or delete areas and stores. You can create up to 100 areas per project and 100 stores per area.Create an area
Go to Home > Project Settings > Areas & Stores.1
Add area
Click Add area.
2
Name the area
Enter the area name.
3
Save
Click Save.
Create a store
Open the Areas and stores tab and select an existing area.1
Add store
Click Add area store.
2
Name the store
Enter the store name.
3
Create
Click Create.
In the area details view, you can:
- Edit the area name
- Add or edit stores
- Delete stores (if they have no campaigns assigned)
- Delete the area (only if it has no stores)
Assign restricted users
Access configuration happens in two stages:- Assign the User restricted role.
- Define the user’s area or store scope.
Assign the Restricted user role
Only the Account owner can assign or remove this role. Go to Team settings > Team.1
Select team member
Choose the team member.
2
Assign role
Assign the User restricted role for the project.
Define area or store access
Only an Admin can define assignments. A Restricted user can have up to 100 assignments. Go to Project settings > General > Project members.1
Edit assignments
Click Edit assignments next to the member with the
USER_RESTRICTED role.2
Set access list
Click Edit access list.
3
Select scope
Select specific areas, stores, or all stores.
4
Save
Click Save.
Create restricted API keys
Only Admins can create API keys with the User Restricted role. These keys follow the same visibility rules as a Restricted user. A Restricted user API key can also have up to 100 assignments. Go to Project settings > General > Application keys.1
Create new key
Click the + button.
2
Select role
Enter a name and select the User restricted role.
3
Define access
Click Edit access list and select areas, stores, or all stores.
Assign campaigns to areas or stores
Campaign assignment controls where a campaign is visible and usable. Admins and Users can assign campaigns. Restricted users must assign new campaigns to their own areas or stores. A campaign can have up to 100 assignments. Open a campaign creation builder and create a new campaign or edit an existing one. Go to the Access settings step.1
Edit access list
Click Edit access list.
2
Select scope
Select the areas or stores where the campaign should be available.
3
Save campaign
Save the campaign.
Manage resources as a Restricted user
Access depends on the role:- Admins and Users can manage all resources in all areas and stores.
- Restricted users can manage resources only within their assigned areas or stores.
Resources managed within assigned areas or stores
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
Resources managed regardless of assignment
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
- Product collections
- Rewards
- Locations
- Categories
- Distributions
A Restricted user can edit or delete a campaign only if their assignments include all of the campaign’s assignments.
Related features
Areas and stores connect to other parts of Voucherify. The features below show how they work together.Developer setup: Management API
Developer setup: Management API
You can manage areas and stores programmatically using the Management API (Enterprise feature). This includes creating, updating, and deleting areas and stores, as well as listing all areas and stores in a project.Area endpoints:
GET /management/v1/projects/{projectId}/areas: List all areasGET /management/v1/projects/{projectId}/areas/{id}: Get area detailsPOST /management/v1/projects/{projectId}/areas: Create an areaPUT /management/v1/projects/{projectId}/areas/{id}: Update an areaDELETE /management/v1/projects/{projectId}/areas/{id}: Delete an area
GET /management/v1/projects/{projectId}/areas/{areaId}/stores: List all stores in an areaGET /management/v1/projects/{projectId}/areas/{areaId}/stores/{storeId}: Get store detailsPOST /management/v1/projects/{projectId}/areas/{areaId}/stores: Create a storePUT /management/v1/projects/{projectId}/areas/{areaId}/stores/{storeId}: Update a storeDELETE /management/v1/projects/{projectId}/areas/{areaId}/stores/{storeId}: Delete a store

