Revo Support

With Revo XEF, you can import CSV files separated by ";". The first row must contain the header with the field names exactly as described below.

To access the product import screen, go to the import tool in the back-office.

1. IMPORT GROUPS
2. IMPORT CATEGORIES
3. IMPORT PRODUCTS
4. UPDATE PRODUCTS
5. CONTAINERS
6. CONTAINER ITEMS
7. SELLING FORMATS
8. ADD INVENTORY
9. SET/DO INVENTORY
10. MOVE INVENTORY
11. IMPORT VENDORS
12. VENDOR ITEMS
13. IMPORT CUSTOMERS
14. GIFT CARDS
15. RELOAD GIFT CARDS
16. PRICE RATES
17. EMPLOYEES
18. UPDATE EMPLOYEES

1. IMPORT GROUPS

To create or update groups in bulk, go to the back-office under Catalog -> GROUPS and click the Import button.

THE NEW IMPORTER

With the new importer, your CSV file columns do not need specific names. When you upload the file, the system will allow you to Map the fields, linking each column of your file with the corresponding field in REVO.

Available fields to map:

FIELD	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
Id	Optional	Group identifier in the system.	Only filled for updates.
Active	Optional	Defines whether the group is active or not.	0 (Inactive), 1 (Active).
Name	Mandatory	The main name of the group.	Free text.
Translations	Critical	Translations for multi-language.	Essential: Map with the name column. Otherwise, it will be created with the generic name "New Item".
Tax	Optional	The tax associated with the group.	Enter the internal numerical ID of the tax.
Analytical group	Optional	The corresponding analytical group.	Enter the numerical ID.
Printer	Optional	The assigned order printer.	Enter the numerical ID.
Printer group	Optional	The assigned printer group.	Enter the numerical ID.
State flow	Optional	The kitchen state flow (KDS).	Enter the numerical ID.
Extra ID	Optional	Additional field for integration identifiers.	Free alphanumeric text.

CSV Example - Import Groups

Nombre	Traduccion	ID	Activo	Impuesto	Grupo_Analitico	Impresora	Grp_Impresoras	Flujo_Estados	Extra_ID
Drinks	Drinks		1	1	3	2	0	1	EXT-001
Food	Food		1	2	4	4	2	1	EXT-002
Desserts	Desserts	15	1	2	5	4	0	2	EXT-003

2. IMPORT CATEGORIES

To bulk import categories into a specific group, go to the back-office under Catalog -> GROUPS, enter the group where you want to add the categories, and click the Import button.

THE NEW IMPORTER

The functionality is identical to that of groups, allowing you to upload any CSV and manually map the columns.

Available fields to map:

FIELD	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
Id	Optional	Internal identifier of the category.	Only filled for updates.
Active	Optional	Defines whether the category is active or not.	0 (Inactive), 1 (Active).
Name	Mandatory	The name of the category.	Free text.
Group	Mandatory	The group to which the category belongs.	Enter the numerical ID or the exact name of the parent group.
Translations	Critical	Translations for multi-language.	Essential: Map with the name column. Otherwise, it will be created with the generic name "New Item".
Tax	Optional	The tax associated with the category.	Enter the numerical ID.
Analytical group	Optional	The corresponding analytical group.	Enter the numerical ID.
Printer	Optional	The assigned order printer.	Enter the numerical ID.
Printer group	Optional	The assigned printer group.	Enter the numerical ID.
State flow	Optional	The kitchen state flow.	Enter the numerical ID.
Extra ID	Optional	Additional field for external integrations.	Free alphanumeric text.

CSV Example - Import Categories

Nombre	Grupo	Traduccion	ID	Activo	Impuesto	Grupo_Analitico	Impresora	Grp_Impresoras	Flujo_Estados	Extra_ID
Soft Drinks	Drinks	Soft Drinks		1	1	6	2	0	1	EXT-010
Beers	Drinks	Beers		1	1	6	3	0	1	EXT-011
Tapas	Food	Tapas	32	1	2	7	5	2	2	EXT-012

3. IMPORT PRODUCTS

Option to import products and configure them via CSV file.

With Revo XEF, you can import CSV files separated by ";". The first row must contain the header with the field names exactly as described below.

