Wiresk

Wiresk

Nham24 Connection & Settings

Estimated reading time: 14 min
Nham24 banner

Nham24 is a food delivery platforms. It functions as an online marketplace connecting customers with local restaurants, cafes, and grocery stores. Users can order meals, beverages, and other products via the Nham24 mobile app or website, and have them delivered to their doorsteps.

Integrating Nham24 with Wiresk simplifies order management between merchants and customers. This integration allows for easy management of product catalogs such as: creation, retrieval, updating, and deletion (CRUD) of categories and items, order placement, and access to order history and earnings.

Prerequisite:
To use Nham24 with Wiresk, you must have a Nham24 Merchant account which is provided by Nham24 company.
See Nham24 API documentation on Postman here.

A connection to your Nham24 merchant account is needed so we can sync it with our platform.

There are two ways to connect your app to Wiresk:

  • In “My apps” section, where you can manage your connections (select or create your group first to get access to this section, refer to the Group system ).
  • While building your Flow, you can easily establish a connection to your app directly within the Flow builder. This can be done during the setup of either a Trigger or a Method.

In this documentation, we will explain how to create a connection in “My apps” section, it is essentially the same as when creating it on-the-go.

On the left panel of Wiresk user interface, go to “My apps” and click on the (+) button. 

Search “Nham24” in the search field or scroll down the list of apps and choose the Nham24 icon.

Screenshot of Wiresk"my apps" tab. Red arrows point to search bar and Nham24 icon.

In the prompted screen:

Screenshot of Wiresk Add apps screen. It shows the connection screen of Nham24. red arrows point to different fields for the connection setting.

Give a name to the connection.

Enter the Credentials information provided by Nham24 company, such as :

  • Nham24 URL
  • Nham24 Username
  • Nham24 Password

Then click on “Create App” button, voila! Your Nham24 app connection is created, you can now use that connection in your Flow.

After linking Nham24 to Wiresk, you can start creating your Flows.

Select your Group, then on the Flow management screen click on “Create Flow”.

Animated image GIF, shows where to click to create a Flow in Wiresk. first select a group then click on create Flow.
Flows can be executed by multiple Triggers, depending on the desired workflow. For example, you could use scheduled Triggers with different recurrence rules alongside a Webhook Trigger for immediate, event-driven runs of the Flow. If you choose to “Run Once“, the Flow will execute using only one Trigger and its sample data.

On the new screen, name the Flow that you want to create.

Add your Trigger by clicking on the red plus (+) Add button.

Screenshot of a Flow setting screen. Red arrows point to different fields like Flow name, and Add Triggers button.

On the Trigger selection screen, search your app or select it from the list below the screen.

Screenshot of Nham24 Trigger search and selection. White background, arrows that point to search field and Nham24 logo.

Select your preferred Trigger on the next screen and customize its settings. (For Nham24 Triggers, refer to the next step for configuration details.)

As mentioned in “How to connect your app to Wiresk” above, during your Trigger settings, you can create a new connection to your apps at this stage.

Check here for a detailed Tutorial step-by-step on how to create a Flow.

An HTTP Trigger allows you to manually activate your Flows.

Click on the red plus button (+) again to add a Trigger for testing your Flow, then click on the button “HTTP Trigger”.

Screenshot of Wiresk HTTP Trigger selection. in manual configuration section, an arrow point to HTTP Trigger.

Write a description and select your API key or create a new one.

Screenshot of HTTP Trigger setting screen. Arrows shows fields that need to be filled and selected for the settings. User need to add a description, select or create an API key.

Click on save. Now you can use your HTTP Trigger to Manually run your Flow.

The Method will perform a specific task on a particular app or service you’ve connected to Wiresk like get info or send emails.

You can add at least 1 or multiple Methods for complex Flows (a maximum of 255 Methods).

On the Flow builder screen, click on the plus button (+) next to the Trigger icon.

Screenshot of Wiresk Flow Builder, showing Trigger icon and arrow pointing to a plus button. This button is use to add Methods in Wiresk.

Search or scroll down to select your apps Methods, then configure it settings. For more details, see Methods list and setting section in this documentation.

If you want to build a complex Flow, Wiresk offers a selection of tools at your disposal. Refer to Wiresk’s Tools

To add Tools in your Flow, Follow the same step as adding the Methods. On the Flow builder screen, click on the plus button (+) then just click on the “Tool” tab and select the Tool that you want to add.

What will start your automation…

These Triggers will start your Flow automatically at a specific time or intervals instead of being triggered real-time event (Webhooks).

Get a list of all items from Nham24.

