Skip to content
API Reference/
/
Get department

Lipp Connect API (1.1.0)

API for managing Lipp software.

Download OpenAPI description
index.json
index.yaml
Overview
Lipp Connect API Support
develop@linecker.at
Languages
Servers
Mock server
https://developer.lipp.cloud/_mock/apis/
Production server
https://connect.lipp.cloud/api/

POS Management

Operations

Get Commodity Group

Request

Security
ApiKeyAuth
Query
idstring(uuid)required
curl -i -X GET \
  'https://developer.lipp.cloud/_mock/apis/POSSystem/GetCommodityGroup?id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A commodity group

Bodyapplication/json
_idstring(uuid)

Unique identifier for the commodity group

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
_scstring(uuid)

The stationcode

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)
Example: "1889-03-10T23:50:00Z"
createdByUserNamestring

The user who created it

modifiedOnUTCstring(date-time)
Example: "1889-03-10T23:50:00Z"
modifiedByUserNamestring

The user who modified it

parentCommodityGroupIdstring(uuid)
namestring

The name of the commodity group

descriptionstring

The description of the commodity group

isActiveboolean

Determents if it is active or not

taxIdstring(uuid)
sortnumber
Response
application/json
{
  "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
  "_sc": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
  "createdOnUTC": "1889-03-10T23:50:00Z",
  "createdByUserName": "string",
  "modifiedOnUTC": "1889-03-10T23:50:00Z",
  "modifiedByUserName": "string",
  "parentCommodityGroupId": "8b5477fc-0268-4804-85d9-f9c4e44efda1",
  "name": "string",
  "description": "string",
  "isActive": true,
  "taxId": "ec2f3321-4009-45bd-9423-63aa80044823",
  "sort": 0
}

Get Commodity Groups

Request

Security
ApiKeyAuth
curl -i -X GET \
  https://developer.lipp.cloud/_mock/apis/POSSystem/GetCommodityGroups \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of all commodity groups

Bodyapplication/jsonArray [
_idstring(uuid)

Unique identifier for the commodity group

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
_scstring(uuid)

The stationcode

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)
Example: "1889-03-10T23:50:00Z"
createdByUserNamestring

The user who created it

modifiedOnUTCstring(date-time)
Example: "1889-03-10T23:50:00Z"
modifiedByUserNamestring

The user who modified it

parentCommodityGroupIdstring(uuid)
namestring

The name of the commodity group

descriptionstring

The description of the commodity group

isActiveboolean

Determents if it is active or not

taxIdstring(uuid)
sortnumber
]
Response
application/json
[
  {
    "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
    "_sc": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
    "createdOnUTC": "1889-03-10T23:50:00Z",
    "createdByUserName": "string",
    "modifiedOnUTC": "1889-03-10T23:50:00Z",
    "modifiedByUserName": "string",
    "parentCommodityGroupId": "8b5477fc-0268-4804-85d9-f9c4e44efda1",
    "name": "string",
    "description": "string",
    "isActive": true,
    "taxId": "ec2f3321-4009-45bd-9423-63aa80044823",
    "sort": 0
  }
]

Get article

Request

Security
ApiKeyAuth
Query
idstring(uuid)required
curl -i -X GET \
  'https://developer.lipp.cloud/_mock/apis/POSSystem/GetArticle?id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

An article

Bodyapplication/json
_idstring(uuid)

Unique identifier

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)

Timestamp when the entity was created (UTC)

Example: "2025-01-23T12:34:56Z"
createdByUserNamestring

Username of the creator

Example: "Peter"
modifiedOnUTCstring or null

Timestamp when the entity was last modified (UTC)

One of:

Timestamp when the entity was last modified (UTC)

string(date-time)
modifiedByUserNamestring or null

Username of the last modifying user

One of:

Username of the last modifying user

string
numberstring

Unique article number.

namestring

Article name.

descriptionstring or null

Optional article description.

One of:

Optional article description.

string
isActiveboolean

Indicates whether the article is active.

Default true
typeinteger

Numeric article type (based on EnArticleType).

Example: 0
commodityGroupIdstring(uuid)

ID of the commodity group.

commodityGroupCommodityGroups (object) or null

Related commodity group entity.

One of:

Related commodity group entity.

courseIdstring or null

Optional course ID.