IMPORTANT: The field names in the header must be exactly as written here. No capital letters at the beginning, no spaces, no ":" symbol.
Correct: category_id
Incorrect: Category_id / CATEGORY_ID / category id

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
category_id	Mandatory	Category ID. Before importing, manually create the structure to obtain this ID.	Enter numerical ID.
name	Mandatory	Product name.	Free text (minimum 3 characters).
price	Optional	Retail price.	Use a dot for decimals. Example: 10.20
costPrice	Optional	Internal cost price.	Use a dot for decimals. Example: 8.20
type	Optional	Defines the operational nature of the product.	0: Product, 1: Menu, 2: Container, 3: Add-on, 4: Format, 5: Gift card, 6: Management only, 7: Kit.
active	Optional	Visibility state in POS.	0 (Inactive), 1 (Active). If omitted, all are activated.
hasInventory	Optional	Unit and stock control.	0 (No control), 1 (With control).
displayInventory	Optional	Shows remaining units in the app.	0 (Does not show), 1 (Shows stock).
usesWeight	Optional	Links with scale.	0 (Does not use weight), 1 (Uses weight).
allergies	Optional	Allergies associated with the product.	Enter the numerical IDs separated by a semicolon (e.g., 1;5;14). ALLERGEN IDs: 1: Eggs 2: Sesame 3: Lupins 4: Mustard 5: Fish 6: Celery 7: Crustaceans 8: Peanuts 9: Molluscs 10: Soy 11: Tree nuts 12: Sulphites 13: Dairy 14: Gluten
isMenu	Optional	Defines if it acts as a menu grouper.	0 (Not menu), 1 (Menu type product).
shouldAppearInMenuList	Optional	If selectable within other menus.	0 (Not activated), 1 (Activated).
isOpen	Optional	Requires entering a price manually when selling.	0 (Fixed price), 1 (Open product).
order	Optional	Display order within the category.	Use numbers: 1, 2, 3, etc.
barcode	Optional	Product barcode.	Numerical value or EAN.
tax_id	Optional	Default product tax.	Numerical ID.
printer_id	Optional	Default direct printer of the product.	Numerical ID.
printer_group_id	Optional	Default direct printer group.	Numerical ID.
modifier_group_id	Optional	Specific modifier group for the product.	Numerical ID.
modifier_category_id	Optional	Modifier category assigned to the product.	Numerical ID.
photo	Optional	Product image.	File name and extension.
info	Optional	Extended description of the product.	Free text.
buttonName	Optional	Alternative short name.	To show on the app's button panel.
nameKitchen	Optional	Different name for prep tickets.	Free text.
dish_order_id	Optional	Dish firing order.	Numerical ID.
unit_id	Optional	Sales unit ID.	Numerical ID.
extra_id	Optional	External code or Nielsen if applicable.	Alphanumeric text.
useAverageCostPrice	Optional	Averaged cost calculation.	0 (Not active), 1 (Activated).
cookDuration	Optional	Estimated prep time.	Value in seconds (For KDS).
minQuantity	Optional	Minimum quantity when adding product.	Numerical value.
extra_attributes	Optional	Special attributes.	Numerical ID.

IMPORTANT: It's important to note that configuring the printer or modifiers directly on products can cause future issues. If configured per product, you will have to change/remove them one by one. If configured in the category or group, it can be modified with a few clicks.

CSV Example - Import Products

category_id	name	price	costPrice	type	active	hasInventory	allergies	isMenu	shouldAppearInMenuList	order	barcode	tax_id	photo	info	buttonName	nameKitchen	unit_id	extra_id	useAverageCostPrice	cookDuration	minQuantity
10	Black Coffee	1.30	0.20	0	1	1		0	0	1	84123456	1	coffee.jpg	Arabica	Coffee B	BLACK COFFEE	2	EX-001	0	120	1
15	Cola	1.80	0.50	0	1	1		0	0	2	84123457	1	cola.jpg	Soft Drink	Cola	COLA	2	EX-002	1	0	1
25	Daily Menu	12.50	4.00	1	1	0	1;5;14	1	1	3		2	menu.jpg	Complete	Daily M	DAILY MENU	1	EX-003	0	0	1

4. UPDATE PRODUCTS

Option to update or add information to existing products using a CSV file.

Since the ID is mandatory, it is recommended to start from the REVO products list previously exported.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
id	Mandatory	Unique product identifier in the database.	Internal REVO numerical ID.
(Any field)	Optional	Any of the fields seen in the previous section.	The columns you include will be bulk updated.

CSV Example - Update Products

