Send Order and Kitchen Events

IG Fly has been enhanced to streamline the order handling process for restaurants and hotels by sending the following events to external systems, improving the management of both food and beverage orders and service requests.

  • Order Event - This event is triggered when an order is placed, refunded, or voided.

  • Kitchen Event - This event is triggered when an order is bumped in the kitchen.

Contact Agilysys to initiate this integration at your property.

Note that development efforts may be required on both sides.

Order Event

Whenever an order is placed, the information is sent to the external system, allowing them to use the data in various ways. For example, they can track delivery status, display it on a guest-facing screen, or assign staff to fulfill the order. The order event notifications are also triggered for refund and void scenarios. This applies not only to food and beverage orders but also room service orders.

Sample

The following is the sample json, showing the details sent to the external system for order events.

Place Order

The order event is triggered when an order is placed.

{

  "type": 1,

  "ctxt": {

    "t_id": 100,

    "ent_id": 100001,

    "sm_id": 1,

    "term_id": 1

},

  "crtdTime": "2025-03-10T13:29:01",

  "chkInfo": {

    "chkNum": "10213",

    "id": "1ad1fb88-6a61-4ec4-8816-41091bb1e45a",

    "ordId": "10213",

    "status": "closed"

  },

  "del_info": {

    "room": "108",

    "ph": "",

    "email": "",

    "lct": "",

    "fl_type": "0"

  },

  "orders": [

    {

      "index": 1,

      "id": 5,

      "status": "order",

      "k_status": "",

      "type": 1,

      "qty": 1,

      "pc_id": "1",

      "pass": 0,

      "is_split": false,

      "split_cnt": 0,

      "splInst": [],

      "chldEntts": []

    }

  ]

}

Refer to the following table for field descriptions:

Field

Description

type

1 indicates that the event type is order event.

ctxt

t_id

The tenant ID of the property.

ent_id

The enterprise ID of the property.

sm_id

The store master ID.

term_id

The terminal ID associated with the site entity.

crtdTime

The date and time of the order.

chkinfo

chknum

The check number of the order.

id

The check GUID of the order.

ordId

The order ID.

status

The status of the order.

  • Closed

  • Refund

del_info

room

The room number of the guest.

ph

The phone number of the guest.

email

The email address of the guest.

lct

The location details selected by the guest.

fl_type

The fulfillment type selected by the guest.

orders

index

The index of the item in the order.

id

The item ID.

status

The status of the item.

  • Order

  • Refund

k_status

The kitchen status of the order.

  • Preparing

  • Rejected

  • Closed

type

Indicates item or modifier.

  • 1 - Item

  • 2 - Modifiers

qty

The item quantity.

pc_id

The profit center ID.

pass

Indicates the recall count.

is_split

  • True - The check is a split check.

  • False - The check is not a split check.

split_cnt

The split count, if the check is a split check.

splInst

The special instruction of the item.

chldEntts

Indicates the child entities, if any.

For example, if an item with modifier is added, modifier will be the child entity.

Refund or Void Order

The order event is triggered when an order is refunded or voided.

{

  "type": 1,

  "ctxt": {

    "t_id": 100,

    "ent_id": 100001,

    "sm_id": 1,

    "term_id": 1

  },

  "crtdTime": "2025-03-10T13:29:01",

  "chkInfo": {

    "chkNum": "10213",

    "asso_chk": "10205",

    "id": "1ad1fb88-6a61-4ec4-8816-41091bb1e45a",

    "ordId": "10213",

    "status": "refund"

  },

  "del_info": {

    "room": "108",

    "ph": "",

    "email": "",

    "lct": "",

    "fl_type": "0"

  },

  "orders": [

    {

      "index": 1,

      "id": 5,

      "status": "order",

      "k_status": "",

      "type": 1,

      "qty": 1,

      "pc_id": "1",

      "pass": 0,

      "is_split": false,

      "split_cnt": 0,

      "splInst": [],

      "chldEntts": []

    }

  ]

}

Refer to the following table for field descriptions:

Field

Description

type

1 indicates that the event type is order event.

ctxt

t_id

The tenant ID of the property.

ent_id

The enterprise ID of the property.

sm_id

The store master ID.

term_id

The terminal ID associated with the site entity.

crtdTime

The date and time of the order.

chkinfo

chknum

The check number of the order.

asso_chk

The parent check number for which the refund is processed.

id

The check GUID of the order.

ordId

The order ID.

status

The status of the order.

  • Closed

  • Refund

del_info

room

The room number of the guest.

ph

The phone number of the guest.

email

The email address of the guest.

lct

The location details selected by the guest.

fl_type

The fulfillment type selected by the guest.

orders

index

The index of the item in the order.

id

The item ID.

status

The status of the item.

  • Order

  • Refund

k_status

The kitchen status of the order.

  • Preparing

  • Rejected

  • Closed

type

Indicates item or modifier.

  • 1 - Item

  • 2 - Modifiers

qty

The item quantity.

pc_id

The profit center ID.

pass

Indicates the recall count.

is_split

  • True - The check is a split check.

  • False - The check is not a split check.

split_cnt

The split count, if the check is a split check.

splInst

The special instruction of the item.

chldEntts

Indicates the child entities, if any.

For example, if an item with modifier is added, modifier will be the child entity.

Kitchen Event

When a food and beverage order is bumped from the kitchen, the information is sent to the external system, allowing them to take action, for example, by assigning staff to deliver the order to the guest.

Sample

The following is the sample json, showing the details sent to the external system for kitchen events.

{

  "type": 3,

  "ctxt": {

    "t_id": 100,

    "ent_id": 110098,

    "sm_id": 209,

    "term_id": 1

  },

  "crtdTime": "2025-02-04T11:37:17.503",

  "chkInfo": {

    "chkNum": "2025035000000010617",

    "ordId": "2025035000000010617",

    "status": "saved"

  },

  "del_info": {},

  "orders": [

    {

      "index": 1,

      "id": 11,

      "status": "",

      "k_status": "PREPARING",

      "type": 1,

      "qty": 10,

      "pc_id": "1",

      "pass": 0,

      "is_split": false,

      "split_cnt": 0,

      "chldEntts": []

    }

  ]

}

Refer to the following table for field descriptions:

Field

Description

type

2 indicates that the event type is kitchen event.

ctxt

t_id

The tenant ID of the property.

ent_id

The enterprise ID of the property.

sm_id

The store master ID.

term_id

The terminal ID associated with the site entity.

crtdTime

The date and time of the order.

chkinfo

chknum

The check number of the order.

ordId

The order ID.

status

The status of the order.

  • Closed

  • Refund

del_info

orders

index

The index of the item in the order.

id

The item ID.

status

The status of the item.

  • Order

  • Refund

k_status

The kitchen status of the order.

  • SUCCESS - When item reaches the kitchen after a successful payment.

  • PREPARING - When item is being prepared in the kitchen.

  • CLOSED - When the item is bumped from the kitchen.

  • REJECTED - When the item is rejected in the kitchen.

type

Indicates item or modifier.

  • 1 - Item

  • 2 - Modifiers

qty

The item quantity.

pc_id

The profit center ID.

pass

Indicates the recall count.

is_split

  • True - The check is a split check.

  • False - The check is not a split check.

split_cnt

The split count, if the check is a split check.

chldEntts

Indicates the child entities, if any.

For example, if an item with modifier is added, modifier will be the child entity.

Updated Documentation: Agilysys InfoGenesis Event Notifications Reference Guide