| Server IP : 34.87.99.72 / Your IP : 216.73.217.31 Web Server : Apache/2.4.46 (Unix) OpenSSL/1.1.1n System : Linux zlock-bitnami-lamp-prod-v2-vm 4.19.0-16-cloud-amd64 #1 SMP Debian 4.19.181-1 (2021-03-19) x86_64 User : bitnami ( 1000) PHP Version : 7.4.18 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /home/bitnami/htdocs/app/storage/api-docs/ |
Upload File : |
{
"openapi": "3.0.0",
"info": {
"title": "Zlock API Documentation",
"description": "L5 Swagger Api for Zlock",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0.0"
},
"paths": {
"/api/auth/login": {
"post": {
"tags": [
"Auth"
],
"summary": "Login User",
"operationId": "loginDefault",
"parameters": [
{
"name": "email",
"in": "query",
"description": "Email",
"schema": {
"type": "string",
"default": "student1"
}
},
{
"name": "login",
"in": "query",
"description": "User Id OR Email",
"schema": {
"type": "string",
"default": "Z202100001"
}
},
{
"name": "password",
"in": "query",
"description": "Password",
"schema": {
"type": "string",
"default": "12345678"
}
},
{
"name": "device_name",
"in": "query",
"description": "Device Name",
"schema": {
"type": "string",
"default": "swagger"
}
},
{
"name": "terminal_id",
"in": "query",
"description": "Locker Terminal ID",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "fcm_token",
"in": "query",
"description": "fcm_token",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "platform",
"in": "query",
"description": "platform",
"schema": {
"type": "enum",
"default": "",
"enum": [
"ios",
"android",
"web"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
}
]
}
},
"/api/auth/knight": {
"post": {
"tags": [
"Auth"
],
"summary": "Login Knight",
"operationId": "login - knight",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "full_name",
"in": "query",
"description": "full_name",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "email",
"in": "query",
"description": "email",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "secret",
"in": "query",
"description": "secret",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "device_name",
"in": "query",
"description": "Device Name",
"schema": {
"type": "string",
"default": "swagger"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
}
]
}
},
"/api/auth/register": {
"post": {
"tags": [
"Auth"
],
"summary": "Register",
"operationId": "register",
"parameters": [
{
"name": "full_name",
"in": "query",
"description": "full_name",
"schema": {
"type": "string",
"default": "student1"
}
},
{
"name": "email",
"in": "query",
"description": "email",
"schema": {
"type": "string"
}
},
{
"name": "mobile_num",
"in": "query",
"description": "mobile_num",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "query",
"description": "Mobile OTP code",
"schema": {
"type": "string"
}
},
{
"name": "gender",
"in": "query",
"description": "Gender (Male/Female)",
"schema": {
"type": "enum",
"default": "",
"enum": [
"Male",
"Female"
]
}
},
{
"name": "address",
"in": "query",
"description": "Address",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "postcode",
"in": "query",
"description": "Postcode",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "city",
"in": "query",
"description": "City",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "state",
"in": "query",
"description": "State",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "password",
"in": "query",
"description": "Password",
"schema": {
"type": "string",
"default": "12345678"
}
},
{
"name": "password_confirmation",
"in": "query",
"description": "Confirm Password",
"schema": {
"type": "string",
"default": "12345678"
}
},
{
"name": "device_name",
"in": "query",
"description": "device_name ( if set, will auto login and return token )",
"schema": {
"type": "string",
"default": "swagger"
}
},
{
"name": "fcm_token",
"in": "query",
"description": "fcm_token",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "platform",
"in": "query",
"description": "platform",
"schema": {
"type": "enum",
"default": "",
"enum": [
"ios",
"android"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
}
]
}
},
"/api/auth/update": {
"put": {
"tags": [
"Auth"
],
"summary": "Edit Profile",
"operationId": "update",
"parameters": [
{
"name": "full_name",
"in": "query",
"description": "full_name",
"schema": {
"type": "string",
"default": "student1"
}
},
{
"name": "mobile_num",
"in": "query",
"description": "mobile_num",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "gender",
"in": "query",
"description": "Gender (Male/Female)",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "address",
"in": "query",
"description": "Address",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "postcode",
"in": "query",
"description": "Postcode",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "city",
"in": "query",
"description": "City",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "state",
"in": "query",
"description": "State",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/user": {
"get": {
"tags": [
"Auth"
],
"summary": "Get Auth User",
"operationId": "user",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/logout": {
"delete": {
"tags": [
"Auth"
],
"summary": "Logout",
"operationId": "logout",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/check-password": {
"get": {
"tags": [
"Auth"
],
"summary": "Check Auth Password",
"operationId": "checkAuthPassword",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/edit-password": {
"put": {
"tags": [
"Auth"
],
"summary": "Edit Password",
"operationId": "editPassword",
"parameters": [
{
"name": "current_password",
"in": "query",
"description": "current Password",
"schema": {
"type": "string",
"default": "12345678"
}
},
{
"name": "password",
"in": "query",
"description": "Password",
"schema": {
"type": "string",
"default": "12345678"
}
},
{
"name": "password_confirmation",
"in": "query",
"description": "Confirm Password",
"schema": {
"type": "string",
"default": "12345678"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/forgot-password": {
"post": {
"tags": [
"Auth"
],
"summary": "Forgot Password by email",
"operationId": "forgotPassword",
"parameters": [
{
"name": "email",
"in": "query",
"description": "email",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
}
]
}
},
"/api/auth/phone-verification": {
"post": {
"tags": [
"Auth"
],
"summary": "Initialize phone verification process.",
"operationId": "phoneVerification",
"parameters": [
{
"name": "mobile_num",
"in": "query",
"description": "mobile_num",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "recaptcha_token",
"in": "query",
"description": "recaptcha_token",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/update-mobile": {
"put": {
"tags": [
"Auth"
],
"summary": "Update the mobile number info for user that registered using oauth2",
"operationId": "updateMobieNumber",
"parameters": [
{
"name": "mobile_num",
"in": "query",
"description": "mobile_num",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "query",
"description": "code",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/email-verification": {
"post": {
"tags": [
"Auth"
],
"summary": "Initialize email verification process.",
"operationId": "emailVerification",
"parameters": [
{
"name": "email",
"in": "query",
"description": "email",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/update-email": {
"put": {
"tags": [
"Auth"
],
"summary": "Update the email info for user that registered using oauth2",
"operationId": "updateEmail",
"parameters": [
{
"name": "email",
"in": "query",
"description": "email",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "code",
"in": "query",
"description": "code",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/update-fcm": {
"put": {
"tags": [
"Auth"
],
"summary": "Update the user fcm token",
"operationId": "updateFcmToken",
"parameters": [
{
"name": "fcm_token",
"in": "query",
"description": "fcm_token",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/delete-account": {
"delete": {
"tags": [
"Auth"
],
"summary": "Delete user account",
"operationId": "deleteAccount",
"parameters": [
{
"name": "password",
"in": "query",
"description": "password",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/auth/{type}/login": {
"post": {
"tags": [
"Auth - Socialize"
],
"summary": "Login User with Socialize",
"operationId": "socializeLogin",
"parameters": [
{
"name": "type",
"in": "path",
"description": "type",
"schema": {
"type": "enum",
"default": "apple",
"enum": [
"apple",
"google",
"facebook"
]
}
},
{
"name": "access_token",
"in": "query",
"description": "access_token",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "device_name",
"in": "query",
"description": "Device Name",
"schema": {
"type": "string",
"default": "swagger"
}
},
{
"name": "fcm_token",
"in": "query",
"description": "fcm_token",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "platform",
"in": "query",
"description": "platform",
"schema": {
"type": "enum",
"default": "",
"enum": [
"ios",
"android"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
}
]
}
},
"/api/box-booking/list/{type}": {
"get": {
"tags": [
"Box Booking"
],
"summary": "BoxBooking List",
"operationId": "BoxBookingList",
"parameters": [
{
"name": "type",
"in": "path",
"description": "type",
"schema": {
"type": "enum",
"default": "history",
"enum": [
"on-going-history"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-booking/open-box": {
"post": {
"tags": [
"Box Booking"
],
"summary": "boxBookingOpenBox",
"operationId": "boxBookingOpenBox",
"parameters": [
{
"name": "type",
"in": "query",
"description": "type",
"schema": {
"type": "enum",
"enum": [
"inventory",
"delivery"
]
}
},
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-booking/qr-open-box": {
"post": {
"tags": [
"Box Booking"
],
"summary": "boxBookingQrOpenBox",
"operationId": "boxBookingQrOpenBox",
"parameters": [
{
"name": "booking_type",
"in": "query",
"description": "booking_type",
"schema": {
"type": "enum",
"enum": [
"inventory",
"delivery"
]
}
},
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-booking/expired-list": {
"get": {
"tags": [
"Box Booking"
],
"summary": "boxBookingExpiredList",
"operationId": "boxBookingExpiredList",
"parameters": [
{
"name": "terminal_id",
"in": "query",
"description": "terminal_id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-booking/force-cancel": {
"post": {
"tags": [
"Box Booking"
],
"summary": "forceCancel",
"operationId": "forceCancel",
"parameters": [
{
"name": "booking_type",
"in": "query",
"description": "booking_type",
"schema": {
"type": "enum",
"enum": [
"inventory",
"delivery"
]
}
},
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/list/{type}": {
"get": {
"tags": [
"Box Delivery"
],
"summary": "BoxDelivery List",
"operationId": "BoxDeliveryList",
"parameters": [
{
"name": "terminal_id",
"in": "query",
"description": "terminal_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "delivery_partner_id",
"in": "query",
"description": "delivery_partner_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "type",
"in": "path",
"description": "type",
"schema": {
"type": "enum",
"default": "history",
"enum": [
"history",
"delivery",
"drop-off",
"on-going-history"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/info/{id}": {
"get": {
"tags": [
"Box Delivery"
],
"summary": "BoxDeliveryInfo",
"operationId": "boxDeliveryInfo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/parcel-type": {
"get": {
"tags": [
"Box Delivery"
],
"summary": "DeliveryParcelType",
"operationId": "deliveryParcelType",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/check-parcel-info": {
"get": {
"tags": [
"Box Delivery"
],
"summary": "Check parcel dimension and weight",
"operationId": "checkParcelInfo",
"parameters": [
{
"name": "parcel_type",
"in": "query",
"description": "parcel_type",
"schema": {
"type": "string",
"default": "1"
}
},
{
"name": "box_size_id",
"in": "query",
"description": "box_size_id",
"schema": {
"type": "string",
"default": "2"
}
},
{
"name": "parcel_length",
"in": "query",
"description": "parcel_length",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "parcel_width",
"in": "query",
"description": "parcel_width",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "parcel_height",
"in": "query",
"description": "parcel_height",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "parcel_weight",
"in": "query",
"description": "parcel_weight",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "receiver_postcode",
"in": "query",
"description": "receiver_postcode",
"schema": {
"type": "string",
"default": "71800"
}
},
{
"name": "receiver_city",
"in": "query",
"description": "receiver_city",
"schema": {
"type": "string",
"default": "Nilai"
}
},
{
"name": "receiver_state",
"in": "query",
"description": "receiver_state",
"schema": {
"type": "string",
"default": "Negeri Sembilan"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/check-delivery-detail": {
"get": {
"tags": [
"Box Delivery"
],
"summary": "Check Delivery Details",
"operationId": "checkDeliveryDetails",
"parameters": [
{
"name": "parcel_info",
"in": "query",
"description": "parcel_info",
"schema": {
"type": "string",
"default": "Groceries"
}
},
{
"name": "dropper_name",
"in": "query",
"description": "dropper_name",
"schema": {
"type": "string",
"default": "customer"
}
},
{
"name": "dropper_num",
"in": "query",
"description": "dropper_num",
"schema": {
"type": "string",
"default": "+60136265471"
}
},
{
"name": "receiver_name",
"in": "query",
"description": "receiver_name",
"schema": {
"type": "string",
"default": "customer_2"
}
},
{
"name": "receiver_email",
"in": "query",
"description": "receiver_email",
"schema": {
"type": "string",
"default": "customer_2@email.com"
}
},
{
"name": "receiver_num",
"in": "query",
"description": "receiver_num",
"schema": {
"type": "string",
"default": "+60136265470"
}
},
{
"name": "receiver_house_num",
"in": "query",
"description": "receiver_house_num",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "receiver_address",
"in": "query",
"description": "receiver_address",
"schema": {
"type": "string",
"default": "12, Jalan Desa Kasia, Taman Desa Kasia"
}
},
{
"name": "receiver_postcode",
"in": "query",
"description": "receiver_postcode",
"schema": {
"type": "string",
"default": "71800"
}
},
{
"name": "receiver_city",
"in": "query",
"description": "receiver_city",
"schema": {
"type": "string",
"default": "Nilai"
}
},
{
"name": "receiver_state",
"in": "query",
"description": "receiver_state",
"schema": {
"type": "string",
"default": "Negeri Sembilan"
}
},
{
"name": "remarks",
"in": "query",
"description": "remarks",
"schema": {
"type": "string",
"default": "No Remarks"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/booking": {
"post": {
"tags": [
"Box Delivery"
],
"summary": "boxDeliveryBooking",
"operationId": "boxDeliveryBooking",
"parameters": [
{
"name": "locker_id",
"in": "query",
"description": "locker_id",
"schema": {
"type": "string",
"default": "4"
}
},
{
"name": "box_size_id",
"in": "query",
"description": "box_size_id",
"schema": {
"type": "string",
"default": "2"
}
},
{
"name": "delivery_partner_id",
"in": "query",
"description": "delivery_partner_id",
"schema": {
"type": "string",
"default": "1"
}
},
{
"name": "parcel_info",
"in": "query",
"description": "parcel_info",
"schema": {
"type": "string",
"default": "Groceries"
}
},
{
"name": "parcel_type",
"in": "query",
"description": "parcel_type",
"schema": {
"type": "string",
"default": "1"
}
},
{
"name": "parcel_length",
"in": "query",
"description": "parcel_length",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "parcel_width",
"in": "query",
"description": "parcel_width",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "parcel_height",
"in": "query",
"description": "parcel_height",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "parcel_weight",
"in": "query",
"description": "parcel_weight",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "dropper_name",
"in": "query",
"description": "dropper_name",
"schema": {
"type": "string",
"default": "customer"
}
},
{
"name": "dropper_num",
"in": "query",
"description": "dropper_num",
"schema": {
"type": "string",
"default": "+60136265471"
}
},
{
"name": "receiver_name",
"in": "query",
"description": "receiver_name",
"schema": {
"type": "string",
"default": "customer_2"
}
},
{
"name": "receiver_email",
"in": "query",
"description": "receiver_email",
"schema": {
"type": "string",
"default": "customer_2@email.com"
}
},
{
"name": "receiver_num",
"in": "query",
"description": "receiver_num",
"schema": {
"type": "string",
"default": "+60136265470"
}
},
{
"name": "receiver_house_num",
"in": "query",
"description": "receiver_house_num",
"schema": {
"type": "string",
"default": "12"
}
},
{
"name": "receiver_address",
"in": "query",
"description": "receiver_address",
"schema": {
"type": "string",
"default": "12, Jalan Desa Kasia, Taman Desa Kasia"
}
},
{
"name": "receiver_postcode",
"in": "query",
"description": "receiver_postcode",
"schema": {
"type": "string",
"default": "71800"
}
},
{
"name": "receiver_city",
"in": "query",
"description": "receiver_city",
"schema": {
"type": "string",
"default": "Nilai"
}
},
{
"name": "receiver_state",
"in": "query",
"description": "receiver_state",
"schema": {
"type": "string",
"default": "Negeri Sembilan"
}
},
{
"name": "remarks",
"in": "query",
"description": "remarks",
"schema": {
"type": "string",
"default": "No Remarks"
}
},
{
"name": "credit_amount",
"in": "query",
"description": "credit_amount",
"schema": {
"type": "string",
"default": "12"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/open-box": {
"post": {
"tags": [
"Box Delivery"
],
"summary": "boxDeliveryOpenBox",
"operationId": "boxDeliveryOpenBox",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/collect": {
"post": {
"tags": [
"Box Delivery"
],
"summary": "boxDeliveryCollect",
"operationId": "boxDeliveryCollect",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/cancel": {
"delete": {
"tags": [
"Box Delivery"
],
"summary": "boxDeliveryCancel",
"operationId": "boxDeliveryCancel",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/print-label": {
"post": {
"tags": [
"Box Delivery"
],
"summary": "boxDeliveryTestPrint",
"operationId": "boxDeliveryTestPrint",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-delivery/test-alert": {
"post": {
"tags": [
"Box Delivery"
],
"summary": "boxDeliveryTestAlert",
"operationId": "boxDeliveryTestAlert",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-inventory/list/{type}": {
"get": {
"tags": [
"Box Inventory"
],
"summary": "BoxInventory List",
"operationId": "BoxInventoryList",
"parameters": [
{
"name": "type",
"in": "path",
"description": "type",
"schema": {
"type": "enum",
"default": "history",
"enum": [
"history",
"collect",
"drop-off",
"on-going-history"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-inventory/info/{id}": {
"get": {
"tags": [
"Box Inventory"
],
"summary": "BoxInventoryInfo",
"operationId": "boxInventoryInfo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-inventory/generate-qr-code": {
"get": {
"tags": [
"Box Inventory"
],
"summary": "Generate QR Code",
"operationId": "generateQrCode",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "type",
"in": "query",
"description": "Type of Qr Code",
"schema": {
"type": "string",
"default": "",
"enum": [
"dropper",
"collector"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-inventory/booking": {
"post": {
"tags": [
"Box Inventory"
],
"summary": "boxInventoryBooking",
"operationId": "boxInventoryBooking",
"parameters": [
{
"name": "locker_id",
"in": "query",
"description": "locker_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "box_size_id",
"in": "query",
"description": "box_size_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "reserved_minute",
"in": "query",
"description": "reserved_minute",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "collector_num",
"in": "query",
"description": "collector_num",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "credit_amount",
"in": "query",
"description": "credit_amount",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-inventory/locker-booking": {
"post": {
"tags": [
"Box Inventory"
],
"summary": "Perform inventory booking at the locker",
"operationId": "lockerInventoryBooking",
"parameters": [
{
"name": "terminal_id",
"in": "query",
"description": "terminal_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "box_size_id",
"in": "query",
"description": "box_size_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "shipment_id",
"in": "query",
"description": "shipment_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "collector_num",
"in": "query",
"description": "collector_num",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "recipient_name",
"in": "query",
"description": "recipient_name",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-inventory/open-box": {
"post": {
"tags": [
"Box Inventory"
],
"summary": "boxInventoryOpenBox",
"operationId": "boxInventoryOpenBox",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-inventory/collect": {
"post": {
"tags": [
"Box Inventory"
],
"summary": "boxInventoryCollect",
"operationId": "boxInventoryCollect",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-inventory/print-label": {
"post": {
"tags": [
"Box Inventory"
],
"summary": "boxInventoryTestPrint",
"operationId": "boxInventoryTestPrint",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/box-inventory/cancel": {
"delete": {
"tags": [
"Box Inventory"
],
"summary": "boxInventoryCancel",
"operationId": "boxInventoryCancel",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/courier/list": {
"get": {
"tags": [
"Shipping"
],
"summary": "Get delivery partner list",
"operationId": "courierList",
"parameters": [
{
"name": "id",
"in": "query",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "activity",
"in": "query",
"description": "activity",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "name",
"in": "query",
"description": "name",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/credit-item/list": {
"get": {
"tags": [
"Credit Item"
],
"summary": "creditItemList",
"operationId": "creditItemList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/dashboard": {
"get": {
"tags": [
"Dashboard"
],
"summary": "getDashboard",
"operationId": "getDashboard",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/feedback/create": {
"post": {
"tags": [
"Feedback"
],
"summary": "Sent feedback",
"operationId": "feedbackCreate",
"parameters": [
{
"name": "type_id",
"in": "query",
"description": "type_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "content",
"in": "query",
"description": "content",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/locker-banner/list": {
"get": {
"tags": [
"Locker Banner"
],
"summary": "listLockerBanner",
"operationId": "listLockerBanner",
"parameters": [
{
"name": "locker_id",
"in": "query",
"description": "ID of the locker which the banner belong to.",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "terminal_id",
"in": "query",
"description": "Terminal ID of the locker which the banner belong to.",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/locker-banner/info/{id}": {
"get": {
"tags": [
"Locker Banner"
],
"summary": "infoLockerBanner",
"operationId": "infoLockerBanner",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/locker/list": {
"get": {
"tags": [
"Locker"
],
"summary": "lockerList",
"operationId": "lockerList",
"parameters": [
{
"name": "itemsPerPage",
"in": "query",
"description": "itemsPerPage",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "search",
"in": "query",
"description": "search",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "searchBy",
"in": "query",
"description": "searchBy",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "coordinate",
"in": "query",
"description": "coordinate",
"schema": {
"type": "string",
"default": "0,0"
}
},
{
"name": "sortBy",
"in": "query",
"description": "sortBy",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "sortDesc",
"in": "query",
"description": "sortDesc",
"schema": {
"type": "string",
"default": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/locker/info/{id}": {
"get": {
"tags": [
"Locker"
],
"summary": "lockerInfo",
"operationId": "lockerInfo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/locker/available-box": {
"get": {
"tags": [
"Locker"
],
"summary": "lockerAvailableBox",
"operationId": "lockerAvailableBox",
"parameters": [
{
"name": "terminal_id",
"in": "query",
"description": "terminal_id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/locker-guide/list": {
"get": {
"tags": [
"Locker Guide"
],
"summary": "lockerGuideList",
"operationId": "lockerGuideList",
"parameters": [
{
"name": "search",
"in": "query",
"description": "search",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "searchBy",
"in": "query",
"description": "searchBy",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "sortBy",
"in": "query",
"description": "sortBy",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "sortDesc",
"in": "query",
"description": "sortDesc",
"schema": {
"type": "string",
"default": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
}
]
}
},
"/api/signIn": {
"post": {
"tags": [
"Locker Hardware Integration"
],
"summary": "Update locker online status and create locker if it doesn't exist in database.",
"operationId": "lockerSignIn",
"parameters": [
{
"name": "terminalID",
"in": "query",
"description": "Unique ID used to identify the locker",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "totalBoxNums",
"in": "query",
"description": "Total number of boxes available at the locker",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "displayName",
"in": "query",
"description": "Name of the locker",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/keepAlive": {
"post": {
"tags": [
"Locker Hardware Integration"
],
"summary": "Update locker online status and inform server which locker box is open/close",
"operationId": "LockerKeepAlive",
"parameters": [
{
"name": "terminalID",
"in": "query",
"description": "Unique ID used to identify the locker",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "openStatusArray",
"in": "query",
"description": "Each locker box open/close status in order of the locker box number where value 1 if locker is close and value 0 if locker is open, with each value seperated by a comma. ",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "webSocketStatus",
"in": "query",
"description": "Locker web socket status",
"schema": {
"type": "enum",
"default": "",
"enum": [
"CONNECTING",
"CONNECTED",
"DISCONNECTED",
"RECONNECTING"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/disconnect": {
"post": {
"tags": [
"Locker Hardware Integration"
],
"summary": "Update locker online status to offline",
"operationId": "LockerDisconnect",
"parameters": [
{
"name": "terminalID",
"in": "query",
"description": "Unique ID used to identify the locker",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/openBox": {
"post": {
"tags": [
"Locker Hardware Integration"
],
"summary": "Open Locker Box",
"operationId": "LockerOpenBox",
"parameters": [
{
"name": "terminalID",
"in": "query",
"description": "Unique ID used to identify the locker",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "lockerBoxID",
"in": "query",
"description": "Unique ID used to identify the locker box",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "attemp",
"in": "query",
"description": "Number of attempts to open the box",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/locker/test": {
"post": {
"tags": [
"Locker"
],
"summary": "testLocker",
"operationId": "testLocker (temporary)",
"parameters": [
{
"name": "box_no",
"in": "query",
"description": "box_no",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"api_key": []
}
]
}
},
"/api/read-qr-code": {
"post": {
"tags": [
"Locker Hardware Integration"
],
"summary": "Read QR Code",
"operationId": "readQrCode",
"parameters": [
{
"name": "terminal_id",
"in": "query",
"description": "The terminal id of the locker",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "json_string",
"in": "query",
"description": "json string",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/payment-record/ready/top-up-credit": {
"post": {
"tags": [
"PaymentRecord"
],
"summary": "readyTopUpCredit",
"operationId": "readyTopUpCredit",
"parameters": [
{
"name": "remark",
"in": "query",
"description": "remark",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "amount",
"in": "query",
"description": "amount",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/pricing/check": {
"get": {
"tags": [
"PriceCalculation"
],
"summary": "pricingCheck",
"operationId": "pricingCheck",
"parameters": [
{
"name": "locker_id",
"in": "query",
"description": "locker_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "box_size_id",
"in": "query",
"description": "box_size_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "reserved_minute",
"in": "query",
"description": "reserved_minute",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/pricing/check-delivery": {
"get": {
"tags": [
"PriceCalculation"
],
"summary": "Calculate Booking and Shipping Fee",
"operationId": "calculateDeliveryBookingFee",
"parameters": [
{
"name": "locker_id",
"in": "query",
"description": "locker_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "box_size_id",
"in": "query",
"description": "box_size_id",
"schema": {
"type": "string",
"default": ""
}
},
{
"name": "locker_postcode",
"in": "query",
"description": "Locker Postcode",
"schema": {
"type": "string"
}
},
{
"name": "delivery_postcode",
"in": "query",
"description": "Delivery Postcode",
"schema": {
"type": "string"
}
},
{
"name": "courier_id",
"in": "query",
"description": "Courier Id",
"schema": {
"type": "string"
}
},
{
"name": "item_weight",
"in": "query",
"description": "Item Weight (kg)",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/promotion/list": {
"get": {
"tags": [
"Promotion"
],
"summary": "listPromotion",
"operationId": "listPromotion",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/promotion/info/{id}": {
"get": {
"tags": [
"Promotion"
],
"summary": "infoPromotion",
"operationId": "infoPromotion",
"parameters": [
{
"name": "id",
"in": "path",
"description": "id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/shipping/dhl/tracking": {
"post": {
"tags": [
"Shipping - DHL"
],
"summary": "Track Shipping",
"operationId": "postTracking",
"requestBody": {
"description": "https://jsonkeeper.com/b/QQS9",
"content": {
"application/json": {
"schema": {}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/api/state/list": {
"get": {
"tags": [
"State"
],
"summary": "Show list of states",
"operationId": "stateList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/state/get": {
"get": {
"tags": [
"State"
],
"summary": "Show state info from postcode",
"operationId": "getStateFromPostcode",
"parameters": [
{
"name": "postcode",
"in": "query",
"description": "Postcode",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/state/city-list": {
"get": {
"tags": [
"State"
],
"summary": "Show list of cities",
"operationId": "cityList",
"parameters": [
{
"name": "state_id",
"in": "query",
"description": "State ID",
"schema": {
"type": "string"
}
},
{
"name": "state_name",
"in": "query",
"description": "State Name",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/supportive/list/{type}": {
"get": {
"tags": [
"Supportive"
],
"summary": "Get supportive",
"operationId": "get supportive",
"parameters": [
{
"name": "type",
"in": "path",
"description": "type",
"schema": {
"type": "enum",
"default": "tnc",
"enum": [
"tnc",
"delivery-tnc",
"locker-overdue",
"about-us",
"faq",
"refund-policy",
"privacy-policy",
"value-declaration"
]
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/user/find": {
"get": {
"tags": [
"User"
],
"summary": "findUserByMobile",
"operationId": "findUserByMobile",
"parameters": [
{
"name": "mobile_num",
"in": "query",
"description": "mobile_num",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/user/filter-contact": {
"post": {
"tags": [
"User"
],
"summary": "filterUserContactList",
"operationId": "filterUserContactList",
"parameters": [
{
"name": "mobile_num[]",
"in": "query",
"description": "array of mobile number",
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": ""
}
},
{
"name": "version_2",
"in": "query",
"description": "Return only array of mobile num that is registered in zlock? Yes = 1, No = 0",
"schema": {
"type": "integer",
"default": "0"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/user-credit/list": {
"get": {
"tags": [
"User Credit"
],
"summary": "Credit List",
"operationId": "CreditList",
"parameters": [
{
"name": "user_id",
"in": "query",
"description": "user_id",
"schema": {
"type": "string",
"default": "1"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/user-notification/list": {
"get": {
"tags": [
"User Notification"
],
"summary": "userNotificationList",
"operationId": "userNotificationList",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
},
"/api/user-notification/read": {
"put": {
"tags": [
"User Notification"
],
"summary": "Mark Notification as Read",
"operationId": "Read",
"parameters": [
{
"name": "notification_id",
"in": "query",
"description": "notification_id",
"schema": {
"type": "string",
"default": ""
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {}
}
}
},
"400": {
"description": "Bad request"
},
"404": {
"description": "Resource Not Found"
},
"422": {
"description": "Unprocessable Entity"
},
"500": {
"description": "Internal Server Error"
}
},
"security": [
{
"open_key": []
},
{
"api_key": []
}
]
}
}
},
"components": {
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "Authorization",
"in": "header"
},
"open_key": {
"type": "apiKey",
"name": "openKey",
"in": "header"
}
}
},
"tags": [
{
"name": "Auth",
"description": "Auth"
},
{
"name": "Auth - Socialize",
"description": "Auth - Socialize"
},
{
"name": "Box Booking",
"description": "Box Booking"
},
{
"name": "Box Delivery",
"description": "Box Delivery"
},
{
"name": "Box Inventory",
"description": "Box Inventory"
},
{
"name": "Shipping",
"description": "Shipping"
},
{
"name": "Credit Item",
"description": "Credit Item"
},
{
"name": "Dashboard",
"description": "Dashboard"
},
{
"name": "Feedback",
"description": "Feedback"
},
{
"name": "Locker Banner",
"description": "Locker Banner"
},
{
"name": "Locker",
"description": "Locker"
},
{
"name": "Locker Guide",
"description": "Locker Guide"
},
{
"name": "Locker Hardware Integration",
"description": "Locker Hardware Integration"
},
{
"name": "PaymentRecord",
"description": "PaymentRecord"
},
{
"name": "PriceCalculation",
"description": "PriceCalculation"
},
{
"name": "Promotion",
"description": "Promotion"
},
{
"name": "Shipping - DHL",
"description": "Shipping - DHL"
},
{
"name": "State",
"description": "State"
},
{
"name": "Supportive",
"description": "Supportive"
},
{
"name": "User",
"description": "User"
},
{
"name": "User Credit",
"description": "User Credit"
},
{
"name": "User Notification",
"description": "User Notification"
}
]
}