👨‍🍳Order endpoints

This page provides a description of the available API routes for managing order endpoint devices.

Once the product (PLU) is added to the Ticket, an Order is created. Based on product settings, order is sent to one or multiple order endpoints for processing. The order endpoint serves as a device that handles incoming orders. This endpoint can take the form of either a printer, such as a kitchen printer, which generates printed instructions for the food preparation team, or a tablet that enables personnel to provide feedback to cashiers once the food is being prepared or is ready for pickup.

Order endpoint device is represented by OrderEndpoint class.

API methods

Get order endpoints

GET http://{server-address}/orderendpoints

Returns all order endpoints that matches query parameters. Result is of type QueryResult<OrderEndpoint>.

Query Parameters

Name	Type	Description
name	string	Supports NData syntax.
$skip	int	Pagination property. Describing number of records to skip from beginning of result collection.
$take	int	Pagination property. Maximum count of items to be returned.
$sort	string[]	Comma separated list of property names. Please see NData syntax.
$count	bool	If set to true, response will not contain items collection. Use to get resource count, not the resources themselves.
isActive	bool	Supports NData syntax.
type	string	Supports NData syntax.
address	string	Supports NData syntax.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

200: OK Successful response

{
    "items":
    [
        {
            "name": "Kitchen",
            "isActive": false,
            "address": "\\\\computer_name\\Kitchen",
            "type": "SRP350",
            "settings":
            {
                "IsBeepEnabled": "true",
                "HighlightOrderNumber": "true",
                "DoubleHeightFont": "true",
                "DoubleWidthFont": "true"
            },
            "_v": 1
        },
        {
            "name": "Pizza",
            "isActive": false,
            "address": "\\\\computer_name\\Pizza",
            "type": "TM88",
            "settings":
            {},
            "_v": 1
        }
    ],
    "count": 2,
    "totalCount": 2
}

Get order endpoint by name

GET http://{server-address}/orderendpoints/{name}

Result is of type OrderEndpoint.

Path Parameters

Name	Type	Description
name*	string	Unique order endpoint name.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

200: OK Resource found.

{
    "name": "Kitchen",
    "isActive": false,
    "address": "\\\\computer_name\\Kitchen",
    "type": "SRP350",
    "settings":
    {
        "IsBeepEnabled": "true",
        "HighlightOrderNumber": "true",
        "DoubleHeightFont": "true",
        "DoubleWidthFont": "true"
    },
    "_v": 1
}

404: Not Found Given resource was not found.

Create order endpoint

POST http://{server-address}/orderendpoints

Creates new order endpoint. Result is of type OrderEndpoint.

Required rights

Authorized user must have OrderEndpointCreate right assigned.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

Request Body

Name	Type	Description
(body)*	OrderEndpoint	Model to create.

201: Created Successfuly created.

{
    "name": "Kitchen",
    "isActive": false,
    "address": "\\\\computer_name\\Kitchen",
    "type": "SRP350",
    "settings":
    {
        "IsBeepEnabled": "true",
        "HighlightOrderNumber": "true",
        "DoubleHeightFont": "true",
        "DoubleWidthFont": "true"
    },
    "_v": 1
}

Create or update order endpoint

PUT http://{server-address}/orderendpoints/{name}

Creates new or updates existing order endpoint. Result is of type OrderEndpoint.

Required rights

Authorized user must have assigned OrderEndpointCreate or OrderEndpointUpdate right.

Path Parameters

Name	Type	Description
name*	string	Unique order endpoint name.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

Request Body

Name	Type	Description
(body)*	OrderEndpoint	Model to create or update.

200: OK Successfuly created or updated.

{
    "name": "Kitchen",
    "isActive": false,
    "address": "\\\\computer_name\\Kitchen",
    "type": "SRP350",
    "settings":
    {
        "IsBeepEnabled": "true",
        "HighlightOrderNumber": "true",
        "DoubleHeightFont": "true",
        "DoubleWidthFont": "true"
    },
    "_v": 2
}

Delete order endpoint by name

DELETE http://{server-address}/orderendpoints/{name}

Required rights

Authorized user must have OrderEndpointDelete right assigned.

Path Parameters

Name	Type	Description
name*	string	Unique order endpoint name.

Headers

Name	Type	Description
Authorization*	string	Authorization header with authorization token.

200: OK Successfuly deleted.

{
    "name": "Kitchen",
    "isActive": false,
    "address": "\\\\computer_name\\Kitchen",
    "type": "SRP350",
    "settings":
    {
        "IsBeepEnabled": "true",
        "HighlightOrderNumber": "true",
        "DoubleHeightFont": "true",
        "DoubleWidthFont": "true"
    },
    "_v": 1
}

404: Not Found Given resource was not found.