Using the Order Logging Module

The Hyra Order Logging API is an advanced, real-time solution for monitoring and managing the lifecycle of an order. It offers comprehensive visibility from the moment an order is placed to when it’s ready for pickup, tracking each participant involved.

​

Ready made scripts

Hyra provides some out of the box solutions for order logging for popular solutions.

• HandTo System by r_r

​

Order Status Lifecycle

Each order must have a status associated with it. Depending on your system, you may decide to use different statuses. The following statuses are available:

• handed_to - The order has been handed to the customer
• submitted - The order has been submitted by the cashier
• waiting_for_preparation - The order is waiting for preparation by a chef or other staff member
• finding_new_colleague - The order is waiting for a new colleague to take over preparation (for example, if the previous chef left the game)
• preparing - The order is being prepared by a chef or other staff member
• completed - The order has been completed
• waiting_for_pickup - The order is waiting for pickup by the customer or a delivery person
• cancelled - The order has been cancelled

​

Requiring the module

The module used for Order Logging is stateful and persists its authentication state with the Hyra API. If you use a single script order solution, you can directly require the module as follows:

local orderLog = require(15254660066)

If you use multiple scripts, you can create a module script exporter. You need one of these to maintain the state of the module across several scripts.

​

Authentication

To authenticate, input your unique apiKey and workspaceId at the beginning of your main script:

orderLog.setupAPI(apiKey, workspaceId)

You only need to do this once per game server.

​

Interacting with the module

orderLog.createOrder(customer, actor, {
    items = {"item 1", "item 2"},
    status = "waiting_for_preparation",
})

orderLog.setWaiting("653db4bb1e3727cc1851ac07")