API docs by Redocly

TapGet API (0.0.1)

Download OpenAPI specification:Download

TapGet API

Orders

Creating and managing orders

Get the orders of the table

Get the orders of the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an order for the table

Create an order for the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "comment": "string",
  • "status": "open",
  • "edited": true,
  • "sum": 0,
  • "orderItems": [
    ],
  • "menuItems": [
    ],
  • "table": null,
  • "createdAt": "string",
  • "updatedAt": "string"
}

Deletes the open order for this table

Deletes the open order for this table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Get order items of a location

Get order items of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

query Parameters
status
string
since
string <date-time>
producerUuid
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an order item of a location

Get an order item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderItemUuid
required
string <uuid>

UUID of the order item

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "menuItemUuid": "string",
  • "quantity": 0,
  • "price": 0,
  • "status": "open",
  • "variations": [
    ],
  • "menuItem": {
    }
}

Update the status of an order item of a location

Update the status of an order item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderItemUuid
required
string <uuid>

UUID of the order item

Request Body schema: application/json
status
required
string (OrderStatus)
Enum: "open" "received" "storno" "confirmed" "refused" "ready" "delivered" "finished"

Responses

Request samples

Content type
application/json
{
  • "status": "open"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "menuItemUuid": "string",
  • "quantity": 0,
  • "price": 0,
  • "status": "open",
  • "variations": [
    ],
  • "menuItem": {
    }
}

Update the external ID of an order item of a locat

Update the external ID of an order item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderItemUuid
required
string <uuid>

UUID of the order item

Request Body schema: application/json
externalId
required
string (UpdateOrderItemExternalDto.externalId)

Responses

Request samples

Content type
application/json
{
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "menuItemUuid": "string",
  • "quantity": 0,
  • "price": 0,
  • "status": "open",
  • "variations": [
    ],
  • "menuItem": {
    }
}

Get orders of a location

Get orders of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

query Parameters
string or Array of strings
since
string <date-time>
producerUuid
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an order of a location

Get an order of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderUuid
required
string <uuid>

UUID of the order

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "comment": "string",
  • "status": "open",
  • "edited": true,
  • "sum": 0,
  • "orderItems": [
    ],
  • "menuItems": [
    ],
  • "table": null,
  • "createdAt": "string",
  • "updatedAt": "string"
}

Sets the status of an order

Sets the status of an order

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderUuid
required
string <uuid>

UUID of the order

Request Body schema: application/json
status
string (OrderStatus)
Enum: "open" "received" "storno" "confirmed" "refused" "ready" "delivered" "finished"

Responses

Request samples

Content type
application/json
{
  • "status": "open"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "comment": "string",
  • "status": "open",
  • "edited": true,
  • "sum": 0,
  • "orderItems": [
    ],
  • "menuItems": [
    ],
  • "table": null,
  • "createdAt": "string",
  • "updatedAt": "string"
}

Sets the external id of an order

Sets the external id of an order

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderUuid
required
string <uuid>

UUID of the order

Request Body schema: application/json
externalId
string (OrderExternalDto.externalId)
externalType
string (OrderExternalDto.externalType)

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "externalType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "comment": "string",
  • "status": "open",
  • "edited": true,
  • "sum": 0,
  • "orderItems": [
    ],
  • "menuItems": [
    ],
  • "table": null,
  • "createdAt": "string",
  • "updatedAt": "string"
}

Variations

Variations of menu items

Returns a variation group

Returns a variation group

path Parameters
locationUuid
required
string <uuid>

UUID of the location

variationGroupUuid
required
string <uuid>

UUID of the variation group

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "locationId": 0,
  • "externalId": "string",
  • "texts": [
    ],
  • "variations": [
    ],
  • "createdAt": "string",
  • "updatedAt": "string"
}

Returns a variation set

Returns a variation set

path Parameters
locationUuid
required
string <uuid>

UUID of the location

variationSetUuid
required
string <uuid>

UUID of the variation set

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "groups": [
    ],
  • "items": [
    ],
  • "rules": [
    ],
  • "externalId": "string"
}

Producers

Producers of a location

Returns a list of producers

Returns a list of producers

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a producer

Returns a producer

