---
# System prepended metadata

title: MGI - BOOKY API Documentation
tags: [MGI - BOOKY API Documentation]

---

---
title: MGI - BOOKY API Documentation
tags: MGI - BOOKY API Documentation
description: API Documentation
---
![](https://i.imgur.com/jEIPfP4.png)

<div style="text-align: center; font-size: 35px"> 
MGI - BOOKY 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      | January 20, 2022 | Final Draft Issue    |
| 0.1      | January 22, 2022| Data Dictionary      |

---
<!-- 
# API Documentation

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

# API
## Order Tracker API
<p>This API is used for order tracking.</p>

- DEVELOPMENT 

        https://913ccbjb8e.execute-api.ap-southeast-1.amazonaws.com/development/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**  | Product_id = -99 <br> option_type_id = -2 <br> option_id = -3     |
| **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>```}```  

## 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_id    | brand_code      | brand_name                  | active |default_trans|default_pricelist|
| -------- | --------------- | --------------------------  |--------|-------------|-----------------|
| 1        | MAXS            | Maxs Restaurant             |   1    |1            |1                |
| 2        | KK              | Krispy Kreme                |   1    |1            |1                |
| 4        | PCK             | Pancake House               |   1    |1            |1                |
| 5        | TBOY            | Teriyaki Boy                |   1    |1            |1                |
| 8        | JJ              | Jamba Juice                 |   1    |1            |1                |
| 9        | DEN             | Dencios                     |   1    |1            |1                |
| 11       | MCB             | Max's Corner Bakery         |   0    |1            |1                |
| 13       | MPL             | Maple                       |   0    |1            |1                |
| 16       | MGI             | Maxs Group Inc              |   1    |1            |1                |
| 17       | YC              | Yellow Cab Pizza Co.        |   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     |
 