Restroworks icon

Restroworks

End-to-end restaurant OS spanning POS, kitchen display, menu engineering, and multi-outlet reporting.

1 trigger15 searches14 actionsPollingAuth: API key

AI-assisted documentation11 min read

This documentation is compiled from our integration source code, internal specs for Restroworks, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Restroworks on WEXTL →

Connecting Restroworks takes an active account plus an API access token from your account settings — no other setup is required.[3]

  • API KeypasswordRequired

    Log in to your Restroworks, go to Settings → Developer/Integrations/API, generate an API key, and copy it to store securely.

    [1]
  • Customer KeypasswordRequired

    Log in to your Restroworks, go to Settings → Integrations/API/Developer, copy your Customer/Client Key from the API credentials section, or contact support if it isn’t enabled.

    [1]
  1. Log in to your WEXTL account, add the Restroworks node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Restroworks account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch InvoicesTrigger
Output fields[3]
FieldType
Invoice numbertext
Reported ondate
Net salesnumber
Total taxnumber
Gross salesnumber
Discountnumber
Return valuenumber
Get a Tracking URLAction
Input fields[3]
FieldType
Order IDRequired
text
Tracking URLRequired
url
Get BillsSearch
Input fields[3]
FieldType
FromRequired
date
ToRequired
date
Limitnumber
Output fields[3]
FieldType
Detailarray
Total amountnumber
Card typetext
Get Coupon and Reward DetailsAction
Input fields[3]
FieldType
Your URL EndpointRequired
url
Merchant IDRequired
text
Coupon CodeRequired
text
Customer MobileRequired
text
Output fields[3]
FieldType
Coupon nametext
Coupon codetext
Discount ontext
Discount typetext
Discount valuenumber
Commenttext
Get Delivery InfoAction
Input fields[3]
FieldType
Order IDRequired
text
Output fields[3]
FieldType
IDtext
Deployment IDtext
Customer keytext
Partner nametext
Bill numbertext
Order IDtext
Datetimedate
vnumber
Partner order IDtext
Accepted timedate
Tracking URLtext
Delivery boy mobiletext
Delivery boy nametext
Statustext
Delivery history dataarray
Is logisticsboolean
Delivery boy infoarray
Rejectionarray
Get Loyalty Customer DetailsAction
Input fields[3]
FieldType
Your URL EndpointRequired
url
Customer MobileRequired
text
Country CodeRequired
text
Table NumberRequired
number
Customer Loyalty IDtext
Country Codetext
Customer Metadataobject
First NameRequired
text
Last NameRequired
text
Emailemail
Customer Loyalty IDtext
Mobiletext
Output fields[3]
FieldType
Status codenumber
Responseobject
Customer meta dataobject
Loyalty pointsnumber
Allow redemption todayboolean
Min bill for redemptionnumber
Redemption cap on max bill percentagenumber
Couponsarray
Get Order StatusAction
Input fields[3]
FieldType
Order IDRequired
text
Get POS Bill DetailsAction
Input fields[3]
FieldType
Your URL EndpointRequired
url
Merchant IDRequired
text
Merchant UsernameRequired
text
Country CodeRequired
text
Country CodeRequired
text
Customerobject
NameRequired
text
Country CodeRequired
text
MobileRequired
text
Addresstext
EmailRequired
email
CityRequired
text
Date of Birthdate
Anniversary Datedate
StateRequired
text
Transactionobject
Transaction IDRequired
text
Transaction NumberRequired
text
Transaction TypeRequired
text
Tab NameRequired
text
Payment TypeRequired
text
Coupon Codetext
Bill Tender TypeRequired
array
Gross AmountRequired
number
Net AmountRequired
number
AmountRequired
number
Output fields[3]
FieldType
Points valuenumber
Get POS Customer DetailsAction
Input fields[3]
FieldType
Your URL EndpointRequired
url
Merchant IDRequired
text
Customerobject
Customer NameRequired
text
MobileRequired
text
Addresstext
Emailemail
Citytext
Date of Birthdate
Output fields[3]
FieldType
Messagetext
List IndentsSearch
Input fields[3]
FieldType
Start DateRequired
date
End DateRequired
date
Deployment AsRequired
text
Limitnumber
To Datedate
From Datedate
Output fields[3]
FieldType
Receive commenttext
Item nametext
Item codetext
Categoryobject
Supercategoryobject
Category codetext
Category nametext
IDtext
Supply commenttext
Supply subtotalnumber
Total supply taxnumber
Unitobject
IDtext
Conversion factornumber
Unit nametext
Base unitobject
Supply qtynumber
Pricenumber
List Inventory DataSearch
Input fields[3]
FieldType
EntityRequired
choice
From DateRequired
date
To DateRequired
date
Transaction Typechoice
Only Local GRNsboolean
Tenant IDtext
Limitnumber
Output fields[3]
FieldType
Sub totalnumber
Unit pricenumber
Quantitynumber
Base quantitynumber
Typenumber
Base pricenumber
Item nametext
Item codetext
Unitobject
Unit nametext
Conversion factornumber
Base unitobject
Categoryobject
Category nametext
Supercategoryobject
Taxesarray
List InvoicesSearch
Input fields[3]
FieldType
Start Datedate
End Datedate
Partnertext
Limitnumber
Output fields[3]
FieldType
Invoice numbertext
Reported ondate
Net salesnumber
Total taxnumber
Gross salesnumber
Discountnumber
Return valuenumber
List Menu ItemsSearch
Input fields[3]
FieldType
Limitnumber
Output fields[3]
FieldType
IDtext
Categoryobject
Super categoryobject
Category nametext
IDtext
Is add onboolean
Is comboboolean
Taxesarray
Preparation timeobject
Timenumber
Map itemsarray
Item variantsarray
Statustext
Ratenumber
Nametext
List Out of Stock ItemsSearch
Input fields[3]
FieldType
Limitnumber
Todate
Fromdate
Output fields[3]
FieldType
Item IDtext
Statustext
List Outlet TabsSearch
Input fields[3]
FieldType
Limitnumber
Todate
Fromdate
Output fields[3]
FieldType
IDtext
Tab typetext
Tab nametext
Menu Sync APISearch
Input fields[3]
FieldType
Last Sync Timedate
Current Sync Timedate
Tab IDtext
Limitnumber
Output fields[3]
FieldType
IDtext
Descriptiontext
Nametext
Categoryobject
IDtext
Nametext
Super category nametext
Super category IDtext
Is add onboolean
Is comboboolean
Is liquorboolean
Not in billingboolean
Ratenumber
Map addon itemsarray
Map combo itemsarray
Taxesarray
Countnumber
Numbertext
Is non vegboolean
Configurationtext
Base itemtext
Itemtext
Active statusarray
Assign a Delivery PersonAction
Input fields[3]
FieldType
Order IDRequired
text
Delivery Boy NameRequired
text
Delivery Boy MobileRequired
text
Authenticate Points RedemptionAction
Input fields[3]
FieldType
Your URL EndpointRequired
url
Customer MobileRequired
text
PointsRequired
number
PurposeRequired
text
Transactionobject
Transaction IDRequired
text
Itemsarray
Gross AmountRequired
number
AmountRequired
number
TypeRequired
text
NumberRequired
text
Merchant IDRequired
text
Output fields[3]
FieldType
Points valuenumber
Cancel an OrderAction
Input fields[3]
FieldType
Order IDRequired
text
ReasonRequired
text
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Order Delivery RejectedAction
Input fields[3]
FieldType
Order IDRequired
text
TimestampRequired
date
Delivery Boy NameRequired
text
ReasonRequired
text
Push an OrderAction
Input fields[3]
FieldType
Sourceobject
NameRequired
text
IDRequired
text
Order IDRequired
text
Paymentsobject
Payment TypeRequired
text
Discountobject
Discount TypeRequired
text
Discount ValueRequired
number
Offer Nametext
Chargesarray
Customerobject
First NameRequired
text
MobileRequired
text
Address TypeRequired
text
Address Line 1Required
text
Address Line 2text
CityRequired
text
Tab TypeRequired
text
Itemsarray
Push an Order to the KitchenAction
Input fields[3]
FieldType
Sourceobject
Client IDRequired
text
Order IDRequired
text
Organization Nametext
Original Sourcetext
Paymentsobject
Payment ModeRequired
choice
Order TypeRequired
choice
Delivery AreaRequired
text
Partner Deliveryboolean
Advance Orderboolean
Advance Order Detailsobject
Expected Delivery Timedate
Preparation Start Timedate
Discountobject
Discount Typechoice
Discount Valuenumber
Chargesarray
Customerobject
Customer NameRequired
text
Customer MobileRequired
text
Address Typetext
Address Line 1text
Address Line 2text
Citytext
Statetext
Date of Birthdate
Itemsarray
Delivery Instructionstext
Special Instructionstext
Triggersobject
Accept Callback URLurl
Reject Callback URLurl
Dispatch Callback URLurl
Prepared Callback URLurl
Output fields[3]
FieldType
vnumber
IDtext
Redeem a CouponAction
Input fields[3]
FieldType
Your URL EndpointRequired
url
Merchant IDRequired
text
Coupon CodeRequired
text
Customer MobileRequired
text
Bill NumberRequired
text
Output fields[3]
FieldType
Messagetext
Redeem Loyalty PointsAction
Input fields[3]
FieldType
Your URL EndpointRequired
url
Customer MobileRequired
text
PointsRequired
number
OTPRequired
text
TransactionRequired
object
Transaction IDRequired
text
ItemsRequired
array
Gross AmountRequired
number
AmountRequired
number
Typetext
Transaction Numbertext
Merchant IDRequired
text
Output fields[3]
FieldType
Points valuenumber
Update an OrderAction
Input fields[3]
FieldType
Order IDRequired
text
TimestampRequired
date
Update an OrderAction
Input fields[3]
FieldType
POS Order IDRequired
text
ActionRequired
choice
Commenttext
Output fields[3]
FieldType
Pos order IDtext
Actiontext
Commenttext
Watch Delivered OrdersAction
Input fields[3]
FieldType
Order IDRequired
text
TimestampRequired
date
Watch MenusAction
Output fields[3]
FieldType
Categoriesarray
Modifiersarray
Chargesarray
Box combo mappingarray
Settingsobject
Send categoriesboolean
Watch Order DeliveryAction
Input fields[3]
FieldType
Order IDRequired
text
TimestampRequired
date

Look for Restroworks templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Restroworks Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Restroworks.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:12