path Parameters
locationUuid
required
string <uuid>

UUID of the location

producerUuid
required
string <uuid>

UUID of the producer

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "externalId": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Notifications

Notifications for waiters and guests

Checks if a payment request notification is presen

Checks if a payment request notification is present for the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Create a call waiter notification for the table

Create a call waiter notification for the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Checks if a call waiter notification is present

Checks if a call waiter notification is present

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Create a payment request notification for the tabl

Create a payment request notification for the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Auth

Authentication

Logs a user in and gets a short-lived authenticati

Logs a user in and gets a short-lived authentication token

Request Body schema: application/json
email
string (LoginDto.email)
password
required
string (LoginDto.password)
device
string (LoginDto.device)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "device": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Logs a user in and gets a long-lived authenticatio

Logs a user in and gets a long-lived authentication token

Request Body schema: application/json
email
string (LoginDto.email)
password
required
string (LoginDto.password)
device
string (LoginDto.device)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "device": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Logs the current user out

Logs the current user out

Request Body schema: application/json
device
required
string (LogoutDto.device)

Responses

Request samples

Content type
application/json
{
  • "device": "string"
}

Verifies an invite token

Verifies an invite token

path Parameters
token
required
string

Authorisation token

Responses

Updates a password by token

Updates a password by token

path Parameters
token
required
string

Authorisation token

Request Body schema: application/json
oldPassword
required
string (UpdatePasswordDto.oldPassword)
newPassword
required
string (UpdatePasswordDto.newPassword)

Responses

Request samples

Content type
application/json
{
  • "oldPassword": "string",
  • "newPassword": "string"
}

Response samples

Content type
application/json
{ }

Requests a password reset message

Requests a password reset message

Request Body schema: application/json
email
required
string (ResetPasswordDto.email)

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Gets a user by reset token

Gets a user by reset token

path Parameters
token
required
string

Authorisation token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Gets a user by invite token

Gets a user by invite token

path Parameters
token
required
string

Authorisation token

Responses

Response samples

Content type
application/json
{ }

Accepts an organisation invitation

Accepts an organisation invitation

path Parameters
token
required
string

Authorisation token

Responses

Response samples

Content type
application/json
{ }

Gets the current user

Gets the current user

Responses

Response samples

Content type
application/json
{ }

Updates a user

Updates a user

path Parameters
id
required
number

An object id

Responses

Response samples

Content type
application/json
{ }

Confirms a free registration

Confirms a free registration

path Parameters
token
required
string

Authorisation token

Responses

Response samples

Content type
application/json
{ }

Get pending invites for an organisation

Get pending invites for an organisation

path Parameters
organisationUuid
required
string <uuid>

UUID of the organisation

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an invite for the organisation

Create an invite for the organisation

path Parameters
organisationUuid
required
string <uuid>

UUID of the organisation

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "organisationUuid": "string",
  • "email": "string",
  • "validThrough": "string"
}

Delete a pending invite for an organisation

Delete a pending invite for an organisation

path Parameters
organisationUuid
required
string <uuid>

UUID of the organisation

inviteUuid
required
string <uuid>

UUID of the invite

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "organisationUuid": "string",
  • "email": "string",
  • "validThrough": "string"
}

User

User

Get settings for the current user

Get settings for the current user

Responses

Response samples

Content type
application/json
{
  • "langFromOs": true,
  • "nativeLang": true,
  • "manualTranslation": true,
  • "creativeCategoryNames": true,
  • "language": "string",
  • "contentLanguages": [
    ]
}

Updates user settings

Updates user settings

Responses

Response samples

Content type
application/json
{
  • "langFromOs": true,
  • "nativeLang": true,
  • "manualTranslation": true,
  • "creativeCategoryNames": true,
  • "language": "string",
  • "contentLanguages": [
    ]
}

Guests

Everything related to guests

Checks if a payment request notification is presen

Checks if a payment request notification is present for the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Get the orders of the table

Get the orders of the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an order for the table

Create an order for the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "comment": "string",
  • "status": "open",
  • "edited": true,
  • "sum": 0,
  • "orderItems": [
    ],
  • "menuItems": [
    ],
  • "table": null,
  • "createdAt": "string",
  • "updatedAt": "string"
}