Example of use case:
Point of Sale (POS) Systems: Scanning and processing items during checkout.
☑️ The barcode can be used for quick item lookup.
☑️ Fields like name_en, price, and recommended provide information at the point of sale.
 
Price Management:
☑️ The price field would be crucial for pricing strategies, enabling businesses to update, review, and modify pricing for each product.
☑️ The price could be used in various pricing models like discounts, dynamic pricing, or promotional offers.

Configuration Table:

Name*Get Item List
Connection*Select your connection or create one.
Time outYou can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage.
Recurrence rule/scheduler*Set up your recurrence rule.

(*) required field

Before saving your Trigger, don’t forget to use “Get Sample”.

Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
FieldTypeDescription
ref_idstringThe reference ID of the item.
name_enstringThe name of the item in English.
desc_enstringThe description of the item in English.
pricenumberThe price of the item.
statusstringThe status of the item.
barcodestringThe barcode of the item.
recommendedbooleanIndicates if the item is recommended to customers.
imagestringThe URL of the item’s image.
created_atstringThe timestamp of when the item was created.

This Trigger will regularly monitor Nham24 for incoming orders.
 
Use Case example:
Managing and Processing New Orders
☑️ Real-Time Monitoring, Allows restaurants, delivery agents, and platform administrators to monitor new orders in real time.
☑️ The method retrieves orders with the status “New,” along with detailed information about each order.

Configuration Table:

Name*Check New Order
Connection*Select your connection or create one.
Time outYou can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage.
Recurrence rule/scheduler*Set up your recurrence rule.
Parameters
Include previous orders
Yes – No		Selecting Yes retrieve all existing orders. Choosing No shows only orders created since the last time the flow was executed.
Preview DataIn this tab, you can preview the retrieved data.
In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available”, or “Cannot read properties of null ” will be displayed.

(*) required field

Before saving your Trigger, don’t forget to use “Get Sample”.

Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
FieldTypeDescriptionValue Sample
order_nostringThe unique identifier for the order.2418189271
statusstringThe current status of the order.New
count_itemsintegerThe number of items in the order.2
order_datestringThe date and time the order was placed.2024-03-13 4:45 PM
sub_totalnumberThe subtotal of the order before charges.20
packaging_chargenumberThe charge for packaging.2
commissionnumberThe commission amount for the order.2
taxnumberThe tax applied to the order.1
service_chargenumberThe service charge applied to the order.0
offer_discountnumberThe discount applied due to offers.0
offer_delivery_discountnumberThe discount applied on delivery.0
totalnumberThe total amount for the order.10
is_new_customerbooleanIndicates if the customer is new.false
need_utensilstringIndicates if utensils are needed.no
company_idstringThe identifier for the associated company.8080
order_details.order_detail_idstringThe unique ID of the order detail.4181741
order_details.category_ref_idstringThe category reference ID of the item.QBPQSUN65TF2
order_details.item_idstringThe unique ID of the item.717536
order_details.item_ref_idstringThe reference ID of the item.ZYXXUDPQM5GK
order_details.qtyintegerThe quantity of the item.2
order_details.original_pricenumberThe original price of the item.3
order_details.unit_pricenumberThe price per unit of the item.3
order_details.discountnumberThe discount on the item.0
order_details.total_pricenumberThe total price for the item.10
order_details.food_namestringThe name of the food item.Moist-Vanilla
order_details.statusstringThe status of the food item.Active
order_details.food_imagestringThe URL of the item’s image.https://s3-ap-southeast-1.amazonaws.com/go24dev/upload/MenuItem/image-sample.png
order_details.instructionstringSpecial instructions for the item.Tear it carefully
order_details.barcodestringThe barcode of the item.I0003
order_details.remarkstringRemarks or comments for the item.special offer
order_details.price_option.idstringThe ID of the price option.1232506
order_details.price_option.namestringThe name of the price option.Regular
order_details.price_option.pricenumberThe price of the option.1
order_details.price_option.ref_idstringThe reference ID of the price option.ZYXXUDPQM5GK_opt_price
order_details.modifier_group.name[0].idstringThe ID of the modifier.12325062
order_details.modifier_group.name[0].namestringThe name of the modifier.cream
order_details.modifier_group.name[0].pricenumberThe price of the modifier.1
order_details.modifier_group.name[0].ref_idstringThe reference ID of the modifier.ZYXXUDPQM5GK_opt_price
totalnumberThe total amount across all orders.20
total_dispatchedintegerThe total number of dispatched orders.2
total_processingintegerThe total number of processing orders.1
total_newintegerThe total number of new orders.1

