SmilePOS offers a premium suite of cutting-edge integrations for our global clientele, encompassing online ordering systems, POS platforms, delivery partners, and a wide array of digital solutions within the modern foodservice ecosystem.
\nThrough our robust and flexible open API, we empower seamless interoperability between your systems and ours—paving the way for impactful collaborations. Join us in shaping dependable, scalable solutions that elevate restaurant operations worldwide.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"43708621","collectionId":"d0335e02-6405-43c7-974a-58395ab26545","publishedId":"2sB2cSh3uw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-22T07:20:22.000Z"},"item":[{"name":"Menu","item":[{"name":"Sync","event":[{"listen":"test","script":{"id":"ec9062d5-14c5-4bfd-a3c9-8f0140d7da39","exec":[""],"type":"text/javascript","packages":{}}}],"id":"077bc5ca-0d6f-435d-9667-92329986d898","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"Key","type":"text"},{"key":"X-Server-Authorization","value":"Encryption","type":"text"},{"key":"uniqueIdentifier","value":"UUID","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"company\" : \"analogai\",\r\n \"storeLinkedOID\" : \"1776225568\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api-gateway.smiledining.com/external/api/v1/menu/sync","description":"This endpoint is used to synchronize the menu for a specific company.
\nMethod: POST
\nURL: https://api-gateway.smiledining.com/external/api/v1/menu/sync
\nHeader
\nX-Api-Key (this key is generated by SmilePOS)
\nThe API uses the POST method.
\nThe header contains two keys for HMAC authentication:
\nX-Server-Authorization – a key used for body encryption with a UUID.
\nuniqueIdentifier – the UUID.
\ncan verify or generate HMAC signatures using this HMAC Generator Tool
\nUsage Tips
\nChoose the correct hashing algorithm (SHA-256).
\nEnter your message (usually the raw request body).
\nUse the appropriate secret key (e.g., your X-Server-Authorization value).
\nThe generated HMAC should match the one sent in your API request header.
\nBody:
\ncompany (string, required): The name of the company for which the menu needs to be synchronized.
\nstoreLinkedOID (string, required): The unique identifier for the menu.
\nThe response for this request can be represented as a JSON schema. Below is a sample representation of the response schema:
\n{\n \"result\": null,\n \"status\": 1,\n \"message\": null\n}\n\nOnce this API is processed, the menu data will be sent to your webhook (endpoint). Below is the result.
\n{\n\"shop\": {\n \"name\": \"Fuji Sushi Bar Delivery\",\n \"address\": \"3828 196th St SW, Lynnwood, WA 98036, USA 98036\",\n \"phone\": \"2069059015\",\n \"timeZone\": \"Eastern Standard Time\",\n \"timeZoneCode\": \"035\",\n \"status\": \"OPEN\",\n \"shippingType\": \"2\",\n \"shopClose\": [\n {\n \"startDate\": \"2025-04-17T00:00:00\",\n \"endDate\": \"2025-04-19T00:00:00\",\n \"startTime\": \"00:00:00\",\n \"endTime\": \"16:28:00\",\n \"reason\": \"Sorry, we are closed.\"\n }\n ]\n },\n \"menu\": [\n {\n \"foodSetId\": 2,\n \"foodSetName\": \"Thai Menu\",\n \"foodSetChar\": \"T\",\n \"foodSetBgColor\": null,\n \"foodSetSorting\": 1,\n \"active\": true,\n \"visible\": false,\n \"isThirdParty\": false,\n \"thirdPartyIntegrationsProviderId\": null,\n \"createOn\": null,\n \"modifyOn\": null,\n \"foodCategories\": [\n {\n \"foodCatId\": 64,\n \"foodCatName\": \"Appetizer\",\n \"foodCatColor\": \"\",\n \"foodCatIcon\": \"None\",\n \"priority\": false,\n \"foodCatSorting\": 10,\n \"foodCatParent\": 0,\n \"active\": true,\n \"visible\": false,\n \"foodCatDesc\": null,\n \"createOn\": null,\n \"modifyOn\": null,\n \"foods\": [\n {\n \"foodId\": 674,\n \"foodName\": \"EDAMAME\",\n \"foodNameAlt\": \"\",\n \"foodPrice\": 0.88,\n \"foodShowOption\": false,\n \"foodPDANumber\": \"\",\n \"plu\": null,\n \"foodDesc\": \"\",\n \"priority\": false,\n \"foodSorting\": 667,\n \"modifyOn\": \"2024-01-30T03:49:47\",\n \"createOn\": \"2022-06-15T02:44:00\",\n \"active\": true,\n \"visible\": false,\n \"isCommand\": false,\n \"printSingle\": true,\n \"foodSetId\": 2,\n \"foodCatId\": 64,\n \"revenueClassId\": 3,\n \"taxRateId\": 3,\n \"taxRate2Id\": null,\n \"image\": null,\n \"imageThirdParty\": \"\",\n \"qtyLimit\": 0,\n \"isLimit\": false,\n \"isOutStock\": false,\n \"isFree\": true,\n \"isShow\": true,\n \"isShowInstruction\": false,\n \"productId\": \"2,4\",\n \"thirdPartyGroupId\": 0,\n \"foodBaseId\": null,\n \"isThirdParty\": false,\n \"thirdPartyIntegrationsProviderId\": null,\n \"choiceOptions\": []\n },\n {\n \"foodId\": 675,\n \"foodName\": \"GRILLED JUMBO CALAMARI\",\n \"foodNameAlt\": \"\",\n \"foodPrice\": 2.5,\n \"foodShowOption\": false,\n \"foodPDANumber\": \"\",\n \"plu\": null,\n \"foodDesc\": \"togarachi pepper aioli\",\n \"priority\": false,\n \"foodSorting\": 668,\n \"modifyOn\": \"2023-02-07T18:11:11\",\n \"createOn\": \"2022-06-15T02:44:00\",\n \"active\": true,\n \"visible\": false,\n \"isCommand\": false,\n \"printSingle\": true,\n \"foodSetId\": 2,\n \"foodCatId\": 64,\n \"revenueClassId\": 3,\n \"taxRateId\": 3,\n \"taxRate2Id\": null,\n \"image\": null,\n \"imageThirdParty\": \"\",\n \"qtyLimit\": 0,\n \"isLimit\": false,\n \"isOutStock\": false,\n \"isFree\": false,\n \"isShow\": true,\n \"isShowInstruction\": false,\n \"productId\": \"2,4\",\n \"thirdPartyGroupId\": 0,\n \"foodBaseId\": null,\n \"isThirdParty\": false,\n \"thirdPartyIntegrationsProviderId\": null,\n \"choiceOptions\": []\n }\n ]\n },\n {\n \"foodCatId\": 65,\n \"foodCatName\": \"Soup & Salad\",\n \"foodCatColor\": \"\",\n \"foodCatIcon\": \"None\",\n \"priority\": false,\n \"foodCatSorting\": 55,\n \"foodCatParent\": 0,\n \"active\": true,\n \"visible\": false,\n \"foodCatDesc\": null,\n \"createOn\": null,\n \"modifyOn\": null,\n \"foods\": [\n {\n \"foodId\": 686,\n \"foodName\": \"MISO SOUP\",\n \"foodNameAlt\": \"\",\n \"foodPrice\": 0.4,\n \"foodShowOption\": false,\n \"foodPDANumber\": \"\",\n \"plu\": null,\n \"foodDesc\": \"japanese soft tofu, seaweed, scallions\",\n \"priority\": false,\n \"foodSorting\": 679,\n \"modifyOn\": null,\n \"createOn\": \"2022-06-15T02:50:02\",\n \"active\": true,\n \"visible\": false,\n \"isCommand\": false,\n \"printSingle\": true,\n \"foodSetId\": 2,\n \"foodCatId\": 65,\n \"revenueClassId\": 3,\n \"taxRateId\": 3,\n \"taxRate2Id\": null,\n \"image\": null,\n \"imageThirdParty\": \"\",\n \"qtyLimit\": 0,\n \"isLimit\": false,\n \"isOutStock\": false,\n \"isFree\": false,\n \"isShow\": true,\n \"isShowInstruction\": false,\n \"productId\": \"2,4\",\n \"thirdPartyGroupId\": 0,\n \"foodBaseId\": null,\n \"isThirdParty\": false,\n \"thirdPartyIntegrationsProviderId\": null,\n \"choiceOptions\": []\n },\n {\n \"foodId\": 690,\n \"foodName\": \"TOM KHA SOUP\",\n \"foodNameAlt\": \"\",\n \"foodPrice\": 0.7,\n \"foodShowOption\": false,\n \"foodPDANumber\": \"\",\n \"plu\": null,\n \"foodDesc\": \"coconut milk, lemongrass-herbs broth, roasted chili pastes, mushrooms, scallions, cilantro\",\n \"priority\": false,\n \"foodSorting\": 683,\n \"modifyOn\": null,\n \"createOn\": \"2022-06-15T02:50:02\",\n \"active\": true,\n \"visible\": false,\n \"isCommand\": false,\n \"printSingle\": true,\n \"foodSetId\": 2,\n \"foodCatId\": 65,\n \"revenueClassId\": 3,\n \"taxRateId\": 3,\n \"taxRate2Id\": null,\n \"image\": null,\n \"imageThirdParty\": \"\",\n \"qtyLimit\": 0,\n \"isLimit\": false,\n \"isOutStock\": false,\n \"isFree\": false,\n \"isShow\": true,\n \"isShowInstruction\": false,\n \"productId\": \"2,4\",\n \"thirdPartyGroupId\": 0,\n \"foodBaseId\": null,\n \"isThirdParty\": false,\n \"thirdPartyIntegrationsProviderId\": null,\n \"choiceOptions\": [\n {\n \"choiceOptionId\": 1,\n \"choiceOptionName\": \"Meat Option\",\n \"choiceOptionNameAlt\": \"\",\n \"plu\": null,\n \"choiceMulti\": false,\n \"choiceNewLine\": true,\n \"choiceRequire\": true,\n \"choiceSorting\": 1,\n \"hidden\": false,\n \"arrange\": 0,\n \"arrangeName\": null,\n \"maxChoice\": 0,\n \"active\": true,\n \"visible\": false,\n \"modifyOn\": null,\n \"choices\": [\n {\n \"choiceId\": 1,\n \"choiceName\": \"Chicken\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 1,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 1,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 7,\n \"choiceName\": \"Shrimp\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.1,\n \"choiceWeight\": null,\n \"choiceSorting\": 13,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 1,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 17,\n \"choiceName\": \"Mild\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 17,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 2,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 18,\n \"choiceName\": \"Medium\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 18,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 2,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 19,\n \"choiceName\": \"Hot\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 19,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 2,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 20,\n \"choiceName\": \"Extra Hot\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 20,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 2,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n }\n ]\n },\n {\n \"choiceOptionId\": 2,\n \"choiceOptionName\": \"Spicy\",\n \"choiceOptionNameAlt\": \"\",\n \"plu\": null,\n \"choiceMulti\": false,\n \"choiceNewLine\": true,\n \"choiceRequire\": false,\n \"choiceSorting\": 2,\n \"hidden\": false,\n \"arrange\": 0,\n \"arrangeName\": null,\n \"maxChoice\": 0,\n \"active\": true,\n \"visible\": false,\n \"modifyOn\": null,\n \"choices\": [\n {\n \"choiceId\": 1,\n \"choiceName\": \"Chicken\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 1,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 1,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 7,\n \"choiceName\": \"Shrimp\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.1,\n \"choiceWeight\": null,\n \"choiceSorting\": 13,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 1,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 17,\n \"choiceName\": \"Mild\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 17,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 2,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 18,\n \"choiceName\": \"Medium\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 18,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 2,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 19,\n \"choiceName\": \"Hot\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 19,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 2,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n },\n {\n \"choiceId\": 20,\n \"choiceName\": \"Extra Hot\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.0,\n \"choiceWeight\": null,\n \"choiceSorting\": 20,\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 2,\n \"choiceTypeId\": 1,\n \"choiceOperator\": null,\n \"createOn\": null,\n \"modifyOn\": null\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"timeMenu\": [\n {\n \"timeMenuId\": 15,\n \"day\": \"Sunday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeMenuId\": 16,\n \"day\": \"Monday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeMenuId\": 17,\n \"day\": \"Tuesday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeMenuId\": 18,\n \"day\": \"Wednesday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeMenuId\": 19,\n \"day\": \"Thursday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeMenuId\": 20,\n \"day\": \"Friday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeMenuId\": 21,\n \"day\": \"Saturday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n }\n ],\n \"timePickup\": [\n {\n \"timePickupId\": 22,\n \"day\": \"Sunday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timePickupId\": 23,\n \"day\": \"Monday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timePickupId\": 24,\n \"day\": \"Tuesday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"TimePickupId\": 25,\n \"Day\": \"Wednesday\",\n \"TimeStart\": \"00:00:00\",\n \"TimeEnd\": \"23:59:00\",\n \"Active\": true\n },\n {\n \"timePickupId\": 26,\n \"day\": \"Thursday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timePickupId\": 27,\n \"day\": \"Friday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timePickupId\": 28,\n \"day\": \"Saturday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n }\n ],\n \"timeDelivery\": [\n {\n \"timeDeliveryId\": 29,\n \"day\": \"Sunday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeDeliveryId\": 30,\n \"day\": \"Monday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeDeliveryId\": 31,\n \"day\": \"Tuesday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeDeliveryId\": 32,\n \"day\": \"Wednesday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeDeliveryId\": 33,\n \"day\": \"Thursday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeDeliveryId\": 34,\n \"day\": \"Friday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"timeDeliveryId\": 35,\n \"day\": \"Saturday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n }\n ],\n \"foodSetTimeMap\": [\n {\n \"foodSetTimeMapId\": 582,\n \"foodSetId\": 2,\n \"day\": \"Sunday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 583,\n \"foodSetId\": 2,\n \"day\": \"Monday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 584,\n \"foodSetId\": 2,\n \"day\": \"Tuesday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 585,\n \"foodSetId\": 2,\n \"day\": \"Wednesday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 586,\n \"foodSetId\": 2,\n \"day\": \"Thursday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 587,\n \"foodSetId\": 2,\n \"day\": \"Friday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 588,\n \"foodSetId\": 2,\n \"day\": \"Saturday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 617,\n \"foodSetId\": 7,\n \"day\": \"Sunday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 618,\n \"foodSetId\": 7,\n \"day\": \"Monday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 619,\n \"foodSetId\": 7,\n \"day\": \"Tuesday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 620,\n \"foodSetId\": 7,\n \"day\": \"Wednesday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 621,\n \"foodSetId\": 7,\n \"day\": \"Thursday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 622,\n \"foodSetId\": 7,\n \"day\": \"Friday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n },\n {\n \"foodSetTimeMapId\": 623,\n \"foodSetId\": 7,\n \"day\": \"Saturday\",\n \"timeStart\": \"00:00:00\",\n \"timeEnd\": \"23:59:00\",\n \"active\": true\n }\n ],\n \"taxRate\": [\n {\n \"taxRateId\": 1,\n \"taxRateName\": \"Beverage\",\n \"taxRatePercentage\": 7.0,\n \"markChar\": null,\n \"markLegend\": null,\n \"createOn\": null,\n \"modifyOn\": \"2019-01-01T00:00:44\",\n \"active\": true\n },\n {\n \"taxRateId\": 2,\n \"taxRateName\": \"Beer/Wine\",\n \"taxRatePercentage\": 7.0,\n \"markChar\": null,\n \"markLegend\": null,\n \"createOn\": null,\n \"modifyOn\": \"2021-06-30T03:38:39\",\n \"active\": true\n },\n {\n \"taxRateId\": 3,\n \"taxRateName\": \"Food\",\n \"taxRatePercentage\": 7.0,\n \"markChar\": null,\n \"markLegend\": null,\n \"createOn\": null,\n \"modifyOn\": \"2019-01-01T00:00:52\",\n \"active\": true\n },\n {\n \"taxRateId\": 4,\n \"taxRateName\": \"Liquor\",\n \"taxRatePercentage\": 7.0,\n \"markChar\": null,\n \"markLegend\": null,\n \"createOn\": null,\n \"modifyOn\": \"2021-06-30T03:38:43\",\n \"active\": true\n },\n {\n \"taxRateId\": 5,\n \"taxRateName\": \"GiftCard\",\n \"taxRatePercentage\": 0.0,\n \"markChar\": null,\n \"markLegend\": null,\n \"createOn\": null,\n \"modifyOn\": \"2021-06-30T03:38:43\",\n \"active\": true\n }\n ],\n \"utensils\": {\n \"isEnable\": false,\n \"price\": \"0.00\"\n }\n}\n\nShop is a configuration object that defines core shop information, including general details (e.g., name, address, time zone) and operating hours such as open status, shipping methods, and scheduled closure periods.
\nA Food Set represents a group or collection of menu items. Each food set contains one or more food categories, and each category contains multiple food items.
\nA Food Category represents a classification or grouping of related food items within a menu. Each category contains one or more food items.
\nA Food item represents an individual menu item that can be ordered by the customer. Each food item may have one or more choice options, or it may have no choice options at all.
\nA Choice Option is a group of related choices that can be selected as add-ons or customizations for a food item. Each choice option contains one or more choices.
\nA Choice represents an additional selectable option for a food item. Choices allow customers to customize their order by adding, removing, or selecting from available modifiers (e.g., toppings, sizes, add-ons).
\nA Time Menu defines the specific time window during which certain food items or menus are available for ordering. It is typically used to control menu availability based on the day and time.
\nA Time Pickup defines the specific time window during which customers are allowed to schedule pickup orders. This helps restaurants manage their operations by limiting pickup availability to certain days and times.
\nA Time Delivery defines the specific time window during which customers can schedule delivery orders. This allows restaurants to manage their operations by restricting delivery availability to certain days and times.
\nA Food Set Time Map defines the specific days and time periods during which a Food Set is available for ordering.
\nA Tax Rate represents the percentage of tax applied to a food item. It is used to calculate the applicable tax during order processing.
\nUtensils is a configuration that determines whether utensil options are offered to customers during the ordering process, and if so, at what price.
\nWhen sending data to your webhook endpoint, we include both the header information and the HMAC signature, just as you did when sending data to us. This ensures that the data can be verified as originating from our system
\n","urlObject":{"protocol":"https","path":["external","api","v1","menu","sync"],"host":["api-gateway","smiledining","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"077bc5ca-0d6f-435d-9667-92329986d898"}],"id":"c881d62b-0bba-41ea-a44d-b7b2794123b7","description":"We use an API called \"Menu\" to transmit structured menu data directly to the partner’s webhook endpoint. This integration allows our system to seamlessly deliver up-to-date menu information—such as item names, prices, categories, and modifiers—ensuring that your platform stays synchronized with the restaurant's current offerings.
\nBy leveraging this API, partners can receive real-time menu updates with minimal effort, enabling a more streamlined experience for both technical teams and end users.
\nLet us know if you require technical documentation or access credentials to get started.
\n","_postman_id":"c881d62b-0bba-41ea-a44d-b7b2794123b7"},{"name":"CpxTransaction","item":[{"name":"CreateOrder","id":"48e30d1b-b9c3-41e8-b21f-3c4097400447","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Api-Key","value":"Key","type":"text"},{"key":"X-Server-Authorization","value":"Encryption","type":"text"},{"key":"uniqueIdentifier","value":"UUID","type":"text"}],"body":{"mode":"raw","raw":"{\n \"externalId\": \"aa997d8a-bb22-407d-887c-2de9bfe0b906\",\n \"storeLinkedOID\": \"1776225568\",\n \"customer\": {\n \"firstName\": \"first name\",\n \"lastName\": \"last name\",\n \"email\": \"email@gmail.com\",\n \"phone\": \"2059059025\",\n \"address\": {\n \"fullAddress\": \"19109 36th Ave W #206, Lynnwood, WA 98036, USA\",\n \"apt\": \"unit 2\",\n \"city\": \"Lynnwood\",\n \"state\": \"WA\",\n \"postal\": \"98036\",\n \"lat\": \"47.8250942\",\n \"lng\": \"-122.2798799\"\n }\n },\n \"menu\": [\n {\n \"foodSetId\": 2,\n \"foodSetName\": \"Thai Menu\",\n \"foodSetChar\": \"T\",\n \"foodSetBgColor\": null,\n \"foodSetSorting\": 1,\n \"createOn\": \"2024-01-02T00:00:00\",\n \"modifyOn\": null,\n \"active\": true,\n \"visible\": false,\n \"isThirdParty\": false,\n \"thirdPartyIntegrationsProviderId\": null,\n \"foodCategories\": [\n {\n \"foodCatId\": 64,\n \"foodCatName\": \"Appetizer\",\n \"foodCatColor\": \"\",\n \"foodCatIcon\": \"None\",\n \"priority\": false,\n \"foodCatSorting\": 10,\n \"foodCatParent\": 0,\n \"createOn\": \"2024-01-02T00:00:00\",\n \"modifyOn\": null,\n \"active\": true,\n \"visible\": false,\n \"foodCatDesc\": null,\n \"foods\": [\n {\n \"foodId\": 704,\n \"foodName\": \"PAD THAI\",\n \"foodNameAlt\": \"\",\n \"foodPrice\": 18.0,\n \"foodShowOption\": false,\n \"foodPDANumber\": \"\",\n \"plu\": null,\n \"foodDesc\": \"Thin rice noodle, egg, scallions, peanuts, bean sprout tofu or chicken or beef or shrimp (+6)\\r\\n\",\n \"priority\": false,\n \"foodSorting\": 697,\n \"modifyOn\": \"2022-06-22T01:05:35\",\n \"createOn\": \"2022-06-15T02:52:54\",\n \"active\": true,\n \"isCommand\": false,\n \"printSingle\": true,\n \"foodSetId\": 2,\n \"foodCatId\": 66,\n \"revenueClassId\": 3,\n \"taxRateId\": 3,\n \"taxRate2Id\": null,\n \"image\": null,\n \"imageThirdParty\": \"\",\n \"qtyLimit\": 0,\n \"isLimit\": false,\n \"isOutStock\": false,\n \"isFree\": false,\n \"isShow\": true,\n \"isShowInstruction\": false,\n \"productId\": \"2,4\",\n \"thirdPartyGroupId\": 0,\n \"foodBaseId\": null,\n \"isThirdParty\": false,\n \"pureImageName\": null,\n \"visible\": false,\n \"thirdPartyIntegrationsProviderId\": null,\n \"comment\": \"Note for this food\",\n \"choiceOptions\": [\n {\n \"choiceOptionId\": 1,\n \"choiceOptionName\": \"Meat Option\",\n \"choiceOptionNameAlt\": \"\",\n \"plu\": null,\n \"choiceMulti\": false,\n \"choiceNewLine\": true,\n \"choiceRequire\": true,\n \"choiceSorting\": 1,\n \"hidden\": false,\n \"arrange\": 0,\n \"arrangeName\": null,\n \"maxChoice\": 0,\n \"createOn\": null,\n \"active\": true,\n \"visible\": false,\n \"modifyOn\": null,\n \"choices\": [\n {\n \"choiceId\": 273,\n \"choiceName\": \"Shrimp\",\n \"choiceNameAlt\": \"\",\n \"plu\": null,\n \"choicePrice\": 0.6,\n \"choiceWeight\": null,\n \"choiceSorting\": 273,\n \"createOn\": \"2024-01-02T00:00:00\",\n \"active\": true,\n \"visible\": false,\n \"choiceOptionId\": 1,\n \"choiceTypeId\": 1,\n \"choiceOperator\": \"+\",\n \"modifyOn\": null\n }\n ] \n }\n ]\n }\n ] \n }\n ]\n }\n ],\n \"ticket\": {\n \"orderTypeId\": 2,\n \"deliveryBy\": \"UberEats\",\n \"orderedAt\": \"2025-04-02T22:37:00\",\n \"asap\": true,\n \"scheduleDateTime\": null,\n \"comment\": \"note for ticket\"\n },\n \"payment\": {\n \"isPayOnline\": true,\n \"subTotal\": 18.60,\n \"deliveryCharge\": 8.00,\n \"otherCharge\": 2.00,\n \"discountAmount\": 5.00,\n \"taxAmount\": 1.30,\n \"isUtensils\": true,\n \"utensilsAmount\": 2.55,\n \"tip\": 3.00,\n \"grandTotal\": 27.45,\n \"creditCard\": {\n \"amount\": 30.45,\n \"creditTypeId\": 0,\n \"ccCardCompany\": \"VISA\",\n \"ccCardName\": \"Credit Card Name\",\n \"ccLastFour\": \"xxxx\",\n \"ccCardExp\": \"xxx\",\n \"ccTroutD\": \"62589716-c73d-4fdd-b62c-236c6705dfdd\",\n \"ccAuthCode\": \"e9f17ee968ee45eab9b410fb6d0af139-8f029bd7adc94c36a181baf6c1db51d1\",\n \"billingAddress\": \"19109 36th Ave W #206, Lynnwood, WA 98036, USA\",\n \"billingCity\": \"Lynnwood\",\n \"billingState\": \"WA\",\n \"billingPostal\": \"98036\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-gateway.smiledining.com/external/api/v1/cpxtransaction/createOrder","description":"This endpoint is used to create order
\nMethod: POST
\nURL: https://api-gateway.smiledining.com/external/api/v1/cpxtransaction/createorder
\nHeader
\nX-Api-Key (this key is generated by SmilePOS)
\nThe API uses the POST method.
\nThe header contains two keys for HMAC authentication:
\nX-Server-Authorization – a key used for body encryption with a UUID.
\nuniqueIdentifier – the UUID.
\ncan verify or generate HMAC signatures using this HMAC Generator Tool
\nUsage Tips
\nThe body message has been changed to a single line.
\nChoose the correct hashing algorithm (SHA-256).
\nEnter your message (usually the raw request body).
\nUse the appropriate secret key (e.g., your X-Server-Authorization value).
\nThe generated HMAC should match the one sent in your API request header.
\n🧩 Menu → Food Set
\n🗂️ FoodCategories → Within FoodSet
\n🍔 Foods → Within FoodCategory
\n🧩 ChoiceOptions → Within Food
\n🧩 Choices → Within ChoiceOption
\nResponse
\nThe response for this request can be represented as a JSON schema. Below is a sample representation of the response schema:
\n{\n \"result\": null,\n \"status\": 1,\n \"message\": null\n}\n\n**
Tip: The menu sends date and time data based on the local time zone.**
This endpoint is used to update OID
\nMethod: POST
\nURL: https://api-gateway.smiledining.com/external/api/v1/cpxtransaction/updateStoreLinkedOID
\nHeader
\nX-Api-Key (this key is generated by SmilePOS)
\nThe API uses the POST method.
\nThe header contains two keys for HMAC authentication:
\nX-Server-Authorization – a key used for body encryption with a UUID.
\nuniqueIdentifier – the UUID.
\ncan verify or generate HMAC signatures using this HMAC Generator Tool
\nUsage Tips
\nThe body message has been changed to a single line.
\nChoose the correct hashing algorithm (SHA-256).
\nEnter your message (usually the raw request body).
\nUse the appropriate secret key (e.g., your X-Server-Authorization value).
\nThe generated HMAC should match the one sent in your API request header.
\nResponse
\nThe response for this request can be represented as a JSON schema. Below is a sample representation of the response schema:
\n{\n \"result\": null,\n \"status\": 1,\n \"message\": null\n}\n\nThe Order API is used to send and receive order data between partner platforms and our POS system. It acts as a central integration point for managing order-related information in real-time, ensuring that all transactions are seamlessly synchronized.
\nThis API supports both incoming orders from external channels (such as online ordering platforms or delivery apps) and order status updates or responses from our POS. By using this endpoint, partners can efficiently communicate order details—such as items, modifiers, notes, timestamps, and payment information—directly with our system.
\nThe Order API is designed to streamline operations, reduce manual errors, and provide a smooth end-to-end order lifecycle for restaurants and their customers.
\nPlease let us know if you need the full API documentation or sample payloads to begin your integration.
\n","_postman_id":"10b9d596-9665-4707-b388-d1f73be57185"}]}