API Documentation

--- title: API Documentation tags: API Documentation description: API Documentation --- ![](https://i.imgur.com/jEIPfP4.png) <div style="text-align: center; font-size: 35px"> MGCC Portal API Documentation </div> --- # Copyright Information **Maxs Group Inc - IT Application Development** 3rd Floor KDC Plaza Building Chino Roces Avenue. Makati City, 1231 Email: appdev@maxsgroupinc.com --- # Confidentiality and Usage <div style="text-align: justify">The information contained in this document (and any attachments) is a confidential information provided by MGI IT - Application Development. This document is intended only for use by merchants approved by MGI. Any copying, distribution or dissemination of this document by any other parties is prohibited.</div> --- # Revision History | Revision | Date | Revision Description | | -------- | --------------- | -------------------- | | 0.0 | August 11, 2021 | Final Draft Issue | | 0.1 | November 2, 2021| Data Dictionary | | 1.0 | September 1, 2022| Data flow| ---  # API ## RTA Map API ### Store Assignment This API is used to check store assignment. For brand list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/check-store-cater - PRODUCTION https://mgcc-api.maxsgroupinc.com/check-store-cater --- | **FUNCTION** | Check store assignment | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*}| | **DATA PARAMS** | ```{```       ```lat:"",```       ```lng:"",```       ```brand_id:""``` ```}``` | | **DATA DEFINITION** | {} | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message":"",```       ```"data":{```                       ```store_code: "",```                       ```store_name:"",```                       ```promise_time:"",```                       ```pricelist_id:"",```                       ```minimum_delivery:"",```                       ```alternate_store:""```                     ```}```  ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"“No store available." ,```       ```"data":{}``` ```}``` | ### Store Check Status This API is used to check the store status. For brand list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/check-store-status - PRODUCTION https://mgcc-api.maxsgroupinc.com/check-store-status --- | **FUNCTION** | Check store status | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```store_code:"",```       ```transaction_date_time:"",```        ```}``` | | **DATA DEFINITION** | {} | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Store available to send order.",```       ``` "data":{} ```  ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Store closed/peak." ,```       ```"data":{}``` ```}``` | --- ### Menu Products This API is used to check the store status. For brand list and transaction type definitions > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). For menu exploration use 1 as default transaction_id and pricelist_id. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/menu-products - PRODUCTION https://mgcc-api.maxsgroupinc.com/menu-products --- | **FUNCTION** | Menu Products | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```brand_id:"",```       ```pricelist_id:"",```       ```transaction_id:"",```       ```transaction_date:""``` ```}``` | | **DATA DEFINITION** | {} | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Menu Product",```       ``` "Menu":{Product: {"product_id, :"",product_name: "", product_description : "", product_image: "", catetgory_id: "", category_name:"", brand_id: "",sort: "", leadtime:"", price:"" }, option: {option_id : "", option_type: "", option_typeid: "", option_image: "",sort:"",brand_id:""}} ```  ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Error" ,```       ```"data":{}``` ```}``` | --- ## Store Details API This API is to get store details by brand. For brand list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). > - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/store-list - PRODUCTION https://mgcc-api.maxsgroupinc.com/store-list | **FUNCTION** | Get store details | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | | **DATA PARAMS** | ```{```       ```brand_id:""``` ```}``` | | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message":"",```       ```"data":{```                       ```"brand_name": "",```                       ```"store_name":"",```                       ```"start_time":"",```                       ```"end_time":"",```                       ```"store_contact_num":"",```                       ```"store_ops":""```                     ```}```  ```}``` | | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"No store details found." ,```       ```"data":{}``` ```}``` | | --- ## Registration API This API is used for customer registration. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/customer-registration - PRODUCTION https://mgcc-api.maxsgroupinc.com/customer-registration --- | **FUNCTION** | Customer registration | | -------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```customer_firstname:"",```       ```customer_middlename:"",```       ```customer_lastname:"",```       ```customer_country:"",```       ```customer_houseno:"",```       ```customer_street:"",```       ```customer_district:"",```       ```customer_city:"",```       ```customer_province:"",```       ```customer_postcode:"",```       ```customer_contact_no:"",```       ```date_of_birth:"",```       ```customer_email_address:"",```       ```customer_password:"",```       ```customer_source:"",```       ```created_by:"",```       ```customer_mobile_no:"",```       ```scv_id:"",``` ```}``` | | **DATA DEFINITION** | Password Encryption: md5 | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Successfully Registered.",```       ``` "data":{```                          ```customer_id:""```                    ```}``` ```}``` | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, already registered" ,```       ```"data:{```             ```customer_firstname:"",```             ```customer_middlename:"",```             ```customer_lastname:"",```             ```customer_country:"",```             ```customer_houseno:"",```             ```customer_street:"",```             ```customer_district:"",```             ```customer_city:"",```             ```customer_province:"",```             ```customer_postcode:"",```             ```customer_contact_no:"",```             ```customer_email_address:"",```             ```created_by:"",```             ```customer_mobile_no:"",```             ```scv_id:"",```        ```}``` ```}``` | ## Login API This API is used for customer login. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/customer-login - PRODUCTION https://mgcc-api.maxsgroupinc.com/customer-login --- | **FUNCTION** | Customer Login | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```email_address:"",```       ```password:"",``` ```}``` | | **DATA DEFINITION** | Password Encryption: md5 | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, already registered" ,```       ```"data:{```             ```customer_id:"",```             ```customer_firstname:"",```             ```customer_middlename:"",```             ```customer_lastname:"",```             ```customer_country:"",```             ```customer_houseno:"",```             ```customer_street:"",```             ```customer_district:"",```             ```customer_city:"",```             ```customer_province:"",```             ```customer_postcode:"",```             ```customer_contact_no:"",```             ```customer_email_address:"",```             ```created_by:"",```             ```customer_mobile_no:"",```             ```scv_id:"",```        ```}``` ```}``` | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Login Failed" ,```       ```"data:{}``` ```}``` | ## Order Tracker API This API is used for order tracking. For brand list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). > - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/order-tracker - PRODUCTION https://mgcc-api.maxsgroupinc.com/order-tracker --- | **FUNCTION** | Order Tracking | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```orderid:"",```       ```brandid:"",``` ```}``` | | **DATA DEFINITION** | {} | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Successful, Order status",```       ``` "data":{```                          ```status_id:"1"```                    ```}``` ```}``` ***Note status_id reference:*** 0 = order float 1 = order assigned to store 2 = order accepted 3 = order on the way 4 = completed| | | | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, Order ID Not found" ,```       ```"data:{}``` ```}``` | ## Place Order This API is used for customer registration. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/save-orders --- | **FUNCTION** | Place Order API | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ![](https://i.imgur.com/NFbGLCS.png) | | **DATA DEFINITION** | `{` `}` | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Successfully Placed Order.",```       ``` "data":{```                          ```order_id:""```                    ```}``` ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, please try again" ,```       ```"data:{}``` ```}``` ## Payment Status This API is used for checking of payment status. > - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/check-payment --- | **FUNCTION** | Payment Status | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- title: API Documentation tags: API Documentation description: API Documentation --- ![](https://i.imgur.com/jEIPfP4.png) <div style="text-align: center; font-size: 35px"> MGCC Portal API Documentation </div> --- # Copyright Information **Maxs Group Inc - IT Application Development** 3rd Floor KDC Plaza Building Chino Roces Avenue. Makati City, 1231 Email: appdev@maxsgroupinc.com --- # Confidentiality and Usage <div style="text-align: justify">The information contained in this document (and any attachments) is a confidential information provided by MGI IT - Application Development. This document is intended only for use by merchants approved by MGI. Any copying, distribution or dissemination of this document by any other parties is prohibited.</div> --- # Revision History | Revision | Date | Revision Description | | -------- | --------------- | -------------------- | | 0.0 | August 11, 2021 | Final Draft Issue | | 0.1 | November 2, 2021| Data Dictionary | | 1.0 | September 1, 2022| Data flow| ---  # API ## RTA Map API ### Store Assignment This API is used to check store assignment. For brand list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/check-store-cater - PRODUCTION https://mgcc-api.maxsgroupinc.com/check-store-cater --- | **FUNCTION** | Check store assignment | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*}| | **DATA PARAMS** | ```{```       ```lat:"",```       ```lng:"",```       ```brand_id:""``` ```}``` | | **DATA DEFINITION** | {} | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message":"",```       ```"data":{```                       ```store_code: "",```                       ```store_name:"",```                       ```promise_time:"",```                       ```pricelist_id:"",```                       ```minimum_delivery:"",```                       ```alternate_store:""```                     ```}```  ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"“No store available." ,```       ```"data":{}``` ```}``` | ### Store Check Status This API is used to check the store status. For brand list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/check-store-status - PRODUCTION https://mgcc-api.maxsgroupinc.com/check-store-status --- | **FUNCTION** | Check store status | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```store_code:"",```       ```transaction_date_time:"",```        ```}``` | | **DATA DEFINITION** | {} | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Store available to send order.",```       ``` "data":{} ```  ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Store closed/peak." ,```       ```"data":{}``` ```}``` | --- ### Menu Products This API is used to check the store status. For brand list and transaction type definitions > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). For menu exploration use 1 as default transaction_id and pricelist_id. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/menu-products - PRODUCTION https://mgcc-api.maxsgroupinc.com/menu-products --- | **FUNCTION** | Menu Products | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```brand_id:"",```       ```pricelist_id:"",```       ```transaction_id:"",```       ```transaction_date:""``` ```}``` | | **DATA DEFINITION** | {} | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Menu Product",```       ``` "Menu":{Product: {"product_id, :"",product_name: "", product_description : "", product_image: "", catetgory_id: "", category_name:"", brand_id: "",sort: "", leadtime:"", price:"" }, option: {option_id : "", option_type: "", option_typeid: "", option_image: "",sort:"",brand_id:""}} ```  ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Error" ,```       ```"data":{}``` ```}``` | --- ## Store Details API This API is to get store details by brand. For brand list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). > - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/store-list - PRODUCTION https://mgcc-api.maxsgroupinc.com/store-list | **FUNCTION** | Get store details | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | | **DATA PARAMS** | ```{```       ```brand_id:""``` ```}``` | | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message":"",```       ```"data":{```                       ```"brand_name": "",```                       ```"store_name":"",```                       ```"start_time":"",```                       ```"end_time":"",```                       ```"store_contact_num":"",```                       ```"store_ops":""```                     ```}```  ```}``` | | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"No store details found." ,```       ```"data":{}``` ```}``` | | --- ## Registration API This API is used for customer registration. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/customer-registration - PRODUCTION https://mgcc-api.maxsgroupinc.com/customer-registration --- | **FUNCTION** | Customer registration | | -------------------- |:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```customer_firstname:"",```       ```customer_middlename:"",```       ```customer_lastname:"",```       ```customer_country:"",```       ```customer_houseno:"",```       ```customer_street:"",```       ```customer_district:"",```       ```customer_city:"",```       ```customer_province:"",```       ```customer_postcode:"",```       ```customer_contact_no:"",```       ```date_of_birth:"",```       ```customer_email_address:"",```       ```customer_password:"",```       ```customer_source:"",```       ```created_by:"",```       ```customer_mobile_no:"",```       ```scv_id:"",``` ```}``` | | **DATA DEFINITION** | Password Encryption: md5 | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Successfully Registered.",```       ``` "data":{```                          ```customer_id:""```                    ```}``` ```}``` | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, already registered" ,```       ```"data:{```             ```customer_firstname:"",```             ```customer_middlename:"",```             ```customer_lastname:"",```             ```customer_country:"",```             ```customer_houseno:"",```             ```customer_street:"",```             ```customer_district:"",```             ```customer_city:"",```             ```customer_province:"",```             ```customer_postcode:"",```             ```customer_contact_no:"",```             ```customer_email_address:"",```             ```created_by:"",```             ```customer_mobile_no:"",```             ```scv_id:"",```        ```}``` ```}``` | ## Login API This API is used for customer login. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/customer-login - PRODUCTION https://mgcc-api.maxsgroupinc.com/customer-login --- | **FUNCTION** | Customer Login | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```email_address:"",```       ```password:"",``` ```}``` | | **DATA DEFINITION** | Password Encryption: md5 | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, already registered" ,```       ```"data:{```             ```customer_id:"",```             ```customer_firstname:"",```             ```customer_middlename:"",```             ```customer_lastname:"",```             ```customer_country:"",```             ```customer_houseno:"",```             ```customer_street:"",```             ```customer_district:"",```             ```customer_city:"",```             ```customer_province:"",```             ```customer_postcode:"",```             ```customer_contact_no:"",```             ```customer_email_address:"",```             ```created_by:"",```             ```customer_mobile_no:"",```             ```scv_id:"",```        ```}``` ```}``` | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Login Failed" ,```       ```"data:{}``` ```}``` | ## Order Tracker API This API is used for order tracking. For brand list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). > - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/order-tracker - PRODUCTION https://mgcc-api.maxsgroupinc.com/order-tracker --- | **FUNCTION** | Order Tracking | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```orderid:"",```       ```brandid:"",``` ```}``` | | **DATA DEFINITION** | {} | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Successful, Order status",```       ``` "data":{```                          ```status_id:"1"```                    ```}``` ```}``` ***Note status_id reference:*** 0 = order float 1 = order assigned to store 2 = order accepted 3 = order on the way 4 = completed| | | | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, Order ID Not found" ,```       ```"data:{}``` ```}``` | ## Place Order This API is used for customer registration. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/save-orders --- | **FUNCTION** | Place Order API | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ![](https://i.imgur.com/NFbGLCS.png) | | **DATA DEFINITION** | `{` `}` | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Successfully Placed Order.",```       ``` "data":{```                          ```order_id:""```                    ```}``` ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, please try again" ,```       ```"data:{}``` ```}``` ## Payment Status This API is used for checking of payment status. > - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/check-payment --- | **FUNCTION** | Payment Status | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```order_id:""``` ```}``` | | **DATA DEFINITION** | {} | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Payment status",```       ``` "data":{```                          ```payment_status:"COMPLETED"```                    ```}``` ```}``` ***Note payment_status reference:*** COMPLETED = Customer paid successfully REJECTED = Credit/Debit Card failed INCOMPLETE = Payment Incomplete | | | | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, Order ID Not found" ,```       ```"data:{}``` ```}``` ## Rider App Timestamps update This API is used for updating order status timestamps. > - DEVELOPMENT https://bqnlrsmifj.execute-api.ap-southeast-1.amazonaws.com/Development --- | **FUNCTION** | RiderApp Update | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```status:""```       ```ticket:""```       ```datetime:""```       ```rider_name:""``` ```}``` | | **DATA DEFINITION** | **Status parameters**: **storein** = rider arrived to the store **storeout** = rider on its way to customer **vicinityin** = rider within the customer vicinity **served** = rider served the order to customer **remit** = rider remit the cash in store **ticket number: ** order_id = ticket **date time format:** yyyy-mm-dd hh:mm:ss| | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": ""SUCCESS: Successfully Updated Timelogs"",```       ``` ``` ```}``` ***Note payment_status reference:*** COMPLETED = Customer paid successfully REJECTED = Credit/Debit Card failed INCOMPLETE = Payment Incomplete | | | | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"Failed, Order ID Not found" ,```       ```"data:{}``` ```}``` ## Data Parameter Definitions Table Name: brands Note: active column ->( 1 = activated, 0 = deactivated) default_trans -> please refe to the transaction_type table default_pricelist -> please refer to the | brand | brand_code | brand_name | active |default_trans|default_pricelist| | -------- | --------------- | -------------------------- |--------|-------------|-----------------| | 1 | MAXS | Maxs Restaurant | 1 |1 |1 | | 2 | KK | Krispy Kreme | 1 |1 |1 | | 3 | YC | Yellow Cab Pizza - Inactive | 0 |1 |1 | | 4 | PCK | Pancake House | 1 |1 |1 | | 5 | TBOY | Teriyaki Boy | 1 |1 |1 | | 7 | TCRS | The Chicken Rice Soup | 0 |1 |1 | | 8 | JJ | Jamba Juice | 1 |1 |1 | | 9 | DEN | Dencios | 1 |1 |1 | | 10 | MER | Yellow Cab 2 | 0 |1 |1 | | 11 | MCB | Max's Corner Bakery | 0 |1 |1 | | 12 | KABI | Kabisera ni Dencios | 1 |1 |1 | | 13 | MPL | Maple | 0 |1 |1 | | 14 | SING | Singkit | 0 |1 |1 | | 15 | LCDF | Le Coeur De France | 0 |1 |1 | | 16 | MGI | Maxs Group Inc | 1 |1 |1 | | 17 | YC | Yellow Cab Pizza Co. | 1 |1 |1 | | 18 | FC | Fun Chao | 1 |1 |1 | Table Name: transaction_type | id | trans_code | trans_name | | -------- | --------------- | -------------------------- | | 1 | deliveryNow | Now | | 2 | deliveryLater | Deliver later | | 3 | pickup | Inside store | | 4 | dinein | Dine-in | | 5 | curbside | Curbside® pick-up point |