id	category_id	name	price	costPrice	type	active	hasInventory	displayInventory	usesWeight	allergies	isMenu	shouldAppearInMenuList	isOpen	order	barcode	tax_id	printer_id	printer_group_id	modifier_group_id	modifier_category_id	photo	info	buttonName	nameKitchen	dish_order_id	unit_id	extra_id	useAverageCostPrice	cookDuration	minQuantity	extra_attributes
100	10	Intense Black Coffee	1.40	0.22	0	1	1	0	0		0	0	0	1	84123456	1					coffee_new.jpg	New	Intense	INTENSE COFFEE	0	2	EX-001	0	120	1	0
101	15	Cola Zero	1.90	0.55	0	1	1	0	0		0	0	0	2	84123457	1					colaz.jpg	Zero	Cola Z	COLA ZERO	0	2	EX-002	1	0	1	0

5. CONTAINERS

Containers are folders where you can group products. They act as a "fourth level" after Groups, Categories, and Products.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
category_id	Mandatory	ID of the category where the folder will reside.	Numerical ID.
name	Mandatory	Visual name of the container/folder.	Free text.
photo	Optional	Cover photo filename.	File and image name.

CSV Example - Containers

category_id	name	photo
10	COFFEES	coffees_folder.jpg
15	WATERS	waters_folder.jpg
17	RED WINES	wines_folder.jpg

6. CONTAINER ITEMS

Associate products to an existing container.

You can get the IDs by hovering over the pencil icon in the back-office.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
main_item_id	Mandatory	ID of the parent container (folder).	Numerical ID.
item_id	Mandatory	ID of the products you are going to put inside.	Numerical ID.
order	Optional	Display order within the container.	Numerical value.
dish_order_id	Optional	Default dish order applied in this folder.	Numerical ID.
active	Optional	Product state within the folder view.	0 (Inactive), 1 (Active).

CSV Example - Container Items

main_item_id	item_id	order	active
15	140	1	1
15	141	2	1
15	142	3	1

7. SELLING FORMATS

Import products with selling formats (mixed, neat, shot, etc.).

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
item_id	Mandatory	Base product ID.	Numerical ID.
format_id	Mandatory	Configured selling format ID.	Numerical ID.
price	Mandatory	Selling price for this format.	Use dot for decimals.
quantity	Mandatory	Exact quantity to deduct from general stock.	Use decimals depending on unit.
unit_id	Mandatory	Stock measurement unit ID.	Numerical ID.
order	Mandatory	Display order in the dropdown.	Numerical value.
combination_group_id	Mandatory	Forced combination group ID (if applicable).	Enter 0 if not applicable.

CSV Example - Selling Formats

item_id	format_id	price	quantity	unit_id	order	combination_group_id
196	3	12.00	1.00	7	1	2
196	4	11.00	1.00	7	2	0
196	5	3.00	0.20	7	3	0

8. ADD INVENTORY

Add stock to your products, especially useful the first time.

If you have several warehouses, repeat the product ID with different warehouse_id.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
item_id	Mandatory	ID of the products to supply.	Numerical ID.
quantity	Mandatory	Quantity you want to ADD to the stock.	Positive numerical value.
warehouse_id	Mandatory	ID of the warehouse where stock enters.	Numerical ID.

CSV Example - Add Inventory

item_id	quantity	warehouse_id
100	150	1
102	150	1
100	500	2

9. SET/DO INVENTORY

Set the exact stock of your products. Ideal after an inventory count.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
item_id	Mandatory	Products ID.	Numerical ID.
quantity	Mandatory	Exact physical quantity to set.	Numerical value that will overwrite the previous one.
warehouse_id	Mandatory	Warehouse ID.	Numerical ID.
defaultQuantity	Optional	Reference / ideal stock quantity.	Numerical value.
alert	Optional	Minimum stock to receive an order alert.	Numerical value.

CSV Example - Set Inventory

item_id	quantity	warehouse_id	defaultQuantity	alert
100	100	1	200	10
110	232	1	400	20

10. MOVE INVENTORY

Transfer stock between warehouses.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
item_id	Mandatory	ID of the products to transfer.	Numerical ID.
quantity	Mandatory	Exact quantity to move.	Numerical value.
warehouse_id	Mandatory	Source warehouse ID.	Warehouse that subtracts (Numerical ID).
to_warehouse_id	Mandatory	Destination warehouse ID.	Warehouse that adds (Numerical ID).

CSV Example - Move Inventory

item_id	quantity	warehouse_id	to_warehouse_id
100	100	1	2
102	100	1	2

11. IMPORT VENDORS