This Method is a crucial API endpoint for retrieving a list of orders and their associated details.
 
Example of use cases:
Order Management for Vendors
Vendors or restaurants can use this method to:
☑️ View the list of incoming orders (e.g., new, processing, or dispatched).
☑️ Track the status of multiple orders.
☑️ new customers through the is_new_customer field.
☑️ Access detailed order items and modify workflows (e.g., preparing food, packaging).
 
Integration with Third-Party Applications
Third-party applications or partners can:
☑️ Retrieve and display order lists for delivery management apps.
☑️ Use the order details to integrate with accounting, inventory, or CRM systems.
☑️ Enhance order insights by combining the data with analytics platforms.
 
Inventory and Stock Management
☑️ Restaurants or stores can:
☑️ Use item details (qty, food_name, and category_ref_id) to track inventory depletion.
☑️ Adjust stock levels based on count_items and order frequencies.

Configuration Table:

Name*Get Order List
Connection*Select your connection or create one.
Time outYou can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage.
Recurrence rule/scheduler*Set up your recurrence rule.
Parameters
StatusFilter the retrieve list by status :
New
Processing
Dispatched
Delivered
Canceled
Store Declined
Preview DataIn this tab, you can preview the retrieved data.
In specific Trigger instances, data can only be previewed when it is available for retrieval. If no event occurs from the Trigger, a message “No data available”, or “Cannot read properties of null ” will be displayed.

(*) required field

Before saving your Trigger, don’t forget to use “Get Sample”.

Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
FieldTypeDescriptionValue Sample
order_nostringThe unique order number.2418189271
statusstringThe current status of the order.New
count_itemsintegerThe number of items in the order.2
order_datestringThe date and time of the order.2024-03-13 4:45 PM
sub_totalnumberThe subtotal amount of the order.20
packaging_chargenumberThe charge for packaging the order.2
commissionnumberThe commission charged on the order.2
taxnumberThe tax charged on the order.1
service_chargenumberThe service charge applied to the order.0
offer_discountnumberThe discount applied to the order.0
offer_delivery_discountnumberThe delivery discount applied to the order.0
totalnumberThe total payable amount for the order.10
is_new_customerbooleanIndicates if the customer is new.false
need_utensilstringWhether utensils are needed for the order.no
company_idstringThe ID of the company fulfilling the order.8080
order_details.order_detail_idstringThe unique ID for the order detail.4181741
order_details.category_ref_idstringThe category reference ID.QBPQSUN65TF2
order_details.item_idstringThe unique ID of the item.717536
order_details.item_ref_idstringThe reference ID of the item.ZYXXUDPQM5GK
order_details.qtyintegerThe quantity of the item ordered.2
order_details.original_pricenumberThe original price of the item.3
order_details.unit_pricenumberThe unit price of the item.3
order_details.discountnumberThe discount applied to the item.0
order_details.total_pricenumberThe total price for the item(s).10
order_details.food_namestringThe name of the food item.Moist-Vanilla
order_details.statusstringThe status of the food item.Active
order_details.food_imagestringThe URL of the food item image.https://s3-ap-southeast-1.amazonaws.com/go24dev/upload/MenuItem/sample-image.png
order_details.instructionstringThe special instruction for the item.Tear it carefully
order_details.barcodestringThe barcode of the food item.I0003
order_details.remarkstringAny remarks about the food item.special offer
order_details.price_option.idstringThe ID of the price option.1232506
order_details.price_option.namestringThe name of the price option.Regular
order_details.price_option.pricenumberThe price of the price option.1
order_details.price_option.ref_idstringThe reference ID of the price option.ZYXXUDPQM5GK_opt_price
order_details.modifier_group.name.idstringThe ID of the modifier group name.12325062
order_details.modifier_group.name.namestringThe name of the modifier group.cream
order_details.modifier_group.name.pricenumberThe price of the modifier group name.1
order_details.modifier_group.name.ref_idstringThe reference ID of the modifier group name.ZYXXUDPQM5GK_opt_price
totalnumberThe total value of all orders.20
total_dispatchednumberThe total number of dispatched orders.2
total_processingnumberThe total number of processing orders.1
total_newnumberThe total number of new orders.1

This Method is used to retrieve a list of categories along with their details.
 
Example of possible use of this Method:
API Integration
Use Case: Provide structured data for third-party integrations.
☑️ Allow other platforms or apps to fetch the category list via APIs.
☑️ Enable seamless integration with external systems, such as inventory or delivery platforms.