Deletes the open order for this table

Deletes the open order for this table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Create a call waiter notification for the table

Create a call waiter notification for the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Checks if a call waiter notification is present

Checks if a call waiter notification is present

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Create a payment request notification for the tabl

Create a payment request notification for the table

path Parameters
code
required
string

Table code

Responses

Response samples

Content type
application/json
{ }

Vendor

Management of locations and menus

Get default categories

Get default categories

Responses

Response samples

Content type
application/json
null

Get a default category

Get a default category

path Parameters
id
required
number

An object id

Responses

Response samples

Content type
application/json
null

Returns a list of currencies

Returns a list of currencies

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get default categories

Get default categories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a default category

Get a default category

path Parameters
categoryUuid
required
string <uuid>

UUID of the category

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "iconKey": "string",
  • "icon": "string",
  • "imageKey": "string",
  • "image": "string",
  • "uuid": "string",
  • "puuid": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "defaultTexts": [
    ]
}

Returns a list of active languages

Returns a list of active languages

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Uploads a temporary file

Uploads a temporary file

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "metadata": {
    }
}

Gets metadata for a file

Gets metadata for a file

path Parameters
locationUuid
required
string <uuid>

UUID of the location

fileKey
required
string

Key of the file

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "metadata": {
    }
}

Get order items of a location

Get order items of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

query Parameters
status
string
since
string <date-time>
producerUuid
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an order item of a location

Get an order item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderItemUuid
required
string <uuid>

UUID of the order item

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "menuItemUuid": "string",
  • "quantity": 0,
  • "price": 0,
  • "status": "open",
  • "variations": [
    ],
  • "menuItem": {
    }
}

Update the status of an order item of a location

Update the status of an order item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderItemUuid
required
string <uuid>

UUID of the order item

Request Body schema: application/json
status
required
string (OrderStatus)
Enum: "open" "received" "storno" "confirmed" "refused" "ready" "delivered" "finished"

Responses

Request samples

Content type
application/json
{
  • "status": "open"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "menuItemUuid": "string",
  • "quantity": 0,
  • "price": 0,
  • "status": "open",
  • "variations": [
    ],
  • "menuItem": {
    }
}

Update the external ID of an order item of a locat

Update the external ID of an order item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderItemUuid
required
string <uuid>

UUID of the order item

Request Body schema: application/json
externalId
required
string (UpdateOrderItemExternalDto.externalId)

Responses

Request samples

Content type
application/json
{
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "menuItemUuid": "string",
  • "quantity": 0,
  • "price": 0,
  • "status": "open",
  • "variations": [
    ],
  • "menuItem": {
    }
}

Get orders of a location

Get orders of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

query Parameters
string or Array of strings
since
string <date-time>
producerUuid
string <uuid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get an order of a location

Get an order of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderUuid
required
string <uuid>

UUID of the order

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "comment": "string",
  • "status": "open",
  • "edited": true,
  • "sum": 0,
  • "orderItems": [
    ],
  • "menuItems": [
    ],
  • "table": null,
  • "createdAt": "string",
  • "updatedAt": "string"
}

Sets the status of an order

Sets the status of an order

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderUuid
required
string <uuid>

UUID of the order

Request Body schema: application/json
status
string (OrderStatus)
Enum: "open" "received" "storno" "confirmed" "refused" "ready" "delivered" "finished"

Responses

Request samples

Content type
application/json
{
  • "status": "open"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "comment": "string",
  • "status": "open",
  • "edited": true,
  • "sum": 0,
  • "orderItems": [
    ],
  • "menuItems": [
    ],
  • "table": null,
  • "createdAt": "string",
  • "updatedAt": "string"
}

Sets the external id of an order

Sets the external id of an order

path Parameters
locationUuid
required
string <uuid>

UUID of the location

orderUuid
required
string <uuid>

UUID of the order

Request Body schema: application/json
externalId
string (OrderExternalDto.externalId)
externalType
string (OrderExternalDto.externalType)

Responses

Request samples

