Kitchen

Mutation

createKitchenScreen — Returns KitchenScreen

Scopes Required: configure_kitchen_screens

Arguments Type Description

name

String!

The name for the kitchen screen

rules

KitchenScreenRulesInput!

The rules to apply to the customer display

Example Mutation
mutation CreateKitchenScreen($name: String!, $rules: KitchenScreenRulesInput!) {
    createKitchenScreen(name: $name, rules: $rules) {
        id,
        name
    }
}

# Example variables
{
    "name": "<NAME>",
    "rules": {
        "ready": "NOT_DONE",
        "categories": [
            "<CATEGORIES>"
        ],
        "tags": [
            "<TAGS>"
        ],
        "registers": [
            "<REGISTERS>"
        ],
        "outlets": [
            "<OUTLETS>"
        ]
    }
}

Mutation

deleteKitchenScreen — Returns KitchenScreen

Scopes Required: configure_kitchen_screens

Arguments Type Description

id

ID!

The ID of the kitchen screen to delete

Example Mutation
mutation DeleteKitchenScreen($id: ID!) {
    deleteKitchenScreen(id: $id) {
        id,
        name
    }
}

# Example variables
{
    "id": "<ID>"
}

Mutation

updateKitchenScreen — Returns KitchenScreen

Scopes Required: configure_kitchen_screens

Arguments Type Description

id

ID!

The ID of the kitchen screen

name

String

The name for the kitchen screen

rules

KitchenScreenRulesInput

The rules to apply to the customer display

Example Mutation
mutation UpdateKitchenScreen($id: ID!) {
    updateKitchenScreen(id: $id) {
        id,
        name
    }
}

# Example variables
{
    "id": "<ID>"
}