Bulk import vendors to use the purchasing module.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
name	Mandatory	Vendor name.	Free text (minimum 3 characters).
address	Mandatory	Main billing/delivery address.	Free text.
nif	Mandatory	Tax identification number.	CIF, DNI, etc.
city	Optional	City or locality.	Free text.
state	Optional	Province or State.	Free text.
country	Optional	Vendor's headquarter country.	Free text.
postalCode	Optional	Postal code.	Alphanumeric.
web	Optional	Corporate website.	URL format.
email	Optional	Email for orders.	Valid email.
phone	Optional	Contact phone.	Numerical.
notes	Optional	Internal notes and remarks.	Free text.
shouldBeNotified	Optional	Notify the vendor upon status changes.	1 (Notify), 0 (Do not notify).

CSV Example - Import Vendors

name	address	nif	city	state	country	postalCode	web	email	phone	notes	shouldBeNotified
Vendor 1	High Street, 30	A58818501	London	London	UK	W1D	www.ven1.co.uk	orders@ven1.co.uk	02012345678	Food	1
Vendor 2	Abbey Road, 22	B54416504	London	London	UK	NW8	www.ven2.com	info@ven2.co.uk	02087654321	Soft Drinks	0

12. VENDOR ITEMS

Associate products to your vendors to use the purchasing module.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
vendor_id	Mandatory	Vendor ID created in the system.	Numerical ID.
item_id	Mandatory	Product ID in REVO that they supply.	Numerical ID.
reference	Optional	Product reference code in the vendor's catalog.	Alphanumeric.
pack	Optional	Units contained in each purchase pack/box.	Numerical value.
costPrice	Optional	Agreed cost price.	Use dot for decimals.
unit_id	Optional	Purchasing measurement unit ID.	Numerical ID.
tax_id	Optional	Input tax ID for purchasing.	Numerical ID.

CSV Example - Vendor Items

vendor_id	item_id	reference	pack	costPrice	unit_id	tax_id
1	100	REF-01	24	0.25	1	2
1	102	REF-02	24	0.30	1	2

13. IMPORT CUSTOMERS

Bulk import customers.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
name	Mandatory	Customer name or corporate name.	Free text (minimum 3 characters).
address_country	Mandatory	Country.	ISO 3166-1 alpha-2 code (example: UK).
address_street_address	Conditional	Street address.	Mandatory if a Tax ID is entered.
address_postal_code	Conditional	Postal code.	Mandatory if a Tax ID is entered.
address_city	Conditional	City or locality.	Mandatory if a Tax ID is entered.
address_state	Conditional	Province or State.	Mandatory if a Tax ID is entered.
nif	Optional	Tax ID or identification number.	If entered, the address becomes mandatory.
active	Optional	Customer state.	0 (Inactive), 1 (Active).
email	Optional	Email address.	Valid email format.
phone	Optional	Contact phone.	Numerical.
language	Optional	Preferred language for communications.	ISO code (en, es, fr...).
nationality	Optional	Nationality.	Free text.
birth_date	Optional	Customer's date of birth.	Strict format: YYYY-MM-DD.
gender	Optional	Gender.	Male, Female or Other.
allergies	Optional	Allergies the customer suffers from.	IDs separated by semicolon (e.g., 1;5;14).
web	Optional	Company website.	URL.
notes	Optional	Notes or customer preferences.	Free text.
extra_id	Optional	Assignment to a Customer Group.	Numerical ID.
address_notes	Optional	Home delivery notes.	Free text.

CSV Example - Import Customers

name	address_country	address_street_address	address_postal_code	address_city	address_state	nif	active	email	phone	language	nationality	birth_date	gender	allergies	web	notes	extra_id	address_notes
Hugo Reyes	UK	High St, 30	W1D	London	London	A58818501	1	hugo@mail.com	0700123456	en	British	1980-05-15	Male	14	www.hugo.co.uk	Special dish	1	Leave at reception
Maggie Greene	UK	Abbey Rd, 11	NW8	London	London	V51218667	1	maggie@mail.com	0700654321	en	British	1992-10-22	Female			Table with views	2	Ring the bell

14. GIFT CARDS

Bulk import gift cards into the back-office.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
uuid	Mandatory	Unique identification code of the card.	Can be text and numbers.
total	Mandatory	Generated initial balance.	Must be numerical.
active	Optional	Defines whether the card is already operational.	0 (Inactive), 1 (Active).
balance	Optional	Actual remaining balance.	Fill in only if different from the total.
campaign_id	Optional	Associated promotional campaign.	Numerical ID of the campaign.
customer_id	Optional	Nominally associated customer.	Numerical ID of the customer.

CSV Example - Gift Cards

uuid	total	active	balance	campaign_id	customer_id
00000123456	100.00	1	100.00	1
TR1234567	50.00	1	25.00	1
Peter Smith	75.00	1	75.00	2	405

