GoGMGo APIs let developers create applications for various integration use cases using common merchant client data.
\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1186615","collectionId":"5c693459-de54-4bb5-a4b1-9c48a6ffcf84","publishedId":"UVC6jSsX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"575454","highlight":"3cc1c0"},"publishDate":"2024-06-19T13:30:01.000Z"},"item":[{"name":"Getting Started","item":[{"name":"How to get the Merchant API key","item":[],"id":"d16e677e-ca1f-40f1-ba4a-57c73a5ee063","description":"In order to get the API key in the GoGMGo platform, ask the merchant client to go to erp.gogmgo.com and login as the account administrator, then go to Settings menu --> Integration Settings.
\nIn Integration Settings click the API partner type from the sub-menu (e.g. Online Ordering, Reservations, Loyalty, etc.) followed by clicking the \"Get GoGMGo API Keys\" button to generate the API key for the given merchant account.
\n","_postman_id":"d16e677e-ca1f-40f1-ba4a-57c73a5ee063"},{"name":"Base URLs","item":[],"id":"32d21dae-4a62-4406-b640-5802a324d71c","description":"| Environment | Base URL |
|---|---|
Production | https://erp.gogmgo.com |
In order to use the GoGMG0 API, you must be granted API credentials. During development, you can use the test credentials as provided in examples. After development is complete you can use a separate set of credentials for use in production generated from the outlet integration settings.
\nUse of the API must follow GoGMGo API Terms of Use and all API requests must be made over TLS 1.2.
\n","_postman_id":"6d25c708-e65b-45ee-b246-614cd6fcb037"},{"name":"HTTP Status Code Summary","item":[],"id":"f844bc56-879e-499d-bc84-6a67c940c87d","description":"","_postman_id":"f844bc56-879e-499d-bc84-6a67c940c87d"}],"id":"398722be-2187-46a3-af94-0d7565c8bfa0","description":"The GoGMGo API is a RESTful API over HTTPS that utilizes JSON as the data response format. It allows application developers to query for data and perform actions, such as looking up Merchant Order data.
\nIn order to use the GoGMGo API, you must be granted API credentials. For testing purposes you can use the example credentials. When ready to go live you can use the api key and secret key generated from the integration settings for a particular outlet.
\nNote: By using the GoGMGo API, you accept the Terms and Conditions
\n","_postman_id":"398722be-2187-46a3-af94-0d7565c8bfa0"},{"name":"Orders","item":[{"name":"Get Token","id":"cf91780d-cc4d-4ddf-a4a3-e2abf7f6f295","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"MkFQZUk1d2V4cHdvcDhNdlFHRWErTkVacko1ejZneHNnWGcvTGVLR3dHTUVlbFRaQ2tzVzRodXM2aVZIeTk2cw==","description":"This is the API key
\n","type":"text"},{"key":"x-api-key","value":"U3FiOFFmc0FINVFyeVNxQ0Zyd1YzNjh1THJoaVJOcmNHb2F6OFlnT3FJdW1DNXRyMDZGRkpCQmg1QzhaTVF0YWtuWDZNM21ENXpKTEx2b2R4ejFjMzU5dWRzeTdNRmVHelBhRkE4YXYxVXdGUFd5VFBzQThwVGNCS0F0VllyMFRzN0tEdHRxcmExWDgyc0V5b2J2a2xBPT0=","description":"This is a the encrypted hash key to be generated using the api key and utc timestamp. This need to be encyrpted using the secret key provided to you in your account using AES-256-CBC + sha256 encryption. The string to be encrypted should be in the following format \"get_token|$api_key|timestamp(UTC)\"
\n","type":"text"}],"url":"https://erp.gogmgo.com/pos_transaction_data/get_token","description":"To fetch a token you will need the API key and your secret key from the merchant outlet.
\nHere is a basic encryption code snippet for reference for generating the x-api-key. The string to be encrypted should be in the following format \"get_token|$api_key|timestamp(UTC)\"
\nfunction __encryptor_key($string, $secret_key, $api_key)\n{\n $output = false;\n $encrypt_method = \"AES-256-CBC\";\n // hash\n $key = hash('sha256', $secret_key);\n // iv - encrypt method AES-256-CBC expects 16 bytes - else you will get a warning\n $iv = substr(hash('sha256', $api_key), 0, 16);\n //do the encyption given text/string/number\n $output = openssl_encrypt($string, $encrypt_method, $key, 0, $iv);\n $output = base64_encode($output);\n return $output;\n}\n\nThis is the token you generated using the get token api
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"date","value":"2021/10/01","description":"The date for which the order list in enquired for. In yyyy/mm/dd format
\n","type":"text"},{"key":"status","value":"Complete","description":"The status of the orders being requested. These can be \"Complete\", \"Open\", \"New\", \"Cancelled\" or \"Refunded\".
\n","type":"text"}]},"url":"/pos_transaction_data/get_order_listing","description":"List of orders and order summary data.
\n","urlObject":{"path":["pos_transaction_data","get_order_listing"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"4eed9c09-88b5-4208-8880-58af6bcb30b5","name":"Get Order Listing","originalRequest":{"method":"POST","header":[{"key":"token","value":"b24qrQWPH70yXGQVq9f5pS9O1ybCWX5JvDPrtKwYtIwv8Ngz2A","description":"This is the token you generated using the get token api ","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"date","value":"2021/10/01","description":"The date for which the order list in enquired for. In yyyy/mm/dd format","type":"text"},{"key":"status","value":"Complete","description":"The status of the orders being requested. These can be \"Complete\", \"Open\", \"New\", \"Cancelled\" or \"Refunded\".","type":"text"}]},"url":"https://erp.gogmgo.com/pos_transaction_data/get_order_listing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 12 Nov 2021 09:47:48 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"968"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.51 (Amazon) OpenSSL/1.0.2k-fips PHP/5.6.40"},{"key":"X-Powered-By","value":"PHP/5.6.40"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, PATCH, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\",\n \"orders\": [\n {\n \"order_Id\": \"P1011020211\",\n \"order_Status\": \"complete\",\n \"order_Sales_Type\": \"Dine-In\",\n \"no_Of_Seats\": \"8\",\n \"table_No\": \"LNG2\",\n \"channel_Name\": \"Chope\",\n \"order_Service_Period\": \"dinner\",\n \"order_Total\": 150,\n \"order_Create_Date\": \"2021/10/01 17:41:44\",\n \"finish_Time\": \"2021/10/01 17:52:21\",\n \"last_Updated\": \"2021/10/01 17:52:26\"\n },\n {\n \"order_Id\": \"P1011020212\",\n \"order_Status\": \"complete\",\n \"order_Sales_Type\": \"Dine-In\",\n \"no_Of_Seats\": \"1\",\n \"table_No\": \"LNG2\",\n \"channel_Name\": \"Chope\",\n \"order_Service_Period\": \"dinner\",\n \"order_Total\": 24,\n \"order_Create_Date\": \"2021/10/01 17:40:28\",\n \"finish_Time\": \"2021/10/01 17:41:18\",\n \"last_Updated\": \"2021/10/01 17:41:20\"\n },\n {\n \"order_Id\": \"P1011020213\",\n \"order_Status\": \"complete\",\n \"order_Sales_Type\": \"Dine-In\",\n \"no_Of_Seats\": \"8\",\n \"table_No\": \"LNG2\",\n \"channel_Name\": \"Walk-in\",\n \"order_Service_Period\": \"dinner\",\n \"order_Total\": 52,\n \"order_Create_Date\": \"2021/10/01 17:52:53\",\n \"finish_Time\": \"2021/10/04 12:22:12\",\n \"last_Updated\": \"2021/10/04 12:22:13\"\n }\n ]\n}"}],"_postman_id":"d88cc3c1-872d-4c0a-a129-44cc8a9b7959"},{"name":"Get Order Detail","id":"087dfbd9-0c77-4016-8027-e08df3c9363a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"XKrlHZ7XO2hp991F6i3Pq3Shv9bwjS0XxpDj6RCzT05pKGuchg","description":"This is the token you generated using the get token api
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"order_Id","value":"P1011020211","description":"The order id string for the order for which details are requested for. These can be pulled in from the order listing end point.
\n","type":"text"}]},"url":"/pos_transaction_data/get_order_details","description":"Order-level detailed breakdown, including breakdown of bills within orders, order items within bills, & modifiers, promotions, and discounts within order items.
\n","urlObject":{"path":["pos_transaction_data","get_order_details"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"7fa773f8-8876-4a06-b814-e33c989e957f","name":"Get Order Detail","originalRequest":{"method":"POST","header":[{"key":"token","value":"XKrlHZ7XO2hp991F6i3Pq3Shv9bwjS0XxpDj6RCzT05pKGuchg","description":"This is the token you generated using the get token api","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"order_Id","value":"P1011020211","description":"The order id string for the order for which details are requested for. These can be pulled in from the order listing end point. ","type":"text"}]},"url":"https://erp.gogmgo.com/pos_transaction_data/get_order_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 12 Nov 2021 09:49:16 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"2510"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"Apache/2.4.51 (Amazon) OpenSSL/1.0.2k-fips PHP/5.6.40"},{"key":"X-Powered-By","value":"PHP/5.6.40"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, GET, PUT, PATCH, DELETE, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\",\n \"Order\": {\n \"order_Id\": \"P1011020211\",\n \"order_Status\": \"complete\",\n \"no_Of_Seats\": \"8\",\n \"table_No\": \"LNG2\",\n \"channel_Name\": \"Chope\",\n \"order_Service_Period\": \"dinner\",\n \"order_Sales_Type\": \"Dine-In\",\n \"online_Order_Type\": \"\",\n \"order_Total\": 150,\n \"split_Type_Name\": \"\",\n \"promotions\": [],\n \"order_Create_Date\": \"2021/10/01 17:41:44\",\n \"finish_Time\": \"2021/10/01 17:52:21\",\n \"last_Updated\": \"2021/10/01 17:52:26\",\n \"bills\": [\n {\n \"bill_Number\": 1,\n \"is_Paid\": true,\n \"split_Type\": \"\",\n \"payment_Type\": \"Amex\",\n \"card_Type\": \"\",\n \"service_Charge\": 12.6,\n \"tips\": 0,\n \"sales_Tax\": 9.7,\n \"paid_Amount\": 148.3,\n \"change_Amount\": 0,\n \"excess_Amount\": 0,\n \"voucher_ID\": \"\",\n \"voucher_Balance\": 0,\n \"is_Refund\": false,\n \"refund\": 0,\n \"refund_reasons\": \"\",\n \"split_Create_Date\": \"\"\n }\n ],\n \"menuItems\": [\n {\n \"menu_item_id\": \"8091\",\n \"menu_item_name\": \"Fish And Chips\",\n \"menu_item_type\": \"standard\",\n \"sub_Category\": \"389\",\n \"menu_item_quantity\": 2,\n \"menu_item_price\": \"26.0\",\n \"discount\": 0,\n \"void\": 0,\n \"service_Charge_Amount\": 5.2,\n \"sales_Tax_Amount\": 4,\n \"promotion_Total_Discount\": 0,\n \"promotions\": [],\n \"comment\": \"\",\n \"create_Date\": \"2021/10/01 17:39:04\",\n \"modifiers\": [],\n \"Bundled_Menu_Item\": []\n },\n {\n \"menu_item_id\": \"8048\",\n \"menu_item_name\": \"6Pcs Harry'S Wings\",\n \"menu_item_type\": \"standard\",\n \"sub_Category\": \"377\",\n \"menu_item_quantity\": 2,\n \"menu_item_price\": \"17.0\",\n \"discount\": 0,\n \"void\": 0,\n \"service_Charge_Amount\": 3.4,\n \"sales_Tax_Amount\": 2.62,\n \"promotion_Total_Discount\": 0,\n \"promotions\": [],\n \"comment\": \"\",\n \"create_Date\": \"2021/10/01 17:38:41\",\n \"modifiers\": [\n {\n \"name\": \"Curry Leaves \",\n \"modifier_price\": \"0.00\",\n \"action\": \"remove\",\n \"modifier_quantity\": 2,\n \"modifier_id\": \"17718\",\n \"unit_amount\": \"0.00\"\n }\n ],\n \"Bundled_Menu_Item\": []\n },\n {\n \"menu_item_id\": \"8093\",\n \"menu_item_name\": \"Bked Lmon-Spice Fish\",\n \"menu_item_type\": \"standard\",\n \"sub_Category\": \"389\",\n \"menu_item_quantity\": 1,\n \"menu_item_price\": \"24.0\",\n \"discount\": 0,\n \"void\": 0,\n \"service_Charge_Amount\": 0,\n \"sales_Tax_Amount\": 0,\n \"promotion_Total_Discount\": 0,\n \"promotions\": [\n {\n \"amount\": 0,\n \"code\": \"141 Lunch\",\n \"id\": \"52\",\n \"promo_usage_limit\": \"upto_half_applicable\",\n \"times\": 1,\n \"combo_allowed\": \"Yes\",\n \"discountPerItem\": 24,\n \"type\": \"1-4-1\",\n \"promotionTotaldiscount\": 24,\n \"name\": \"141 Lunch\"\n }\n ],\n \"comment\": \"\",\n \"create_Date\": \"2021/10/01 17:41:44\",\n \"modifiers\": [],\n \"Bundled_Menu_Item\": []\n },\n {\n \"menu_item_id\": \"8067\",\n \"menu_item_name\": \"Margherita Flatbread\",\n \"menu_item_type\": \"standard\",\n \"sub_Category\": \"385\",\n \"menu_item_quantity\": 2,\n \"menu_item_price\": \"20.0\",\n \"discount\": 0,\n \"void\": 0,\n \"service_Charge_Amount\": 4,\n \"sales_Tax_Amount\": 3.08,\n \"promotion_Total_Discount\": 0,\n \"promotions\": [],\n \"comment\": \"\",\n \"create_Date\": \"2021/10/01 17:39:38\",\n \"modifiers\": [],\n \"Bundled_Menu_Item\": []\n }\n ]\n }\n}"}],"_postman_id":"087dfbd9-0c77-4016-8027-e08df3c9363a"},{"name":"Get Token","id":"2877314f-1b6c-46d7-94f4-194f4554da6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"api-key","value":"M0F0c3Njcm8rV0FzTmpsanZlZEhGZ1pzQktTaXZSdGhPSHllZzh5UE1DZz0=","description":"This is the API key
\n","type":"text"},{"key":"x-api-key","value":"SGhEdUszSWFXL3NIblh6RUVZRDd0SU51ZCtHTDBtb2t6NFFpdW5OS2N1RmdEZ0JtWkVtNyt0dHBjaHFBVmtrSW5ma3FhczN1dXVTK29INVJNQ3ZxMXJjdG1XSnE3dVcvMFEzS2tEbXNsNkM0UTRtZTRqQkFZc0RZakRLVlB2WG4=\n","description":"This is a the encrypted hash key to be generated using the api key and utc timestamp. This need to be encyrpted using the secret key provided to you in your account. The string to be encrypted should be in the following format \"get_token|$api_key|timestamp(UTC)\"
\n","type":"text"}],"url":"/pos_transaction_data/get_token","urlObject":{"path":["pos_transaction_data","get_token"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"2877314f-1b6c-46d7-94f4-194f4554da6b"}],"id":"c48896be-3860-4694-a53a-014bd64e214e","description":"Use this end-point to post order-level details. Common fields supplied include spend, tax, tip, discounts, item-level detail (including quantity, description, price), bill-level detail, order number, and other fields.
\nPlease see the Request Body description for required information that will be mapped to the GoGMGo internal POS JSON object.
\nOnce implemented, contact GoGMGo support to enable mapping and make the integration live.
\n","_postman_id":"c48896be-3860-4694-a53a-014bd64e214e"}],"variable":[{"key":"baseURL","value":"","type":"default"}]}