---
# System prepended metadata

title: API Documentation
tags: [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**<br>
3rd Floor KDC Plaza Building<br>
Chino Roces Avenue. Makati City, 1231<br>
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.<br><br>
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 Documentation

- <span style="color:red">API Key provided in email</span> -->

# API
## RTA Map API
### Store Assignment
<p>This API is used to check store assignment.</p>

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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}|
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```lat:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```lng:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```brand_id:""```<br>```}```                                 |
| **DATA DEFINITION**  | {} |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```store_code: "",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```store_name:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```promise_time:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```pricelist_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```minimum_delivery:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```alternate_store:""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br>&nbsp;```}``` |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"“No store available." ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{}```<br>```}``` |


### Store Check Status

<p>This API is used to check the store status.</p>

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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                         |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```store_code:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```transaction_date_time:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>```}```                                                                          |
| **DATA DEFINITION**  | {}                                                                                                                                                                                                                                                                            |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Store available to send order.",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "data":{} ```<br>&nbsp;```}``` |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Store closed/peak." ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{}```<br>```}```                            |

---

### Menu Products

<p>This API is used to check the store status.</p>
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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                         |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```brand_id:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```pricelist_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```transaction_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```transaction_date:""```<br>```}```                                                                          |
| **DATA DEFINITION**  | {}                                                                                                                                                                                                                                                                            |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Menu Product",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "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:""}} ```<br>&nbsp;```}``` |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Error" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{}```<br>```}```                            |

---
## Store Details API

<p>This API is to get store details by brand.</p>

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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |     |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```brand_id:""```<br>```}```                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |     |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"brand_name": "",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"store_name":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"start_time":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"end_time":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"store_contact_num":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"store_ops":""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br>&nbsp;```}``` |     |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"No store details found." ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{}```<br>```}```                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |     |

---


## Registration API
<p>This API is used for customer registration.</p>

- 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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_firstname:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_middlename:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_lastname:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_country:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_houseno:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_street:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_district:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_city:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_province:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_postcode:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_contact_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```date_of_birth:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_email_address:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_password:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_source:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```created_by:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_mobile_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```scv_id:"",```<br>```}```  |
| **DATA DEFINITION**  | Password Encryption: md5  |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Successfully Registered.",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_id:""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}``` <br>```}```  
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, already registered" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_firstname:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_middlename:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_lastname:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_country:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_houseno:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_street:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_district:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_city:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_province:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_postcode:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_contact_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_email_address:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```created_by:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_mobile_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```scv_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br>```}``` | 


## Login API
<p>This API is used for customer login.</p>
- 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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                         |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```email_address:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```password:"",```<br>```}```                                                                          |
| **DATA DEFINITION**  | Password Encryption: md5                                                                                                                                                                                                                                                                            |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, already registered" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_id:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_firstname:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_middlename:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_lastname:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_country:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_houseno:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_street:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_district:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_city:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_province:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_postcode:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_contact_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_email_address:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```created_by:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_mobile_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```scv_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br>```}```  
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Login Failed" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{}```<br>```}```                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
## Order Tracker API
<p>This API is used for order tracking.</p>

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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```orderid:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```brandid:"",```<br>```}```                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| **DATA DEFINITION**  | {}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Successful, Order status",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```status_id:"1"```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}``` <br>```}```<br><br>***Note status_id reference:***<br>0 = order float<br>1 =  order assigned to store<br>2 = order accepted<br>3  = order on the way<br>4 = completed|
|                      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, Order ID Not found" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{}```<br>```}```       |

## Place Order
<p>This API is used for customer registration.</p>
- 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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}     |
| **DATA PARAMS**      |       ![](https://i.imgur.com/NFbGLCS.png)
 |
| **DATA DEFINITION**  | `{`<br>`}`       |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Successfully Placed Order.",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```order_id:""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}``` <br>```}``` |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, please try again" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{}```<br>```}```  

## Payment Status
<p>This API is used for checking of payment status.</p>

> 
- 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**<br>
3rd Floor KDC Plaza Building<br>
Chino Roces Avenue. Makati City, 1231<br>
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.<br><br>
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 Documentation

- <span style="color:red">API Key provided in email</span> -->

# API
## RTA Map API
### Store Assignment
<p>This API is used to check store assignment.</p>

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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}|
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```lat:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```lng:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```brand_id:""```<br>```}```                                 |
| **DATA DEFINITION**  | {} |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```store_code: "",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```store_name:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```promise_time:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```pricelist_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```minimum_delivery:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```alternate_store:""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br>&nbsp;```}``` |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"“No store available." ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{}```<br>```}``` |


### Store Check Status

<p>This API is used to check the store status.</p>

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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                         |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```store_code:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```transaction_date_time:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>```}```                                                                          |
| **DATA DEFINITION**  | {}                                                                                                                                                                                                                                                                            |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Store available to send order.",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "data":{} ```<br>&nbsp;```}``` |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Store closed/peak." ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{}```<br>```}```                            |

---

### Menu Products

<p>This API is used to check the store status.</p>
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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                         |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```brand_id:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```pricelist_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```transaction_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```transaction_date:""```<br>```}```                                                                          |
| **DATA DEFINITION**  | {}                                                                                                                                                                                                                                                                            |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Menu Product",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "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:""}} ```<br>&nbsp;```}``` |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Error" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{}```<br>```}```                            |

