Copyright Information

![](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| | 1.1 | January 20, 2023| Additional Response and Delivery address API| | 1.2 | January 31, 2023| Additional Data Parameter and Best paired API| | 1.3 | Febuary 14, 2023| Additional Data Parameter and Notes| | 1.4 | Febuary 17, 2023| Check store status API change date to time format | | 1.5 | Febuary 20, 2023| Additional Data Parameter (extended service time) | | 1.6 | Febuary 20, 2023| Single Customer View, Province and City API | | 1.7 | Febuary 21, 2023| Delivery Zones API | | 2.0 | March 01, 2023 | Version 2 | | 2.1 | March 10, 2023 | Place order error response | | 2.2 | March 22, 2023 | Additional payment_id parameter | | 2.3 | April 5, 2023 | Remove brand_id in check store cater | --- # API ## RTA Map API ### Delivery Zones This API is used to check stores delivery zones. For brand list definition > See full list [here](#Data-Parameter-Definitions). - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/delivery-zones - PRODUCTION https://mgcc-api.maxsgroupinc.com/delivery-zones --- | **FUNCTION** | Check stores delivery zones | | - | -| | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*}| | **DATA PARAMS** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/deliveryzonebody.JPG" width="170"> | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/deliveryzonesuccess1.JPG" width="350"> | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/deliveryzonefailed.JPG" width="300"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Store Assignment This API is used to check store assignment. For brand list definition > See full list [here](#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** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/storecaterbody.JPG" width="200"> | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/storecatersuccess.JPG" width="350"> <img src="https://mgi-deliveryportal.s3.amazonaws.com/storecatersuccess1.JPG" width="350"> | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/ota.JPG" width="300"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Store Check Status This API is used to check the store status. For brand list definition > See full list [here](#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** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/storecheckbody.JPG" width="300"> ***Note transaction_date_time - 24hrs time format: (H:i:s)*** | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/storechecksuccess.JPG" width="400"> ***Note: add extended_service_time on top of the promise_time*** | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/storecheckerror.JPG" width="400"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Store Details This API is to get store details by brand. For brand list definition > See full list [here](#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 | | - | - | | **METHOD** | GET | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/deliveryzonebody.JPG" width="150"> | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/storelistsuccess.JPG" width="400"> | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/storelisterror.JPG" width="300"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ## Menu API ### Menu Products v1 This API is to check all menu of the store. For brand list and transaction type definitions > See full list [here](#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** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/menubody.JPG" width="240"> ***Note transaction_date format: (Y-m-d)*** | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/menusuccess.JPG" width="400"> | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/menuerror.JPG" width="300"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Menu Best Paired With This API is used to view best paired product. For brand list and transaction type definitions > See full list [here](#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/best-paired - PRODUCTION https://mgcc-api.maxsgroupinc.com/best-paired --- | **FUNCTION** | Menu Best Paired | |-|-| | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/bestpairedbody.JPG" width="250"> ***Note date format: (Y-m-d h:i:s)*** | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/bestpairedsuccess.JPG" width="400"> | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/bestpairederror.JPG" width="300"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ## Customer API ### Registration 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** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/registerbody.JPG" width="400"> *Note: scv_id can get in Single Customer View API* | | **DATA DEFINITION** | Password Encryption: md5 | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/registersuccess1.JPG" width="300"> | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/registererror.JPG" width="400"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Login v1 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** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/loginbody.JPG" width="350"> | | **DATA DEFINITION** | Password Encryption: md5 | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/loginv1success.JPG" width="400"> | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/loginerror.JPG" width="250"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Login v2 This API is used for customer login and get customer delivery addresses. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/customer-login-v2 - PRODUCTION https://mgcc-api.maxsgroupinc.com/customer-login-v2 --- | **FUNCTION** | Customer Login | |-|-| | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/loginbody.JPG" width="350"> | | **DATA DEFINITION** | Password Encryption: md5 | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/loginv2success.JPG" width="400"> | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/loginerror.JPG" width="250"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Update Customer This API is used for updating customer info. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/customer-update - PRODUCTION https://mgcc-api.maxsgroupinc.com/customer-update --- | **FUNCTION** | Update Customer | |-|-| | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/customerupdatebody.JPG" width="300"> | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/customerupdatesuccess.JPG" width="400"> | | **ERROR RESPONSE** | Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Delivery Address This API is used for customer delivery address. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/customer-addresses - PRODUCTION https://mgcc-api.maxsgroupinc.com/customer-addresses --- | **FUNCTION** | Customer Delivery Address | |-|-| | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/deladdbody.JPG" width="200"> | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/deladdsuccess.JPG" width="400"> | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/deladderror.JPG" width="300">` Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Update Delivery Address This API is used for updating customer delivery address. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/update-customer-addresses - PRODUCTION https://mgcc-api.maxsgroupinc.com/update-customer-addresses --- | **FUNCTION** | Update Customer Delivery Address | |-|-| | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/delupdatebody.JPG" width="350"> | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/delupdatesuccess.JPG" width="300"> | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/delupdateerror.JPG" width="250">` Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ## Order API ### Place Order This API is used for saving order > - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/save-orders --- - PRODUCTION https://mgcc-api.maxsgroupinc.com/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** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/placeorderbody.JPG" width="350"> <img src="https://mgi-deliveryportal.s3.amazonaws.com/placeorderbody1.JPG" width="350"> ***Note: If customer uses exisitng delivery address, the dlvry_address_id can get in Delivery Address API. If customer use new delivery address, dlvry_address_id = NEW cutleries values With Cutleries or Without Cutleries If item_options is empty. The format should be in a object json. "item_options": [{}] *** | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/placeordersuccess.JPG" width="350"> | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/placeordererror2.JPG" width="350"> Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/placeordererror1.JPG" width="300"> Status: 400 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/placeordererror.JPG" width="300"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Order Tracker This API is used for order tracking. For brand list definition > See full list [here](#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** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/ordertrackerbody.JPG" width="200"> | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/ordertrackersuccess.JPG" width="400"> ***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: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/ordertrackererror.JPG" width="300"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ### Payment Status This API is used for checking of payment status. - DEVELOPMENT https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/check-payment --- - PRODUCTION https://mgcc-api.maxsgroupinc.com/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** | <img src="https://mgi-deliveryportal.s3.amazonaws.com/paymentbody.JPG" width="200"> | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/paymentsuccess.JPG" width="350"> ***Note payment_status reference:*** COMPLETED = Customer paid successfully REJECTED = Credit/Debit Card failed INCOMPLETE = Payment Incomplete | | **ERROR RESPONSE** | Status: 202 Sample Response Body: <img src="https://mgi-deliveryportal.s3.amazonaws.com/paymenterror.JPG" width="300"> Status: 500 Sample Response Body <img src="https://mgi-deliveryportal.s3.amazonaws.com/missingparam.JPG" width="300"> | --- ## Rider App Timestamps update This API is used for updating order status timestamps. - DEVELOPMENT https://bqnlrsmifj.execute-api.ap-southeast-1.amazonaws.com/Development --- - PRODUCTION https://bqnlrsmifj.execute-api.ap-southeast-1.amazonaws.com/Production --- | **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:{}``` ```}``` --- ## Single Customer View ### Check and Create Customer This API is used for checking and creating a customer. > - DEVELOPMENT https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/DEV/checkcustomer --- - PRODUCTION https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/Production/createcustomer --- | **FUNCTION** | Check and Create Customer | | - | - | | **METHOD** | GET | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```first_name:"Foo",```       ```last_name:"Bar",```       ```email_address:"foo@bar.com",```       ```mobile_number:"9776592285",```       ```municipality:"City of Makati",```       ```province:"Metro Manila",```       ```birthday:"0000-12-31",```       ```gender:"M",```       ```source:"PROJECT NAME"``` ```}``` *Note: Province (from Province List API) & Municipality (from Citylist API) | | **DATA DEFINITION** |first_name- String last_name- String email_address - String mobile_number- int(10) municipality- String province - String birthday- String(YYYY-MM-DD) gender - String(1) Source - String | | **SUCCESS RESPONSE** | **If inputted email_address, first_name, and last_name already exist in the database. ** Status: 100 Sample Response Body: ```{```       ```"code": 100,```       ```"message": "SUCCESS: Successfully created user",```       ```"data": {```                     ```"id": "MGI126",```                     ```"status": "exist-accepted",```       ```}``` ```}``` *Note: Return id from data is the SCV Customer_id **If inputted email_address already exist in the database, but first_name, and last_name is not equal .** Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message": "Warning: User already exists! (Duplicate customer/contact details)",```       ```"data": {```                     ```"id": "MGI126",```                     ```"status": "exist-conflict",```       ```}``` ```}``` *Note: Return id from data is the SCV Customer_id Status: 404 Sample Response Body: ```{```       ```"code": 404,```       ```"message": "Insufficient number of arguments passed.Expected 14 got 13"``` ```}``` | | **ERROR RESPONSE** | **Code** : 1000 **Description**: Query runtime error. See logs associated with the error response **Code** : 2003 **Description** : Cannot establish connection to MySQL Server | --- ### Update Customer Details This API is used for updating customer info. > - DEVELOPMENT https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/DEV/updatecust --- - PRODUCTION https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/Production/updatecustomer --- | **FUNCTION** | Update Customer Details | | - | - | | **METHOD** | GET | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```scvid:"MGI11",```       ```first_name:"Foo",```       ```last_name:"Bar",```       ```email_address:"foo@bar.com",```       ```other_contact_no:"91111111",```       ```mobile_number:"9776592285",```       ```country:"PH",```       ```municipality:"City of Makati",```       ```province:"Metro Manila",```       ```town:"Metro Manila",```       ```address:"house no, street,brgy, district",```       ```birthday:"0000-12-31",```       ```gender:"M",```       ```source:"PROJECT NAME"``` ```}``` *Note: Province (from Province List API) & Municipality (from Citylist API) | | **DATA DEFINITION** | customer_id- String first_name- String last_name- String email_address - String mobile_number- int(10) municipality- String province - String birthday- String(YYYY-MM-DD) gender - String(1) Source - String | | **SUCCESS RESPONSE** | **If inputted email_address already exist in the database.** Status: 100 Sample Response Body: ```{```       ```"code": 100,```       ```"message": "SUCCESS: User Details Successfully Updated",```       ```"data": {```                     ```"id": "MGI126",```                     ```"status": "updated",```       ```}``` ```}``` *Note: Return value from data is the SCV Customer_id **If new inputted email_address already exist in the database** Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message": "Warning: Email Address Already Taken!",```       ```"data": {```                     ```"id": "MGI126",```                     ```"status": "conflict",```       ```}``` ```}``` *Note: Return id from data is the SCV Customer_id Status: 404 Sample Response Body: ```{```       ```"code": 404,```       ```"message": "Insufficient number of arguments passed.Expected 14 got 13"``` ```}``` | | **ERROR RESPONSE** | **Code** : 1000 **Description**: Query runtime error. See logs associated with the error response **Code** : 2003 **Description** : Cannot establish connection to MySQL Server | --- ### Opt-in This API is used for sending special offers,news and updates to the customer > - DEVELOPMENT https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/DEV/optincustomer --- - PRODUCTION https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/Production/optincustomer --- | **FUNCTION** | Opt-in | | - | - | | **METHOD** | GET | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```brand:"4",```       ```scvid:"143",```       ```source:"PROJECT NAME"``` ```}``` | | **DATA DEFINITION** | brand - Int scvid - int source - String | | **SUCCESS RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message": "Warning: Opt-in Failed",```       ```"data": False``` ```}``` Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "SUCCESS: Successfully Opt-in"``` ```}``` Status: 404 Sample Response Body: ```{```       ```"code": 404,```       ```"message": "Insufficient number of arguments passed.Expected 14 got 13"``` ```}``` | | **ERROR RESPONSE** | **Code** : 1000 **Description**: Query runtime error. See logs associated with the error response **Code** : 2003 **Description** : Cannot establish connection to MySQL Server | --- ### Province List This API is used for getting all the provinces. > - DEVELOPMENT https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/DEV/provincelist --- - PRODUCTION https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/Production/provincelist --- | **FUNCTION** | Province List | | - | - | | **METHOD** | GET | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{}``` | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 100,```       ```"message": "SUCCESS",```       ```"data": {Provinces}``` ```}``` Status: 404 Sample Response Body: ```{```       ```"code": 404,```       ```"message": "Insufficient number of arguments passed.Expected 14 got 13"``` ```}``` | | **ERROR RESPONSE** | **Code** : 1000 **Description**: Query runtime error. See logs associated with the error response **Code** : 2003 **Description** : Cannot establish connection to MySQL Server | --- ### City List This API is used for getting all the cities per province. > - DEVELOPMENT https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/DEV/citylist --- - PRODUCTION https://e30852sr65.execute-api.ap-southeast-1.amazonaws.com/Production/citylist --- | **FUNCTION** | City List | | - | - | | **METHOD** | GET | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{}``` | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 100,```       ```"message": "SUCCESS",```       ```"data": {Cities}``` ```}``` Status: 404 Sample Response Body: ```{```       ```"code": 404,```       ```"message": "Insufficient number of arguments passed.Expected 14 got 13"``` ```}``` | | **ERROR RESPONSE** | **Code** : 1000 **Description**: Query runtime error. See logs associated with the error response **Code** : 2003 **Description** : Cannot establish connection to MySQL Server | --- # 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 | Use in Place order API **payment_options** column. | payment_id | payment_options | | --- | --- | | 1 | Cash on Delivery | | 2 | Credit Card on Delivery | | 3 | Pay Online via Credit Card/Debit Card | | 7 | Globe GCash | | 359 | BPI Bank Online Transfer | | 357 | ShopeePay | | 372 | TendoPay |