Menu Management
Use Case: Automatically populate and organize menus.
☑️ Sync the categories (name_en, name_kh, name_zh) with the restaurant’s digital menu.
☑️ Use the sequence field to control the display order of categories for better organization (e.g., starters, mains, desserts).
☑️ Update or modify menu items linked to these categories without manual re-entry.

Inventory Management
Use Case: Link categories with inventory items for stock tracking.
☑️ Associate categories with specific inventory groups to monitor stock levels accurately (e.g., “Seafood,” “Beverages”).
☑️ Enable automated stock updates when items from a category are sold.

Configuration Table:

Name*Get Category List
Connection*Select your connection or create one.
Time outYou can additionally set the Trigger duration to limit the information processed per execution to optimize performance and resource usage.
Recurrence rule/scheduler*Set up your recurrence rule.

(*) required field

Before saving your Trigger, don’t forget to use “Get Sample”.

Mapping Table from this Trigger (use this table to Map your Methods “Input” fields>Input tab>uncheck “Show recommended” to see all fields).
FieldTypeDescriptionValue Sample
ref_idstringThe unique reference ID of the category.EIZTORKF9VYW
name_enstringThe name of the category in English.Japan Food
name_khstringThe name of the category in Khmer.Japan Food KM
name_zhstringThe name of the category in Chinese.Japan Food ZH
desc_enstringThe description of the category in English.Description EN
desc_khstringThe description of the category in Khmer.Description KH
desc_zhstringThe description of the item in Chinese.Description ZH
sequenceintegerThe number ordering of the category.1
statusstringThe status of the category.Active
created_atstringThe timestamp of when the category was created.2023-09-26 10:11:25

What your automation will do…

This Method is used to update the status of an order.
 
Example of use cases for POS and Restaurant Management:
Staff Task Assignment
Use Case: Assigning specific tasks to staff members.
☑️ Once the API confirms the order’s acceptance, the POS system can:
☑️ Notify chefs to start preparing the items.
☑️ Queue up pickup orders for packaging.

Multichannel Order Management
Use Case: Consolidating orders from multiple channels.
☑️ Orders from online platforms, in-house kiosks, or phone calls are processed centrally in the POS system.
☑️ The “accept” status syncs across all platforms to prevent duplicate processing.
 
Queue Management
Use Case: Prioritizing orders effectively.
☑️ Accepted orders are added to a “processing” queue in the POS system, helping staff focus on active tasks.
☑️ Reduces bottlenecks and ensures timely preparation and delivery.
 
Inventory Adjustment
Use Case: Syncing order acceptance with stock levels.
☑️ Once an order is accepted, the POS system can automatically deduct ingredients or items from the inventory.
☑️ Helps maintain real-time stock levels and prevents overselling.

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Accept an Order
Connection*Select your connection or create one.
Map Fields
Order Number*Order number to accept (you can get the order number from the Trigger “Check New Order“, then map the field order_no to the input field).

Order Accepted : "message": "success", "code": 0

Failed to accept : error code and message :
1, This order is already cancelled.
2, This order is already accepted.
3, This order is already declined.
4, This order is already processed.

(*) required field

This Method creates a new item or category in Nham24.
 
Use case example:
Dynamic Menu Management
Use Case: Quickly add new items or categories to the menu.
☑️ For Categories: Create new sections (e.g., “Appetizers,” “Seasonal Specials”) in the menu hierarchy.
☑️ For Items: Add newly introduced dishes, drinks, or promotional items to the menu in real-time.
 
Real-Time Updates Across Platforms
Use Case: Synchronizing menu updates with delivery platforms.
☑️ Newly created categories and items are pushed to third-party platforms (e.g., food delivery apps) via the POS system.
☑️ Ensures consistency across all customer-facing channels.

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Create
Connection*Select your connection or create one.
Entity*Select to create a new category or items
Create category – Map Fields [+ Add Field] you can add optional fields:
Name KH, Name ZH, Description EN, Description KH, Description ZH, Sequence.
Reference ID*The reference ID for the category.
Name EN*The English name of the category.
Status*Active – Inactive, The status of the category.
Category optional fieldsName KH: The Khmer name of the category.
Name ZH: The Chinese name of the category.
Description EN: The English description of the category.
Description KH: The Khmer description of the category.
Description ZH: The Chinese description of the category.
Sequence: The order of the category to display.
Create items – Map Fields [+ Add Field] you can add optional fields:
Name KH, Name ZH, Description EN, Description KH, Description ZH, Barcode, Image, Recommended, Option Prices, Modifier Group.
Reference ID*Reference ID of the item. Value example: “ref_id”: “125“
Reference Category ID*Reference category ID of the item. Value example: “ref_id”: “XMM59L3KB2JP”
Name EN*Name of the item in English.
Status*Active – Inactive, Status of the item.
Option Prices*[+Element] you can add multiple option prices.