One of:

Optional course ID.

string(uuid)
costsnumber(double)

Cost price of the article.

textEntryForBookingboolean

Requires a text entry during booking.

Default false
priceEntryForBookingboolean

Requires a manual price input during booking.

Default false
externalDocumentNumberEntryForBookingboolean

Requires an external document number during booking.

Default false
isNegativeboolean

Indicates that the article is a negative item (e.g., discount).

Default false
priceGrossnumber(double)

Gross price of the article.

priceListPricesArray of arrays or null

Field reserved for future features.

One of:

Field reserved for future features.

arrays
printerIdsArray of strings or null

List of printer IDs.

One of:

List of printer IDs.

barcodesArray of strings or null

List of barcodes associated with the article.

One of:

List of barcodes associated with the article.

articlePackageDetailsArray of arrays or null

Field reserved for future features.

One of:

Field reserved for future features.

arrays
articlePackageGroupsArray of arrays or null

Field reserved for future features.

One of:

Field reserved for future features.

arrays
articleAddonsArray of arrays or null

Field reserved for future features.

One of:

Field reserved for future features.

arrays
Response
application/json
{
  "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
  "createdOnUTC": "2025-01-23T12:34:56Z",
  "createdByUserName": "Peter",
  "modifiedOnUTC": "2019-08-24T14:15:22Z",
  "modifiedByUserName": "string",
  "number": "string",
  "name": "string",
  "description": "string",
  "isActive": true,
  "type": 0,
  "commodityGroupId": "8677cad8-6e5a-4797-b76e-96afd2f33ad4",
  "commodityGroup": {
    "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
    "_sc": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
    "createdOnUTC": "1889-03-10T23:50:00Z",
    "createdByUserName": "string",
    "modifiedOnUTC": "1889-03-10T23:50:00Z",
    "modifiedByUserName": "string",
    "parentCommodityGroupId": "8b5477fc-0268-4804-85d9-f9c4e44efda1",
    "name": "string",
    "description": "string",
    "isActive": true,
    "taxId": "ec2f3321-4009-45bd-9423-63aa80044823",
    "sort": 0
  },
  "courseId": "a6aaec24-4fe5-49f2-8b74-509d2f931acc",
  "costs": 0.1,
  "textEntryForBooking": false,
  "priceEntryForBooking": false,
  "externalDocumentNumberEntryForBooking": false,
  "isNegative": false,
  "priceGross": 0.1,
  "priceListPrices": [],
  "printerIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "barcodes": [
    "string"
  ],
  "articlePackageDetails": [],
  "articlePackageGroups": [],
  "articleAddons": []
}

Get articles

Request

Security
ApiKeyAuth
curl -i -X GET \
  https://developer.lipp.cloud/_mock/apis/POSSystem/GetArticles \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of all articles

Bodyapplication/jsonArray [
_idstring(uuid)

Unique identifier

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)

Timestamp when the entity was created (UTC)

Example: "2025-01-23T12:34:56Z"
createdByUserNamestring

Username of the creator

Example: "Peter"
modifiedOnUTCstring or null

Timestamp when the entity was last modified (UTC)

One of:

Timestamp when the entity was last modified (UTC)

string(date-time)
modifiedByUserNamestring or null

Username of the last modifying user

One of:

Username of the last modifying user

string
numberstring

Unique article number.

namestring

Article name.

descriptionstring or null

Optional article description.

One of:

Optional article description.

string
isActiveboolean

Indicates whether the article is active.

Default true
typeinteger

Numeric article type (based on EnArticleType).

Example: 0
commodityGroupIdstring(uuid)

ID of the commodity group.

commodityGroupCommodityGroups (object) or null

Related commodity group entity.

One of:

Related commodity group entity.

courseIdstring or null

Optional course ID.

One of:

Optional course ID.

string(uuid)
costsnumber(double)

Cost price of the article.

textEntryForBookingboolean

Requires a text entry during booking.

Default false
priceEntryForBookingboolean

Requires a manual price input during booking.

Default false
externalDocumentNumberEntryForBookingboolean

Requires an external document number during booking.

Default false
isNegativeboolean

Indicates that the article is a negative item (e.g., discount).

Default false
priceGrossnumber(double)

Gross price of the article.

priceListPricesArray of arrays or null