---
## Store Details API

<p>This API is to get store details by brand.</p>

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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |     |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```brand_id:""```<br>```}```                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |     |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"brand_name": "",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"store_name":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"start_time":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"end_time":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"store_contact_num":"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"store_ops":""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br>&nbsp;```}``` |     |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"No store details found." ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data":{}```<br>```}```                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |     |

---


## Registration API
<p>This API is used for customer registration.</p>

- 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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_firstname:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_middlename:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_lastname:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_country:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_houseno:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_street:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_district:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_city:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_province:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_postcode:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_contact_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```date_of_birth:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_email_address:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_password:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_source:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```created_by:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_mobile_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```scv_id:"",```<br>```}```  |
| **DATA DEFINITION**  | Password Encryption: md5  |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Successfully Registered.",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_id:""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}``` <br>```}```  
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, already registered" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_firstname:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_middlename:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_lastname:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_country:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_houseno:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_street:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_district:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_city:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_province:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_postcode:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_contact_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_email_address:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```created_by:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_mobile_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```scv_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br>```}``` | 


## Login API
<p>This API is used for customer login.</p>
- 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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                         |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```email_address:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```password:"",```<br>```}```                                                                          |
| **DATA DEFINITION**  | Password Encryption: md5                                                                                                                                                                                                                                                                            |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, already registered" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_id:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_firstname:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_middlename:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_lastname:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_country:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_houseno:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_street:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_district:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_city:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_province:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_postcode:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_contact_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_email_address:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```created_by:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```customer_mobile_no:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```scv_id:"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}```<br>```}```  
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Login Failed" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{}```<br>```}```                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
## Order Tracker API
<p>This API is used for order tracking.</p>

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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```orderid:"",``` <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```brandid:"",```<br>```}```                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| **DATA DEFINITION**  | {}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Successful, Order status",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```status_id:"1"```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}``` <br>```}```<br><br>***Note status_id reference:***<br>0 = order float<br>1 =  order assigned to store<br>2 = order accepted<br>3  = order on the way<br>4 = completed|
|                      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, Order ID Not found" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{}```<br>```}```       |

## Place Order
<p>This API is used for customer registration.</p>
- 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<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}     |
| **DATA PARAMS**      |       ![](https://i.imgur.com/NFbGLCS.png)
 |
| **DATA DEFINITION**  | `{`<br>`}`       |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Successfully Placed Order.",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```order_id:""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}``` <br>```}``` |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, please try again" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{}```<br>```}```  

## Payment Status
<p>This API is used for checking of payment status.</p>

> 
- DEVELOPMENT 

        https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/check-payment

---


| **FUNCTION**         | Payment Status                           |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **METHOD**           | POST                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **HTTP HEADERS**     | Content-Type: application/json<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```order_id:""``` <br>```}```                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| **DATA DEFINITION**  | {}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": "Payment status",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` "data":{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```payment_status:"COMPLETED"```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```}``` <br>```}```<br><br>***Note payment_status reference:***<br>COMPLETED = Customer paid successfully<br>REJECTED =  Credit/Debit Card failed<br>INCOMPLETE = Payment Incomplete |
|                      |        |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, Order ID Not found" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{}```<br>```}```   

## Rider App Timestamps update
<p>This API is used for updating order status timestamps.</p>

> 
- DEVELOPMENT 

        https://bqnlrsmifj.execute-api.ap-southeast-1.amazonaws.com/Development

---


| **FUNCTION**         | RiderApp Update                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **METHOD**           | POST          |
| **HTTP HEADERS**     | Content-Type: application/json<br> x-api-key: {<span style="color:red">*Note: API key to be sent separately*</span>}   |
| **DATA PARAMS**      | ```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```status:""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```ticket:""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```datetime:""```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```rider_name:""``` <br>```}``` |
| **DATA DEFINITION**  | **Status parameters**: <br>  <br>  **storein** = rider arrived to the store<br>**storeout** = rider on its way to customer<br> **vicinityin** = rider within the customer vicinity <br> **served** = rider served the order to customer <br> **remit** = rider remit the cash in store <br><br> **ticket number: ** order_id = ticket<br><br> **date time format:**  yyyy-mm-dd hh:mm:ss|
| **SUCCESS RESPONSE** | Status: 200<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 200,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message": ""SUCCESS: Successfully Updated Timelogs"",```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;``` ``` <br>```}```<br><br>***Note payment_status reference:***<br>COMPLETED = Customer paid successfully<br>REJECTED =  Credit/Debit Card failed<br>INCOMPLETE = Payment Incomplete |
|                      |        |
| **ERROR RESPONSE**   | Status: 69<br>Sample Response Body:<br>```{```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"code": 69,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"message":"Failed, Order ID Not found" ,```<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```"data:{}```<br>```}```   

## Data Parameter Definitions

Table Name: <b>brands</b>
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: <b>transaction_type</b>

| 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     |
 