Content type
application/json
{
  • "externalId": "string",
  • "externalType": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uuid": "string",
  • "comment": "string",
  • "status": "open",
  • "edited": true,
  • "sum": 0,
  • "orderItems": [
    ],
  • "menuItems": [
    ],
  • "table": null,
  • "createdAt": "string",
  • "updatedAt": "string"
}

Get all Partnercard Data of a location

Get all Partnercard Data of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Partnercard Categories of a location

Get Partnercard Categories of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Partnercard Categories of a location

Create a Partnercard Categories of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Partnercard Category of a location

Delete Partnercard Category of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

partnerCardCategoryUuid
required
string <uuid>

UUID of the PartnerCard Category

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Partnercard Item of a location

Create Partnercard Item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

partnerCardCategoryUuid
required
string <uuid>

UUID of the PartnerCard Category

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Partnercard Item of a location

Update Partnercard Item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

partnerCardItemUuid
required
string <uuid>

UUID of the PartnerCard Item

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Partnercard Item of a location

Delete Partnercard Item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

partnerCardItemUuid
required
string <uuid>

UUID of the PartnerCard Item

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of producers

Returns a list of producers

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a producer

Returns a producer

path Parameters
locationUuid
required
string <uuid>

UUID of the location

producerUuid
required
string <uuid>

UUID of the producer

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "externalId": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Returns a variation group

Returns a variation group

path Parameters
locationUuid
required
string <uuid>

UUID of the location

variationGroupUuid
required
string <uuid>

UUID of the variation group

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "locationId": 0,
  • "externalId": "string",
  • "texts": [
    ],
  • "variations": [
    ],
  • "createdAt": "string",
  • "updatedAt": "string"
}

Returns a variation set

Returns a variation set

path Parameters
locationUuid
required
string <uuid>

UUID of the location

variationSetUuid
required
string <uuid>

UUID of the variation set

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "description": "string",
  • "groups": [
    ],
  • "items": [
    ],
  • "rules": [
    ],
  • "externalId": "string"
}

Returns a list of timezones

Returns a list of timezones

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Meta

Information about the backend and API

Returns information about the current running serv

Returns information about the current running server instance

query Parameters
platform
string
version
string

Responses

Response samples

Content type
application/json
{
  • "apiHash": "string",
  • "minClientVersion": "string",
  • "type": "string",
  • "mapToken": "string",
  • "mapLayerIds": [
    ],
  • "availableLanguages": {
    }
}

Get the current backend version

Get the current backend version

Responses

Response samples

Content type
application/json
{ }

Register

Create a registered User

Create a registered User

Request Body schema: application/json
uuid
required
string (UserDto.uuid)
email
required
string (UserDto.email)
temporary
required
boolean (UserDto.temporary)
firstname
required
string (UserDto.firstname)
lastname
required
string (UserDto.lastname)
status
required
string (UserStatus)
Enum: "PENDING" "ACTIVE"
required
Array of objects (UserDto.userRoles)
required
Array of objects (UserDto.organisationRoles)
renew
required
boolean (UserDto.renew)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "email": "string",
  • "temporary": true,
  • "firstname": "string",
  • "lastname": "string",
  • "status": "PENDING",
  • "userRoles": [
    ],
  • "organisationRoles": [
    ],
  • "renew": true
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "email": "string",
  • "temporary": true,
  • "firstname": "string",
  • "lastname": "string",
  • "status": "PENDING",
  • "userRoles": [
    ],
  • "organisationRoles": [
    ],
  • "renew": true
}

Create a registered User

Create a registered User

Request Body schema: application/json
uuid
required
string (UserDto.uuid)
email
required
string (UserDto.email)
temporary
required
boolean (UserDto.temporary)
firstname
required
string (UserDto.firstname)
lastname
required
string (UserDto.lastname)
status
required
string (UserStatus)
Enum: "PENDING" "ACTIVE"
required
Array of objects (UserDto.userRoles)
required
Array of objects (UserDto.organisationRoles)
renew
required
boolean (UserDto.renew)

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "email": "string",
  • "temporary": true,
  • "firstname": "string",
  • "lastname": "string",
  • "status": "PENDING",
  • "userRoles": [
    ],
  • "organisationRoles": [
    ],
  • "renew": true
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "email": "string",
  • "temporary": true,
  • "firstname": "string",
  • "lastname": "string",
  • "status": "PENDING",
  • "userRoles": [
    ],
  • "organisationRoles": [
    ],
  • "renew": true
}