Field reserved for future features.

One of:

Field reserved for future features.

arrays
printerIdsArray of strings or null

List of printer IDs.

One of:

List of printer IDs.

barcodesArray of strings or null

List of barcodes associated with the article.

One of:

List of barcodes associated with the article.

articlePackageDetailsArray of arrays or null

Field reserved for future features.

One of:

Field reserved for future features.

arrays
articlePackageGroupsArray of arrays or null

Field reserved for future features.

One of:

Field reserved for future features.

arrays
articleAddonsArray of arrays or null

Field reserved for future features.

One of:

Field reserved for future features.

arrays
]
Response
application/json
[
  {
    "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
    "createdOnUTC": "2025-01-23T12:34:56Z",
    "createdByUserName": "Peter",
    "modifiedOnUTC": "2019-08-24T14:15:22Z",
    "modifiedByUserName": "string",
    "number": "string",
    "name": "string",
    "description": "string",
    "isActive": true,
    "type": 0,
    "commodityGroupId": "8677cad8-6e5a-4797-b76e-96afd2f33ad4",
    "commodityGroup": { … },
    "courseId": "a6aaec24-4fe5-49f2-8b74-509d2f931acc",
    "costs": 0.1,
    "textEntryForBooking": false,
    "priceEntryForBooking": false,
    "externalDocumentNumberEntryForBooking": false,
    "isNegative": false,
    "priceGross": 0.1,
    "priceListPrices": [],
    "printerIds": [ … ],
    "barcodes": [ … ],
    "articlePackageDetails": [],
    "articlePackageGroups": [],
    "articleAddons": []
  }
]

Get department

Request

Security
ApiKeyAuth
Query
idstring(uuid)required
curl -i -X GET \
  'https://developer.lipp.cloud/_mock/apis/POSSystem/GetDepartment?id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A department

Bodyapplication/json
_idstring(uuid)

Unique identifier

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)

Timestamp when the entity was created (UTC)

Example: "2025-01-23T12:34:56Z"
createdByUserNamestring

Username of the creator

Example: "Peter"
modifiedOnUTCstring or null

Timestamp when the entity was last modified (UTC)

One of:

Timestamp when the entity was last modified (UTC)

string(date-time)
modifiedByUserNamestring or null

Username of the last modifying user

One of:

Username of the last modifying user

string
namestring

Department name.

discountRatenumber(double)

Default discount rate for this department.

Example: 0
isActiveboolean

Indicates whether the department is active.

Default true
sortinteger(int32)

Sort order for displaying the department.

Example: 99999999
tablesArray of Table (objects) or null

List of tables belonging to this department.

One of:

List of tables belonging to this department.

Response
application/json
{
  "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
  "createdOnUTC": "2025-01-23T12:34:56Z",
  "createdByUserName": "Peter",
  "modifiedOnUTC": "2019-08-24T14:15:22Z",
  "modifiedByUserName": "string",
  "name": "string",
  "discountRate": 0,
  "isActive": true,
  "sort": 99999999,
  "tables": [
    { … }
  ]
}

Get departments

Request

Security
ApiKeyAuth
curl -i -X GET \
  https://developer.lipp.cloud/_mock/apis/POSSystem/GetDepartments \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of all departments

Bodyapplication/json
_idstring(uuid)

Unique identifier

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)

Timestamp when the entity was created (UTC)

Example: "2025-01-23T12:34:56Z"
createdByUserNamestring

Username of the creator

Example: "Peter"
modifiedOnUTCstring or null

Timestamp when the entity was last modified (UTC)

One of:

Timestamp when the entity was last modified (UTC)

string(date-time)
modifiedByUserNamestring or null

Username of the last modifying user

One of:

Username of the last modifying user

string
namestring

Department name.

discountRatenumber(double)

Default discount rate for this department.

Example: 0
isActiveboolean

Indicates whether the department is active.

Default true
sortinteger(int32)

Sort order for displaying the department.

Example: 99999999
tablesArray of Table (objects) or null

List of tables belonging to this department.

One of:

List of tables belonging to this department.

Response
application/json
{
  "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
  "createdOnUTC": "2025-01-23T12:34:56Z",
  "createdByUserName": "Peter",
  "modifiedOnUTC": "2019-08-24T14:15:22Z",
  "modifiedByUserName": "string",
  "name": "string",
  "discountRate": 0,
  "isActive": true,
  "sort": 99999999,
  "tables": [
    { … }
  ]
}

