Bessa Display API

v2 28.01.2021

Die Daten für das Bessa Display werden vom Bessa REST API Server zur Verfügung gestellt. Im folgenden Dokument werden die API Calls mit diesem Server beschrieben.

API Zugriff erhält man durch einen Access token api_token , dieser wird von uns erstellt.

Request

curl "https://api.bessa.app/v1/web/pos/notifications/" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Authorization: Token <api_token>'

Response

{
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "created": "2021-01-28T15:39:48.202499Z",
            "updated": "2021-01-28T15:39:48.202515Z",
            "deleted": null,
            "uuid": "bab2fc76-539a-4976-820c-cfa2586cb3fe",
            "message": "Test 1",
            "pickup_code": "2001",
            "picked_up": null,
            "order": 1
        },
        {
            "id": 2,
            "created": "2021-01-28T15:39:48.203213Z",
            "updated": "2021-01-28T15:39:48.203242Z",
            "deleted": null,
            "uuid": "25d49f76-a8a5-407c-86ff-8cbed91589f2",
            "message": "Test 2",
            "pickup_code": "2002",
            "picked_up": null,
            "order": 2
        }
    ]
}

Response Structure

Name	DataType	Nullable	Description

Name	DataType	Nullable	Description
next	string	true	set if the there are more results available
previous	string	true	set if not the first page
results	array of notifications	false	contains the notifications objects or is empty

Notifications Structure

Name	DataType	Nullable	Description

Name	DataType	Nullable	Description
id	integer	false	the id of the notification
message	string	false	a message for the user, can be empty
pickup_code	string	false	the pickup code of the order
picked_up	date	true	`ISO-8601`, the date when the user picked the order up, only set if the location supports that feature, otherwise always `null`.
order	interger	false	the id of the order
created	string	false	`ISO-8601`, the creation date
updated	string	false	`ISO-8601`, the update date
deleted	string	false	`ISO-8601`, set if the notification was marked as deleted
uuid	string	false	an uuid to identify the object

Notes

Das Feld, picked_up wird während erst gesetzt wenn der Kunde seine Bestellung abholt. Ist es gesetzt kann man die Bestellung vom Display nehmen. Das selbe gilt für das deleted Feld. Des weiteren werde Bestellungen die nicht abgeholt werden auch nach einer 20 Minuten ausgeblendet.