Fresh KDS APIs

Locations and Screens

Contents

Locations and Screens

Routes

There are three routes available to get information about a customer’s KDS account. They are:

Route Description
GET KDS Information Returns all active KDS locations and screens for a brand
GET KDS Locations Returns all active KDS locations for a brand
GET KDS Location Devices Returns all active screens for a specific location

KDS Information

Request

GET /integrators/kds-information

Required Header

x-integration-token: {token}

Response

Fresh KDS will return all active locations and KDS screens for the brand. The brand is identified by the integration token. A location is considered active if it has an active Fresh KDS subscription. A screen is considered active if it is registered to the location and has not been deleted. Note: the id value for a location will be required for future API calls

Example Response

[
    {
        "id": "81db5db1-b5af-4e45-8767-71fb78e29bdb",
        "number": "123456",
        "name": "Test Location Fresh",
        "address": {
            "zip": "12345",
            "city": "Any Town",
            "line1": "123 Test Lane",
            "line2": null,
            "state": "NV"
        },
        "timezone": "US/Pacific",
        "devices": [
            {
                "id": "ef837416-c674-40ab-9aa3-eb0f202e8646",
                "name": "Device 1",
                "type": "android",
                "version": "3.20.0",
                "ipAddress": "192.168.0.0"
            }
        ]
    }
]

KDS Locations

Request

GET /integrators/kds-information/locations

Required Header

x-integration-token: {token}

Response

Fresh KDS will return all active locations for the brand. A location is considered active if it has an active Fresh KDS subscription. Note: the id value for a location will be required for future API calls

Example Response

[
    {
        "id": "81db5db1-b5af-4e45-8767-71fb78e29bdb",
        "number": "123456",
        "name": "Test Location Fresh",
        "address": {
            "zip": "12345",
            "city": "Any Town",
            "line1": "123 Test Lane",
            "line2": null,
            "state": "NV"
        },
        "timezone": "US/Pacific"
    }
]

KDS Location Devices

Request

GET /integrators/kds-information/locations/{locationId}/devices

Required Header

x-integration-token: {token}

Response

Fresh KDS will return all active KDS screens for the location. A screen is considered active if it is registered to the location and has not been deleted. Note: the id value for a device can be used for future API calls

Example Response

[
    {
        "id": "ef837416-c674-40ab-9aa3-eb0f202e8646",
        "name": "Device 1",
        "type": "android",
        "version": "3.20.0",
        "ipAddress": "192.168.0.0"
    }
]