Get table

Request

Security
ApiKeyAuth
Query
idstring(uuid)required
curl -i -X GET \
  'https://developer.lipp.cloud/_mock/apis/POSSystem/GetTable?id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A table

Bodyapplication/json
_idstring(uuid)

Unique identifier

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)

Timestamp when the entity was created (UTC)

Example: "2025-01-23T12:34:56Z"
createdByUserNamestring

Username of the creator

Example: "Peter"
modifiedOnUTCstring or null

Timestamp when the entity was last modified (UTC)

One of:

Timestamp when the entity was last modified (UTC)

string(date-time)
modifiedByUserNamestring or null

Username of the last modifying user

One of:

Username of the last modifying user

string
departmentIdstring(uuid)

ID of the department this table belongs to.

departmentDepartment (object) or null

Related department entity.

One of:

Base entity with audit information

numberinteger(int32)

Table number.

namestring

Table name or label.

isActiveboolean

Indicates whether the table is active.

Default true
recalledCourseIdstring or null

Optional ID of the recalled course.

One of:

Optional ID of the recalled course.

string(uuid)
tableTypeinteger(int32)

Table type identifier.

Example: 0
Response
application/json
{
  "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
  "createdOnUTC": "2025-01-23T12:34:56Z",
  "createdByUserName": "Peter",
  "modifiedOnUTC": "2019-08-24T14:15:22Z",
  "modifiedByUserName": "string",
  "departmentId": "a3452d1e-b055-4677-aa66-858ddc0a1f59",
  "department": {
    "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
    "createdOnUTC": "2025-01-23T12:34:56Z",
    "createdByUserName": "Peter",
    "modifiedOnUTC": "2019-08-24T14:15:22Z",
    "modifiedByUserName": "string",
    "name": "string",
    "discountRate": 0,
    "isActive": true,
    "sort": 99999999,
    "tables": [null]
  },
  "number": 0,
  "name": "string",
  "isActive": true,
  "recalledCourseId": "9dae819a-5799-4f65-92b8-5952921750a0",
  "tableType": 0
}

Get tables

Request

Security
ApiKeyAuth
curl -i -X GET \
  https://developer.lipp.cloud/_mock/apis/POSSystem/GetTables \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

A list of all tables

Bodyapplication/jsonArray [
_idstring(uuid)

Unique identifier

Example: "6c0df0b4-4a8a-4278-8b47-5e68f32b6658"
createdOnUTCstring(date-time)

Timestamp when the entity was created (UTC)

Example: "2025-01-23T12:34:56Z"
createdByUserNamestring

Username of the creator

Example: "Peter"
modifiedOnUTCstring or null

Timestamp when the entity was last modified (UTC)

One of:

Timestamp when the entity was last modified (UTC)

string(date-time)
modifiedByUserNamestring or null

Username of the last modifying user

One of:

Username of the last modifying user

string
departmentIdstring(uuid)

ID of the department this table belongs to.

departmentDepartment (object) or null

Related department entity.

One of:

Base entity with audit information

numberinteger(int32)

Table number.

namestring

Table name or label.

isActiveboolean

Indicates whether the table is active.

Default true
recalledCourseIdstring or null

Optional ID of the recalled course.

One of:

Optional ID of the recalled course.

string(uuid)
tableTypeinteger(int32)

Table type identifier.

Example: 0
]
Response
application/json
[
  {
    "_id": "6c0df0b4-4a8a-4278-8b47-5e68f32b6658",
    "createdOnUTC": "2025-01-23T12:34:56Z",
    "createdByUserName": "Peter",
    "modifiedOnUTC": "2019-08-24T14:15:22Z",
    "modifiedByUserName": "string",
    "departmentId": "a3452d1e-b055-4677-aa66-858ddc0a1f59",
    "department": { … },
    "number": 0,
    "name": "string",
    "isActive": true,
    "recalledCourseId": "9dae819a-5799-4f65-92b8-5952921750a0",
    "tableType": 0
  }
]

POS Transaction

Operations

POS-PMS Interface

Operations
Terms
Copyright © Lipp Software GmbH. No rights reserved.