15. RELOAD GIFT CARDS

Import reloads into gift cards.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
uuid	Mandatory	Exact code of the existing gift card.	Alphanumeric.
reloadAmount	Mandatory	Balance to inject into the current balance.	Numerical using a decimal dot.

CSV Example - Reload Cards

uuid	reloadAmount
00000123456	100.00
00000789100	100.00

16. PRICE RATES

To import rates, go to: https://revoxef.works/thrust/prices/import

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
priceable_id	Mandatory	ID of the base element to which the rate is associated.	Numerical ID.
table_price_id	Mandatory	ID of the rate created in Configuration.	Numerical ID.
price	Mandatory	Stipulated price for the combination of both.	Price with dot for decimals.
priceable_type	Mandatory	Base element type.	Use exactly the value from the table below.

Values for priceable_type:

TYPE	VALUE TO BE WRITTEN IN THE COLUMN
Products	App\Models\Menu\MenuItem
Menu products	App\Models\Menu\MenuMenuPivot
Modifiers	App\Models\Menu\Modifier
Selling format	App\Models\Menu\ItemSellingFormatPivot
Combinations	App\Models\Menu\Combination

CSV Example - Rates

priceable_id	table_price_id	price	priceable_type
902	2	4.00	App\Models\Menu\MenuItem
870	2	3.00	App\Models\Menu\MenuMenuPivot
331	2	1.50	App\Models\Menu\Modifier

17. EMPLOYEES

Bulk import employees.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
name	Mandatory	Employee name.	Free text.
pin	Mandatory	Access PIN for the iPad POS.	Numerical value.
permission_id	Mandatory	App security privilege.	Numerical ID.
active	Optional	Employee state in staff.	0 (Inactive), 1 (Active).
surname	Optional	Surname.	Free text.
username	Optional	Web back-office access username.	Short text without spaces.
password	Optional	Secret password for the back-office.	Alphanumeric.
email	Optional	Email address.	Valid email.
phone	Optional	Contact phone.	Numerical.
notes	Optional	Internal notes.	Free text.
profile_id	Optional	Default employee profile.	Numerical ID.
photo	Optional	Visual avatar.	File name and extension.
cashier_id	Optional	Default assigned cashier.	Numerical ID.
identifier	Optional	POS security key identifier.	Hexadecimal value (NFC, QR...).
back_permission_id	Optional	Back-office privilege level.	Numerical ID.
nif	Optional	Employee ID (Tax Number).	Alphanumeric.

CSV Example - Employees

name	pin	permission_id	active	surname	username	password	email	phone	notes	profile_id	photo	cashier_id	identifier	back_permission_id	nif
Fran	1111	1	1	Smith	Fran	pass123	fran@mail.com	0700111222	Manager	2	fran.jpg	0	1A2B3C	2	12345678A
Lucy	2222	2	1	Kailey	Lucy	pass456	lucy@mail.com	0700333444	Waitress	1	lucy.jpg	0	4D5E6F	1	87654321B

18. UPDATE EMPLOYEES

Updates existing employees' information. Starts from the exported employees list in CSV.

EXACT HEADER	REQUIREMENT	DESCRIPTION	ADDITIONAL INFORMATION
id	Mandatory	Unique internal employee identifier.	Numerical ID generated by REVO.
(Any field)	Optional	Any of the fields from the previous section.	The columns you attach will be bulk updated.

CSV Example - Update Employees

id	name	pin	permission_id	active	surname	username	password	email	phone	notes	profile_id	photo	cashier_id	identifier	back_permission_id	nif
2	Mary	1122	1	1	Jones	mary	maRy24!	mary@mail.com	0700999888		2	mary.jpg	0	7G8H9I	1	11111111C
3	Peter	3344	2	0	Davis	peter	pEter24!	peter@mail.com	0700777666	Leave	1	peter.jpg	0	0J1K2L	3	22222222D

Import XEF

1. IMPORT GROUPS

THE NEW IMPORTER

2. IMPORT CATEGORIES

THE NEW IMPORTER

3. IMPORT PRODUCTS

4. UPDATE PRODUCTS

5. CONTAINERS

6. CONTAINER ITEMS

7. SELLING FORMATS

8. ADD INVENTORY

9. SET/DO INVENTORY

10. MOVE INVENTORY

11. IMPORT VENDORS

12. VENDOR ITEMS

13. IMPORT CUSTOMERS

14. GIFT CARDS

15. RELOAD GIFT CARDS

16. PRICE RATES

17. EMPLOYEES

18. UPDATE EMPLOYEES

Contact

Support