Reference ID*: The reference ID of the item price.
Name*: The name of the item price.
Price* : price of the item.
Status*: Active – Inactive, the status of the item price.
Default*: If this price is the default price selected for customers. Yes – No

Option Prices Value Example :
"option_prices": [
{
"ref_id": "167",
"name": "Unbranded",
"price": 3.1,
"status": "active",
"default": true
Item optional fieldsName KH: The name of the item in Khmer.
Name ZH: The name of the item in Chinese.
Description EN: The description of the item in English.
Description KH: The description of the item in Khmer.
Description ZH: The description of the item in Chinese.
Barcode: The barcode of the item.
SKU: The stock keeping unit of the item.
Enable Stock: Indicates if the stock is enabled for the item.
Stock Balance: The stock balance of the item.
Image: The URL of the item’s image.
Recommended: Yes – No, indicates if the item is recommended.

Modifier Group: The different options that a consumer can select within an item.
For example: Choice of Crust, Sugar Level, Extra Toppings.

[+Element] you can add multiple Modifier group :
__Name*: The name of item modifier group
__Type*: The type of item modifier group (single or multiple)
__Required*: Yes – No, if the item type is single, modifier group is require for customer to select.
__Minimum: Minimum modifier that customer can select (Mandatory when type = multiple).
__Maximum: Maximum modifier that customer can select (Mandatory when type = multiple).

__Modifiers*: Are the selections within a modifier group.
For example: 100% Sugar, 50% Sugar, No Ice.

[+Element] you can add multiple Modifiers:
. Reference ID*: The reference ID of the modifier.
. Name*: The name of the modifier.
. Price*: The price of the modifier.
. Status*: Active – Inactive, the status of the modifier.
. Sequence*: The order of the modifier to display.

Modifier Group Value Example :
"modifier_group": [
{
"name": "payment",
"type": "single",
"required": false,

"modifiers": [
{
"ref_id": "47",
"name": "Toys",
"price": 0.0,
"status": "active",
"display_order":1
},]
}
]

(*) required field

This Method is used to decline an order.
 
Use case examples for a tiered app POS and Restaurant Management solution:
Multi-Channel Order Management
Use Case: Synchronizing declines across platforms.
☑️ Orders placed via external channels (e.g., delivery apps Nham24) are synced back to the POS system with the updated declined status.
☑️ Ensures consistency across all order management systems.

Analytics and Reporting
Use Case: Tracking declined orders for insights.
☑️ Record reasons for declined orders to identify trends (e.g., frequent ingredient shortages or peak-hour overloads).
☑️ Use this data to optimize operations and reduce the number of declined orders.

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Decline an Order
Connection*Select your connection or create one.
Map Fields
Order Number*Order number to decline (you can get the order number from the Trigger “Check New Order“, then map the field order_no to the input field).

Order declined : "message": "success", "code": 0

Failed to decline : error code and message :
1, This order is already cancelled.
2, This order is already accepted.
3, This order is already declined.
4, This order is already processed.
Reason*Reason for the decline order.
Message*Message to display for customers.

(*) required field

This Method is used to delete a record (Category or Item).
 
Use case examples for a tiered app POS and Restaurant Management solution:
Multi-Channel Synchronization
Use Case: Syncing menu changes across platforms.
☑️ When a category or item is deleted, the change propagates across all platforms connected to the POS, such as:
— In-store kiosks.
— Online ordering systems.
— Third-party delivery apps.
☑️ Ensures a unified menu experience for customers.
 
Dynamic Menu Adjustments
Use Case: Adapting to real-time changes.
☑️ In cases of sudden unavailability (e.g., sold-out items or supply issues), items can be quickly deleted to reflect the current offering.
☑️ Ensures accurate inventory representation across all platforms.

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Delete
Connection*Select your connection or create one.
Entity*Select Category or Item to delete.
Map Fields
Delete Category:Reference ID*: You can get the category reference ID from the Method “List” Category.
Delete Items:Reference ID*: You can get the item reference ID from the Method “List” Item.

(*) required field

This Method provides information about the revenue or earnings generated from delivered orders.
 
Use case examples:
Financial Tracking and Reporting
Use Case: Providing detailed financial insights.
☑️ Restaurants can view earnings from completed orders, track trends, and reconcile revenues daily, weekly, or monthly.
☑️ Supports financial reporting, tax calculations, and performance analysis for the business.
 
Real-Time Dashboard Updates
Use Case: Displaying up-to-date earnings on POS dashboards.
☑️ Integrates the earning history into a live dashboard, allowing restaurant managers to monitor earnings at a glance.
 
Integration with Accounting Systems
Use Case: Automating data export for bookkeeping.
☑️ The earning history can be synced with accounting software to automate entries for completed orders, ensuring accurate records without manual input.

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Earning Order
Connection*Select your connection or create one.
Map Fields
From Date*Select the starting date of the completed order to retrieve.
To Date*Select the end date of the completed order to retrieve.

Result example:

{
"order_no": "1951913299",
"order_date": "2021-01-15 7:44 PM",
"earned": 2.592,
"status": "Delivered"
},

{
"order_no": "1407672788",
"order_date": "2021-01-15 7:44 PM",
"earned": 3.825,
"status": "Delivered"
}

(*) required field

Use this Method to find a single Record (Category, Item, order) by adding Matching Criterias. Return error when 0 or more than 1 record found.
 
Use case examples:
Centralized Data Retrieval.
Use Case: Quickly accessing specific records.
☑️ For categories: Retrieve category details (e.g., name, description, sequence) to display or update in the POS menu.
☑️ For items: Access specific menu items (e.g., ingredients, price, stock status) for customer inquiries or order customization.
☑️ For orders: Fetch order details for tracking, updates, or customer support.
 
Data Consistency Across Platforms
Use Case: Synchronizing data between the POS and third-party platforms.
☑️ Fetch specific categories or items to ensure the POS menu aligns with online menus on delivery apps or websites.
☑️ Ensures accurate display of data, such as pricing, descriptions, and availability.

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Find
Connection*Select your connection or create one.
Entity*Select Category, Item or order to retrieve details.
Map Fields
Find a specific Category:
Matching Criteria*[+ Add Matching] filter the search by :
Name: Name of the category to find.
Reference ID: Reference ID of the Category to find.

You can use condition logic such as:
Equal
Does not equal
Contain
Not contain
Find a Specific Item:Reference ID*: Reference ID of the item.

You can use condition logic such as:
Equal
Does not equal
Contain
Not contain
Find a Specific Order:Order Number*: Number of the order to find.

You can use condition logic such as:
Equal
Does not equal
Contain
Not contain

(*) required field

List all records (Category, Item, Order) and optionally filter the result by matching criteria.
 
Use case examples:
Centralized Data Display
Use Case: Display all records for categories, items, or orders in the POS system.
☑️ For categories: Populate the restaurant’s menu structure in the POS or app.
☑️ For items: Display the full list of menu items with details like pricing, availability, and descriptions.
☑️ For orders: Show all recent or historical orders for tracking and management.
 
Real-Time Data Synchronization
Use Case: Keep menus and order data up-to-date across platforms.
☑️ Synchronize menu data between the POS system, online ordering platforms, and third-party delivery apps.
☑️ Ensure accurate order status updates in real-time for both staff and customers.

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*List
Connection*Select your connection or create one.
Entity*Select Category, Item or order to list.
Map Fields
List Category:
Matching Criteria[+ Add Matching] filter the result by :
Name: Name of the category to list.

You can use condition logic such as:
Equal
Does not equal
Contain
Not contain
List Item:Matching Criteria[+ Add Matching] filter the result by :
Name: Name of the item to list.

You can use condition logic such as:
Equal
Does not equal
Contain
Not contain
List Order:Matching Criteria[+ Add Matching] filter the result by :
Order Number: Number of the order to find.

You can use condition logic such as:
Equal
Does not equal
Contain
Not contain

(*) required field

This Method is used to update a Category or Item with the specified ID.
 
Use case examples:
Real-Time Menu Updates
Use Case: Keeping the menu updated.
☑️ For categories: Update category names, descriptions, or sequences to reflect changes in the menu structure.
Example: Renaming “Lunch Specials” to “Brunch Favorites.”
☑️ For items: Adjust item details such as prices, availability, or descriptions in real-time.
Example: Changing the price of a dish during happy hours or marking it as unavailable.
 
Centralized Menu Management for Multi-Branch Restaurants
Use Case: Standardizing or localizing menu options.
☑️ Update categories or items across multiple branches to ensure consistency.
Example: Updating a category like “Signature Dishes” for all locations.
☑️ Alternatively, customize items for branch-specific menus (e.g., adding regional dishes).

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Update Record
Connection*Select your connection or create one.
Entity*Select category or item to update.
Create category – Map Fields [+ Add Field] you can add optional fields:
Name EN, Name KH, Name ZH, Description EN, Description KH, Description ZH, Sequence.
Reference ID*The reference ID of the category to update.
Status*Active – Inactive, The status of the category.
Category optional fieldsName EN: The English name of the category.
Name KH: The Khmer name of the category.
Name ZH: The Chinese name of the category.
Description EN: The English description of the category.
Description KH: The Khmer description of the category.
Description ZH: The Chinese description of the category.
Sequence: The order of the category to display.
Create items – Map Fields [+ Add Field] you can add optional fields:
Name KH, Name ZH, Description EN, Description KH, Description ZH, Barcode, Image, Recommended, Option Prices, Modifier Group.
Reference ID*Reference ID of the item to update. Value example: “ref_id”: “OJT1QADNOOCP”
Reference Category ID*New reference category ID of the item. Value example: “ref_id”: “XMM59L3KB2JP”
Name EN*New name of the item in English.
Status*Active – Inactive, update the status of the item.
Update Option Prices*[+Element] add elements to update multiple option prices.

Reference ID*: The reference ID of the item price to update.
Name*: New name of the item price.
Price* : New price of the item.
Status*: Active – Inactive, new status of the item price.
Default*: If this price is the default price selected for customers. Yes – No

Value Example :

"option_prices": [
{
"ref_id": "56",
"name": "Verde",
"price": 3.1,
"status": "active",
"default": true
}
Update Item optional fieldsName KH: New name of the item in Khmer.
Name ZH: New name of the item in Chinese.
Description EN: New description of the item in English.
Description KH: New description of the item in Khmer.
Description ZH: New description of the item in Chinese.
Barcode: The barcode of the item.
SKU: The stock keeping unit of the item.
Enable Stock: Indicates if the stock is enabled for the item.
Stock Balance: The stock balance of the item.
Image: The URL of the item’s image.
Recommended: Yes – No, indicates if the item is recommended.

Modifier Group The different options that a consumer can select within an item.
For example: Choice of Crust, Sugar Level, Extra Toppings.

[+Element] you can add multiple Modifier group :
__Name*: The name of item modifier group
__Type*: The type of item modifier group (single or multiple)
__Required*: Yes – No, if the item type is single, modifier group is require for customer to select.
__Minimum: Minimum modifier that customer can select (Mandatory when type = multiple).
__Maximum: Maximum modifier that customer can select (Mandatory when type = multiple).

__Modifiers*: Are the selections within a modifier group.
For example: 100% Sugar, 50% Sugar, No Ice.

[+Element] you can add multiple Modifiers:
. Reference ID*: The reference ID of the modifier to update.
. Name*: New name of the modifier.
. Price*: New price of the modifier.
. Status*: Active – Inactive, the status of the modifier.
. Sequence*: New order of the modifier to display.

Modifier Group Value Example :

"modifier_group": [
{
"name": "Incredible",
"type": "single",
"required": false,

"modifiers": [
{
"ref_id": "69",
"name": "Berkshire",
"price": 0.0, "status":
"active", "display_order":1
},
{
"ref_id": "698",
"name": "Uruguay",
"price": 0.0,
"status": "active",
"display_order":1
}

(*) required field

This Method update the status of a Category or item with the specific ID.
Keep in Mind, you can get those ID from Mapping from Triggers or a previous step.
 
Use case example:
Managing Menu Availability
Use Case: Toggle the availability of categories or items in real-time.
☑️ Mark a category like “Desserts” or an item like “Chocolate Cake” as unavailable when out of stock or during specific times.
☑️ Ensures that customers and staff see only available options, reducing errors and dissatisfaction.
 
Real-Time Updates Across Platforms
Use Case: Synchronize status changes across multiple sales channels.
☑️ If a menu item or category is updated in the POS system, the change is reflected instantly on other platforms like:
— In-house kiosks.
— Online ordering apps (e.g., Nham24).

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Update Status
Connection*Select your connection or create one.
Entity*Select category or item to update their status.
Update Category Status Reference ID*: The reference ID of the category to update.
Status*: Active – Inactive, The status of the category.
Update Item Status Reference ID*: The reference ID of the item to update.
Status*: Active – Inactive, The status of the item.

(*) required field

Use case example: POS and restaurant management system
 
Store Opening and Closing
Use Case: Dynamically manage store hours.
☑️ Mark the store as “Open” when it is ready to receive orders.
☑️ Change the status to “Closed” at the end of operating hours or during unexpected closures.
☑️ Automatically sync with predefined schedules in the POS system.
 
Real-Time Status Updates Across Platforms
Use Case: Synchronize status changes across all channels.
☑️ Ensure that the store status is reflected consistently in:
— Nham24’s platform.
— The restaurant’s POS system.
— Other integrated third-party delivery apps.

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Update Store Status
Connection*Select your connection or create one.
Update Store Status Status*: Available – Not Available

(*) required field

This Method is used to update a Category or Item with the specified ID. If The ID is not found, a new record will be created with the filled information.

Configuration Table:

Input Options:

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: You can specify a fixed attribute.
Name*Upsert
Connection*Select your connection or create one.
Entity*Select to create a new category or items
Create category – Map Fields [+ Add Field] you can add optional fields:
Name KH, Name ZH, Description EN, Description KH, Description ZH, Sequence.
Reference ID*The reference ID for the category.
Name EN*The English name of the category.
Status*Active – Inactive, The status of the category.
Category optional fieldsName KH: The Khmer name of the category.
Name ZH: The Chinese name of the category.
Description EN: The English description of the category.
Description KH: The Khmer description of the category.
Description ZH: The Chinese description of the category.
Sequence: The order of the category to display.
Create items – Map Fields [+ Add Field] you can add optional fields:
Name KH, Name ZH, Description EN, Description KH, Description ZH, Barcode, Image, Recommended, Option Prices, Modifier Group.
Reference ID*Reference ID of the item. Value example: “ref_id”: “OJT1QADNOOCP”
Reference Category ID*Reference category ID of the item. Value example: “ref_id”: “XMM59L3KB2JP”
Name EN*Name of the item in English.
Status*Active – Inactive, Status of the item.
Item optional fieldsName KH: The name of the item in Khmer.
Name ZH: The name of the item in Chinese.
Description EN: The description of the item in English.
Description KH: The description of the item in Khmer.
Description ZH: The description of the item in Chinese.
Barcode: The barcode of the item.
SKU: The stock keeping unit of the item.
Enable Stock: Indicates if the stock is enabled for the item.
Stock Balance: The stock balance of the item.
Image: The URL of the item’s image.
Recommended: Yes – No, indicates if the item is recommended.

Option Prices [+Element] you can add multiple option prices.
__Reference ID*: The reference ID of the item price.
__Name*: The name of the item price.
__Price* : price of the item.
__Status*: Active – Inactive, the status of the item price.
__Default*: If this price is the default price selected for customers. Yes – No

Option Price Value Example :
"price_option": { "id": 1095112,
"name": "small",
"price": 0,
"ref_id": "e156759d-1c7f-4e80-9202-151f4c9e7e67" },

Modifier Group: The different options that a consumer can select within an item.
For example: Choice of Crust, Sugar Level, Extra Toppings.

[+Element] you can add multiple Modifier group :
__Name*: The name of item modifier group
__Type*: The type of item modifier group (single or multiple)
__Required*: Yes – No, if the item type is single, modifier group is require for customer to select.
__Minimum: Minimum modifier that customer can select (Mandatory when type = multiple).
__Maximum: Maximum modifier that customer can select (Mandatory when type = multiple).

__Modifiers*: Are the selections within a modifier group.
For example: 100% Sugar, 50% Sugar, No Ice.

[+Element] you can add multiple Modifiers:. Reference ID*: The reference ID of the modifier.
. Name*: The name of the modifier.
. Price*: The price of the modifier.
. Status*: Active – Inactive, the status of the modifier.
. Sequence*: The order of the modifier to display.

Modifier Value Example :
"ice": [ { "id": 1095116,
"name": "less ice",
"price": 0,
"ref_id": "abe2409b-bf4b-402f-ad44-df7d11a2ee92"

(*) required field


After setting up your Flow, you can choose to:

  • “Run once”, your Flow will run only a single time. You can use this function to test your Flow. Refer to how to set up an HTTP Trigger, in the “Create a Flow” step.
  • “Run Scheduler” will automate your Flows with the recurrence rule you previously defined.


For more details, refer to How to run a Flow tutorial in our Help Center.
 
If you are using a Webhook Trigger, the Flow will initiate automatically when a webhook is received from your connected apps. This means that the Flow is automated without a scheduler and will run until you deactivate the Flow manually. Refer to Webhook documentation in our Help Center.

Wiresk makes things easier for you! Check our Templates Gallery to discover various ready to use cases.
If you need an integration that you cannot find in Wiresk, you can make a request to our team, and we will try our best to satisfy your needs.