Xef

Prerequisites

Please read this section first. (Do you want to use our API?)

To be able to use the external api you need a Revo XEF test account and an Access Token and your Integrator Token

1. Login into the desired account
2. Go to account management
3. Create a new token
4. To get your integration token, contact us

Basic usage

The main URL for the external api is

https://revoxef.works/api/external/v2/

And you should provide the mandatory headers for the authentication

The API has a data size límit of 2MB for each request.

The API has a limit of 120 requests every minute so the best practice is to cache for x time the fetched information done with the getXXX actions.

Contact us to get your client-token

Payment Methods

GET PaymentMethods

GET https://revoxef.works/api/external/v2/paymentMethods

Response is an array of payment methods with the following fields:

"id": 1,
"name": "Payment method name",
"active": true,

Rooms

GET Rooms

GET https://revoxef.works/api/external/v2/rooms

Response is paginated for every 20 rooms

    "id": 1,
    "name": "Room 1",
    "order": "0",
    "active": "1",

You can add ?withTables parameter. This way apart from rooms another array will be loaded called tables, it will contain a tables array within each room.

"tables": [
    {
        "id": 1,
        "name": "Table 1",
        "x": "0",
        "y": "0",
        "width": "100",
        "height": "100",
        "baseX": "0",
        "baseY": "0",
        "isJoined": "0",
        "baseWidth": "100",
        "baseHeight": "100",
        "color": "#dddddd",
        "type_id": "2",
        "room_id": "1",
        "price_id": null,
    }
]

GiftCards

POST GiftCards

GET https://revoxef.works/api/external/v2/giftCards

Response

{
    "balance": 1.25,
    "uuid": "123456"
    "campaign_id": "3"
}

Responses

Use Gift Card

Response

{
    "balance": 1.25,
    "customer_id": "3"
}

POST GiftCards/{uuid}

Customers

GET Customers

GET https://revoxef.works/api/external/v2/customers
GET https://revoxef.works/api/external/v2/customers/<customer_id>
POST https://revoxef.works/api/external/v2/customers
    Data must be sent as an array.
    Create a customer:          [{"name": "Customer 1", "active": 1}]
        "name" is required
    Update a customer:          [{"id": 2, "name": "Customer 1 updated", "active": 0}]
        "id" and "name" are required
    Create multiple customers:  [
            {"name": "Customer 1", "active": 1},
            {"name": "Customer 2", "active": 1}
        ]
DELETE https://revoxef.works/api/external/v2/customers/<customer_id>

Response is a groups paginated array with the following fields:

    'id',
    'name',
    'active',
    'tax_id',
    'photo',
    'super_group_id',
    'printer_id',
    'printer_group_id',

Others

Get images

To get the image, you need to do a get request the ideal thing for the images is to store it in your server and only request the image if the path changed.

Normal size:

https://storage.googleapis.com/revo-cloud-bucket/xef/{account}/images/{image_path}

Thumbnail size:

https://storage.googleapis.com/revo-cloud-bucket/xef/{account}/images/resized_100_{image_path}

The image_path is the photo name (with the extension). You can get the photos in the catalog.

Sync Resources

POST https://revoxef.works/api/external/chains/sync

With this endpoint, you will be able to sync some resources from the master account to each child account.

The 'tenant' must be from the master account.

The resources that will be synced, are the next ones:

• Tax
• Unit
• MenuSuperGroup
• ModifierCategory
• Modifier
• ModifierGroup
• ModifierPivot
• MenuGroup
• MenuCategory
• MenuItem
• LinkedItemPivot
• MenuItemInventory
• MenuMenuCategory
• MenuMenuPivot
• SellingFormat
• Combination
• CombinationGroup
• CombinationPivot
• ItemSellingFormatPivot

More info about Master Accounts.

Xef Catalog

Inside catalog there are many resources; items, categories, groups, modifiers and sellingFormats.

To explore those resources as a paginated list we can use a GET request with the following pattern:

• GET https://revoxef.works/api/external/v2/catalog/{resource} replacing the desired resource on this url.

The API has a data size límit of 2MB for each request.

The API has a limit of 120 requests every minute so the best practice is to cache for x time the fetched information done with the getXXX actions.

Prerequisistes

To be able to use the external api you need a revo xef account and a access token

1. Login into the desired account
2. Go to account management
3. Create a new token

Basic usage

The main URL for the external API:

https://revoxef.works/api/external/v2/catalog

The URL for the integrations API environment:

https://integrations.revoxef.works/api/external/v2/catalog

And you should provide the mandatory headers for the authentication

URL parameters

You can add the next URL parameters for the paginated responses:

At the bottom of the request, it is specified information about the current page and pagination.

Catalog structure

The main catalog structure is the following:

Groups => Categories => Items

Items cannot exist without Categories, and Categories cannot exists without Groups.

Groups

Can list, show, create, update and delete Groups

GET https://revoxef.works/api/external/v2/catalog/groups

Response is a groups paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/groups/<group_id>

POST https://revoxef.works/api/external/v2/catalog/groups

Create a group (POST) catalog/groups

All parameters are optional.

{
    "name": "Group 1",
    "active": 1
    ...
}

Update a group (POST) catalog/groups

{
    "id": 2, // required to update
    "name": "Group 1 updated",
    "active": 0
    ...
}