Create a tempoary User

Create a tempoary User

Request Body schema: application/json
device
string
birthdate
string

Responses

Request samples

Content type
application/json
{
  • "device": "string",
  • "birthdate": "string"
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "email": "string",
  • "temporary": true,
  • "firstname": "string",
  • "lastname": "string",
  • "status": "PENDING",
  • "userRoles": [
    ],
  • "organisationRoles": [
    ],
  • "renew": true
}

Organisations

Get pending invites for an organisation

Get pending invites for an organisation

path Parameters
organisationUuid
required
string <uuid>

UUID of the organisation

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an invite for the organisation

Create an invite for the organisation

path Parameters
organisationUuid
required
string <uuid>

UUID of the organisation

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "organisationUuid": "string",
  • "email": "string",
  • "validThrough": "string"
}

Delete a pending invite for an organisation

Delete a pending invite for an organisation

path Parameters
organisationUuid
required
string <uuid>

UUID of the organisation

inviteUuid
required
string <uuid>

UUID of the invite

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "organisationUuid": "string",
  • "email": "string",
  • "validThrough": "string"
}

PaymentMethods

Get all Payment Methods from the LocationUuid

Get all Payment Methods from the LocationUuid

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

update a PaymentMethod to an LocationUuid Admin Ro

update a PaymentMethod to an LocationUuid Admin Role Requiert

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deprecated

Get default categories

Get default categories

Responses

Response samples

Content type
application/json
null

Get a default category

Get a default category

path Parameters
id
required
number

An object id

Responses

Response samples

Content type
application/json
null

Get default categories

Get default categories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Default Data

Get default categories

Get default categories

Responses

Response samples

Content type
application/json
null

Get a default category

Get a default category

path Parameters
id
required
number

An object id

Responses

Response samples

Content type
application/json
null

Returns a list of currencies

Returns a list of currencies

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get default categories

Get default categories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a default category

Get a default category

path Parameters
categoryUuid
required
string <uuid>

UUID of the category

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "iconKey": "string",
  • "icon": "string",
  • "imageKey": "string",
  • "image": "string",
  • "uuid": "string",
  • "puuid": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "defaultTexts": [
    ]
}

Returns a list of active languages

Returns a list of active languages

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of timezones

Returns a list of timezones

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Categories

Get default categories

Get default categories

Responses

Response samples

Content type
application/json
null

Get a default category

Get a default category

path Parameters
id
required
number

An object id

Responses

Response samples

Content type
application/json
null

Get default categories

Get default categories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a default category

Get a default category

path Parameters
categoryUuid
required
string <uuid>

UUID of the category

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "key": "string",
  • "iconKey": "string",
  • "icon": "string",
  • "imageKey": "string",
  • "image": "string",
  • "uuid": "string",
  • "puuid": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "defaultTexts": [
    ]
}

Files

Uploads a temporary file

Uploads a temporary file

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "metadata": {
    }
}

Gets metadata for a file

Gets metadata for a file

path Parameters
locationUuid
required
string <uuid>

UUID of the location

fileKey
required
string

Key of the file

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "metadata": {
    }
}

Partnercards

Get all Partnercard Data of a location

Get all Partnercard Data of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Partnercard Categories of a location

Get Partnercard Categories of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a Partnercard Categories of a location

Create a Partnercard Categories of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Partnercard Category of a location

Delete Partnercard Category of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

partnerCardCategoryUuid
required
string <uuid>

UUID of the PartnerCard Category

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Partnercard Item of a location

Create Partnercard Item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

partnerCardCategoryUuid
required
string <uuid>

UUID of the PartnerCard Category

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Partnercard Item of a location

Update Partnercard Item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

partnerCardItemUuid
required
string <uuid>

UUID of the PartnerCard Item

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Partnercard Item of a location

Delete Partnercard Item of a location

path Parameters
locationUuid
required
string <uuid>

UUID of the location

partnerCardItemUuid
required
string <uuid>

UUID of the PartnerCard Item

Responses

Response samples

Content type
application/json
[
  • {
    }
]