Web Ordering 2.0 API Documentation

--- title: Web Ordering 2.0 API Documentation tags: Web Ordering 2.0 API Documentation description: API Documentation --- ![](https://i.imgur.com/jEIPfP4.png) <div style="text-align: center; font-size: 35px"> WEB ORDERING API Documentation </div> --- # Copyright Information **Maxs Group Inc - IT Application Development** 3rd Floor KDC Plaza Building Chino Roces Avenue. Makati City, 1231 Email: appdev@maxsgroupinc.com --- # Confidentiality and Usage <div style="text-align: justify">The information contained in this document (and any attachments) is a confidential information provided by MGI IT - Application Development. This document is intended only for use by merchants approved by MGI. Any copying, distribution or dissemination of this document by any other parties is prohibited.</div> --- # Revision History | Revision | Date | Revision Description | | -------- | --------------- | -------------------- | | 0.0 | August 01, 2022 | Final Draft | | 1.0 | September 18, 2022|Initial Release | | 1.1 | September 23, 2022| Tempo DR Revision| ---  # API ## WEB ORDER 2.0 API ### Temporary Delivery Receipt This API is used to process and download word document. For commissary list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). - DEVELOPMENT https://9sda584osh.execute-api.ap-southeast-1.amazonaws.com/development/report-export-word - PRODUCTION https://9sda584osh.execute-api.ap-southeast-1.amazonaws.com/production/report-export-word --- | **FUNCTION** | Web ordering export word | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*}| | **DATA PARAMS** | ```{```       ```erp_org_id_num:"",```       ```delivery_date_from:"",```       ```delivery_date_to:"",```       ```report_name:"",```       ```filter_params:""``` ```}``` | | **DATA DEFINITION** |       ```erp_org_id_num:" ERP ORG CODE",```       ```delivery_date_from:"",```       ```delivery_date_to:"",```       ```report_name:"",```       ```filter_params:""``` | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message":"",```       ```"data":{```                       ```customer_name: "",```                       ```erp_org_code:"",```                       ```promise_time:"",```                       ```item_code:"",```                       ```item_name:"",```                       ```quantity:""```                     ```}```  ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":"“No store available." ,```       ```"data":{}``` ```}``` | ### Order Summary Report per Store and per Item This API is used to extract excel store orders summary report per store. For brand list definition > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). - DEVELOPMENT https://9sda584osh.execute-api.ap-southeast-1.amazonaws.com/development/report-export - PRODUCTION https://9sda584osh.execute-api.ap-southeast-1.amazonaws.com/production/report-export --- | **FUNCTION** | mgi-web-ordering | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```commi_id:"",```       ```delivery_date_from:"",```       ```delivery_date_to:"",```       ```comminame:"",```       ```reporttype:"",```       ```order_type_id:"",```        ```}``` | | **DATA DEFINITION** | ```commi_id:" ERP ORG CODE",``` ```comminame:" REPORT NAME",``` ```delivery_date_from:" Delivery Date",``` ```delivery_date_to:" Delivery Date ",``` ```reporttype:" order_summary_store",``` ```order_type_id:" order class",``` | | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Extracted Successfully ",```       ``` "data":{} ```  ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":" No data available." ,```       ```"data":{}``` ```}``` | --- ### Auto Allocation Import Data This API is used to extract excel store orders summary report per Item. For commissary list and order class definitions > See full list [here](https://hackmd.io/pa3z7pZmQDmbjYKBBC-IXQ?view#Data-Parameter-Definitions). - DEVELOPMENT https://9sda584osh.execute-api.ap-southeast-1.amazonaws.com/development/order-imports - PRODUCTION https://9sda584osh.execute-api.ap-southeast-1.amazonaws.com/production/order-imports --- | **FUNCTION** | mgi-web-ordering-import-items | | -------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **METHOD** | POST | | **HTTP HEADERS** | Content-Type: application/json x-api-key: {*Note: API key to be sent separately*} | | **DATA PARAMS** | ```{```       ```operation:"",```       ```tableName:"",```       ```headerid:"",```       ```payload:""``` ```}``` | | **DATA DEFINITION** |       ```operation:"CREATE",```       ```tableName:"orders_items_auto_allocate_tmp",```       ```headerid:" HEADER ID",```       ```payload:" EXCEL DATA ARRAY"``` | **SUCCESS RESPONSE** | Status: 200 Sample Response Body: ```{```       ```"code": 200,```       ```"message": "Upload Successfully ",```       ``` "data":{} ```  ```}``` | | **ERROR RESPONSE** | Status: 69 Sample Response Body: ```{```       ```"code": 69,```       ```"message":" Upload Unsuccessful." ,```       ```"data":{}``` ```}``` | |