(v1.0) LS Central hospitality API (1.0.0)

Download OpenAPI specification:

(v1.0) LS Central hospitality API for Dynamics 365 Business Central. Published by the LS Central AL API pages at /api/lsRetail/hospitality/v1.0.

KOT Line

Read-only projection of the item lines of a KOT (Kitchen Order Ticket), replacing the line detail returned by the legacy GetKotStatus SOAP operation. Reached nested under the kots entity via $expand=kotLines, and independently via $filter=kotNo eq ''...'' on this entity set. Mutation is not available through this entity.

Get kotLines from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "kotNo" "kotLineNo" "no" "quantity" "unitOfMeasure" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get kotLines from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

kotLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of kotLine

query Parameters
$select
Array of strings unique
Items Enum: "id" "kotNo" "kotLineNo" "no" "quantity" "unitOfMeasure" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "kotNo": null,
  • "kotLineNo": null,
  • "no": null,
  • "quantity": null,
  • "unitOfMeasure": null,
  • "lastModifiedDateTime": null
}

Get kotLines from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

kot-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of kot

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "kotNo" "kotLineNo" "no" "quantity" "unitOfMeasure" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get kotLines from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

kot-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of kot

kotLine-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of kotLine

query Parameters
$select
Array of strings unique
Items Enum: "id" "kotNo" "kotLineNo" "no" "quantity" "unitOfMeasure" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "kotNo": null,
  • "kotLineNo": null,
  • "no": null,
  • "quantity": null,
  • "unitOfMeasure": null,
  • "lastModifiedDateTime": null
}

KOT

Exposes Kitchen Order Ticket (KOT) status data as a read-only OData v4 entity, replacing the legacy GetKotStatus SOAP operation for read scenarios. GetKotStatus (and the GetKotStatusUtils/GetKotStatusXML objects behind it) remain available unchanged for the duration of the coexistence window. This release is GET-only; no write verbs are exposed. Scope: this entity is NOT restaurant-scoped as an enforced filter - KOT data is inherently restaurant-owned (every KOT has a real Restaurant No.), but legacy GetKotStatus never applies that as a filter (it only checks that the passed store exists), so restaurantNo is deliberately not exposed here and consumers must not assume tenant/restaurant isolation from this endpoint; the separate GetKOTStatusAll legacy operation, which does filter by restaurant, is out of scope. statusMessage is computed per record at read time from the order''s hospitality type and matching service flow line; it is blank whenever the order, hospitality type, or matching service flow line cannot be resolved, or when that flow line''s Send LS Commerce Message is false - blank is a normal result, not an error. Lines are reached via kots({id})?$expand=kotLines (note: kotLines, the part''s entity set name - not "lines", the control name) and independently via the kotLines entity set with $filter=kotNo eq ''...''. Performance note: statusMessage costs up to three extra table reads per row, so an unfiltered GET kots over a large KOT table is expensive - filter by receiptNo or kotNo.

Get kots from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "receiptNo" "kotNo" "status" "confirmedByExpeditorStation" "kotProductionTime" "actualOrderId" "statusMessage" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique
Items Value: "kotLines"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get kots from companies

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

kot-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of kot

query Parameters
$select
Array of strings unique
Items Enum: "id" "receiptNo" "kotNo" "status" "confirmedByExpeditorStation" "kotProductionTime" "actualOrderId" "statusMessage" "lastModifiedDateTime"

Select properties to be returned

$expand
Array of strings unique
Items Value: "kotLines"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "receiptNo": null,
  • "kotNo": null,
  • "status": "Not_x0020_Sent",
  • "confirmedByExpeditorStation": null,
  • "kotProductionTime": null,
  • "actualOrderId": null,
  • "statusMessage": null,
  • "lastModifiedDateTime": null,
  • "kotLines": [
    ]
}

Company

Get entities from companies

Authorizations:
oAuth2basicAuth
query Parameters
$top
number <int64> >= 0
Example: $top=50

Show only the first n items

$skip
number <int64> >= 0

Skip the first n items

$search
string

Search items by search phrases

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique
Items Enum: "id" "systemVersion" "timestamp" "name" "displayName" "businessProfileId" "systemCreatedAt" "systemCreatedBy" "systemModifiedAt" "systemModifiedBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "kots" "kotLines"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from companies by key

Authorizations:
oAuth2basicAuth
path Parameters
company-id
required
string <uuid> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}...

The unique identifier of company

query Parameters
$select
Array of strings unique
Items Enum: "id" "systemVersion" "timestamp" "name" "displayName" "businessProfileId" "systemCreatedAt" "systemCreatedBy" "systemModifiedAt" "systemModifiedBy"

Select properties to be returned

$expand
Array of strings unique
Items Enum: "kots" "kotLines"

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "systemVersion": null,
  • "timestamp": null,
  • "name": null,
  • "displayName": null,
  • "businessProfileId": null,
  • "systemCreatedAt": null,
  • "systemCreatedBy": null,
  • "systemModifiedAt": null,
  • "systemModifiedBy": null,
  • "kots": [
    ],
  • "kotLines": [
    ]
}