Create/update multiple groups (POST) catalog/groups

{
    "groups": [
        {
            "id": 1, // only required to update
            "name": "Group 1",
            ...
        },
        {
            "id": 2, // only required to update
            "name": "Group 2",
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/groups/<group_id>

Categories

Can list, show, create, update and delete Categories

GET https://revoxef.works/api/external/v2/catalog/categories or

GET https://revoxef.works/api/external/v2/catalog/groups/<group_id>/categories

Response for GET categories is a categories paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/categories/<category_id>

POST https://revoxef.works/api/external/v2/catalog/categories

Create a category (POST) catalog/categories

{
    "name": "Category 1",
    "active": 1,
    "group_id": 1
    ...
}

Update a category (POST) catalog/categories

{
    "id": 1, // required to update
    "name": "Category 1 updated",
    "active": 0
    ...
}

Create/update multiple categories (POST) catalog/categories

{
    "categories": [
        {
            "id": 1, // only required to update
            "name": "Category 1",
            ...
        },
        {
            "id": 2, // only required to update
            "name": "Category 2",
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/categories/<category_id>

Items

For the Items, there are the following types:

• Normal Items: item.type = 0
• Menu Items: item.type = 1
• Selling format Items: item.type = 4

Can list, show, create, update and delete Items

GET https://revoxef.works/api/external/v2/catalog/items or

GET https://revoxef.works/api/external/v2/catalog/categories/<category_id>/items

Response for GET items is an items paginated array with the following fields:

Allergies

There are the following allergies:

To save (POST) the allergies, you must send the values split by ';' Example: "2;3;6;10"

GET https://revoxef.works/api/external/v2/catalog/items/<item_id>

POST https://revoxef.works/api/external/v2/catalog/items

Create a item (POST) catalog/items

{
    "name": "Product 1",
    "price": 8.50,
    "active": 1,
    "category_id": 1
    ...
}

Update a item (POST) catalog/items

{
    "id": 1, // required to update
    "name": "Category 1 updated",
    "active": 0
    ...
}

Create/update multiple items (POST) catalog/items

{
    "items": [
        {
            "id": 1, // only required to update
            "name": "Item 1",
            ...
        },
        {
            "id": 2, // only required to update
            "name": "Item 2",
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/items/<item_id>

Selling Formats

Can list, show, create, update and delete Selling Formats

GET https://revoxef.works/api/external/v2/catalog/sellingFormats

Response for GET selling formats is a selling formats paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/sellingFormats/<format_id>

POST https://revoxef.works/api/external/v2/catalog/sellingFormats

Create a selling format (POST) catalog/sellingFormats

{
    "name": "Selling format 1",
    "active": 1
    ...
}

Update a selling format (POST) catalog/sellingFormats

{
    "id": 1, // required to update
    "name": "Selling format 1 updated",
    "active": 0
    ...
}

Create/update multiple selling formats (POST) catalog/sellingFormats

{
    "sellingFormats": [
        {
            "id": 1, // only required to update
            "name": "Selling format 1",
            ...
        },
        {
            "id": 2, // only required to update
            "name": "Selling format 2",
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/sellingFormats/<format_id>

Selling Format Pivots

An Item can be of Selling format type.

This can be distinguished by item.type = 4.

The Selling format item can manage different Selling formats, with different prices and quantities, for its TPV selling.

Can list, show, create, update and delete Selling Format Pivots

GET https://revoxef.works/api/external/v2/catalog/sellingFormatPivots

Response for GET selling format pivots is a selling format pivots paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/sellingFormatPivots/<format_pivot_id>

POST https://revoxef.works/api/external/v2/catalog/sellingFormatPivots

Create a selling format pivot (POST) catalog/sellingFormatPivots

{
    "price": 5.00,
    "quantity": 1,
    "format_id": 1,
    "item_id": 1,
    ...
}

Update a selling format pivot (POST) catalog/sellingFormatPivots

{
    "id": 1, // required to update
    "quantity": 2
    ...
}

Create/update multiple selling format pivots (POST) catalog/sellingFormatPivots

{
    "sellingFormatPivots": [
        {
            "id": 1, // only required to update
            "quantity": 1,
            "format_id": 1,
            "item_id": 1,
            ...
        },
        {
            "id": 2, // only required to update
            "quantity": 2,
            "format_id": 2,
            "item_id": 2,
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/sellingFormatPivots/<format_pivot_id>

Modifiers

The Modifiers structure is the following:

Modifier groups (<= Modifier pivot =>) Modifier categories => Modifiers.

Modifiers must exist in a Modifier category, and Modifier categories can exist independently or in a Modifier group.

Both Modifier groups and Modifier categories can be linked to catalog Categories and Items.

Can list, show, create, update and delete Modifiers

GET https://revoxef.works/api/external/v2/catalog/modifiers

Response for GET modifiers is a modifiers paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/modifiers/<modifier_id>

POST https://revoxef.works/api/external/v2/catalog/modifiers

Create a modifier (POST) catalog/modifiers

{
    "name": "Modifier 1",
    "price": 1.00,
    "category_id": 1,
    "active": 1
    ...
}

Update a modifier (POST) catalog/modifiers

{
    "id": 1, // required to update
    "price": 2.00
    ...
}

Create/update multiple modifiers (POST) catalog/modifiers

{
    "modifiers": [
        {
            "id": 1, // only required to update
            "name": "Modifier 1",
            ...
        },
        {
            "id": 2, // only required to update
            "name": "Modifier 2",
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/modifiers/<modifier_id>

Modifier Categories

Can list, show, create, update and delete Modifier Categories

GET https://revoxef.works/api/external/v2/catalog/modifierCategories

Response for GET modifier categories is a modifier categories paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/modifierCategories/<modifier_category_id>

POST https://revoxef.works/api/external/v2/catalog/modifierCategories

Create a modifier category (POST) catalog/modifierCategories

{
    "name": "Modifier category 1"
    ...
}

Update a modifier category (POST) catalog/modifierCategories

{
    "id": 1, // required to update
    "isChoice": 0
    ...
}

Create/update multiple modifier categories (POST) catalog/modifierCategories

{
    "modifierCategories": [
        {
            "id": 1, // only required to update
            "name": "Modifier category 1",
            ...
        },
        {
            "id": 2, // only required to update
            "name": "Modifier category 2",
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/modifierCategories/<modifier_category_id>

Modifier Groups

Can list, show, create, update and delete Modifier Groups

GET https://revoxef.works/api/external/v2/catalog/modifierGroups

Response for GET modifier groups is a modifier groups paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/modifierGroups/<modifier_group_id>

POST https://revoxef.works/api/external/v2/catalog/modifierGroups

Create a modifier group (POST) catalog/modifierGroups

{
    "name": "Modifier group 1"
    ...
}

Update a modifier group (POST) catalog/modifierGroups

{
    "id": 1, // required to update
    "name": "Modifier group updated 1"
    ...
}

Create/update multiple modifier groups (POST) catalog/modifierGroups

{
    "modifierGroups": [
        {
            "id": 1, // only required to update
            "name": "Modifier group 1",
            ...
        },
        {
            "id": 2, // only required to update
            "name": "Modifier group 2",
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/modifierGroups/<modifier_group_id>

Modifier Pivot

The next pivot endpoints define the (optional) relationship between Modifier Categories and Modifier Groups.

Can list, show, create, update and delete Modifier Pivots

GET https://revoxef.works/api/external/v2/catalog/modifierPivots

Response for GET modifier pivots is a modifier pivots paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/modifierPivots/<modifier_pivot_id>

POST https://revoxef.works/api/external/v2/catalog/modifierPivots

Create a modifier pivot (POST) catalog/modifierPivots

{
    "group_id": 1,
    "category_id": 1
    ...
}

Update a modifier pivot (POST) catalog/modifierPivots

{
    "id": 1, // required to update
    "group_id": 2
    ...
}

Create/update multiple modifier pivots (POST) catalog/modifierPivots

{
    "modifierPivots": [
        {
            "id": 1, // only required to update
            "category_id": 1,
            ...
        },
        {
            "id": 2, // only required to update
            "category_id": 1,
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/modifierPivots/<modifier_pivot_id>

Menu Categories

An Item can be of Menu type.

This can be distinguished by item.type = 1.

Each Menu Item can contain different Menu Categories and each Menu Category can have multiple Normal Items (item.type = 0):

Menu Item => Menu Categories => Normal Items

Can list, show, create, update and delete Menu Categories

GET https://revoxef.works/api/external/v2/catalog/menuMenuCategories

Response for GET menu categories is a menu categories paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/menuMenuCategories/<menu_category_id>

POST https://revoxef.works/api/external/v2/catalog/menuMenuCategories

Create a menu category (POST) catalog/menuMenuCategories

{
    "name": "First dishes",
    "item_id": 1
    "isMultipleChoice": 2,
    ...
}

Update a menu category (POST) catalog/menuMenuCategories

{
    "id": 1, // required to update
    "isMultipleChoice": 2
    ...
}

Create/update multiple menu menu categories (POST) catalog/menuMenuCategories

{
    "menuMenuCategories": [
        {
            "id": 1, // only required to update
            "name": "Menu category 1",
            "item_id": 1,
            ...
        },
        {
            "id": 2, // only required to update
            "name": "Menu category 2",
            "item_id": 2,
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/menuMenuCategories/<menu_category_id>

Menu Item-Category Pivot

This endpoint links the Normal Items, from the menu, with their Menu Category.

Can list, show, create, update and delete Menu Item-Category Pivot

GET https://revoxef.works/api/external/v2/catalog/menuMenuItemCategoryPivots

Response for GET menu item-category pivots is a menu item-category pivots paginated array with the following fields:

GET https://revoxef.works/api/external/v2/catalog/menuMenuItemCategoryPivots/<menu_item_category_pivot_id>

POST https://revoxef.works/api/external/v2/catalog/menuMenuItemCategoryPivots

Create a menu item-category pivot (POST) catalog/menuMenuItemCategoryPivots

{
    "item_id": 1,
    "category_id": 1
    ...
}

Update a menu item-category pivot (POST) catalog/menuMenuItemCategoryPivots

{
    "id": 1, // required to update
    "price": 1.00
    ...
}

Create/update multiple menu item-category pivots (POST) catalog/menuMenuItemCategoryPivots

{
    "menuMenuItemCategoryPivots": [
        {
            "id": 1, // only required to update
            "item_id": 1,
            "category_id": 1
            ...
        },
        {
            "id": 2, // only required to update
            "item_id": 2,
            "category_id": 1
            ...
        }
        ...
    ]
}

DELETE https://revoxef.works/api/external/v2/catalog/menuMenuItemCategoryPivots/<menu_item_category_pivot_id>

Warehouses

GET Warehouses https://revoxef.works/api/external/v2/warehouses

Response is a warehouses paginated array with the following fields:

    'id',
    'name',
    'order',

GET Warehouses stocks https://revoxef.works/api/external/v2/warehouses/<warehouse_id>

Response for a warehouse is a stocks paginated array with the following fields:

    'id',
    'quantity',
    'defaultQuantity',
    'alert',
    'warehouse_id',
    'item_id',
    'unit_id'

POST https://revoxef.works/api/external/v2/warehouses/<warehouse_id>/addStock

Add a stock to a warehouse (POST) warehouses/<warehouse_id>/addStock

{"item_id": <item_id>, "quantity": <quantity_to_add>}

POST https://revoxef.works/api/external/v2/warehouses/<warehouse_id>/setStock

Set a item stock to a warehouse (POST) warehouses/<warehouse_id>/setStock

{"item_id": <item_id>, "quantity": <quantity_to_set>}

Set multiple stocks to a warehouse (POST) warehouses/<warehouse_id>/setStock

{"stocks": [
    {"item_id": <item_id>, "quantity": <quantity_to_set>},
    {"item_id": <item_id>, "quantity": <quantity_to_set>},
]}

Purchases

GET Purchase orders https://revoxef.works/api/external/v2/purchaseOrders

Response is a purchase orders paginated array with the following fields:

    'id',
    'vendor_order_id',
    'reference',
    'subtotal',
    'tax',
    'total',
    'status',
    'vendor_id',
    'vendorName',
    'contentsArray'

GET Purchase order contents https://revoxef.works/api/external/v2/purchaseOrders/{purchase_order_id}

Response is a purchase order contents paginated array with the following fields:

    'id',
    'status',
    'quantity',
    'received',
    'price',
    'subtotal',
    'tax',
    'total',
    'order_id',
    'item_vendor_id',
    'itemName',
    'itemBarcode',
    'item_id'

Vendors

GET https://revoxef.works/api/external/v2/vendors

GET ...vendors

{
    "current_page": 1,
    "data": [
        {
            "id": 1,
            "name": "RevoVendor",
            "address": "Address",
            "city": "City",
            "state": "State",
            "country": "Country",
            "postalCode": "00000",
            "nif": "000000000B",
            "web": null,
            "email": null,
            "phone": "111222333",
            "notes": null,
            "shouldBeNotified": 0
        },
        ...

GET https://revoxef.works/api/external/v2/vendors/{vendor_id}

GET ...vendors/{vendor_id}

{
    "id": 1,
    "name": "RevoVendor",
    "address": "Address",
    "city": "City",
    "state": "State",
    "country": "Country",
    "postalCode": "00000",
    "nif": "000000000B",
    "web": null,
    "email": null,
    "phone": "111222333",
    "notes": null,
    "shouldBeNotified": 0
}

POST https://revoxef.works/api/external/v2/vendors

POST ...vendors

{
    "name": "RevoVendor", // required
    "address": "Address", // required
    "city": "City",
    "state": "State",
    "country": "Country",
    "postalCode": "00000",
    "nif": "000000000B", // required | unique
    "web": null,
    "email": null,
    "phone": "111222333",
    "notes": null,
    "shouldBeNotified": 0
}

PUT https://revoxef.works/api/external/v2/vendors/{vendor_id}

PUT ...vendors/{vendor_id}

{
    "name": "RevoVendor",
    "address": "Address",
    "city": "City",
    "state": "State",
    "country": "Country",
    "postalCode": "00000",
    "nif": "000000000B", // unique
    "web": null,
    "email": null,
    "phone": "111222333",
    "notes": null,
    "shouldBeNotified": 0
}

DELETE https://revoxef.works/api/external/v2/vendors/{vendor_id}

Vendor Items

GET https://revoxef.works/api/external/v2/vendors/{vendor_id}/items

GET ...items

{
    "current_page": 1,
    "data": [
        {
            "item_id": 1,
            "reference": "",
            "costPrice": "1.00",
            "unit_id": 1,
            "pack": 1,
            "tax_id": null
        },
        ...

POST https://revoxef.works/api/external/v2/vendors/{vendor_id}/items

POST ...items

With this endpoint you can create or update, if the vendor.item_id already exists.

{
    "items": [
        {
            "item_id": 1, // required
            "costPrice": "1.00",  // required
            "pack": 2,  // required
            "tax_id": 2,
            "unit_id": 1
        },
        {
            "item_id": 2, // required
            "costPrice": "2.00",  // required
            "pack": 2,  // required
            "reference": "Reference"
        }
    ]
}

DELETE https://revoxef.works/api/external/v2/vendors/{vendor_id}/items

DELETE ...items

All items_id must exist to delete their relation to vendor.

{ 
    "items": [ item1_id, item3_id, item10_id ]
}

Xef Booking (Flow API)

Prerequisistes

To be able to use the Flow api you need a revo xef account and a access token

1. Login into the desired account
2. Go to account management
3. Create a new token

Basic usage

The main URL for the external api is

https://revoxef.works/apiFlow

Creating an order with customer

POST

shell script POST message={ "auth":{ "tenant":"account", "token":"account_token" }, "action":"newOrder", "data":{ "customer":{ "name":"customer name", "email":"email2@example.com", "notes":"{\"note1\":\"text1\",\"note2\":\"text2\"...} }, "table_id":[ 1, 2, 3 ], "guests":"8", "contents":[ ], "payments":[ ] } }

Response with the created order identifier

shell script { "result" : true, "errorMessage" : null, "data" : { "id" : 1 } }

Xef Loyalty

Basic usage

The main URL for the external API:

https://revoxef.works/api/loyalty

The API has a data size límit of 2MB for each request.

The API has a limit of 120 requests every minute so the best practice is to cache for x time the fetched information done with the getXXX actions.

The URL for the integrations API environment:

https://integrations.revoxef.works/api/loyalty

And you should provide the mandatory headers for the authentication

Create an order

POST https://revoxef.works/api/loyalty/orders

The payload to create the order, must be sent as a JSON.

The parameters for the payload, are the following:

General payload example:

{
    "order": {
        ...
    },
    "customer": {
        ...
    },
    "delivery": {
        ...
    }
}

Response:

{
    "order_id": 1
}

Order payload

Most of the parameters are recalculated when the order is processed in the POS.

Order payload example:

{
    "order": {
        "total": 10.50,
        "table_id": 1,
        "tableName": "TableName",
        "guests": 1,
        "notes": "Notes",
        "extraId": "Ext-1",
        "orderDiscount": {
            ...
        },
        "contents": [
            {
                ...
            },
            ...
        ],
        "payment": {
            ...
        },
    }
    ...
}

Order discount payload

Order discount payload example:

{
    "order": {
        "total": 8.00, // discount subtracted
        ...
        "orderDiscount": {
            "name": "Discount",
            "amount": -2.50
        },
        ...
    }
    ...
}

Contents payload

Content payload example:

{
    "order": {
        "total": 13.00
        ...
        "contents": {
            "item_id": 1,
            "itemPrice": 6.50,
            "quantity": 2,
            "modifiers" or "menuContents": [
                {
                    ...
                },
                ...
            ],
        }
        ...
    }
    ...
}

Modifiers payload

Only for normal and selling format items.

For normal items (item.type = 0):

There is no quantity and each modifier must be sent idividually.

Modifier (normal item) payload example:

{
    "order": {
        "total": 17.80
        ...
        "contents": {
            "itemPrice": 6.50,
            "quantity": 2,
            ...
            "modifiers": [
                {
                    "id": 1, // modifier ID exists ("name": "Nuts")
                    "price": 1.20
                },
                {
                    "name": "Nuts",
                    "price": 1.20
                },
                ...
            ]
        }
        ...
    }
    ...
}

For selling format items (item.type = 4):

Normal modifiers cannot be set.

Modifier (selling format item) payload example:

{
    "order": {
        ...
        "contents": {
            ...
            "modifiers": [ // only 1 modifier to set the selling format
                {
                    "id": 1,
                }
            ]
        }
        ...
    }
    ...
}

MenuContents payload

Only for menu items (item.type = 1):

MenuContents (menu item) payload example:

{
    "order": {
        "total": 25.70
        ...
        "contents": {
            "item_id": 12, // menu item
            "itemPrice": 10.00,
            ...
            "menuContents": [
                {
                    "item_id": 1, // normal item
                    "price": 6.50,
                    "quantity": 1,
                    "modifiers": [
                        {
                            "name": "Nuts",
                            "price": 1.20
                        },
                        ...
                    ]
                },
                {
                    "item_id": 2, // selling format item
                    "itemPrice": 7,
                    "quantity": 1,
                    "modifiers": [
                        {
                            "id",
                            "price": 1.00
                        }
                    ]
                }
                ...
            ]
        }
        ...
    }
    ...
}

Payment payload

Regarding the payment methods, there are 2 fix payment methods for all accounts:

• Card => "payment_method_id": 1

• Cash => "payment_method_id": 2

Payment payload example:

{
    "order": {
        "total": 12.20,
        ...
        "payment": {
            "amount": 12.20
            "payment_method_id": 1,
            "payment_reference": "QR code payment.",
            ...
        }
    }
    ...
}

Customer payload

If a customer is found with the email or phone from this section, respectively, we will get the existing customer, and the other fields will not be updated.

If the customer is not found, we will create one with all the fields sent.

The customer info and the delivery info are not the same. Customer object is the customer itself, the customer data linked to the invoice. The delivery object is a complement data only linked to the delivery order. It is up to you if you want to match customer and delivery fields, in case of non existing customer.

We recommend to manage customers using the specific endpoints. Check the customer section

Customer payload example:

{
    "order": {
        ...
    },
    "customer": {
        "name": "Customer Name",
        "email": "customer@revo.test"
    }
    ...
}

Delivery payload

The delivery info and the customer info are not the same.

The delivery data is the info for the delivery/pickup order. This info will not be saved in the customer data.

Delivery payload example:

{
    "order": {
        ...
    },
    "delivery": {
        "phone": 123456789,
        "date": "2009-05-02 21:45:00",
        ...
    }
    ...
}

Standalone payment

If you only want to make a payment for an existing order, you must use the following endpoint:

POST orders/{orderId}/payments

The payload structure is the same as the payment done in the order creation, but sent as a form-data body request. See again the details.

Standalone payload example:

# Must be sent as a form-data body request.
"payment": {
    "amount": 12.20
    "payment_method_id": 1,
    "payment_reference": "QR code payment.",
    "contents": [1,2,3]
    ...
}

Fetch an Order

GET orders/{orderId}

You can fetch an order information using this endpoint

Fetch an Order with Table Id

If you want to fetch an order for an specific table you can use this endpoint.

GET tables/{tableId}/order

It will return a 404 if there is no open order at that table at the moment

Fetch multiple Order with list of tables id

If you want to fetch an order for an specific table you can use this endpoint. It will return the open orders paginated by 50.

GET orders?table_id[]=5&table_id[]=6&table_id[]=7

You can send the array using the body as well instead of the query

It will return a 404 if there is no open order at that table at the moment

Cancel Order

curl -XDELETE -H 'tenant: {tenant}' -H 'Authorization: Bearer {token}' \
-d 'reason="Payment Failed"' \
'https://revoxef.works/api/loyalty/orders/123456'

This endpoint makes a refund (a new order with negatives values).

There is a limit time to cancel the order. If the account has configured the Previous delivery minutes, the limit to cancel the order will be the Delivery date subtract the Delivery minutes. Otherwise, you will have 5 minutes after an order has been place.

DELETE orders/{orderId}

Fetch Invoice details

You can use this endpoint to fetch an specific invoice details

GET invoices/{invoiceId}

Fetch tables

Get all the tables with is name and id

GET tables

Tables availability

{
    "available" : true
}

Use this method to know if a table is available or not (there is no open order on it)

GET tables/{tableId}/available

Xef Loyalty WebView

Introduction

Since Revo Xef 4.1 we include a new integration that lets you manipulate the current order through a webview and a powerful Javascript Api.

You can enable it by adding the integration called RevoLoyalty WebView and providing your URL. When this integration is enabled in the edit order screen, there will appear a new action that will open your site and inject the RevoLoyaltyJs framework for you to be able to interact with the current order.

This api includes a few methods described below

To be able to interact with iOS all the function will have a callback parameter that will be called when the action is finished in the POS

GET ORDER

Gets all the information of the current order

    RevoLoyalty.getOrder(function(json) {
        var order = JSON.parse(json)
        const total = order["total"]
    })

GET ACCOUNT

Gets the account id and the account name

    RevoLoyalty.getAccount(function(json) {
        var items = JSON.parse(json)
        document.getElementById("text").innerHTML = json
        document.getElementById("orderTotal").innerHTML = "Account id: "+ account["id"]
    })

GET ITEMS

Gets all the information of the items requested by its ids, array of ints. If there is no item with a requested id, it won't be in the response

    RevoLoyalty.getItems([itemId1, itemId2, itemId3], function(json) {
        var items = JSON.parse(json)
        document.getElementById("text").innerHTML = json
        document.getElementById("orderTotal").innerHTML = "Account id: "+ account["id"]
    })

ADD EXISTING DISCOUNT

Adds a discount that exists in the database to the whole order

    RevoLoyalty.addExistingDiscount({id}, function(error) {

    })

Result: Error if the discount does not exist

ADD PERCENTAGE DISCOUNT

Adds a new discount with percentage to the whole order

RevoLoyalty.addPercentageDiscount({name}, {percentage}, function() {

})

ADD AMOUNT DISCOUNT

Adds a new discount with amount to the whole order

RevoLoyalty.addAmountDiscount({name}, {amount}, function() {

})

ADD EXISTING CONTENT DISCOUNT

Adds a discount that exists in the database to the whole order

    RevoLoyalty.addContentExistingDiscount({line}, {id}, function(error) {

    })

Result: Error if the discount does not exist

ADD CONTENT PERCENTAGE DISCOUNT

Adds a new discount with percentage to the whole order

RevoLoyalty.addContentPercentageDiscount({line}, {name}, {percentage}, {withoutExtras}, function() {

})

ADD CONTENT AMOUNT DISCOUNT

Adds a new discount with amount to the whole order

RevoLoyalty.addContentAmountDiscount({line}, {name}, {amount}, {withoutExtras}, function() {

})

ADD PRODUCT

Adds a new content to the order, the product must me of type standard as no popups can be shown

RevoLoyalty.addProduct({id}, {price}, function(error) {

})

Error when the product does not exists or is not standard

ADD Payment

Adds a payment to the order, it will create an invoice there isn't one yet

RevoLoyalty.addPayment({id}, {amount}, function(error) {

})

error when the payment method does not exist

CLOSE

Closes the webview

    RevoLoyalty.close()

Xef Reports

Authentication

curl --header "tenant: {myaccount}" \
     --header "authorization: Bearer {token}" \
     --header 'client-token: {client-token}' \
https://revoxef.works/api/external/v3

Base endpoint

https://revoxef.works/api/external/v3

You should send the headers tenant with your account username and authorization with the token created at account > tokens

The API has a data size límit of 2MB for each request.

The API has a limit of 120 requests every minute so the best practice is to cache for x time the fetched information done with the getXXX actions.

Get your token at https://revoxef.works/account/tokens

Request

curl --header "tenant: {myaccount}" --header "authorization: Bearer {token}" \ --header 'client-token: {client-token}' \
https://revoxef.works/api/external/v3/reports/{reportName}?start_date=2018-01-01&end_date=2018-01-29

GET reports/{reportName}

Response

{
    "current_page": 1,
    "data": {"HERE WILL GO THE SPECIFIC REPORT DATA"},
    "from": 1,
    "last_page": 4,
    "next_page_url": "https://revoxef.works/api/external/v3/reports/{reportName}?page=2",
    "path": "https://revoxef.works/api/external/v3/reports/{reportName}",
    "per_page": 50,
    "prev_page_url": null,
    "to": 50,
    "total": 190
}

All responses will have this header

Available reports

Here is a list of all available reports

• actionLog
• categories
• contentDiscounts
• cookDurations
• customers
• discounts
• groupedInvoices
• hours
• channels
• invoices
• menuProducts
• menus
• openOrders
• orderContents
• orders
• payments
• presences
• products
• rooms
• receipts
• stocks
• stockMovements
• inventoryContents
• taxes
• turns
• tenantUsers
• warehouses
• allProducts
• canceledContents
• canceledOrders

Filters

All filters and flags must be used as a query parameters.

Example:

Using order reports endpoint, if you want PriceRates resource, as it belongs to Contents, you will also need withContents filter.

?withAppliedTaxes
{
    ...
    "RESOURCE": [ // "invoices", "contents", "sub_contents"
        {
            ...
            "applied_taxes": [
                {
                    "id": 1, // register ID
                    "tax_id": 3, // tax ID
                    "tax_name": "IVA 21%",
                    "tax_percentage": 21.00,
                    "base_amount": 0.8264, // up to 4 decimal precision
                    "tax_amount": 0.1736 // up to 4 decimal precision
                }
            ],
            ...
        }
    ]
}

Fields with fullPrecision

This section lists all fields that can have their decimal precision increased by using the "?fullPrecision=true" flag.

Master

In case you have a master account you can create a token for the master account and use it to access all the chain reports as well as get a list of all the accounts within the master account

Get Accounts V3

GET https://revoxef.works/api/external/v3/accounts

Using the optional query parameter ?withBusiness=true in the endpoint, we can retrieve information about the business account.

V3 accounts endpoint
{
    "data": [
        {
            "id": 1,
            "tenant": "accountname",
            "business": { // only with withBusiness flag
                "name": "Name",
                "legal_name": "Legal Name",
                "slogan": "Sloga",
                "phone": "123456789",
                "address": "Address",
                "city": "City",
                "state": "State",
                "country": "Country",
                "postal_code": "01234",
                "nif": "B123456789",
                "logo": "abcdefg123.png",
                "web": "https://www.revo.works",
                "tax_included": true, // bool
                "opening_time": "05:00:00",
                "cash_control_type": "SIMPLE", // "NONE", "SIMPLE", "FULL" or "AUTO"
                "blind_cashier": false, // bool
                "presence_control": true, // bool
                "currency": "EUR",
                "second_currency": "USD",
                "exchange_rate": 0,  // 4 decimal precision
                "currency2_cash_payment_method_id": 8,
                "currency2_card_payment_method_id": 9,
                "comma_decimal": true, // bool
                "languages": [ // "ca", "en", "es", "eu", "fr", "pt", "it", "zh", "de"
                    "ca"
                ]
            }
        },
        ...
    ]
}

Get Accounts V2 (old)

GET https://revoxef.works/api/external/v2/accounts

V2 endpoint (old)
{
    "IDTenant": "Tenant/AccountName"
}

Chain reports

GET https://revoxef.works/api/external/v2/accounts/reports/{reportName}

And you have to add a new header that defines the chain to connect to

Chain fetch order

GET https://revoxef.works/api/external/v2/accounts/orders/{id}

You can fetch one (or multiple orders) for an specific chain using the same header as in the previous example.

The id field can be a single order id or multiple orders separated by , such as id1,id2,id3

Xef Webhooks

Introduction

Revo Xef offers webhooks, allowing you to add as many as needed on the webhooks page:

• Production URL: https://revoxef.works/account/webhooks
• Test URL: https://integrations.revoxef.works/account/webhooks

When you create your first webhook, a secret key will be generated. This key is used to create a hash that we include in every webhook call, allowing you to verify that the request comes from us.

When creating a new webhook you will have the following options

Webhook Request

We include the following headers in the request:

• X-Revo-Hmac-SHA256: This header contains the body hashed using the SHA256 algorithm, with the secret key generated during the creation of your first webhook.
• content-type:application/x-www-form-urlencoded

The payload will always include the following keys:

{
    "tenant": "tenant",
    "event" : "event.name",
    "data" : {
        ...
    }
}

Available Webhooks

There is a {model}.* event, which signifies that you want to receive all available events associated with the model.

Product Webhooks

Customer webhooks

Purchase Order Webhooks

Stocks Webhooks

Order Webhooks

Gift Card Webhooks

KDS Webhooks

Order Payment Webhooks

Turn Webhooks

Webhooks Retries

Each time a webhook is triggered, several retry attempts are made until one of them receives a successful HTTP client response from the URL.

These retries are made consecutively every:

• Initial attempt
• After 10 seconds
• After 30 seconds
• After 1 minute
• After 2 minutes
• After 5 minutes

If none of these attempts are successful, we increment the "Retry count".

Once the "Retry count" reaches 5, we deactivate the event for security reasons.

Xef (Deprecated)

Although this api is still working, it has been deprecated in favor of the new REST one See Xef Catalog section one instead

Basic Request

    {
        "auth":{
            "tenant"  :"account",
            "password":"password"
        },
        "action":"action",
        "data":data
    }

To work with Revo external api a POST or GET request is required to the following url:

https://revoxef.works/apiExternal

With a variable named message that has to be a json with the following information

The API has a limit of 120 requests every minute so the best practice is to cache for x time the fetched information done with the getXXX actions.

Get (Deprecated)

Returns the full data for an specific model and id.

"data":{
        "model":"model",
        "id":"id"
        }

https://revoxef.works/apiExternal?message=
    {
        "auth"      : {"tenant":"account","password":"password"},
        "action"    : "get",
        "data"      : {"model":"MenuItem","id":"236"}
    }

getMenuGroups (Deprecated)

https://revoxef.works/apiExternal?message=
    {
        "auth":{"tenant":"account","password":"password"},
        "action":"getMenuGroups",
        "data":{}
    }

Since maybe we want to create an online shop that starts with menu groups, we can get them all using the action getMenuGroups with empty data. This will return a list of all the groups (with their ID). With this Id we can fetch the categories.

getChildren (Deprecated)

"data":{
    "model":"parentModel",
    "id":id
    }

This action returns all the children for an specific model

https://revoxef.works/apiExternal?message=
    {
        "auth":{"tenant":"account","password":"password"},
        "action":"getChilds",
        "data":{"model":"MenuGroup","id":2}
    }

It will return all the childs of the menuGroup with ID 2.

getInventory (Deprecated)

 https://revoxef.works/apiExternal?message=
     {
         "auth":{"tenant":"account","password":"password"},
         "action":"getInventory",
         "data":{"warehouse_id":1,"items":[2,4,10]}
     }

Gets the current inventory for an Item in a Warehouse.

decreaseInventory (Deprecated)

Decreases the inventory for an Item in a Warehouse.

 https://revoxef.works/apiExternal?message=
     {
         "auth":{"tenant":"account","password":"password"},
         "action":"decreaseInventory",
         "data":{"warehouse_id":1,"item_id":2, "quantity":1}
     }

Revo Display Images (Deprecated)

Returns an array of paths for each Revo Display ads image.

To get the image

https://a89f683ae563759322a9-3330e0d085d4ba4fd7f5395ee3f3cd7a.ssl.cf3.rackcdn.com/{account}/banners/{image_path}

Orders (Deprecated)

GET Orders

GET https://revoxef.works/api/external/v2/orders?from=2017-01-02&to=2017-01-04

Response is paginated for every 50

    "id": 4,
    "opened": "2017-12-15 08:40:52",
    "closed": "2017-01-03 00:00:00",
    "merged": null,
    "canceled": null,
    "guests": "4",
    "status": "0",
    "orderDiscountAmount": "0",
    "sum": "0",
    "discountAmount": "0",
    "subtotal": "0",
    "taxAmount": "0",
    "total": "14.5",
    "alreadyPaid": "0.0",
    "tenantUser_id": null,
    "tenantUserName": null,
    "discount": null,
    "table_id": null,
    "tableName": null,
    "margin": null,
    "delivery_id": null,
    "orderInvoices": [],
    "delivery": null,
    "orderContents": [
        {
            "id": 1,
            "order_id": "4",
            "item_id": "1",
            "dishOrder": "0",
            "seat": "0",
            "quantity": "2",
            "weight": "0",
            "itemName": "Oran Cartwright",
            "itemPrice": "17.49",
            "alreadyPaidQuantity": "0",
            "alreadyPrintedQuantity": "0",
            "modifiers": null,
            "discount": null,
            "taxPercentage": "0",
            "discountAmount": "79.84",
            "taxAmount": "85.91",
            "total": "98.98",
            "extrasAmount": "12.96",
            "subtotal": "74.96",
            "priceWithExtrasIndividual": "66.52",
            "notes": null,
            "price_id": null,
            "optional_modifiers": null,
            "format_pivot_id": null,
            "margin": null,
            "menuMenuContents": [],
        }
       ],
      } 

You can add ?withPayments parameter. This way apart from orderContents another array will be loaded called orderInvoices, it will contain an array of invoices and each invoice will contain an array of orderPayments.

"orderContents": [{…}, {…}, …],
"orderInvoices": [
    {
        "orderPayments": [
            {
                "payAmount": 10,
                "paymentMethod": 1,
                …
            }, {…}, …
        ], …
    }, {…}, …
]

You can add ?withRooms parameter. This way apart from orderContents another array will be loaded called table which will contain a room.

"orderContents": [{…}, {…}, …],
"table": {
    "id"        : <table_id>,
    "name"      : <tableName>,
    "room_id"   : <room_id>,
    "room"      : {
        "id"    : <room_id>,
        "name"  : <roomName>
    },
}