MENU navbar-image

Introduction

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Admin

APIs for Admin Management

Roles

APIs for interacting with roles

Show all permissions to specific rule

requires authentication

This endpoint lets you show all permissions to specific rule

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/permissions?page=1&per_page=4&filter=commodi&sort=aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/permissions"
);

const params = {
    "page": "1",
    "per_page": "4",
    "filter": "commodi",
    "sort": "aut",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5cc-5ce5-4707-b8f1-980ed2559d97",
            "name": "Myrtle Ratke Jr.",
            "description": "Consequatur odio consequatur voluptatum quae. Voluptas aliquid ea qui quo sed id quidem."
        },
        {
            "id": "9fdec5cc-5a8f-4e1d-bbd1-7679d206dfd8",
            "name": "Kiana Wiegand",
            "description": "Error et autem iusto voluptatum non quibusdam. Enim similique ipsa omnis enim et reiciendis. Omnis minus voluptas quidem voluptas."
        },
        {
            "id": "9fdec5cc-597b-4dcc-9048-be41740cfc0f",
            "name": "Adrianna Kuhlman V",
            "description": "Voluptatem qui dolorum ratione veniam rem est dolore. Perferendis numquam illo officiis optio qui veritatis voluptas minus. Dolorem porro pariatur eius cumque eius quo."
        },
        {
            "id": "9fdec5cc-5865-4406-b2f2-e8044673c9d2",
            "name": "Candace Heathcote",
            "description": "Nihil praesentium illo alias. Nam ab et voluptatem debitis et."
        },
        {
            "id": "9fdec5cc-5718-4c00-b265-ac9a0ddc5198",
            "name": "Cara Koepp",
            "description": "Ut ut voluptas repudiandae amet dolore similique quod. Ut praesentium quo cumque distinctio voluptatem suscipit. Consectetur molestiae quasi aperiam et qui."
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/roles/{role_id}/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 1

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 4

filter   string  optional  

Field to filter by id,name,description. Example: commodi

sort   string  optional  

Field to sort items by id,name,description. Example: aut

Edit rule's permissions

requires authentication

This endpoint lets you edit rule's permissions (add,update,delete)

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"permissionIds\": [
        13
    ]
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "permissionIds": [
        13
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "The role's permissions updated successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/admin/roles/{role_id}/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

role_id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Body Parameters

permissionIds   integer[]  optional  

List of the permissions Ids.

Show All

requires authentication

This endpoint lets you show all roles

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5cb-e71e-460a-81d0-b567d7fc8f0a",
            "name": "Dedric Vandervort",
            "description": "Molestias minus saepe velit impedit non."
        },
        {
            "id": "9fdec5cb-e516-40cf-9584-088819cd8c06",
            "name": "Athena Jast I",
            "description": "Hic ipsam natus dolores blanditiis consectetur."
        },
        {
            "id": "9fdec5cb-e2e0-4438-bfad-a1f81243416e",
            "name": "Mr. Waino Willms DDS",
            "description": "Quo quo soluta at autem nobis ducimus cum totam."
        },
        {
            "id": "9fdec5cb-e1ad-4177-a4b7-d58987e4502a",
            "name": "Janae Fadel",
            "description": "Corporis et consequuntur quos velit."
        },
        {
            "id": "9fdec5cb-e09e-4312-bf72-1f9551bb136a",
            "name": "Selmer Thompson",
            "description": "Et iusto corrupti omnis qui id."
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Add role

requires authentication

This endpoint lets you add role

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"noksmvnsfigdo\",
    \"description\": \"Ut aut quia natus magni qui recusandae corrupti.\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "noksmvnsfigdo",
    "description": "Ut aut quia natus magni qui recusandae corrupti."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5d0-4b60-4a6f-a770-0a3d46bcfe16",
        "name": "Name role",
        "description": "Description role"
    },
    "message": "The role added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/admin/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: noksmvnsfigdo

description   string  optional  

Must not be greater than 255 characters. Example: Ut aut quia natus magni qui recusandae corrupti.

Show specific role

requires authentication

This endpoint lets you show specific role

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5cf-a318-483e-b513-e48c375f55c6",
        "name": "Jocelyn Cummerata",
        "description": "Occaecati dolores sed quis harum et eum esse."
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/roles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Update specific role

requires authentication

This endpoint lets you update specific role

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"yaqdgyeuijlehhpedd\",
    \"description\": \"Quia voluptate porro deserunt culpa eaque libero.\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "yaqdgyeuijlehhpedd",
    "description": "Quia voluptate porro deserunt culpa eaque libero."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5d0-9a87-410f-b982-3b0816c95205",
        "name": "New Name",
        "description": "New description"
    },
    "message": "The role updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/admin/roles/{id}

PATCH api/v1/admin/roles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: yaqdgyeuijlehhpedd

description   string  optional  

Must not be greater than 255 characters. Example: Quia voluptate porro deserunt culpa eaque libero.

Delete specific role

requires authentication

This endpoint lets you delete specific role

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The role deleted successfully",
    "status_code": 200
}
 

Request      

DELETE api/v1/admin/roles/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Users

APIs for user Management

Show all roles to specific user

requires authentication

This endpoint lets you show all roles to specific user

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473/roles?page=8&per_page=14&filter=maxime&sort=sit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473/roles"
);

const params = {
    "page": "8",
    "per_page": "14",
    "filter": "maxime",
    "sort": "sit",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5d2-c854-4211-8ca1-99580a776dec",
            "name": "Miss Evangeline Gislason",
            "description": "Dolorem minus aperiam qui vel a est fugit."
        },
        {
            "id": "9fdec5d2-c713-4cc2-aae4-f2ef71c06f6c",
            "name": "Briana Schumm",
            "description": "Quo harum aliquid vel ut sit."
        },
        {
            "id": "9fdec5d2-c541-4380-b698-8561620b3957",
            "name": "Astrid Kautzer",
            "description": "Voluptatum qui porro maxime similique."
        },
        {
            "id": "9fdec5d2-c3d2-4602-9c3f-ee7331eee2e1",
            "name": "William Schowalter",
            "description": "Aut dolore ab quaerat nesciunt."
        },
        {
            "id": "9fdec5d2-c25f-4112-8ef9-7c7d171dbc5b",
            "name": "Shakira Dach",
            "description": "Dolor alias non est tenetur est est ex."
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/users/{user_id}/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   string   

The ID of the user. Example: 9fdec6fb-7102-4b98-b7b8-56e6f3811473

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 8

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 14

filter   string  optional  

Field to filter items by id,name,description. Example: maxime

sort   string  optional  

Field to sort items by id,name,description. Example: sit

Edit user's roles

requires authentication

This endpoint lets you edit user's roles (add,update,delete)

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_ids\": [
        20
    ]
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473/roles"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "role_ids": [
        20
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "role_ids": [
            "The role ids field is required."
        ]
    },
    "message": "The given data was invalid.",
    "status_code": 422
}
 

Request      

POST api/v1/admin/users/{user_id}/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   string   

The ID of the user. Example: 9fdec6fb-7102-4b98-b7b8-56e6f3811473

Body Parameters

role_ids   integer[]  optional  

List of the roles Ids.

Show user's profile

requires authentication

This endpoint lets you show user's authenticated profile

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/profile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/profile"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5d1-fa2d-49cb-8b20-b2b439eddc37",
        "first_name": "Test1",
        "last_name": "Test1",
        "email": "test1@gmail.com",
        "phone": "+9639487222",
        "image": "http://localhost/storage/users/6Nh6bBEAewOlHzDgr8KjFlHF2EMgl2pUkD82ihFT.jpg",
        "has_verified_email": true,
        "has_verified_phone": true,
        "roles": null
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/profile

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Request email OTP

requires authentication

This endpoint lets you send OTP through email

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473/request-otp" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473/request-otp"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Code is sent successfully",
    "status_code": 200
}
 

Request      

POST api/v1/admin/users/{user_id}/request-otp

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_id   string   

The ID of the user. Example: 9fdec6fb-7102-4b98-b7b8-56e6f3811473

Show all users

requires authentication

This endpoint lets you show all users

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/users?page=3&per_page=3&filter%5Bid%5D=alias&filter%5Bname%5D=soluta&filter%5Bemail%5D=ipsa&filter%5Bphone%5D=placeat&filter%5Brole%5D=cum&filter%5Bsearch%5D=aperiam&sort=consequatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users"
);

const params = {
    "page": "3",
    "per_page": "3",
    "filter[id]": "alias",
    "filter[name]": "soluta",
    "filter[email]": "ipsa",
    "filter[phone]": "placeat",
    "filter[role]": "cum",
    "filter[search]": "aperiam",
    "sort": "consequatur",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5d1-5009-4e4d-8853-968269605896",
            "first_name": "Cary",
            "last_name": "Jacobson",
            "email": "ahettinger@example.net",
            "phone": "+1-480-680-8705",
            "image": "http://localhost/storage/users/user.png",
            "has_verified_email": true,
            "has_verified_phone": true,
            "roles": null
        },
        {
            "id": "9fdec5d1-4ed3-4f30-a633-aa230a7750e1",
            "first_name": "Kelton",
            "last_name": "Schaefer",
            "email": "goyette.twila@example.net",
            "phone": "+14453679469",
            "image": "http://localhost/storage/users/user.png",
            "has_verified_email": true,
            "has_verified_phone": true,
            "roles": null
        },
        {
            "id": "9fdec5d1-4cf9-41b8-8a4c-e802a2dc4174",
            "first_name": "Oda",
            "last_name": "Jakubowski",
            "email": "kim.purdy@example.net",
            "phone": "+1-251-268-4375",
            "image": "http://localhost/storage/users/user.png",
            "has_verified_email": true,
            "has_verified_phone": true,
            "roles": null
        },
        {
            "id": "9fdec5d1-4b3f-4999-a357-4bc86fbccaa0",
            "first_name": "Keaton",
            "last_name": "Bauch",
            "email": "elza.swaniawski@example.net",
            "phone": "+1.907.215.9746",
            "image": "http://localhost/storage/users/user.png",
            "has_verified_email": true,
            "has_verified_phone": true,
            "roles": null
        },
        {
            "id": "9fdec5d1-48fb-4a0b-8de3-51484f505301",
            "first_name": "Amani",
            "last_name": "Gorczany",
            "email": "lola70@example.com",
            "phone": "+1-660-483-9811",
            "image": "http://localhost/storage/users/user.png",
            "has_verified_email": true,
            "has_verified_phone": true,
            "roles": null
        }
    ],
    "meta": {
        "pagination": {
            "total": 16,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 3

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 3

filter[id]   string  optional  

Field to filter items by id. Example: alias

filter[name]   string  optional  

Field to filter items by name. Example: soluta

filter[email]   string  optional  

Field to filter items by email. Example: ipsa

filter[phone]   string  optional  

Field to filter items by phone. Example: placeat

filter[role]   string  optional  

Field to filter items by role. Example: cum

filter[search]   string  optional  

Field to filter items by first_name, last_name, email, phone. Example: aperiam

sort   string  optional  

Field to sort items by id,name,email. Example: consequatur

Add user

requires authentication

This endpoint lets you add user

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "first_name=ixjwyxfzxzbj"\
    --form "last_name=g"\
    --form "email=rkoch@example.net"\
    --form "phone=quam"\
    --form "password=V-=_`%Ea'+"\
    --form "image=@/tmp/phpBpJCnl" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('first_name', 'ixjwyxfzxzbj');
body.append('last_name', 'g');
body.append('email', 'rkoch@example.net');
body.append('phone', 'quam');
body.append('password', 'V-=_`%Ea'+');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5d3-937b-4010-8263-cc439798ddfc",
        "first_name": "Test",
        "last_name": "Test",
        "email": "test@gmail.com",
        "phone": "+963994622354",
        "image": "http://localhost/storage/users/68c5c51150d61.jpg",
        "has_verified_email": false,
        "has_verified_phone": false,
        "roles": null
    },
    "message": "The user added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/admin/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

first_name   string   

Must not be greater than 255 characters. Example: ixjwyxfzxzbj

last_name   string   

Must not be greater than 255 characters. Example: g

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: rkoch@example.net

phone   string   

Example: quam

password   string   

Must be at least 6 characters. Example: V-=_%Ea'+`

image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpBpJCnl

Show specific user

requires authentication

This endpoint lets you show specific user

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5d2-6af7-4acb-9c6f-9a4caef6bcc0",
        "first_name": "Lavinia",
        "last_name": "Cartwright",
        "email": "josue.hansen@example.net",
        "phone": "+1-928-659-0546",
        "image": "http://localhost/storage/users/user.png",
        "has_verified_email": true,
        "has_verified_phone": true,
        "roles": null
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the user. Example: 9fdec6fb-7102-4b98-b7b8-56e6f3811473

Update specific user

requires authentication

This endpoint lets you update specific user

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "first_name=xosquutbvhzdnpepfu"\
    --form "last_name=n"\
    --form "email=pfannerstill.elmo@example.com"\
    --form "password=nbSe#cerhYW."\
    --form "image=@/tmp/phpcojadj" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('first_name', 'xosquutbvhzdnpepfu');
body.append('last_name', 'n');
body.append('email', 'pfannerstill.elmo@example.com');
body.append('password', 'nbSe#cerhYW.');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5d3-a421-401b-a18e-f8cb68c6de54",
        "first_name": "TESTER",
        "last_name": "TESTER",
        "email": "test@gmail.com",
        "phone": "+963994622354",
        "image": "http://localhost/storage/users/68c5c5116cb6e.jpg",
        "has_verified_email": true,
        "has_verified_phone": true,
        "roles": null
    },
    "message": "User's information updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/admin/users/{id}

PATCH api/v1/admin/users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the user. Example: 9fdec6fb-7102-4b98-b7b8-56e6f3811473

Body Parameters

first_name   string  optional  

Must not be greater than 255 characters. Example: xosquutbvhzdnpepfu

last_name   string  optional  

Must not be greater than 255 characters. Example: n

email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: pfannerstill.elmo@example.com

phone   string  optional  
country_id   string  optional  

The id of an existing record in the countries table.

password   string  optional  

Must be at least 6 characters. Example: nbSe#cerhYW.

image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpcojadj

Delete specific user

requires authentication

This endpoint lets you user specific user

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/users/9fdec6fb-7102-4b98-b7b8-56e6f3811473"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The user deleted successfully",
    "status_code": 200
}
 

Request      

DELETE api/v1/admin/users/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the user. Example: 9fdec6fb-7102-4b98-b7b8-56e6f3811473

Company

APIs for Company Management

Show all companies

requires authentication

This endpoint lets you show all companies

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies?page=16&per_page=17&filter%5Bid%5D=error&filter%5Bname%5D=dolor&filter%5Buser_id%5D=molestiae&filter%5Bemail%5D=dolor&filter%5Bstatus%5D=itaque&filter%5Bphone%5D=explicabo&sort=est&filter%5Bsearch%5D=dolorum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies"
);

const params = {
    "page": "16",
    "per_page": "17",
    "filter[id]": "error",
    "filter[name]": "dolor",
    "filter[user_id]": "molestiae",
    "filter[email]": "dolor",
    "filter[status]": "itaque",
    "filter[phone]": "explicabo",
    "sort": "est",
    "filter[search]": "dolorum",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "6de214cc-c81e-4abd-ba4c-fb569a27fc68",
            "user": {
                "id": "9fdec5c6-f972-4b14-b6fc-8dcc0f8fb911",
                "name": "Elenor Altenwerth"
            },
            "name": "Bettie Grimes",
            "name_ar": "Blanche Collier",
            "url": "maye.haley@yahoo.com",
            "abbreviation": "Facere ad enim sint eius.",
            "logo": "http://localhost/storage/companies/logo.png",
            "phone": "+1-539-598-1440",
            "status": {
                "key": 1,
                "value": "ACTIVE"
            },
            "email": "harris.rafael@example.com",
            "email_from": "swift.bobbie@kris.com",
            "settings": {
                "option1": "value1",
                "option2": "value2"
            }
        },
        {
            "id": "69d657e3-a53c-47a2-9d23-1491205f808c",
            "user": {
                "id": "9fdec5c7-4162-4c56-816a-9d23ac89d86b",
                "name": "Makayla Bednar"
            },
            "name": "Terrence Deckow",
            "name_ar": "Bennett Hayes",
            "url": "schuster.kaylee@yahoo.com",
            "abbreviation": "Dolores amet voluptatibus amet est consequatur.",
            "logo": "http://localhost/storage/companies/logo.png",
            "phone": "(986) 462-7042",
            "status": {
                "key": 1,
                "value": "ACTIVE"
            },
            "email": "runte.jazmyn@example.com",
            "email_from": "deckow.fanny@yahoo.com",
            "settings": {
                "option1": "value1",
                "option2": "value2"
            }
        },
        {
            "id": "6905b66b-8006-4dc6-a814-e5f2234ca531",
            "user": {
                "id": "9fdec5c7-593e-4d48-bed4-ccba3527f1fe",
                "name": "Larissa Roob"
            },
            "name": "Prof. Harmony Kassulke",
            "name_ar": "Breana Little",
            "url": "derick68@wiegand.com",
            "abbreviation": "Molestias ducimus voluptates et et et dolores.",
            "logo": "http://localhost/storage/companies/logo.png",
            "phone": "+1-667-578-5484",
            "status": {
                "key": 1,
                "value": "ACTIVE"
            },
            "email": "sasha23@example.com",
            "email_from": "rschimmel@moore.com",
            "settings": {
                "option1": "value1",
                "option2": "value2"
            }
        },
        {
            "id": "3c95324b-1767-45a3-ac70-8a5eaae9696c",
            "user": {
                "id": "9fdec5c7-011c-4f9f-920a-7ead02d080f4",
                "name": "Fletcher Willms"
            },
            "name": "Trycia Hirthe",
            "name_ar": "Cristian Runolfsson MD",
            "url": "maureen78@pacocha.biz",
            "abbreviation": "Sint earum labore quas ad aut.",
            "logo": "http://localhost/storage/companies/logo.png",
            "phone": "(938) 769-7817",
            "status": {
                "key": 3,
                "value": "ON_HOLD"
            },
            "email": "alena39@example.org",
            "email_from": "kitty49@hotmail.com",
            "settings": {
                "option1": "value1",
                "option2": "value2"
            }
        },
        {
            "id": "331c743f-e858-4ba4-bf5f-8b1437fecbb8",
            "user": {
                "id": "9fdec5c7-5ec6-49b3-adf3-ae385e0aa5de",
                "name": "Edison Kreiger"
            },
            "name": "Clementine Crist",
            "name_ar": "Dr. Theron Abbott Jr.",
            "url": "kpadberg@king.biz",
            "abbreviation": "Voluptates quia asperiores dolorem eveniet sit.",
            "logo": "http://localhost/storage/companies/logo.png",
            "phone": "+1.949.838.6563",
            "status": {
                "key": 1,
                "value": "ACTIVE"
            },
            "email": "maximillia88@example.net",
            "email_from": "zmonahan@gmail.com",
            "settings": {
                "option1": "value1",
                "option2": "value2"
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/companies

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 16

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 17

filter[id]   string  optional  

Field to filter items by id. Example: error

filter[name]   string  optional  

Field to filter items by name. Example: dolor

filter[user_id]   string  optional  

Field to filter items by user_id. Example: molestiae

filter[email]   string  optional  

Field to filter items by email. Example: dolor

filter[status]   string  optional  

Field to filter items by status. Example: itaque

filter[phone]   string  optional  

Field to filter items by phone. @queryParam filter[url] string Field to filter items by url. Example: explicabo

sort   string  optional  

Field to sort items by name,email,phone,created_at,updated_at. Example: est

filter[search]   string  optional  

Field to perform a custom search. Example: dolorum

Add Company

requires authentication

This endpoint lets you add company

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=wxpujnuoq"\
    --form "name_ar=xxrsbchfardfturf"\
    --form "user_id=nobis"\
    --form "abbreviation=wfrrieomgmewpqmsf"\
    --form "url=http://mueller.com/autem-a-eos-enim-iusto-praesentium-vero-sunt"\
    --form "email=coralie.rippin@example.com"\
    --form "phone=quisquam"\
    --form "status=3"\
    --form "email_from=jcirjometolrpcxuwchtjzp"\
    --form "logo=@/tmp/phplBBLdg" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'wxpujnuoq');
body.append('name_ar', 'xxrsbchfardfturf');
body.append('user_id', 'nobis');
body.append('abbreviation', 'wfrrieomgmewpqmsf');
body.append('url', 'http://mueller.com/autem-a-eos-enim-iusto-praesentium-vero-sunt');
body.append('email', 'coralie.rippin@example.com');
body.append('phone', 'quisquam');
body.append('status', '3');
body.append('email_from', 'jcirjometolrpcxuwchtjzp');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5c9-7788-4292-bb63-6d851b35fe6e",
        "user": {
            "id": "9fdec5c9-4523-4283-b2ed-b1cd40df813c",
            "name": "Darren Larson"
        },
        "name": "Company Name",
        "name_ar": "Company Name",
        "url": "CompanyName.com",
        "abbreviation": "Company abbreviation",
        "logo": "http://localhost/storage/companies/68c5c50aabbc2.jpg",
        "phone": "+971555422373",
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "email": "companytest@hotmail.com",
        "email_from": "test@test.com",
        "settings": null
    },
    "message": "The Company added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/admin/companies

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

name   string   

Must not be greater than 255 characters. Example: wxpujnuoq

name_ar   string   

Must not be greater than 255 characters. Example: xxrsbchfardfturf

user_id   string   

The id of an existing record in the users table. Example: nobis

abbreviation   string   

Must not be greater than 255 characters. Example: wfrrieomgmewpqmsf

url   string   

Must not be greater than 255 characters. Example: http://mueller.com/autem-a-eos-enim-iusto-praesentium-vero-sunt

email   string   

Must be a valid email address. Must not be greater than 255 characters. Example: coralie.rippin@example.com

phone   string   

Example: quisquam

status   integer  optional  

Example: 3

Must be one of:
  • 1
  • 2
  • 3
logo   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phplBBLdg

email_from   string  optional  

Must not be greater than 255 characters. Example: jcirjometolrpcxuwchtjzp

settings   object  optional  

Show Specific Company

requires authentication

This endpoint lets you show specific company

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "b087debc-6186-47b7-b51c-e399aa73996b",
        "user": {
            "id": "9fdec5c8-5433-4e62-bfa0-7e1184e09381",
            "name": "Eloise Morar"
        },
        "name": "Bernadette Ebert",
        "name_ar": "Sonya Reichel",
        "url": "ecorkery@yahoo.com",
        "abbreviation": "Non ut quo ut adipisci.",
        "logo": "http://localhost/storage/companies/logo.png",
        "phone": "+1 (707) 372-0533",
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "email": "verla.hammes@example.org",
        "email_from": "arowe@gmail.com",
        "settings": {
            "option1": "value1",
            "option2": "value2"
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/companies/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the company. Example: 9fdec6fc-629d-4c81-b5eb-60fc718753b6

Update specific company

requires authentication

This endpoint lets you update specific company

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=nyshzhtk"\
    --form "name_ar=oy"\
    --form "abbreviation=kemwd"\
    --form "url=http://kuhic.net/quisquam-et-autem-iusto-quas-voluptatem-eum-minus-laudantium"\
    --form "email=bianka.halvorson@example.org"\
    --form "status=1"\
    --form "email_from=mgpnludoccinyrgzucojrfj"\
    --form "logo=@/tmp/phpfmoIgd" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'nyshzhtk');
body.append('name_ar', 'oy');
body.append('abbreviation', 'kemwd');
body.append('url', 'http://kuhic.net/quisquam-et-autem-iusto-quas-voluptatem-eum-minus-laudantium');
body.append('email', 'bianka.halvorson@example.org');
body.append('status', '1');
body.append('email_from', 'mgpnludoccinyrgzucojrfj');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "b072b143-e1e3-402d-8971-fb6472c06b9d",
        "user": {
            "id": "9fdec5ca-2243-4335-82ef-d7edf4053dab",
            "name": "Pedro Green"
        },
        "name": "Company Name",
        "name_ar": "Carmelo Maggio IV",
        "url": "CompanyName.com",
        "abbreviation": "Company abbreviation",
        "logo": "http://localhost/storage/companies/logo.png",
        "phone": "+971555422373",
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "email": "companytest@hotmail.com",
        "email_from": "test@test.com",
        "settings": {
            "option1": "value1",
            "option2": "value2"
        }
    },
    "message": "The Company updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/admin/companies/{id}

PATCH api/v1/admin/companies/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the company. Example: 9fdec6fc-629d-4c81-b5eb-60fc718753b6

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: nyshzhtk

name_ar   string  optional  

Must not be greater than 255 characters. Example: oy

user_id   string  optional  

The id of an existing record in the users table.

abbreviation   string  optional  

Must not be greater than 255 characters. Example: kemwd

url   string  optional  

Must not be greater than 255 characters. Example: http://kuhic.net/quisquam-et-autem-iusto-quas-voluptatem-eum-minus-laudantium

email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: bianka.halvorson@example.org

phone   string  optional  
status   integer  optional  

Example: 1

Must be one of:
  • 1
  • 2
  • 3
logo   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpfmoIgd

email_from   string  optional  

Must not be greater than 255 characters. Example: mgpnludoccinyrgzucojrfj

settings   object  optional  

Delete specific company

requires authentication

This endpoint lets you delete specific company

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Company deleted successfully",
    "status_code": 200
}
 

Request      

DELETE api/v1/admin/companies/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the company. Example: 9fdec6fc-629d-4c81-b5eb-60fc718753b6

Permissions

APIs for getting permissions

Show All

requires authentication

This endpoint lets you show all permissions

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5ca-41a7-48af-897f-25f1f4c15f01",
            "name": "Libby Ortiz",
            "description": "Ut natus ea enim corrupti recusandae illo perspiciatis. Aut fugit veniam saepe cupiditate cum. Nisi dignissimos dolores eos."
        },
        {
            "id": "9fdec5ca-4049-4d70-abd8-82800b7abcd5",
            "name": "Maymie Treutel",
            "description": "Accusantium non et odio pariatur aliquam. Deserunt at sunt itaque aliquam est quo porro."
        },
        {
            "id": "9fdec5ca-3ee8-4583-ab01-2029e6ccb52e",
            "name": "Hayley Lebsack",
            "description": "Laboriosam delectus reprehenderit maxime est. Incidunt in ad perferendis voluptatibus."
        },
        {
            "id": "9fdec5ca-3db0-4088-8177-f535c8e442a1",
            "name": "Wade Tromp",
            "description": "Laborum sunt labore odio saepe saepe cupiditate. Id deserunt fugiat nesciunt fugiat. Sint et sint eius aut possimus et voluptate omnis."
        },
        {
            "id": "9fdec5ca-3c5a-4aa1-8ca1-778a48e4e93d",
            "name": "Jayme Green Jr.",
            "description": "Dignissimos architecto consequatur dignissimos et quae aut quis. Sunt sit corrupti provident et dolores. Reiciendis rem esse doloribus eum."
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Show specific permission

requires authentication

This endpoint lets you show specific permission

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/admin/permissions/9fdec6f1-79eb-446c-a4e0-4b07e18a71c4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/admin/permissions/9fdec6f1-79eb-446c-a4e0-4b07e18a71c4"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5ca-db93-4f5d-a6e9-a0ea84b751da",
        "name": "Dr. Stephan Boyle",
        "description": "Reprehenderit velit qui totam nobis quas. Alias soluta et saepe consequuntur in ex quo."
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/admin/permissions/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

id   string   

The ID of the permission. Example: 9fdec6f1-79eb-446c-a4e0-4b07e18a71c4

Company

APIs for Company Management

Restaurants

APIs for restaurant Management

Show all restaurants

requires authentication

This endpoint lets you show all restaurants

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants?page=5&per_page=9&filter%5Bname%5D=est&filter%5Bsearch%5D=velit&sort=blanditiis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants"
);

const params = {
    "page": "5",
    "per_page": "9",
    "filter[name]": "est",
    "filter[search]": "velit",
    "sort": "blanditiis",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5fa-3f01-40e0-9307-32e2afbd326a",
            "company": {
                "id": "5dbfcbe1-7d63-4e91-b9c9-a3abcff95e1c",
                "name": "Scarlett Trantow"
            },
            "name": "Murray and Sons",
            "name_ar": "Waelchi PLC",
            "slug": "murray-and-sons",
            "abbreviation": "cuu",
            "status": {
                "key": 3,
                "value": "ON_HOLD"
            },
            "settings": {
                "option1": "value1",
                "option2": "value2"
            },
            "image": "http://localhost/storage/restaurants/restaurant.png",
            "address": "83140 Mayert Mountains Suite 178\nLake Jeanette, WI 61556-7950",
            "address_ar": "3581 Grady Crossing Apt. 985\nEast Doyle, GA 88483"
        },
        {
            "id": "9fdec5fa-3c01-438d-a844-26fa02bc7902",
            "company": {
                "id": "5dbfcbe1-7d63-4e91-b9c9-a3abcff95e1c",
                "name": "Scarlett Trantow"
            },
            "name": "Feil-Schmidt",
            "name_ar": "Upton Inc",
            "slug": "feil-schmidt",
            "abbreviation": "fwl",
            "status": {
                "key": 3,
                "value": "ON_HOLD"
            },
            "settings": {
                "option1": "value1",
                "option2": "value2"
            },
            "image": "http://localhost/storage/restaurants/restaurant.png",
            "address": "9601 Treutel Causeway\nPort Emerson, CA 25319",
            "address_ar": "3848 Emmet Pine Apt. 565\nNew Bella, VA 67971"
        },
        {
            "id": "9fdec5fa-38fe-4e4a-8b55-f17098695773",
            "company": {
                "id": "5dbfcbe1-7d63-4e91-b9c9-a3abcff95e1c",
                "name": "Scarlett Trantow"
            },
            "name": "Renner-Lemke",
            "name_ar": "Luettgen-Marquardt",
            "slug": "renner-lemke",
            "abbreviation": "chn",
            "status": {
                "key": 3,
                "value": "ON_HOLD"
            },
            "settings": {
                "option1": "value1",
                "option2": "value2"
            },
            "image": "http://localhost/storage/restaurants/restaurant.png",
            "address": "51648 Abraham Gardens\nHellerton, MT 55634",
            "address_ar": "7824 Rodriguez Row\nLake Daija, GA 68377-6450"
        },
        {
            "id": "9fdec5fa-35d1-4fa3-abf9-7b24f3d2f3d1",
            "company": {
                "id": "5dbfcbe1-7d63-4e91-b9c9-a3abcff95e1c",
                "name": "Scarlett Trantow"
            },
            "name": "Sawayn-Johns",
            "name_ar": "Armstrong PLC",
            "slug": "sawayn-johns",
            "abbreviation": "zgw",
            "status": {
                "key": 2,
                "value": "INACTIVE"
            },
            "settings": {
                "option1": "value1",
                "option2": "value2"
            },
            "image": "http://localhost/storage/restaurants/restaurant.png",
            "address": "32604 Frank Forge\nGreenfelderhaven, MO 88772",
            "address_ar": "1364 Dixie Radial\nSpinkaview, IA 91834"
        },
        {
            "id": "9fdec5fa-32df-4e39-a2e8-353c2ac1644c",
            "company": {
                "id": "5dbfcbe1-7d63-4e91-b9c9-a3abcff95e1c",
                "name": "Scarlett Trantow"
            },
            "name": "Schroeder Ltd",
            "name_ar": "Goodwin, Paucek and Hickle",
            "slug": "schroeder-ltd",
            "abbreviation": "bxt",
            "status": {
                "key": 3,
                "value": "ON_HOLD"
            },
            "settings": {
                "option1": "value1",
                "option2": "value2"
            },
            "image": "http://localhost/storage/restaurants/restaurant.png",
            "address": "19447 Stehr Fall Apt. 597\nWest Margareteview, ME 00403-6150",
            "address_ar": "42033 Jones Harbors\nRomanfort, MT 89959"
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/companies/{company_id}/restaurants

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_id   string   

The ID of the company. Example: 9fdec6fc-629d-4c81-b5eb-60fc718753b6

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 5

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 9

filter[name]   string  optional  

Field to filter items by name. Example: est

filter[search]   string  optional  

Field to filter items by name. Example: velit

sort   string  optional  

Field to sort items by name,email. Example: blanditiis

Add restaurant

requires authentication

This endpoint lets you add restaurant

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=wamdnkeklknjiekcywuqnd"\
    --form "name_ar=uvyqqddyeeurqreboxmll"\
    --form "abbreviation=a"\
    --form "status=1"\
    --form "address=sed"\
    --form "address_ar=harum"\
    --form "image=@/tmp/phpGAegFG" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'wamdnkeklknjiekcywuqnd');
body.append('name_ar', 'uvyqqddyeeurqreboxmll');
body.append('abbreviation', 'a');
body.append('status', '1');
body.append('address', 'sed');
body.append('address_ar', 'harum');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec643-cb9b-44e4-a8cb-aa572cac21c9",
        "company": {
            "id": "fd85ad18-318d-47b9-920d-48742434705d",
            "name": "Ewell Hudson"
        },
        "name": "Test Restaurant",
        "name_ar": "Test Restaurant",
        "slug": "test-restaurant",
        "abbreviation": "TR",
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "settings": "{\"option1\":\"value1\",\"option2\":\"value2\"}",
        "image": "http://localhost/storage/restaurants/68c5c55ad61a7.jpg",
        "address": "Test Address",
        "address_ar": "Test Address"
    },
    "message": "The restaurant added successfully with a default branch",
    "status_code": 200
}
 

Request      

POST api/v1/companies/{company_id}/restaurants

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_id   string   

The ID of the company. Example: 9fdec6fc-629d-4c81-b5eb-60fc718753b6

Body Parameters

name   string   

Must not be greater than 255 characters. Example: wamdnkeklknjiekcywuqnd

name_ar   string   

Must not be greater than 255 characters. Example: uvyqqddyeeurqreboxmll

abbreviation   string   

Must not be greater than 255 characters. Example: a

status   integer   

Example: 1

Must be one of:
  • 1
  • 2
  • 3
settings   object  optional  
image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpGAegFG

address   string   

Example: sed

address_ar   string   

Example: harum

Show specific restaurant

requires authentication

This endpoint lets you show specific restaurant

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec636-5d78-467b-b8ac-a5f693812c64",
        "company": {
            "id": "2946df6b-a620-49f2-84c5-13a00f30f346",
            "name": "Zoey Ward"
        },
        "name": "Hartmann, Bernhard and Quitzon",
        "name_ar": "Welch, Mosciski and Harvey",
        "slug": "hartmann-bernhard-and-quitzon",
        "abbreviation": "pty",
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "settings": {
            "option1": "value1",
            "option2": "value2"
        },
        "image": "http://localhost/storage/restaurants/restaurant.png",
        "address": "90917 Stephanie Lane Suite 188\nSheabury, CA 60497-7182",
        "address_ar": "74480 Christina Plain\nPort Jairoview, NY 35169"
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/companies/{company_id}/restaurants/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_id   string   

The ID of the company. Example: 9fdec6fc-629d-4c81-b5eb-60fc718753b6

id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

Update specific restaurant

requires authentication

This endpoint lets you update specific restaurant

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=msr"\
    --form "name_ar=vadiksqbvkjgqewxryix"\
    --form "abbreviation=eytbfrhmaqqnmoepcoh"\
    --form "status=2"\
    --form "address=voluptatem"\
    --form "address_ar=praesentium"\
    --form "image=@/tmp/phpdjEIEF" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'msr');
body.append('name_ar', 'vadiksqbvkjgqewxryix');
body.append('abbreviation', 'eytbfrhmaqqnmoepcoh');
body.append('status', '2');
body.append('address', 'voluptatem');
body.append('address_ar', 'praesentium');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec654-587c-4052-b15e-9f4129e518e8",
        "company": {
            "id": "0638b9df-0581-4c2c-8912-a85782d08310",
            "name": "Prof. Jed Streich Jr."
        },
        "name": "Updated Restaurant Name",
        "name_ar": "Zulauf-Schowalter",
        "slug": "updated-restaurant-name",
        "abbreviation": "URN",
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "settings": "{\"option1\":\"value1\",\"option2\":\"value2\"}",
        "image": "http://localhost/storage/restaurants/restaurant.png",
        "address": "Updated Test Address",
        "address_ar": "541 Cummerata Corners\nPort Abbeytown, IL 05136"
    },
    "message": "The restaurant updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/companies/{company_id}/restaurants/{id}

PATCH api/v1/companies/{company_id}/restaurants/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_id   string   

The ID of the company. Example: 9fdec6fc-629d-4c81-b5eb-60fc718753b6

id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: msr

name_ar   string  optional  

Must not be greater than 255 characters. Example: vadiksqbvkjgqewxryix

abbreviation   string  optional  

Must not be greater than 255 characters. Example: eytbfrhmaqqnmoepcoh

status   integer  optional  

Example: 2

Must be one of:
  • 1
  • 2
  • 3
settings   object  optional  
image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpdjEIEF

address   string  optional  

Example: voluptatem

address_ar   string  optional  

Example: praesentium

Delete specific restaurant

requires authentication

This endpoint lets you restaurant specific restaurant

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The restaurant deleted successfully",
    "status_code": 200
}
 

Request      

DELETE api/v1/companies/{company_id}/restaurants/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_id   string   

The ID of the company. Example: 9fdec6fc-629d-4c81-b5eb-60fc718753b6

id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

Show analytics

requires authentication

This endpoint lets you show analytics of company

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/analytics/main" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/companies/9fdec6fc-629d-4c81-b5eb-60fc718753b6/analytics/main"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "orders": {
                "today": {
                    "count": 1,
                    "total_price": 10004
                },
                "yesterday": {
                    "count": 0,
                    "total_price": 0
                },
                "week": {
                    "count": 1,
                    "total_price": 10004
                },
                "month": {
                    "count": 1,
                    "total_price": 10004
                }
            }
        }
    ],
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/companies/{company_id}/analytics/main

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_id   string   

The ID of the company. Example: 9fdec6fc-629d-4c81-b5eb-60fc718753b6

Customer

APIs for Customer Management

Menu

APIs for Menu

Show restaurants with branches

requires authentication

This endpoint lets you show restaurants with branches

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/restaurants?filter%5Bsearch%5D=maxime" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/restaurants"
);

const params = {
    "filter[search]": "maxime",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec66b-8432-4cf0-97d8-4e53ab095a30",
            "name": "Pouros-Carter",
            "address": "152 Dare Pass Apt. 445\nDejonstad, IN 52202-6876",
            "slug": "pouros-carter",
            "branches": [
                {
                    "id": "7e912b87-1546-4662-924d-96ae0019add6",
                    "name": "Prof. Roman Frami",
                    "address": "3617 Gottlieb Tunnel Suite 864\nCarolynstad, MI 64651",
                    "slug": "voluptatem-quisquam-ullam-neque-dolorem-similique",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "b019dfa4-52e6-4d04-af51-81e4593cbbda",
                    "name": "Dr. Marjory O'Kon",
                    "address": "179 Howell Pine\nSouth Sigridport, MO 78215-1726",
                    "slug": "eligendi-quisquam-accusantium-id-repudiandae-animi-omnis-asperiores",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-8673-4aa6-8380-c9c4a6ec08fe",
            "name": "Kuhlman PLC",
            "address": "270 Prohaska Lake\nWest Cindyburgh, TN 09763",
            "slug": "kuhlman-plc",
            "branches": [
                {
                    "id": "14d4de18-cde5-477f-ba91-739b94781de3",
                    "name": "Jarvis Kassulke Jr.",
                    "address": "374 Greenfelder Tunnel\nMikaylaborough, NV 25569-3950",
                    "slug": "et-aut-iure-odio-perspiciatis-voluptas",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "a98558f7-0ba1-474f-94a4-f3ae4c3998c2",
                    "name": "Hilario Carter",
                    "address": "162 Karina Wells\nEast Keagan, OK 68648",
                    "slug": "id-et-quibusdam-quis-provident-numquam",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-88cd-468c-ad70-0ee1198b5140",
            "name": "Effertz PLC",
            "address": "58700 Celestine Parks\nNew Corrine, MD 64657",
            "slug": "effertz-plc",
            "branches": [
                {
                    "id": "10f707c8-647d-4503-86c3-8d809b1e7bb4",
                    "name": "Miss Willa Beahan",
                    "address": "172 Joseph Drives\nMcLaughlinberg, NV 45053",
                    "slug": "molestiae-est-facere-nihil-aut-quaerat-autem",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "46a2bf95-64d2-435e-aef3-005b7ba7e0b4",
                    "name": "Zack Runte",
                    "address": "95102 Mraz Ramp\nLake Clementine, SC 38357-3256",
                    "slug": "in-tempore-nihil-facilis-itaque",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-8b12-4d25-9618-9192f3580e92",
            "name": "Quitzon-VonRueden",
            "address": "7870 Batz Crossing\nO'Keefeland, AZ 22691",
            "slug": "quitzon-vonrueden",
            "branches": [
                {
                    "id": "3793be40-b2f8-4e75-a8e8-16244470068c",
                    "name": "Newell Eichmann",
                    "address": "41538 Christiansen Point\nLake Austyn, TX 63785",
                    "slug": "possimus-eius-occaecati-ipsam-magnam-dolorem",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "747cd3db-b017-4224-8e95-00bd3b4059eb",
                    "name": "Ethan White",
                    "address": "4010 Austin Square\nDouglasland, SD 25920-1876",
                    "slug": "saepe-sed-exercitationem-voluptatum-est-est-quidem-cumque-hic",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-8d49-4e40-a793-8854f71730ca",
            "name": "Marquardt-Torphy",
            "address": "586 Strosin Cove Suite 511\nCaleview, IL 63191",
            "slug": "marquardt-torphy",
            "branches": [
                {
                    "id": "7c332001-4c69-4b16-822b-09ed0453d305",
                    "name": "Vallie Barton",
                    "address": "201 Prosacco Valleys\nWest Zoe, SC 05020-9032",
                    "slug": "qui-omnis-placeat-recusandae-consequatur",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "b8d33d41-a4a1-4efa-86ee-45c8d564ad15",
                    "name": "Danyka Jacobson",
                    "address": "6245 Rubie Rue Apt. 485\nPort Elwin, WA 38584",
                    "slug": "at-fugiat-rerum-iste-culpa-quia-quasi",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-8fa8-4987-adb4-b5e6d6af19fe",
            "name": "Cummerata-Murphy",
            "address": "1256 Deanna Mount\nNorth Malcolmland, DE 59091",
            "slug": "cummerata-murphy",
            "branches": [
                {
                    "id": "320fb187-5108-40a7-92ae-fc28ffd00cfc",
                    "name": "Amely Crooks",
                    "address": "14800 Stokes Ridges\nVinnieton, MI 71356",
                    "slug": "molestias-id-suscipit-assumenda-deleniti-laborum-alias-asperiores",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "b29ba86b-9308-42d5-94e2-b49e47cf2729",
                    "name": "Jeffry Emard",
                    "address": "281 Rodriguez Pike\nSouth Sandra, LA 71331",
                    "slug": "aspernatur-atque-id-perspiciatis-laborum-corrupti-veritatis-quod",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-91c9-4860-a325-74c59094679a",
            "name": "Powlowski, Tromp and Prosacco",
            "address": "45443 Christiansen Ports\nAdahchester, AK 62944",
            "slug": "powlowski-tromp-and-prosacco",
            "branches": [
                {
                    "id": "31ca5ebe-596f-4a5d-85ce-88fe0fc4ab83",
                    "name": "Bert Pagac",
                    "address": "962 Hettinger Stravenue Suite 446\nWest Micahtown, DE 86839-7421",
                    "slug": "voluptas-officia-qui-esse-sed-voluptatem-est-laudantium-laborum",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "9b3d997a-54ed-4461-b16c-a5503ff9c35f",
                    "name": "Mr. Joesph Hettinger I",
                    "address": "4853 Zieme Ridge Apt. 118\nLake Horaciohaven, TN 11290",
                    "slug": "laborum-quo-harum-qui-dolore",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-9405-4086-ab41-5214c297c537",
            "name": "Weimann PLC",
            "address": "6032 Schmitt Path\nEast Osvaldo, FL 85164",
            "slug": "weimann-plc",
            "branches": [
                {
                    "id": "3c585a80-ebfa-4ad7-8f23-c6010e2dfa23",
                    "name": "Javon Koss",
                    "address": "1927 Haley Rapid Suite 363\nNew Vance, CO 92514-7429",
                    "slug": "a-inventore-laboriosam-cupiditate-omnis",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "66530c91-01b8-4efc-898e-22ddb6a16b55",
                    "name": "Sydnee Hamill",
                    "address": "9375 Conroy Loop Apt. 607\nWest Johnnie, MA 78546-2920",
                    "slug": "vel-reiciendis-aliquam-quod-iste-error-quae-delectus-quis",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-9638-4be7-a594-9ffb85c23c08",
            "name": "Wisozk, Grimes and Reilly",
            "address": "183 Walker Causeway\nProhaskatown, VT 73898",
            "slug": "wisozk-grimes-and-reilly",
            "branches": [
                {
                    "id": "2b14153c-2252-4ab2-9d2c-423f3bdbb34e",
                    "name": "Monroe Doyle",
                    "address": "3383 Horacio Spring\nWest Zena, MS 97201",
                    "slug": "quia-impedit-ea-porro-iure-aut",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "67e6217e-47a7-411b-a463-484077fb526a",
                    "name": "Katlyn Hammes",
                    "address": "4697 Yundt Hills Apt. 789\nSouth Merrittfort, ME 14600-0126",
                    "slug": "quis-quos-dolores-sequi-aliquam-voluptatum",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-988a-4c08-b944-f587dfdfecea",
            "name": "Quigley-Veum",
            "address": "3002 Mireya Mountain Apt. 967\nAlfonsoside, MS 25851-5819",
            "slug": "quigley-veum",
            "branches": [
                {
                    "id": "4b00f82a-9dfa-4f26-9780-328c08a796a0",
                    "name": "Prof. Lavern Zemlak",
                    "address": "134 Lueilwitz Village Apt. 178\nLake Tamiamouth, WI 10791-3992",
                    "slug": "mollitia-sit-reiciendis-voluptatem-laboriosam-iste-dolorem-temporibus",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "f4aa7986-8d55-4bb5-99d9-df0b1b92abb1",
                    "name": "Ms. Lilla Reilly",
                    "address": "9569 Mayert Pass\nBudstad, OR 97738-1450",
                    "slug": "autem-consequatur-occaecati-nihil",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-9c89-422c-91df-ae578ed9c3a7",
            "name": "O'Reilly-Gerlach",
            "address": "566 Glover Loop\nShawnberg, FL 95304-4682",
            "slug": "oreilly-gerlach",
            "branches": [
                {
                    "id": "28f02db5-b91e-4771-a9c6-e31f79c84622",
                    "name": "Audra Waters",
                    "address": "50617 Blaise Plain\nGreenstad, OH 13242",
                    "slug": "modi-sequi-sit-cumque-esse-ut-provident-sit",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "7e938093-8655-4458-bfd1-fcb049869be4",
                    "name": "Dr. Holden Armstrong II",
                    "address": "49120 Magdalen Greens Apt. 912\nArjunmouth, OR 54682",
                    "slug": "tempora-vero-velit-excepturi-recusandae-aperiam-provident",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-9eb6-4280-8860-7be340a1d4e3",
            "name": "Leffler, Harris and Waters",
            "address": "5821 Kessler Overpass Apt. 756\nCharleymouth, MS 61819-3731",
            "slug": "leffler-harris-and-waters",
            "branches": [
                {
                    "id": "e7fff761-e605-4663-be84-42a5e75a0161",
                    "name": "Dessie D'Amore",
                    "address": "76986 Rene Avenue\nBlockfort, WA 81842",
                    "slug": "quam-placeat-dolorem-explicabo",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "ebc21257-8ceb-4231-a7e1-3ce9bb0dda04",
                    "name": "Liza Block",
                    "address": "48476 Kuhic Mall Suite 940\nNorth Alfred, NE 41082",
                    "slug": "quia-consectetur-culpa-odio-molestiae",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-a0f4-4397-b7c7-e1ee6167d661",
            "name": "Halvorson-Bartoletti",
            "address": "889 Kathlyn Valleys\nWisokybury, GA 13942",
            "slug": "halvorson-bartoletti",
            "branches": [
                {
                    "id": "9f561a33-1c91-4f06-baaa-64b682581b7c",
                    "name": "Aidan Balistreri",
                    "address": "43436 Kilback Shore\nOraborough, TX 65609-4554",
                    "slug": "esse-voluptatibus-veritatis-libero-dolores-consequuntur-assumenda-explicabo-ea",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "cb061121-7da9-4a67-b1e2-9e8d719cef6d",
                    "name": "Prof. Geo Daniel II",
                    "address": "4273 Amari Falls Apt. 372\nNew Lenora, VT 91647-0412",
                    "slug": "hic-ad-ut-ad-ab-et-molestias-sit-voluptas",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-a322-4761-866f-b4b9288a2c33",
            "name": "Ortiz, Rau and Dach",
            "address": "49705 Llewellyn Track Suite 568\nTorpville, MS 03230",
            "slug": "ortiz-rau-and-dach",
            "branches": [
                {
                    "id": "6abdbc80-1b36-4350-b1a5-3bc39681c380",
                    "name": "Ms. Ella Swift V",
                    "address": "1040 Triston Curve\nLempitown, NH 45012-7670",
                    "slug": "eveniet-porro-quos-beatae-consequuntur-soluta-enim-saepe-fugit",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "c59ff6f0-a4bd-486f-bde4-cfe95596db5a",
                    "name": "Ms. Delpha Wyman MD",
                    "address": "5607 Mary Meadow\nLake Bradleychester, RI 92525-4653",
                    "slug": "minima-voluptas-dolor-et-non-ratione-ut-ab",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-a544-4941-803a-5bb15eb78ef4",
            "name": "Moen, Weimann and Lebsack",
            "address": "1230 Hamill Isle\nSouth Gwenhaven, FL 87332",
            "slug": "moen-weimann-and-lebsack",
            "branches": [
                {
                    "id": "8edf8d6f-afd3-4c0e-855c-31c689336144",
                    "name": "Prof. Elta Schmitt",
                    "address": "1250 Wisoky Summit\nMertzshire, CA 53116",
                    "slug": "veritatis-aut-dolorem-quo-velit-atque-et",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                },
                {
                    "id": "ebd5ab4a-5dad-4539-a6ab-1084e21fb441",
                    "name": "Mrs. Charlene Runolfsdottir",
                    "address": "70941 Cartwright Common Apt. 416\nSouth Freida, VT 42290-9145",
                    "slug": "nisi-aliquid-quibusdam-maxime-et-blanditiis-maiores-ut",
                    "logo": "branch.png",
                    "settings": "{\"reservations\":{\"is_active\":true}}"
                }
            ]
        },
        {
            "id": "9fdec66b-b115-4b05-b2fd-7114fcbe43d6",
            "name": "Jacobi, Walsh and Lubowitz",
            "address": "337 Mireya Walk Suite 967\nWest Graysonland, MT 41329-6570",
            "slug": "jacobi-walsh-and-lubowitz",
            "branches": null
        },
        {
            "id": "9fdec66b-bd1f-42ae-b75a-e7fbd730f183",
            "name": "Bradtke-Kohler",
            "address": "99280 Mosciski Gateway\nRolfsonfort, WY 84233-9720",
            "slug": "bradtke-kohler",
            "branches": null
        },
        {
            "id": "9fdec66b-cd9c-4a4b-a5a4-ce1336739563",
            "name": "Wolf and Sons",
            "address": "33602 Terry Spur Suite 632\nRickbury, UT 90934",
            "slug": "wolf-and-sons",
            "branches": null
        },
        {
            "id": "9fdec66b-dd04-4749-971a-b111620f9cd8",
            "name": "Mosciski, Braun and Connelly",
            "address": "85194 Cleta Dam Suite 502\nVinnieton, NH 30734-9188",
            "slug": "mosciski-braun-and-connelly",
            "branches": null
        },
        {
            "id": "9fdec66b-f821-4821-9345-362d1cdb1637",
            "name": "Gleichner, Wintheiser and Cremin",
            "address": "93318 Windler Parks Suite 441\nPort Yazminmouth, DC 04922",
            "slug": "gleichner-wintheiser-and-cremin",
            "branches": null
        },
        {
            "id": "9fdec66c-0ac3-4549-8015-86490ff195e6",
            "name": "Schoen, McKenzie and Mayer",
            "address": "6355 Macey Causeway\nSwaniawskiside, OH 16479",
            "slug": "schoen-mckenzie-and-mayer",
            "branches": null
        },
        {
            "id": "9fdec66c-1ce4-4697-8e97-7e43b6fab1f0",
            "name": "Koss, Bergnaum and Smitham",
            "address": "72935 Osinski Divide\nLake Ernestohaven, WI 90278",
            "slug": "koss-bergnaum-and-smitham",
            "branches": null
        },
        {
            "id": "9fdec66c-2caf-4f3a-a910-a8de257b21e2",
            "name": "Moore-Erdman",
            "address": "50391 Darrion Pass\nNorth Aliyatown, NV 83853",
            "slug": "moore-erdman",
            "branches": null
        },
        {
            "id": "9fdec66c-3e93-409a-96e8-9210f5c4127e",
            "name": "Kuhlman LLC",
            "address": "4521 Tod Locks\nLake Misael, MI 48722-4265",
            "slug": "kuhlman-llc",
            "branches": null
        },
        {
            "id": "9fdec66c-496a-4fc7-bff2-61a862a9d02a",
            "name": "Leuschke-Moore",
            "address": "8727 Sonya Mountains Apt. 491\nHeleneshire, PA 30168-0937",
            "slug": "leuschke-moore",
            "branches": null
        },
        {
            "id": "9fdec66c-5897-43a2-80d8-5c86c463606d",
            "name": "Stroman-Marvin",
            "address": "3373 Beth Squares\nMurrayburgh, RI 77484",
            "slug": "stroman-marvin",
            "branches": null
        },
        {
            "id": "9fdec66c-632a-495d-b3dc-0164ffecd548",
            "name": "Waters PLC",
            "address": "651 Kara Throughway\nAntoneside, ND 85726",
            "slug": "waters-plc",
            "branches": null
        },
        {
            "id": "9fdec66c-71bf-4205-83d6-b3da2e65f047",
            "name": "Emard Inc",
            "address": "35597 Verona Greens Apt. 439\nNew Jarod, VT 08560",
            "slug": "emard-inc",
            "branches": null
        },
        {
            "id": "9fdec66c-7e00-432f-bf81-30288d5306c7",
            "name": "Prohaska Ltd",
            "address": "6876 Maryse Light Apt. 949\nRosaliamouth, NC 69882",
            "slug": "prohaska-ltd",
            "branches": null
        },
        {
            "id": "9fdec66c-8bc9-49e2-a290-0c50c764f80f",
            "name": "Anderson-Volkman",
            "address": "52379 Merlin Path\nNorth Claudine, MD 06597-3344",
            "slug": "anderson-volkman",
            "branches": null
        },
        {
            "id": "9fdec66c-9b51-488d-bedd-cfdc25926062",
            "name": "Hackett-Daniel",
            "address": "8954 Orn Junction\nBelleville, CA 56655-5441",
            "slug": "hackett-daniel",
            "branches": null
        },
        {
            "id": "9fdec66c-abb5-444e-85fd-7e6e0bd71ee7",
            "name": "Kuhlman-Jacobs",
            "address": "942 Imani Green Suite 803\nLisaview, IL 91423-9627",
            "slug": "kuhlman-jacobs",
            "branches": null
        },
        {
            "id": "9fdec66c-b598-4629-a414-1f235e9feac1",
            "name": "Feeney-O'Keefe",
            "address": "46603 Beahan Lakes Apt. 617\nEast Arvidport, OR 27576",
            "slug": "feeney-okeefe",
            "branches": null
        },
        {
            "id": "9fdec66c-c6e2-4be9-995b-a2e7b183a9fa",
            "name": "Konopelski, Buckridge and Cruickshank",
            "address": "7088 Shane Forest Apt. 886\nAdafort, IA 21629-6228",
            "slug": "konopelski-buckridge-and-cruickshank",
            "branches": null
        },
        {
            "id": "9fdec66c-d36c-4f89-b83b-a92e4a30624f",
            "name": "Hansen-Krajcik",
            "address": "53767 Bradtke Point Suite 666\nPort Bertrandton, RI 98344-8292",
            "slug": "hansen-krajcik",
            "branches": null
        },
        {
            "id": "9fdec66c-e29d-488b-822b-263326b242a9",
            "name": "Moore-Zboncak",
            "address": "154 Brad Light Apt. 246\nSouth Mosheton, IL 03588-1193",
            "slug": "moore-zboncak",
            "branches": null
        },
        {
            "id": "9fdec66c-ecc6-4f4b-abd3-2e5c7a95e52b",
            "name": "Berge, Ernser and Schamberger",
            "address": "3658 Syble Stravenue Apt. 397\nNew Ursula, KY 51657-4022",
            "slug": "berge-ernser-and-schamberger",
            "branches": null
        },
        {
            "id": "9fdec66c-fa45-46bd-84ce-597d9d626bf2",
            "name": "Frami-Becker",
            "address": "26580 Halvorson Rapid\nPort Lesterfurt, PA 24664-4034",
            "slug": "frami-becker",
            "branches": null
        },
        {
            "id": "9fdec66d-07b1-47e8-b7b3-1306f017ddea",
            "name": "Volkman Group",
            "address": "290 Nader Parkways Apt. 269\nBeermouth, ME 48751-4655",
            "slug": "volkman-group",
            "branches": null
        },
        {
            "id": "9fdec66d-1b6e-4640-8d55-e2994f19cef6",
            "name": "Mante-Zboncak",
            "address": "13292 Raven Track\nPort Genevieveton, TN 06924-0706",
            "slug": "mante-zboncak",
            "branches": null
        },
        {
            "id": "9fdec66d-2983-4742-bb11-be2902c1ee27",
            "name": "Greenfelder-Feest",
            "address": "81664 Dannie Square Suite 622\nNorth Reina, MO 23276",
            "slug": "greenfelder-feest",
            "branches": null
        },
        {
            "id": "9fdec66d-3ce3-452f-9a11-bb1f3c7ec187",
            "name": "Bailey LLC",
            "address": "2917 Labadie Gateway\nBriahaven, WA 54027-4382",
            "slug": "bailey-llc",
            "branches": null
        },
        {
            "id": "9fdec66d-4889-4c3d-9220-7950cd2c69bf",
            "name": "Crooks Ltd",
            "address": "96438 Esmeralda Parkways\nNew Verliehaven, ID 43034",
            "slug": "crooks-ltd",
            "branches": null
        },
        {
            "id": "9fdec66d-564d-47d2-9fb7-70b163b14c42",
            "name": "Goodwin, Hegmann and Rolfson",
            "address": "910 Will Mountain Suite 500\nSouth Lacy, TX 54314-7076",
            "slug": "goodwin-hegmann-and-rolfson",
            "branches": null
        },
        {
            "id": "9fdec66d-655d-4e04-b87a-7c2fd984ff30",
            "name": "O'Keefe, Considine and Hauck",
            "address": "7846 Linnea Common Apt. 792\nSouth Cletachester, NJ 74044-1734",
            "slug": "okeefe-considine-and-hauck",
            "branches": null
        }
    ],
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/web/restaurants

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

filter[search]   string  optional  

Field to perform a custom search. Example: maxime

Reserve in branch in specific restaurant

requires authentication

This endpoint lets you reserve in branch in specific restaurant

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reserve" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"tcnukzjulktih\",
    \"last_name\": \"v\",
    \"phone\": \"aliquam\",
    \"number_of_people\": 42,
    \"reservation_time\": \"2041-04-02\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reserve"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "tcnukzjulktih",
    "last_name": "v",
    "phone": "aliquam",
    "number_of_people": 42,
    "reservation_time": "2041-04-02"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec66b-7b28-46b6-b9f4-ef60d3aa1f0c",
        "customer": {
            "name": "John Doe",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "+971581234567"
        },
        "branch": {
            "id": "c4ca074e-2f55-4583-8bd8-a6e7f4ec8b2e",
            "name": "Alycia Pouros",
            "address": "113 Kaci Ville Apt. 121\nLake Paolo, WI 21981",
            "slug": "quia-nostrum-qui-quas-tempora-eveniet-in-sapiente",
            "logo": "branch.png",
            "settings": "{\"reservations\":null}"
        },
        "reservation_time": "2025-09-13 21:26:44",
        "number_of_people": 4,
        "status": {
            "key": 1,
            "value": "PENDING"
        }
    },
    "message": "Your reservation has been added successfully. Please wait for the confirmation!",
    "status_code": 200
}
 

Request      

POST api/v1/web/restaurants/{restaurant_id}/{branch_id}/reserve

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

first_name   string   

Must not be greater than 255 characters. Example: tcnukzjulktih

last_name   string   

Must not be greater than 255 characters. Example: v

phone   string   

Example: aliquam

number_of_people   number   

Must be at least 1. Example: 42

reservation_time   string   

Must be a valid date. Must be a date after now. Example: 2041-04-02

update Specific Reservation Status To Cancel

requires authentication

This endpoint lets you update specific reservation status

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations/9fdec6fe-c32a-48e8-827a-6e04c907c5bc/cancel" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations/9fdec6fe-c32a-48e8-827a-6e04c907c5bc/cancel"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Reservation cancelled successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/web/restaurants/{restaurant_id}/{branch_id}/reservations/{reservation_id}/cancel

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

reservation_id   string   

The ID of the reservation. Example: 9fdec6fe-c32a-48e8-827a-6e04c907c5bc

Show Restaurant's Menu

requires authentication

This endpoint lets you show menu for specific restaurant

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/qui/fuga/menu?sort=nobis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/qui/fuga/menu"
);

const params = {
    "sort": "nobis",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "menu": {
            "id": "9fdec655-7189-41a9-a108-2e704ed8820d",
            "title": "Et mollitia reprehenderit placeat labore.",
            "description": "Aspernatur minima ut sint facilis. Ab vero et tempora odit esse voluptatum. Sit cum et minima voluptatum. Tempore quisquam omnis omnis nulla.",
            "menu_categories": [
                {
                    "id": "9fdec655-820b-41da-8d1b-55cf4e2507de",
                    "title": "Unde voluptatem eum veritatis repellendus sequi numquam.",
                    "description": "Libero ea autem sed neque. Expedita incidunt iste ex nemo provident eligendi. Enim voluptas quas et eos temporibus alias blanditiis.",
                    "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
                    "menu_items": [
                        {
                            "id": "9fdec655-aa41-4684-a808-ffbb6475ba1f",
                            "menu_category_id": "9fdec655-820b-41da-8d1b-55cf4e2507de",
                            "menu_id": "9fdec655-7189-41a9-a108-2e704ed8820d",
                            "title": "Velit quis veritatis facilis nisi.",
                            "description": "Aut aspernatur velit porro veniam cumque. Itaque optio minus officiis inventore distinctio ex. Eius labore illo atque numquam voluptatum cupiditate quis.",
                            "available_quantity": 66,
                            "image": "http://localhost/storage/restaurants/menu_item.png",
                            "price": 704,
                            "currency": {
                                "key": 3,
                                "value": "AED"
                            },
                            "status": {
                                "key": 1,
                                "value": "AVAILABLE"
                            },
                            "type_label": "Medium",
                            "sub_items": null,
                            "availability_message": "Available"
                        },
                        {
                            "id": "9fdec655-ce8c-46b0-8689-782291f25831",
                            "menu_category_id": "9fdec655-820b-41da-8d1b-55cf4e2507de",
                            "menu_id": "9fdec655-7189-41a9-a108-2e704ed8820d",
                            "title": "Perferendis sit assumenda doloremque voluptatum architecto corrupti.",
                            "description": "Explicabo incidunt ratione officia veniam et. Nisi iure neque officiis earum tenetur earum totam. Doloremque esse qui voluptatem suscipit debitis in nisi. Ut sint optio nostrum debitis. Ut animi ut blanditiis vel iusto.",
                            "available_quantity": 7,
                            "image": "http://localhost/storage/restaurants/menu_item.png",
                            "price": 241,
                            "currency": {
                                "key": 3,
                                "value": "AED"
                            },
                            "status": {
                                "key": 1,
                                "value": "AVAILABLE"
                            },
                            "type_label": "Medium",
                            "sub_items": null,
                            "availability_message": "Available"
                        }
                    ]
                }
            ]
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/web/{restaurant_slug}/{branch_slug}/menu

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: qui

branch_slug   string   

The slug of the branch. Example: fuga

Query Parameters

sort   string  optional  

Field to sort items by title. Example: nobis

Show Table details

requires authentication

This endpoint lets you show all show table details for specific restaurant

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/enim/mollitia/voluptatem?sort=numquam" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/enim/mollitia/voluptatem"
);

const params = {
    "sort": "numquam",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "branch": {
            "id": "e5e7edd7-cf15-4250-82aa-704d99f13958",
            "name": "Bernita Dare",
            "logo": "http://localhost/storage/restaurants/branch.png",
            "color": "#C29432",
            "phone": "+17407536004",
            "email": null,
            "settings": {
                "review_type": 3,
                "review_link": "https://maps.app.goo.gl/example",
                "stars_threshold": 4
            }
        },
        "table": {
            "id": "9fdec66e-d923-4c4f-9abe-cd69d56c5f1e",
            "number": "8",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            }
        },
        "menu": {
            "id": "9fdec66e-f210-43a0-906b-f98e75717071",
            "title": "Iure est fugiat.",
            "description": "Consequuntur eos facilis inventore quasi quae reiciendis voluptas. Voluptatibus architecto asperiores molestiae aut dolor vel. Porro consequatur molestiae consequatur maiores ea esse et. Et iure in et nemo.",
            "menu_categories": [
                {
                    "id": "9fdec66f-0ccd-4a54-872d-a0ae1588ac65",
                    "title": "Laborum eveniet aut esse earum molestias molestiae.",
                    "description": "Aut aut voluptates quas. Est beatae necessitatibus amet illum a. Dolores libero tempora rerum eius officia. Eum beatae est aliquam tempora.",
                    "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
                    "menu_items": [
                        {
                            "id": "9fdec66f-45e8-461f-9764-6baaf0b82bf8",
                            "menu_category_id": "9fdec66f-0ccd-4a54-872d-a0ae1588ac65",
                            "menu_id": "9fdec66e-f210-43a0-906b-f98e75717071",
                            "title": "Aut aut deleniti blanditiis et.",
                            "description": "Mollitia dolor est cumque incidunt rerum eos. Dolores at et sed temporibus et aut. Mollitia rem illo nostrum ea cumque rem voluptas. Animi veniam recusandae esse non incidunt sint quidem maxime.",
                            "available_quantity": 82,
                            "image": "http://localhost/storage/restaurants/menu_item.png",
                            "price": 882,
                            "currency": {
                                "key": 3,
                                "value": "AED"
                            },
                            "status": {
                                "key": 1,
                                "value": "AVAILABLE"
                            },
                            "type_label": "Medium",
                            "sub_items": null,
                            "availability_message": "Available"
                        },
                        {
                            "id": "9fdec66f-709e-464c-833d-a422383bb9e8",
                            "menu_category_id": "9fdec66f-0ccd-4a54-872d-a0ae1588ac65",
                            "menu_id": "9fdec66e-f210-43a0-906b-f98e75717071",
                            "title": "Eos numquam est quos perspiciatis aut consequatur ex est.",
                            "description": "Accusantium error praesentium sint voluptas est ipsa. Impedit reprehenderit quae sapiente voluptatem neque aut a. Excepturi ratione ratione quis et itaque. Excepturi perferendis illum ea nihil sit sint.",
                            "available_quantity": 97,
                            "image": "http://localhost/storage/restaurants/menu_item.png",
                            "price": 979,
                            "currency": {
                                "key": 3,
                                "value": "AED"
                            },
                            "status": {
                                "key": 1,
                                "value": "AVAILABLE"
                            },
                            "type_label": "Medium",
                            "sub_items": null,
                            "availability_message": "Available"
                        }
                    ]
                }
            ]
        },
        "order": {
            "id": "9fdec66f-987d-423c-85f9-3dfd17b73730",
            "number": "Maedah_025_3",
            "items": [],
            "total_amount": 91466,
            "final_amount": 99999,
            "paid_amount": 0,
            "remaining_amount": 99999,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": 2,
            "created_by": {
                "key": 1,
                "value": "CUSTOMER"
            },
            "serviceFee": 4573.3,
            "serviceFeeDescription": "Service fee helps maintain restaurant standards and ensures quality service.",
            "totalBillDescription": "The total bill includes all charges for the order.",
            "tip_amount": [
                {
                    "title": "5%",
                    "value": 4999.950000000001
                },
                {
                    "title": "10%",
                    "value": 9999.900000000001
                },
                {
                    "title": "15%",
                    "value": 14999.849999999999
                },
                {
                    "title": "20%",
                    "value": 19999.800000000003
                }
            ],
            "additional_notes": null,
            "payments": null
        },
        "enums": [
            {
                "key": 2,
                "value": "PENDING",
                "description": "We have received your request! We are reviewing your request and will update you once it is accepted."
            },
            {
                "key": 3,
                "value": "ACCEPTED",
                "description": "Your order has been confirmed by our team. We will start preparing your snack soon."
            },
            {
                "key": 4,
                "value": "PREPARING",
                "description": "Your order is currently being prepared. Our chefs are working on your order to ensure it is made fresh and to your liking."
            },
            {
                "key": 5,
                "value": "READY",
                "description": "Your order is ready! Thank you for choosing us."
            }
        ]
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: enim

branch_slug   string   

The slug of the branch. Example: mollitia

restaurantTable_number   string   

Example: voluptatem

Query Parameters

sort   string  optional  

Field to sort items by title. Example: numquam

Show Menu Item Details

requires authentication

This endpoint lets you Show specific menu item details

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/sequi/quia/temporibus/menu/assumenda" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/sequi/quia/temporibus/menu/assumenda"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec66d-eb35-4a51-b00a-63240953f60a",
        "menu_category_id": "9fdec66d-9fd8-4509-bf36-a22c95f94333",
        "menu_id": "9fdec66d-8f2e-4275-9f3b-2ddfed151be7",
        "title": "Dicta voluptatem hic velit nemo.",
        "description": "Suscipit aut distinctio laboriosam aliquam modi. Exercitationem quo nihil facilis veniam. Voluptas asperiores iure cum rerum repudiandae expedita quibusdam autem.",
        "available_quantity": 46,
        "image": "http://localhost/storage/restaurants/menu_item.png",
        "price": 648,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 1,
            "value": "AVAILABLE"
        },
        "type_label": "Medium",
        "sub_items": null,
        "availability_message": "Available"
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/menu/{menu_item_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: sequi

branch_slug   string   

The slug of the branch. Example: quia

restaurantTable_number   string   

Example: temporibus

menu_item_id   string   

The ID of the menu item. Example: assumenda

Show terms and conditions

requires authentication

This endpoint lets you Show terms and conditions

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/porro/ut/sit/terms-and-conditions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/porro/ut/sit/terms-and-conditions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "terms_and_conditions": "<h3>Terms and Conditions</h3><h4>Introduction</h4><p>Welcome to Rozana. These terms and conditions govern your use of our application. By downloading, accessing, or using the App, you agree to these Terms in full. If you do not agree with these Terms, you must not use the App.</p><br><h3>Use of the App</h3><h5>Eligibility</h5><p>You must be at least 18 years of age to use this App. By using the App, you warrant that you are of legal age to form a binding contract.</p><br><h5>User Account</h5><p>To place orders or access certain features, you may need to create an account. You are responsible for maintaining the confidentiality of your account credentials and for all activities that occur under your account.</p><h4>Orders and Payment</h4><h5>Placing Orders</h5><p>All orders placed through the App are subject to acceptance by us. We reserve the right to refuse or cancel any order for any reason, including product availability, errors in the description or price of the product, or errors in your order.</p><h5>Payment</h5><p>Payment for orders must be made through the payment methods available in the App. You agree to provide accurate and complete payment information. We reserve the right to cancel your order if your payment method is declined or if there are issues with your payment.</p><h5>Pricing and Availability</h5><p>All prices are listed in AED and are subject to change without notice. Availability of products or services is subject to change at any time, and we may impose quantity limits on any order.</p><br><h5>Delivery and Pickup</h5><h5>Delivery</h5><p>Delivery times provided are estimates and may vary. We will not be responsible for any delays in delivery due to reasons beyond our control.</p><h5>Pickup</h5><p>If you choose to pick up your order, it will be available at the designated time and location provided in the App. You must present your order confirmation at the time of pickup.</p><h5>Risk of Loss</h5><p>All items purchased through the App are made pursuant to a shipment contract. The risk of loss and title for such items pass to you upon our delivery to the carrier.</p><h4>Privacy Policy</h4><p>Our Privacy Policy, which is available on the App, explains how we collect, use, and protect your personal information. By using the App, you agree to the terms of the Privacy Policy.</p>"
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/terms-and-conditions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: porro

branch_slug   string   

The slug of the branch. Example: ut

restaurantTable_number   string   

Example: sit

Unlock Restaurant Table

requires authentication

This endpoint lets customer ask staff to unlock the restaurant table

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/veritatis/ab/perspiciatis/unlock/table?sort=autem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/veritatis/ab/perspiciatis/unlock/table"
);

const params = {
    "sort": "autem",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "A waiter will be notified to unlock your table shortly.",
    "status_code": 200
}
 

Request      

POST api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/unlock/table

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: veritatis

branch_slug   string   

The slug of the branch. Example: ab

restaurantTable_number   string   

Example: perspiciatis

Query Parameters

sort   string  optional  

Field to sort items by title. Example: autem

notify staff

requires authentication

This endpoint lets customer notify staff

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/expedita/quia/amet/notify-waiter" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/expedita/quia/amet/notify-waiter"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "A waiter will be notified shortly.",
    "status_code": 200
}
 

Request      

POST api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/notify-waiter

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: expedita

branch_slug   string   

The slug of the branch. Example: quia

restaurantTable_number   string   

Example: amet

notify staff to edit order

requires authentication

This endpoint lets customer notify staff to edit order

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/adipisci/ut/commodi/notify-waiter-to-update-order" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/adipisci/ut/commodi/notify-waiter-to-update-order"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "A waiter will be notified to edit your order.",
    "status_code": 200
}
 

Request      

POST api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/notify-waiter-to-update-order

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: adipisci

branch_slug   string   

The slug of the branch. Example: ut

restaurantTable_number   string   

Example: commodi

notify staff to pay cash

requires authentication

This endpoint lets customer notify staff to pay cash

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/ducimus/reiciendis/laboriosam/notify-waiter-to-pay-cash" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/ducimus/reiciendis/laboriosam/notify-waiter-to-pay-cash"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The waiter has been notified to collect cash payment.",
    "status_code": 200
}
 

Request      

POST api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/notify-waiter-to-pay-cash

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: ducimus

branch_slug   string   

The slug of the branch. Example: reiciendis

restaurantTable_number   string   

Example: laboriosam

Request verification code

requires authentication

This endpoint lets customer Request verification code

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/eveniet/aut/quis/request-verification-code?sort=nihil" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/eveniet/aut/quis/request-verification-code"
);

const params = {
    "sort": "nihil",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Code is sent successfully",
    "status_code": 200
}
 

Request      

GET api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/request-verification-code

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: eveniet

branch_slug   string   

The slug of the branch. Example: aut

restaurantTable_number   string   

Example: quis

Query Parameters

sort   string  optional  

Field to sort items by title. Example: nihil

Show Payment details

requires authentication

This endpoint lets you show payment details for specific order

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/qui/ea/officia/payments/dolorem?sort=dolores" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/qui/ea/officia/payments/dolorem"
);

const params = {
    "sort": "dolores",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec675-5b06-47c7-8ccf-a55b4e5cb3f2",
        "customer_phone": "484-473-1834",
        "payment_method": {
            "key": 4,
            "value": "CASH"
        },
        "status": {
            "key": 1,
            "value": "UNPAID"
        },
        "amount": 776,
        "order": {
            "id": "9fdec673-5a5c-4735-8b10-a8d3a14f658c",
            "number": "Maedah_025_17",
            "items": [
                {
                    "id": "9fdec675-1689-4ab3-bece-4d61ae4d24dc",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-08ce-41e0-8418-0cb79154682d",
                        "title": "Animi aperiam ut cumque fugit laborum ratione ducimus necessitatibus.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 921,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                },
                {
                    "id": "9fdec675-184f-47cd-8b4e-5a371f1f072c",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-0a3b-45dc-865f-cff6faf0a006",
                        "title": "Id excepturi saepe est.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 376,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                },
                {
                    "id": "9fdec675-19d2-4c7d-8fba-cd4ba4ea20bc",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-0b89-451e-b1c7-6820931316e7",
                        "title": "Et omnis vel rerum provident.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 861,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                },
                {
                    "id": "9fdec675-1bfd-4977-9155-c90905589d93",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-0cd3-46fa-bc6f-8e17693d0411",
                        "title": "Aut eius illo molestiae in eum hic.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 716,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                },
                {
                    "id": "9fdec675-1e14-4399-8123-94398df459a4",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-0e0b-4c85-b19c-eee69720f8cc",
                        "title": "Repudiandae est soluta eos recusandae at aliquid.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 379,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                },
                {
                    "id": "9fdec675-204a-445a-829c-c8dcc6f0e2b6",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-0f3c-4f09-b4f2-cc3029d39eb6",
                        "title": "Ullam placeat molestias sit et rerum.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 288,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                },
                {
                    "id": "9fdec675-225c-49c0-be52-054c4ea33482",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-1095-4fd5-ba8c-bc61a8d1d56f",
                        "title": "Corporis omnis magni consectetur blanditiis qui.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 598,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                },
                {
                    "id": "9fdec675-246a-4dec-8e37-2f214531b8e8",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-11db-448f-9fd0-433d914bc6ad",
                        "title": "Aut culpa qui et dolore.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 886,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                },
                {
                    "id": "9fdec675-2687-4e3b-9843-e0dded27cc0d",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-1328-4458-b0b7-9daa555dd43c",
                        "title": "In sit sed rerum ea.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 619,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                },
                {
                    "id": "9fdec675-2c28-4521-8fdc-c04407b1f073",
                    "status": 2,
                    "notes": null,
                    "menuItem": {
                        "id": "9fdec675-147e-474d-901d-0234a034e188",
                        "title": "Maxime at non voluptas delectus debitis et odit.",
                        "quantity": 1,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 213,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "type_label": "Medium"
                    }
                }
            ],
            "total_amount": 6012,
            "final_amount": 100,
            "paid_amount": 0,
            "remaining_amount": 100,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": 8,
            "created_by": {
                "key": 2,
                "value": "WAITER"
            },
            "serviceFee": 800.6,
            "serviceFeeDescription": "Service fee helps maintain restaurant standards and ensures quality service.",
            "totalBillDescription": "The total bill includes all charges for the order.",
            "tip_amount": [
                {
                    "title": "5%",
                    "value": 5
                },
                {
                    "title": "10%",
                    "value": 10
                },
                {
                    "title": "15%",
                    "value": 15
                },
                {
                    "title": "20%",
                    "value": 20
                }
            ],
            "additional_notes": null,
            "payments": [
                {
                    "id": "9fdec675-5b06-47c7-8ccf-a55b4e5cb3f2",
                    "customer_phone": "484-473-1834",
                    "payment_method": {
                        "key": 4,
                        "value": "CASH"
                    },
                    "status": {
                        "key": 1,
                        "value": "UNPAID"
                    },
                    "amount": 776,
                    "tip_amount": 0
                }
            ]
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/payments/{payment_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: qui

branch_slug   string   

The slug of the branch. Example: ea

restaurantTable_number   string   

Example: officia

payment_id   string   

The ID of the payment. Example: dolorem

Query Parameters

sort   string  optional  

Field to sort items by title. Example: dolores

Generate Payment PDF

requires authentication

This endpoint lets you generate a PDF for a specific payment.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/itaque/nam/quidem/payments/qui/pdf" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/itaque/nam/quidem/payments/qui/pdf"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (404):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
 

{
    "message": "Restaurant not found for IDs: itaque",
    "status_code": 404
}
 

Request      

GET api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/payments/{payment_id}/pdf

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: itaque

branch_slug   string   

The slug of the branch. Example: nam

restaurantTable_number   string   

Example: quidem

payment_id   string   

The ID of the payment. Example: qui

Order

APIs for Order

Add Order

requires authentication

This endpoint lets you add order

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/blanditiis/consequuntur/vel/orders" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order_items\": [
        {
            \"id\": \"quis\",
            \"notes\": \"possimus\"
        }
    ],
    \"phone\": \"animi\",
    \"validation_code\": \"od\",
    \"additional_notes\": \"molestiae\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/blanditiis/consequuntur/vel/orders"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order_items": [
        {
            "id": "quis",
            "notes": "possimus"
        }
    ],
    "phone": "animi",
    "validation_code": "od",
    "additional_notes": "molestiae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec668-6e88-493b-b803-cb42e5c41bdb",
        "number": "# ret_025_11",
        "items": [
            {
                "id": "9fdec668-7138-4829-a207-b2b98c076699",
                "status": 2,
                "notes": "dfsdsfs",
                "menuItem": {
                    "id": "9fdec667-5a2f-4661-8fb7-30f8b4cb2bee",
                    "title": "shaowrma",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 10,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            },
            {
                "id": "9fdec668-740d-4909-bf80-db18baa5a3aa",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec667-90bb-46b0-98a5-f026efc66326",
                    "title": "taboulah",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 5,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            },
            {
                "id": "9fdec668-76d2-4d50-a6ad-93b85f317a7f",
                "status": 2,
                "notes": "with more lemon",
                "menuItem": {
                    "id": "9fdec667-90bb-46b0-98a5-f026efc66326",
                    "title": "taboulah",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 5,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            }
        ],
        "total_amount": 20,
        "final_amount": 121,
        "paid_amount": 0,
        "remaining_amount": 121,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": 1,
        "created_by": {
            "key": 1,
            "value": "CUSTOMER"
        },
        "serviceFee": 101,
        "serviceFeeDescription": "Service fee helps maintain restaurant standards and ensures quality service.",
        "totalBillDescription": "The total bill includes all charges for the order.",
        "tip_amount": [
            {
                "title": "5%",
                "value": 6.050000000000001
            },
            {
                "title": "10%",
                "value": 12.100000000000001
            },
            {
                "title": "15%",
                "value": 18.15
            },
            {
                "title": "20%",
                "value": 24.200000000000003
            }
        ],
        "additional_notes": "this additional notes",
        "payments": null
    },
    "message": "The order added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/orders

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: blanditiis

branch_slug   string   

The slug of the branch. Example: consequuntur

restaurantTable_number   string   

Example: vel

Body Parameters

order_items   object[]   

Must have at least 1 items.

id   string   

The id of an existing record in the menu_items table. Example: quis

notes   string  optional  

Example: possimus

phone   string   

Example: animi

validation_code   string  optional  

Must not be greater than 3 characters. Example: od

additional_notes   string  optional  

Example: molestiae

Show specific Order

requires authentication

This endpoint lets you show specific order

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/quidem/debitis/aut/orders/dolor" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/quidem/debitis/aut/orders/dolor"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec667-8ec1-4b09-9a93-cdbe18b1dd9e",
        "number": "Maedah_025_14",
        "items": [
            {
                "id": "9fdec667-fc26-4e26-b1a5-ce2cc6aa6fb2",
                "status": 3,
                "notes": "Repellat perferendis ipsum consequatur suscipit.",
                "menuItem": {
                    "id": "9fdec667-0baa-401b-af61-1a297a129d79",
                    "title": "Small Tabbouleh",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 20,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            },
            {
                "id": "9fdec668-515f-4e73-9a4e-9aab0ef03568",
                "status": 3,
                "notes": "Et omnis veniam explicabo ad nam repellat.",
                "menuItem": {
                    "id": "9fdec667-3659-405e-bc77-597085474be6",
                    "title": "Shish Tawook",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 30,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            },
            {
                "id": "9fdec668-a6c9-4758-b409-f4f3d2ed7d63",
                "status": 3,
                "notes": "Qui est odio aut aliquid at.",
                "menuItem": {
                    "id": "9fdec667-61b1-4974-aee0-2d260767ffeb",
                    "title": "Cheese Roll",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 25,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            }
        ],
        "total_amount": 500,
        "final_amount": 500,
        "paid_amount": 0,
        "remaining_amount": 500,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": 4,
        "created_by": {
            "key": 2,
            "value": "WAITER"
        },
        "serviceFee": 125,
        "serviceFeeDescription": "Service fee helps maintain restaurant standards and ensures quality service.",
        "totalBillDescription": "The total bill includes all charges for the order.",
        "tip_amount": [
            {
                "title": "5%",
                "value": 25
            },
            {
                "title": "10%",
                "value": 50
            },
            {
                "title": "15%",
                "value": 75
            },
            {
                "title": "20%",
                "value": 100
            }
        ],
        "additional_notes": "this order",
        "payments": null
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/orders/{order_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: quidem

branch_slug   string   

The slug of the branch. Example: debitis

restaurantTable_number   string   

Example: aut

order_id   string   

The ID of the order. Example: dolor

Verify the validation code for an order.

requires authentication

This endpoint lets customer validation code for an order.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/quo/nisi/nihil/dolore/verify-code" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"otp_code\": \"libero\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/quo/nisi/nihil/dolore/verify-code"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "otp_code": "libero"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Order code verified successfully",
    "status_code": 200
}
 

Request      

POST api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/{order_id}/verify-code

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: quo

branch_slug   string   

The slug of the branch. Example: nisi

restaurantTable_number   string   

Example: nihil

order_id   string   

The ID of the order. Example: dolore

Body Parameters

otp_code   string   

Example: libero

update Specific Order Status To Cancel

requires authentication

This endpoint lets you update specific order status

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/voluptas/sed/quia/non/mark-status-cancelled" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/voluptas/sed/quia/non/mark-status-cancelled"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Order cancelled successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/{order_id}/mark-status-cancelled

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: voluptas

branch_slug   string   

The slug of the branch. Example: sed

restaurantTable_number   string   

Example: quia

order_id   string   

The ID of the order. Example: non

store Order Item

requires authentication

This endpoint lets customer store an order item.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/rerum/harum/facilis/iste/order-item" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"notes\": \"fugit\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/rerum/harum/facilis/iste/order-item"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "notes": "fugit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec664-74e5-4f39-b279-392eef5a1ee6",
        "number": "Maedah_025_14",
        "items": [
            {
                "id": "9fdec664-77b8-4ad8-9c56-3ec88c2d25e4",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec664-1406-49b0-9d64-6e5e4eea2905",
                    "title": "shawarma",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 100,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            },
            {
                "id": "9fdec664-8b46-4532-8364-dcee346a0cdf",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec664-40aa-4254-8a59-893ca3f4ad89",
                    "title": "tabbouleh",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 5,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            }
        ],
        "total_amount": 105,
        "final_amount": 210,
        "paid_amount": 0,
        "remaining_amount": 210,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": 7,
        "created_by": {
            "key": 1,
            "value": "CUSTOMER"
        },
        "serviceFee": 105.25,
        "serviceFeeDescription": "Service fee helps maintain restaurant standards and ensures quality service.",
        "totalBillDescription": "The total bill includes all charges for the order.",
        "tip_amount": [
            {
                "title": "5%",
                "value": 10.5
            },
            {
                "title": "10%",
                "value": 21
            },
            {
                "title": "15%",
                "value": 31.5
            },
            {
                "title": "20%",
                "value": 42
            }
        ],
        "additional_notes": null,
        "payments": null
    },
    "message": "The order updated successfully",
    "status_code": 200
}
 

Request      

POST api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/{order_id}/order-item

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: rerum

branch_slug   string   

The slug of the branch. Example: harum

restaurantTable_number   string   

Example: facilis

order_id   string   

The ID of the order. Example: iste

Body Parameters

id   string  optional  

The id of an existing record in the order_items table.

menu_item_id   string  optional  

The id of an existing record in the menu_items table.

notes   string  optional  

Example: fugit

update Order Item

requires authentication

This endpoint lets customer update an order item.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/harum/quia/aut/assumenda/order-item/consequuntur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"notes\": \"autem\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/harum/quia/aut/assumenda/order-item/consequuntur"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "notes": "autem"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec665-3225-4ce1-9129-8cc159b1fa0a",
        "number": "Maedah_025_11",
        "items": [
            {
                "id": "9fdec665-3389-4041-bb39-668e16937193",
                "status": 2,
                "notes": "note one",
                "menuItem": {
                    "id": "9fdec665-0952-4b8d-ae79-7a61790146a2",
                    "title": "tabbouleh",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 50,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            }
        ],
        "total_amount": 50,
        "final_amount": 72,
        "paid_amount": 0,
        "remaining_amount": 72,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": 9,
        "created_by": {
            "key": 1,
            "value": "CUSTOMER"
        },
        "serviceFee": 22.5,
        "serviceFeeDescription": "Service fee helps maintain restaurant standards and ensures quality service.",
        "totalBillDescription": "The total bill includes all charges for the order.",
        "tip_amount": [
            {
                "title": "5%",
                "value": 3.6
            },
            {
                "title": "10%",
                "value": 7.2
            },
            {
                "title": "15%",
                "value": 10.799999999999999
            },
            {
                "title": "20%",
                "value": 14.4
            }
        ],
        "additional_notes": null,
        "payments": null
    },
    "message": "The order updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/{order_id}/order-item/{order_item_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: harum

branch_slug   string   

The slug of the branch. Example: quia

restaurantTable_number   string   

Example: aut

order_id   string   

The ID of the order. Example: assumenda

order_item_id   string   

The ID of the order item. Example: consequuntur

Body Parameters

id   string  optional  

The id of an existing record in the order_items table.

menu_item_id   string  optional  

The id of an existing record in the menu_items table.

notes   string  optional  

Example: autem

Delete Order Item

requires authentication

This endpoint lets customer delete an order item.

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/blanditiis/vel/aut/quis/order-item/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/blanditiis/vel/aut/quis/order-item/ut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec663-4f89-49ac-a8f5-6083021c8f9d",
        "number": "Maedah_025_21",
        "items": [
            {
                "id": "9fdec663-a437-4a06-aa5c-41f9edbda8f3",
                "status": 2,
                "notes": "Sed ex excepturi totam at sed omnis.",
                "menuItem": {
                    "id": "9fdec663-2bd8-4466-92cb-3af98bb33342",
                    "title": "Nostrum accusantium numquam libero vel id mollitia omnis.",
                    "quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 50,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "type_label": "Medium"
                }
            }
        ],
        "total_amount": 100,
        "final_amount": 125,
        "paid_amount": 0,
        "remaining_amount": 125,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": 5,
        "created_by": {
            "key": 2,
            "value": "WAITER"
        },
        "serviceFee": 25,
        "serviceFeeDescription": "Service fee helps maintain restaurant standards and ensures quality service.",
        "totalBillDescription": "The total bill includes all charges for the order.",
        "tip_amount": [
            {
                "title": "5%",
                "value": 6.25
            },
            {
                "title": "10%",
                "value": 12.5
            },
            {
                "title": "15%",
                "value": 18.75
            },
            {
                "title": "20%",
                "value": 25
            }
        ],
        "additional_notes": null,
        "payments": null
    },
    "message": "The order item deleted successfully",
    "status_code": 200
}
 

Request      

DELETE api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/{order_id}/order-item/{order_item}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: blanditiis

branch_slug   string   

The slug of the branch. Example: vel

restaurantTable_number   string   

Example: aut

order_id   string   

The ID of the order. Example: quis

order_item   string   

Example: ut

Show status for specific order

requires authentication

This endpoint lets you show status for specific order

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/web/quod/magnam/ipsum/orders/explicabo/get-order-status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/quod/magnam/ipsum/orders/explicabo/get-order-status"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec664-f07e-4bd3-8c7b-6884e8511f98",
        "status": {
            "key": 4,
            "value": "PREPARING"
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/orders/{order_id}/get-order-status

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: quod

branch_slug   string   

The slug of the branch. Example: magnam

restaurantTable_number   string   

Example: ipsum

order_id   string   

The ID of the order. Example: explicabo

Reviews

APIs for Reviews

Add Review for specific order

requires authentication

This endpoint lets user add Review

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/harum/et/qui/orders/review" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order_id\": \"alias\",
    \"rating\": 13,
    \"comment\": \"zsxduwocyzoeri\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/harum/et/qui/orders/review"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order_id": "alias",
    "rating": 13,
    "comment": "zsxduwocyzoeri"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "order_id": "9fdec66b-f671-4633-8902-e060f1e9a01d",
        "customer_id": "9fdec66b-cb5c-418e-9ab3-6ddaf5d920b2",
        "rating": 5,
        "comment": "this restaurant is good",
        "google_review_link": "https://maps.app.goo.gl/example"
    },
    "message": "The Review added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/orders/review

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: harum

branch_slug   string   

The slug of the branch. Example: et

restaurantTable_number   string   

Example: qui

Body Parameters

order_id   string   

The id of an existing record in the orders table. Example: alias

rating   number   

Must be at least 0. Example: 13

comment   string  optional  

Must not be greater than 255 characters. Example: zsxduwocyzoeri

Health

API For Health Check

Handle the health check request.

requires authentication

This method returns the status of the application as a JSON response. It includes the current timestamp,database connection ,cache, application name, and environment.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/health" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/health"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "status": "ok",
    "database": "Database connection is OK",
    "cache": "Cache connection is OK",
    "app": "Laravel",
    "environment": "testing",
    "timestamp": "2025-09-13T19:26:47+00:00"
}
 

Request      

GET api/health

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Payment

APIs for Payments Management

PayFort

APIs for PayFort Payment

Create a Checkout Session for PayFort or stripe Payment.

requires authentication

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/web/adipisci/voluptatem/tenetur/pay" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order_id\": \"alias\",
    \"tip_amount\": 3675585.23224,
    \"pay_amount\": 7
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/web/adipisci/voluptatem/tenetur/pay"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order_id": "alias",
    "tip_amount": 3675585.23224,
    "pay_amount": 7
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "payment_method": {
            "key": 7,
            "value": "AMAZON_PAY"
        },
        "purchase_data": {
            "command": "PURCHASE",
            "access_code": "svcoBTlttafdlj7BD1JD",
            "merchant_identifier": "rVPUwwns",
            "language": "en",
            "currency": "AED",
            "return_url": "http://localhost/api/v1/callback?payment_id=9fdec675-49b1-4a60-9c12-f81129a21454",
            "amount": 110,
            "customer_email": "test@gmail.com",
            "merchant_reference": "9fdec675-49b1-4a60-9c12-f81129a21454",
            "order_description": "order",
            "signature": "fdf40d767ad6a464b932515bfeb8fb514bc97c6f5bb22831c353779862b28e8e"
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

POST api/v1/web/{restaurant_slug}/{branch_slug}/{restaurantTable_number}/pay

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_slug   string   

The slug of the restaurant. Example: adipisci

branch_slug   string   

The slug of the branch. Example: voluptatem

restaurantTable_number   string   

Example: tenetur

Body Parameters

order_id   string   

The id of an existing record in the orders table. Example: alias

tip_amount   number   

Example: 3675585.23224

pay_amount   number  optional  

Must be at least 0. Example: 7

POST api/v1/callback

requires authentication

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/callback" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/callback"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/callback

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

GET api/v1/stripe/callback

requires authentication

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/stripe/callback" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/stripe/callback"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (400):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *
 

{
    "error": "Session ID is required"
}
 

Request      

GET api/v1/stripe/callback

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

POST api/v1/checkout/webhook

requires authentication

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/checkout/webhook" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/checkout/webhook"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/checkout/webhook

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Restaurant

APIs for Restaurant Management

Branch

APIs for Branch Management

Show all branches

requires authentication

This endpoint lets you show all branches

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches?page=12&per_page=10&filter%5Bname%5D=rem&filter%5Bid%5D=magnam&filter%5Brestaurant_id%5D=nam&filter%5Bslug%5D=totam&filter%5Bstatus%5D=fugiat&filter%5Baddress%5D=laboriosam&sort=debitis&filter%5Bsearch%5D=sint" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches"
);

const params = {
    "page": "12",
    "per_page": "10",
    "filter[name]": "rem",
    "filter[id]": "magnam",
    "filter[restaurant_id]": "nam",
    "filter[slug]": "totam",
    "filter[status]": "fugiat",
    "filter[address]": "laboriosam",
    "sort": "debitis",
    "filter[search]": "sint",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "8e391112-d70d-4736-aec7-55967804b81b",
            "restaurant": {
                "id": "9fdec5df-002d-41a0-bc36-fb91f93c72f6"
            },
            "name": "Anne Volkman",
            "name_ar": "Mr. Marty Wisozk",
            "abbreviation": "ivr",
            "background_image": "http://localhost/storage/restaurants/bg.png",
            "logo": "http://localhost/storage/restaurants/branch.png",
            "phone": "+1 (518) 774-7620",
            "email": null,
            "status": {
                "key": 3,
                "value": "ON_HOLD"
            },
            "address": "420 Hahn Hills\nLittelchester, MA 22938-1659",
            "address_ar": "91165 Zoila Plain\nWest Patrick, MO 46978-1181",
            "slug": "autem-iste-ullam-harum-quia-rem-tenetur"
        },
        {
            "id": "7ae2a5a0-4b75-4e97-9721-862ff988f00f",
            "restaurant": {
                "id": "9fdec5df-002d-41a0-bc36-fb91f93c72f6"
            },
            "name": "Kieran Schuster",
            "name_ar": "Helena Bechtelar",
            "abbreviation": "kpo",
            "background_image": "http://localhost/storage/restaurants/bg.png",
            "logo": "http://localhost/storage/restaurants/branch.png",
            "phone": "+1-463-922-2053",
            "email": null,
            "status": {
                "key": 1,
                "value": "ACTIVE"
            },
            "address": "8719 Parker Trail Apt. 406\nNorth Eulalia, IN 99670",
            "address_ar": "4672 Robel Mill Apt. 634\nSouth Alethamouth, DC 49378-1618",
            "slug": "dolorum-dignissimos-ipsa-sit-molestias-ratione"
        },
        {
            "id": "77881a2a-baca-4c0e-a4e4-f49358993ddf",
            "restaurant": {
                "id": "9fdec5df-002d-41a0-bc36-fb91f93c72f6"
            },
            "name": "Loraine Schaefer",
            "name_ar": "Leanna Toy",
            "abbreviation": "elc",
            "background_image": "http://localhost/storage/restaurants/bg.png",
            "logo": "http://localhost/storage/restaurants/branch.png",
            "phone": "+1-716-476-8912",
            "email": null,
            "status": {
                "key": 3,
                "value": "ON_HOLD"
            },
            "address": "748 Rippin Landing\nLetitiahaven, IA 77581-6595",
            "address_ar": "21566 Barney Plain\nSouth Dina, CT 10225-7958",
            "slug": "ut-aut-et-et-repudiandae-enim-nulla-voluptatem"
        },
        {
            "id": "75367546-8bb7-4eb3-888b-48ab1c597f78",
            "restaurant": {
                "id": "9fdec5df-002d-41a0-bc36-fb91f93c72f6"
            },
            "name": "Reid Osinski",
            "name_ar": "Norwood Klocko",
            "abbreviation": "ewr",
            "background_image": "http://localhost/storage/restaurants/bg.png",
            "logo": "http://localhost/storage/restaurants/branch.png",
            "phone": "+1 (432) 325-7559",
            "email": null,
            "status": {
                "key": 3,
                "value": "ON_HOLD"
            },
            "address": "1911 Veronica Estates\nEast Amiraland, OH 23981",
            "address_ar": "1761 Delphia Courts\nKariannemouth, CT 80507",
            "slug": "veritatis-quisquam-iste-a-culpa-aut-consectetur-blanditiis"
        },
        {
            "id": "6b9404f6-b895-4fcb-88b4-b976fafffce3",
            "restaurant": {
                "id": "9fdec5df-002d-41a0-bc36-fb91f93c72f6"
            },
            "name": "Madyson Padberg DVM",
            "name_ar": "Dominic Wunsch Jr.",
            "abbreviation": "osl",
            "background_image": "http://localhost/storage/restaurants/bg.png",
            "logo": "http://localhost/storage/restaurants/branch.png",
            "phone": "+1-725-972-4683",
            "email": null,
            "status": {
                "key": 2,
                "value": "INACTIVE"
            },
            "address": "592 Labadie Wells Suite 345\nKossland, NJ 57556",
            "address_ar": "241 Krajcik Field\nDickensburgh, ND 72552",
            "slug": "voluptatem-ea-aperiam-ducimus"
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 12

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 10

filter[name]   string  optional  

Field to filter items by name. Example: rem

filter[id]   string  optional  

Field to filter items by id. Example: magnam

filter[restaurant_id]   string  optional  

Field to filter items by restaurant_id. Example: nam

filter[slug]   string  optional  

Field to filter items by slug. Example: totam

filter[status]   string  optional  

Field to filter items by status. Example: fugiat

filter[address]   string  optional  

Field to filter items by address. Example: laboriosam

sort   string  optional  

Field to sort items by name,slug,status. Example: debitis

filter[search]   string  optional  

Field to perform a custom search. Example: sint

Add Branch

requires authentication

This endpoint lets you add branch

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=anpzbwljpsyzevrwdxcpshgjw"\
    --form "name_ar=qiig"\
    --form "abbreviation=wtldbeguceodm"\
    --form "status=2"\
    --form "address=zqxnsmhgunttgtxqx"\
    --form "address_ar=dloplysuzdxaxexpmdg"\
    --form "email=zackery92@example.com"\
    --form "conditions=atque"\
    --form "conditions_ar=delectus"\
    --form "background_image=@/tmp/phpGnFiMB" \
    --form "logo=@/tmp/phpJkndOb" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'anpzbwljpsyzevrwdxcpshgjw');
body.append('name_ar', 'qiig');
body.append('abbreviation', 'wtldbeguceodm');
body.append('status', '2');
body.append('address', 'zqxnsmhgunttgtxqx');
body.append('address_ar', 'dloplysuzdxaxexpmdg');
body.append('email', 'zackery92@example.com');
body.append('conditions', 'atque');
body.append('conditions_ar', 'delectus');
body.append('background_image', document.querySelector('input[name="background_image"]').files[0]);
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5f6-b90b-4ea3-850f-3facb05731d8",
        "restaurant": {
            "id": "9fdec5f6-90bd-43eb-ab7f-8ac92afdd171"
        },
        "name": "branch name",
        "name_ar": "branch name",
        "abbreviation": "BN",
        "background_image": "http://localhost/storage/restaurants/9fdec5f6-90bd-43eb-ab7f-8ac92afdd171/D5F9Bpsk7GpjcPEsihGAhHBJkjgwQrtfp4SPqhxd.jpg",
        "logo": "http://localhost/storage/restaurants/9fdec5f6-90bd-43eb-ab7f-8ac92afdd171/OyCVNUUcDmlKtlTJQgwpuy3pqvUJgjd5ASDUHcE5.jpg",
        "phone": "+914454578745",
        "email": null,
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "address": "this branch address",
        "address_ar": "this branch address",
        "slug": "branch-name"
    },
    "message": "The Branch added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

Body Parameters

name   string   

Must not be greater than 255 characters. Example: anpzbwljpsyzevrwdxcpshgjw

name_ar   string   

Must not be greater than 255 characters. Example: qiig

abbreviation   string   

Must not be greater than 255 characters. Example: wtldbeguceodm

status   integer  optional  

Example: 2

Must be one of:
  • 1
  • 2
  • 3
background_image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpGnFiMB

logo   file   

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpJkndOb

address   string   

Must not be greater than 255 characters. Example: zqxnsmhgunttgtxqx

address_ar   string   

Must not be greater than 255 characters. Example: dloplysuzdxaxexpmdg

phone   string  optional  
email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: zackery92@example.com

conditions   string  optional  

Example: atque

conditions_ar   string  optional  

Example: delectus

Show Specific Branch

requires authentication

This endpoint lets you show specific branch

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9f6c0059-5fad-4b04-9219-2aa1aff5378b",
        "restaurant": {
            "id": "9fdec5f4-4179-4227-886b-888da39f0f6a"
        },
        "name": "Waino Larson",
        "name_ar": "Neal Koepp",
        "abbreviation": "zgv",
        "background_image": "http://localhost/storage/restaurants/bg.png",
        "logo": "http://localhost/storage/restaurants/branch.png",
        "phone": "+19185800559",
        "email": null,
        "status": {
            "key": 2,
            "value": "INACTIVE"
        },
        "address": "963 Abbott Way Apt. 919\nFloton, CT 53486",
        "address_ar": "499 Roberts Mews\nNorth Kyra, WI 21877-3322",
        "slug": "eos-distinctio-aut-quaerat-aliquid-quam"
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Update Specific Branch

requires authentication

This endpoint lets you update specific branch

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=atzbmithgcowpxivyzkry"\
    --form "name_ar=sxfmnojdooevltvajpalb"\
    --form "abbreviation=txg"\
    --form "status=2"\
    --form "address=khe"\
    --form "address_ar=wrkearbkxsnvw"\
    --form "email=alexzander.rodriguez@example.net"\
    --form "background_image=@/tmp/phpjkOEoe" \
    --form "logo=@/tmp/phpFMIECi" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'atzbmithgcowpxivyzkry');
body.append('name_ar', 'sxfmnojdooevltvajpalb');
body.append('abbreviation', 'txg');
body.append('status', '2');
body.append('address', 'khe');
body.append('address_ar', 'wrkearbkxsnvw');
body.append('email', 'alexzander.rodriguez@example.net');
body.append('background_image', document.querySelector('input[name="background_image"]').files[0]);
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "93338368-7d5a-484a-ac2e-6a8cd199cbfc",
        "restaurant": {
            "id": "9fdec5fa-3eb3-4cff-b963-5cef69919f31"
        },
        "name": "branch name",
        "name_ar": "branch name",
        "abbreviation": "this branch abbreviation",
        "background_image": "http://localhost/storage/restaurants/bg.png",
        "logo": "http://localhost/storage/restaurants/branch.png",
        "phone": "+914454578745",
        "email": null,
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "address": "this branch address",
        "address_ar": "this branch address",
        "slug": "branch-name"
    },
    "message": "The Branch updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{id}

PATCH api/v1/restaurants/{restaurant_id}/branches/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: atzbmithgcowpxivyzkry

name_ar   string  optional  

Must not be greater than 255 characters. Example: sxfmnojdooevltvajpalb

abbreviation   string  optional  

Must not be greater than 255 characters. Example: txg

status   integer  optional  

Example: 2

Must be one of:
  • 1
  • 2
  • 3
background_image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpjkOEoe

logo   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpFMIECi

address   string  optional  

Must not be greater than 255 characters. Example: khe

address_ar   string  optional  

Must not be greater than 255 characters. Example: wrkearbkxsnvw

phone   string  optional  
email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: alexzander.rodriguez@example.net

Delete Specific Branch

requires authentication

This endpoint lets you delete specific branch

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Branch deleted successfully",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Get Settings for Specific Branch

requires authentication

This endpoint lets you get Settings for Specific Branch

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "payment_gateway": {
            "payment_method": 7
        },
        "payfort_config": {
            "base_url": "https://sbpaymentservices.payfort.com/FortAPI/paymentApi",
            "is_sandbox": false,
            "language": "en",
            "merchant_identifier": "rVPUwwns",
            "access_code": "svcoBTlttafdlj7BD1JD",
            "sha_type": "sha256",
            "sha_request_phrase": "261O4bctyh/adasdadwda",
            "sha_response_phrase": "03T6i7tdsfaaw555464",
            "currency": "AED",
            "return_url": "http://localhost:8080",
            "return_url_tokenization": "/test",
            "exception_return_type": "JSON"
        },
        "stripe_config": null,
        "checkout_config": null,
        "qr_settings": {
            "logo_path": "logo.png",
            "dots_color": "#5c8986",
            "second_dots_color": "#89865c",
            "isGradient": "true",
            "isRadialGradient": "true",
            "dots_shape": "square",
            "border_shape": "square",
            "border_color": "#5c8986",
            "qr_bg_color": "#fff"
        },
        "menu_qr_settings": {
            "logo_path": "logo.png",
            "dots_color": "#5c8986",
            "second_dots_color": "#89865c",
            "isGradient": "true",
            "isRadialGradient": "true",
            "dots_shape": "square",
            "border_shape": "square",
            "border_color": "#5c8986",
            "qr_bg_color": "#fff"
        },
        "location": null,
        "google_review": {
            "review_type": 3,
            "review_link": "https://maps.app.goo.gl/example",
            "stars_threshold": 4
        },
        "notifications": {
            "deletion_time": "01:00",
            "deletion_is_active": true
        },
        "reservations": null,
        "fees": [
            {
                "type": 1,
                "title": "service fee",
                "amount": 0
            }
        ]
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/settings

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Update Settings for Specific Branch

requires authentication

This endpoint lets you update settings for Specific Branch

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payment_gateway\": {
        \"payment_method\": 6
    },
    \"payfort_config\": {
        \"base_url\": \"http:\\/\\/aufderhar.com\\/et-veritatis-tempore-officiis\",
        \"is_sandbox\": true,
        \"language\": \"facere\",
        \"merchant_identifier\": \"in\",
        \"access_code\": \"doloremque\",
        \"sha_type\": \"molestiae\",
        \"sha_request_phrase\": \"veniam\",
        \"sha_response_phrase\": \"praesentium\",
        \"currency\": \"quia\",
        \"return_url\": \"http:\\/\\/kertzmann.biz\\/facere-voluptas-distinctio-commodi-consequatur-quae-modi-autem-eos.html\",
        \"return_url_tokenization\": \"soluta\",
        \"exception_return_type\": \"eum\",
        \"path\": \"molestias\",
        \"is_active\": true
    },
    \"stripe_config\": {
        \"STRIPE_KEY\": \"possimus\",
        \"STRIPE_SECRET\": \"voluptas\",
        \"is_active\": false
    },
    \"checkout_config\": {
        \"base_url\": \"http:\\/\\/ondricka.com\\/voluptas-est-nobis-tempora-quasi.html\",
        \"sha_type\": \"et\",
        \"public_key\": \"voluptatibus\",
        \"secret_key\": \"veniam\",
        \"webhook_secret\": \"provident\",
        \"processing_channel_id\": \"ut\",
        \"environment\": \"minima\",
        \"is_active\": false
    },
    \"qr_settings\": {
        \"logo\": \"culpa\",
        \"dots_shape\": \"circular\",
        \"isGradient\": false,
        \"isRadialGradient\": true,
        \"border_shape\": \"circular\"
    },
    \"menu_qr_settings\": {
        \"logo\": \"suscipit\",
        \"dots_shape\": \"square\",
        \"isGradient\": false,
        \"isRadialGradient\": false,
        \"border_shape\": \"square\"
    },
    \"google_review\": {
        \"review_link\": \"https:\\/\\/ankunding.com\\/nesciunt-aperiam-ut-dolor-cupiditate-alias-molestiae-earum-qui.html\",
        \"review_type\": 3,
        \"stars_threshold\": 5
    },
    \"notifications\": {
        \"deletion_time\": \"19:28\",
        \"deletion_is_active\": false
    },
    \"reservations\": {
        \"is_active\": false
    },
    \"fees\": [
        {
            \"type\": 1,
            \"title\": \"est\",
            \"amount\": 18
        }
    ]
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "payment_gateway": {
        "payment_method": 6
    },
    "payfort_config": {
        "base_url": "http:\/\/aufderhar.com\/et-veritatis-tempore-officiis",
        "is_sandbox": true,
        "language": "facere",
        "merchant_identifier": "in",
        "access_code": "doloremque",
        "sha_type": "molestiae",
        "sha_request_phrase": "veniam",
        "sha_response_phrase": "praesentium",
        "currency": "quia",
        "return_url": "http:\/\/kertzmann.biz\/facere-voluptas-distinctio-commodi-consequatur-quae-modi-autem-eos.html",
        "return_url_tokenization": "soluta",
        "exception_return_type": "eum",
        "path": "molestias",
        "is_active": true
    },
    "stripe_config": {
        "STRIPE_KEY": "possimus",
        "STRIPE_SECRET": "voluptas",
        "is_active": false
    },
    "checkout_config": {
        "base_url": "http:\/\/ondricka.com\/voluptas-est-nobis-tempora-quasi.html",
        "sha_type": "et",
        "public_key": "voluptatibus",
        "secret_key": "veniam",
        "webhook_secret": "provident",
        "processing_channel_id": "ut",
        "environment": "minima",
        "is_active": false
    },
    "qr_settings": {
        "logo": "culpa",
        "dots_shape": "circular",
        "isGradient": false,
        "isRadialGradient": true,
        "border_shape": "circular"
    },
    "menu_qr_settings": {
        "logo": "suscipit",
        "dots_shape": "square",
        "isGradient": false,
        "isRadialGradient": false,
        "border_shape": "square"
    },
    "google_review": {
        "review_link": "https:\/\/ankunding.com\/nesciunt-aperiam-ut-dolor-cupiditate-alias-molestiae-earum-qui.html",
        "review_type": 3,
        "stars_threshold": 5
    },
    "notifications": {
        "deletion_time": "19:28",
        "deletion_is_active": false
    },
    "reservations": {
        "is_active": false
    },
    "fees": [
        {
            "type": 1,
            "title": "est",
            "amount": 18
        }
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "payment_gateway": {
            "payment_method": 7
        },
        "payfort_config": {
            "base_url": "https://sbpaymentservices.payfort.com/FortAPI/paymentApi",
            "is_sandbox": false,
            "language": "en",
            "merchant_identifier": "rVPUwwns",
            "access_code": "svcoBTlttafdlj7BD1JD",
            "sha_type": "sha256",
            "sha_request_phrase": "261O4bctyh/adasdadwda",
            "sha_response_phrase": "03T6i7tdsfaaw555464",
            "currency": "AED",
            "return_url": "http://localhost:8080",
            "return_url_tokenization": "/test",
            "exception_return_type": "JSON",
            "is_active": true
        },
        "stripe_config": {
            "STRIPE_KEY": "pk_test_51OoOKGHWRnKKFukoQ6Ra2dsfXVQ3YNytT82w23RkxCU96WuqsaJVkoWAVpbVMefrbGh0NhNV4jAoklS8nf839Ijc00kFAi4KFp",
            "STRIPE_SECRET": "sk_test_51OoOKGHWRnKKFukoOKkOeKD4LRQqtswjY6No7NYpd7Pu5Qu4oe43LDiSibonqlscMVROmh1PZHIOtMzen410IGkc00dAdjNwXc",
            "is_active": false
        },
        "checkout_config": {
            "is_active": false
        },
        "qr_settings": {
            "logo": "logo.png",
            "dots_color": "#5c8986",
            "second_dots_color": "#89865c",
            "isGradient": "true",
            "isRadialGradient": false,
            "dots_shape": "circular",
            "border_shape": "circular",
            "border_color": "#5c8986",
            "qr_bg_color": "#fff"
        },
        "menu_qr_settings": {
            "logo": "logo.png",
            "dots_color": "#5c8986",
            "second_dots_color": "#89865c",
            "isGradient": true,
            "isRadialGradient": false,
            "dots_shape": "circular",
            "border_shape": "circular",
            "border_color": "#5c8986",
            "qr_bg_color": "#fff"
        },
        "location": null,
        "google_review": {
            "review_type": 3,
            "review_link": "https://maps.app.goo.gl/new_example",
            "stars_threshold": 5
        },
        "notifications": {
            "deletion_time": "01:00",
            "deletion_is_active": true
        },
        "reservations": {
            "is_active": true
        },
        "fees": [
            {
                "type": 1,
                "title": "municipal_fee",
                "amount": 0.05
            },
            {
                "type": 1,
                "title": "sss",
                "amount": 0.05
            }
        ]
    },
    "message": "The settings for the branch have been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/settings

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

payment_gateway   object  optional  
payment_method   integer  optional  

Example: 6

Must be one of:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
payfort_config   object  optional  
base_url   string  optional  

Must be a valid URL. Example: http://aufderhar.com/et-veritatis-tempore-officiis

is_sandbox   boolean  optional  

Example: true

language   string  optional  

Example: facere

merchant_identifier   string  optional  

Example: in

access_code   string  optional  

Example: doloremque

sha_type   string  optional  

Example: molestiae

sha_request_phrase   string  optional  

Example: veniam

sha_response_phrase   string  optional  

Example: praesentium

currency   string  optional  

Example: quia

return_url   string  optional  

Must be a valid URL. Example: http://kertzmann.biz/facere-voluptas-distinctio-commodi-consequatur-quae-modi-autem-eos.html

return_url_tokenization   string  optional  

Example: soluta

exception_return_type   string  optional  

Example: eum

path   string  optional  

Example: molestias

is_active   boolean  optional  

Example: true

stripe_config   object  optional  
STRIPE_KEY   string  optional  

Example: possimus

STRIPE_SECRET   string  optional  

Example: voluptas

is_active   boolean  optional  

Example: false

checkout_config   object  optional  
base_url   string  optional  

Must be a valid URL. Example: http://ondricka.com/voluptas-est-nobis-tempora-quasi.html

sha_type   string  optional  

Example: et

public_key   string  optional  

Example: voluptatibus

secret_key   string  optional  

Example: veniam

webhook_secret   string  optional  

Example: provident

processing_channel_id   string  optional  

Example: ut

environment   string  optional  

Example: minima

is_active   boolean  optional  

Example: false

qr_settings   object  optional  
logo   string  optional  

Example: culpa

dots_color   string  optional  
dots_shape   string  optional  

Example: circular

Must be one of:
  • circular
  • square
border_color   string  optional  
qr_bg_color   string  optional  
second_dots_color   string  optional  
isGradient   boolean  optional  

Example: false

isRadialGradient   boolean  optional  

Example: true

border_shape   string  optional  

Example: circular

Must be one of:
  • circular
  • square
menu_qr_settings   object  optional  
logo   string  optional  

Example: suscipit

dots_color   string  optional  
dots_shape   string  optional  

Example: square

Must be one of:
  • circular
  • square
border_color   string  optional  
qr_bg_color   string  optional  
second_dots_color   string  optional  
isGradient   boolean  optional  

Example: false

isRadialGradient   boolean  optional  

Example: false

border_shape   string  optional  

Example: square

Must be one of:
  • circular
  • square
google_review   object  optional  
review_link   string  optional  

Must be a valid URL. Example: https://ankunding.com/nesciunt-aperiam-ut-dolor-cupiditate-alias-molestiae-earum-qui.html

review_type   integer  optional  

Example: 3

Must be one of:
  • 1
  • 2
  • 3
stars_threshold   integer  optional  

Must be at least 1. Must not be greater than 5. Example: 5

notifications   object  optional  
deletion_time   string  optional  

Must be a valid date in the format H:i. Example: 19:28

deletion_is_active   boolean  optional  

Example: false

fees   object[]  optional  
type   integer  optional  

Example: 1

Must be one of:
  • 1
  • 2
title   string  optional  

Example: est

amount   number  optional  

Must be at least 0. Example: 18

reservations   object  optional  
is_active   boolean  optional  

Example: false

Store Settings for Specific Branch

requires authentication

This endpoint lets you store settings for Specific Branch

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/add-settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"payfort_config\": {
        \"base_url\": \"http:\\/\\/williamson.com\\/sed-corporis-eius-esse-velit-ullam-culpa-quaerat-voluptatum.html\",
        \"is_sandbox\": false,
        \"language\": \"provident\",
        \"merchant_identifier\": \"reiciendis\",
        \"access_code\": \"est\",
        \"sha_type\": \"quia\",
        \"sha_request_phrase\": \"quo\",
        \"sha_response_phrase\": \"perspiciatis\",
        \"currency\": \"deleniti\",
        \"return_url\": \"http:\\/\\/hodkiewicz.net\\/dolores-sint-numquam-recusandae-magnam\",
        \"return_url_tokenization\": \"qui\",
        \"exception_return_type\": \"minus\",
        \"path\": \"pariatur\",
        \"is_active\": false
    },
    \"stripe_config\": {
        \"STRIPE_KEY\": \"aut\",
        \"STRIPE_SECRET\": \"in\",
        \"is_active\": false
    },
    \"checkout_config\": {
        \"base_url\": \"http:\\/\\/heidenreich.com\\/ipsum-velit-consequatur-aut-quibusdam-temporibus-iusto-tempora.html\",
        \"sha_type\": \"nihil\",
        \"public_key\": \"non\",
        \"secret_key\": \"deleniti\",
        \"webhook_secret\": \"laborum\",
        \"processing_channel_id\": \"ut\",
        \"environment\": \"aut\",
        \"is_active\": false
    },
    \"qr_settings\": {
        \"logo\": \"quibusdam\",
        \"dots_shape\": \"circular\",
        \"isGradient\": false,
        \"isRadialGradient\": true,
        \"border_shape\": \"square\"
    },
    \"menu_qr_settings\": {
        \"logo\": \"pariatur\",
        \"dots_shape\": \"circular\",
        \"isGradient\": false,
        \"isRadialGradient\": false,
        \"border_shape\": \"square\"
    },
    \"location\": {
        \"latitude\": -89,
        \"longitude\": -180
    },
    \"google_review\": {
        \"review_link\": \"http:\\/\\/www.mayer.com\\/optio-voluptas-quasi-id-itaque-et-et-dolorem-ut\",
        \"review_type\": 1,
        \"stars_threshold\": 5
    },
    \"notifications\": {
        \"deletion_time\": \"19:28\",
        \"deletion_is_active\": true
    },
    \"reservations\": {
        \"is_active\": false
    },
    \"fees\": [
        {
            \"type\": 1,
            \"title\": \"aspernatur\",
            \"amount\": 66
        }
    ]
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/add-settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "payfort_config": {
        "base_url": "http:\/\/williamson.com\/sed-corporis-eius-esse-velit-ullam-culpa-quaerat-voluptatum.html",
        "is_sandbox": false,
        "language": "provident",
        "merchant_identifier": "reiciendis",
        "access_code": "est",
        "sha_type": "quia",
        "sha_request_phrase": "quo",
        "sha_response_phrase": "perspiciatis",
        "currency": "deleniti",
        "return_url": "http:\/\/hodkiewicz.net\/dolores-sint-numquam-recusandae-magnam",
        "return_url_tokenization": "qui",
        "exception_return_type": "minus",
        "path": "pariatur",
        "is_active": false
    },
    "stripe_config": {
        "STRIPE_KEY": "aut",
        "STRIPE_SECRET": "in",
        "is_active": false
    },
    "checkout_config": {
        "base_url": "http:\/\/heidenreich.com\/ipsum-velit-consequatur-aut-quibusdam-temporibus-iusto-tempora.html",
        "sha_type": "nihil",
        "public_key": "non",
        "secret_key": "deleniti",
        "webhook_secret": "laborum",
        "processing_channel_id": "ut",
        "environment": "aut",
        "is_active": false
    },
    "qr_settings": {
        "logo": "quibusdam",
        "dots_shape": "circular",
        "isGradient": false,
        "isRadialGradient": true,
        "border_shape": "square"
    },
    "menu_qr_settings": {
        "logo": "pariatur",
        "dots_shape": "circular",
        "isGradient": false,
        "isRadialGradient": false,
        "border_shape": "square"
    },
    "location": {
        "latitude": -89,
        "longitude": -180
    },
    "google_review": {
        "review_link": "http:\/\/www.mayer.com\/optio-voluptas-quasi-id-itaque-et-et-dolorem-ut",
        "review_type": 1,
        "stars_threshold": 5
    },
    "notifications": {
        "deletion_time": "19:28",
        "deletion_is_active": true
    },
    "reservations": {
        "is_active": false
    },
    "fees": [
        {
            "type": 1,
            "title": "aspernatur",
            "amount": 66
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "payment_gateway": {
            "payment_method": 7
        },
        "payfort_config": {
            "base_url": "https://sbpaymentservices.payfort.com/FortAPI/paymentApi",
            "is_sandbox": false,
            "language": "en",
            "merchant_identifier": "rVPUwwns",
            "access_code": "svcoBTlttafdlj7BD1JD",
            "sha_type": "sha256",
            "sha_request_phrase": "261O4bctyh/adasdadwda",
            "sha_response_phrase": "03T6i7tdsfaaw555464",
            "currency": "AED",
            "return_url": "http://localhost:8080",
            "return_url_tokenization": "/test",
            "exception_return_type": "JSON",
            "is_active": true
        },
        "stripe_config": {
            "STRIPE_KEY": "pk_test_51OoOKGHWRnKKFukoQ6Ra2dsfXVQ3YNytT82w23RkxCU96WuqsaJVkoWAVpbVMefrbGh0NhNV4jAoklS8nf839Ijc00kFAi4KFp",
            "STRIPE_SECRET": "sk_test_51OoOKGHWRnKKFukoOKkOeKD4LRQqtswjY6No7NYpd7Pu5Qu4oe43LDiSibonqlscMVROmh1PZHIOtMzen410IGkc00dAdjNwXc",
            "is_active": false
        },
        "checkout_config": null,
        "qr_settings": {
            "logo": "logo.png",
            "dots_color": "#5c8986",
            "dots_shape": "square",
            "isGradient": true,
            "qr_bg_color": "#fff",
            "border_color": "#5c8986",
            "border_shape": "square",
            "isRadialGradient": true,
            "second_dots_color": "#89865c"
        },
        "menu_qr_settings": {
            "logo": "logo.png",
            "dots_color": "#5c8986",
            "dots_shape": "square",
            "border_color": "#5c8986",
            "qr_bg_color": "#fff",
            "second_dots_color": "#89865c",
            "isGradient": true,
            "isRadialGradient": true,
            "border_shape": "square"
        },
        "location": null,
        "google_review": {
            "review_link": "https://maps.app.goo.gl/example",
            "review_type": 3,
            "stars_threshold": 4
        },
        "notifications": {
            "deletion_time": "10:15",
            "deletion_is_active": true
        },
        "reservations": {
            "is_active": true
        },
        "fees": [
            {
                "type": 1,
                "title": "service fee",
                "amount": 0
            }
        ]
    },
    "message": "the settings for branch have been added successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/add-settings

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

payfort_config   object  optional  

This field is required when payment_gateway.payment_method is 7.

base_url   string  optional  

This field is required when payfort_config is present. Must be a valid URL. Example: http://williamson.com/sed-corporis-eius-esse-velit-ullam-culpa-quaerat-voluptatum.html

is_sandbox   boolean  optional  

This field is required when payfort_config is present. Example: false

language   string  optional  

This field is required when payfort_config is present. Example: provident

merchant_identifier   string  optional  

This field is required when payfort_config is present. Example: reiciendis

access_code   string  optional  

This field is required when payfort_config is present. Example: est

sha_type   string  optional  

This field is required when payfort_config is present. Example: quia

sha_request_phrase   string  optional  

This field is required when payfort_config is present. Example: quo

sha_response_phrase   string  optional  

This field is required when payfort_config is present. Example: perspiciatis

currency   string  optional  

This field is required when payfort_config is present. Example: deleniti

return_url   string  optional  

This field is required when payfort_config is present. Must be a valid URL. Example: http://hodkiewicz.net/dolores-sint-numquam-recusandae-magnam

return_url_tokenization   string  optional  

This field is required when payfort_config is present. Example: qui

exception_return_type   string  optional  

This field is required when payfort_config is present. Example: minus

path   string  optional  

Example: pariatur

is_active   boolean  optional  

Example: false

stripe_config   object  optional  

This field is required when payment_gateway.payment_method is 8.

STRIPE_KEY   string  optional  

This field is required when stripe_config is present. Example: aut

STRIPE_SECRET   string  optional  

This field is required when stripe_config is present. Example: in

is_active   boolean  optional  

Example: false

checkout_config   object  optional  
base_url   string  optional  

This field is required when checkout_config is present. Must be a valid URL. Example: http://heidenreich.com/ipsum-velit-consequatur-aut-quibusdam-temporibus-iusto-tempora.html

sha_type   string  optional  

This field is required when checkout_config is present. Example: nihil

public_key   string  optional  

This field is required when checkout_config is present. Example: non

secret_key   string  optional  

This field is required when checkout_config is present. Example: deleniti

webhook_secret   string  optional  

This field is required when checkout_config is present. Example: laborum

processing_channel_id   string  optional  

This field is required when checkout_config is present. Example: ut

environment   string  optional  

This field is required when checkout_config is present. Example: aut

is_active   boolean  optional  

Example: false

qr_settings   object  optional  
logo   string  optional  

Example: quibusdam

dots_color   string  optional  
dots_shape   string  optional  

Example: circular

Must be one of:
  • circular
  • square
border_color   string  optional  
qr_bg_color   string  optional  
second_dots_color   string  optional  
isGradient   boolean  optional  

Example: false

isRadialGradient   boolean  optional  

Example: true

border_shape   string  optional  

Example: square

Must be one of:
  • circular
  • square
menu_qr_settings   object  optional  
logo   string  optional  

Example: pariatur

dots_color   string  optional  
dots_shape   string  optional  

Example: circular

Must be one of:
  • circular
  • square
border_color   string  optional  
qr_bg_color   string  optional  
second_dots_color   string  optional  
isGradient   boolean  optional  

Example: false

isRadialGradient   boolean  optional  

Example: false

border_shape   string  optional  

Example: square

Must be one of:
  • circular
  • square
location   object  optional  
latitude   number  optional  

This field is required when location is present. Must be between -90 and 90. Example: -89

longitude   number  optional  

This field is required when location is present. Must be between -180 and 180. Example: -180

google_review   object  optional  
review_link   string  optional  

Must be a valid URL. Example: http://www.mayer.com/optio-voluptas-quasi-id-itaque-et-et-dolorem-ut

review_type   integer  optional  

Example: 1

Must be one of:
  • 1
  • 2
  • 3
stars_threshold   integer  optional  

Must be at least 1. Must not be greater than 5. Example: 5

notifications   object  optional  
deletion_time   string  optional  

Must be a valid date in the format H:i. Example: 19:28

deletion_is_active   boolean  optional  

Example: true

reservations   object  optional  
is_active   boolean  optional  

Example: false

fees   object[]  optional  
type   integer   

Example: 1

Must be one of:
  • 1
  • 2
title   string   

Example: aspernatur

amount   number   

Must be at least 0. Example: 66

Get Terms And Conditions for Specific Branch

requires authentication

This endpoint lets you get terms and conditions for Specific Branch

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/terms-and-conditions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/terms-and-conditions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "conditions": "<h5>Terms And Conditions<h5>",
        "conditions_ar": "<h5>الشروط والأحكام <h5>"
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/terms-and-conditions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Update Terms And Conditions For Specific Branch

requires authentication

This endpoint lets you update terms and conditions for specific branch

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/terms-and-conditions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"conditions\": \"saepe\",
    \"conditions_ar\": \"earum\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/terms-and-conditions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "conditions": "saepe",
    "conditions_ar": "earum"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "conditions": "<h5>Terms And Conditions<h5>",
        "conditions_ar": "<h5>الشروط والأحكام <h5>"
    },
    "message": "success",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/terms-and-conditions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

conditions   string  optional  

Example: saepe

conditions_ar   string  optional  

Example: earum

Show all orders with reviews

requires authentication

This endpoint lets you show all reviews for orders in specific branch for restaurant

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders-with-reviews?page=6&per_page=10" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders-with-reviews"
);

const params = {
    "page": "6",
    "per_page": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5ed-4456-46da-a6aa-cdb0d906b0cd",
            "table": {
                "id": "9fdec5ea-ad18-4ef6-af13-94d53a466feb",
                "number": "8",
                "status": {
                    "key": 1,
                    "value": "AVAILABLE"
                }
            },
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 3,
                "value": "ACCEPTED"
            },
            "reviews": [
                {
                    "id": "9fdec5ed-4817-42fe-be91-80b8422c7ebe",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 4,
                    "comment": "Non qui sint tenetur enim."
                },
                {
                    "id": "9fdec5ed-4d0f-4944-b55f-654db53518b7",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 4,
                    "comment": "Perspiciatis beatae sit eos reiciendis itaque commodi velit."
                },
                {
                    "id": "9fdec5ed-5289-41ee-ae54-79b6791b4bb5",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 1,
                    "comment": "Est non eius veritatis culpa eveniet adipisci hic."
                }
            ]
        },
        {
            "id": "9fdec5ed-015d-4080-9817-df276f874ec4",
            "table": {
                "id": "9fdec5ea-abd7-4118-aaae-cff2049a1e06",
                "number": "2",
                "status": {
                    "key": 3,
                    "value": "LOCK"
                }
            },
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 5,
                "value": "READY"
            },
            "reviews": [
                {
                    "id": "9fdec5ed-069a-435e-82ae-9597d1ef81ec",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 5,
                    "comment": "Architecto rerum cumque ut omnis sunt."
                },
                {
                    "id": "9fdec5ed-0b77-4ae3-9d97-ef799b1016e3",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 5,
                    "comment": "Odio consequatur dolor ratione."
                },
                {
                    "id": "9fdec5ed-1009-4846-afaf-cc0fc7b4983e",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 1,
                    "comment": "Consequuntur et voluptatem voluptas velit."
                }
            ]
        },
        {
            "id": "9fdec5ec-b5af-43d6-bf9e-20e5a9d4aa29",
            "table": {
                "id": "9fdec5ea-aa8c-4617-a585-27a0fc1aee12",
                "number": "5",
                "status": {
                    "key": 2,
                    "value": "OCCUPIED"
                }
            },
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 8,
                "value": "CANCELLED"
            },
            "reviews": [
                {
                    "id": "9fdec5ec-bbe3-42f1-9d27-1b04c8dfdcfc",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 4,
                    "comment": "Esse excepturi et est voluptas ut."
                },
                {
                    "id": "9fdec5ec-c1b1-48ca-ba4d-76708d1c1045",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 2,
                    "comment": "Animi quia neque aut consequatur quasi."
                },
                {
                    "id": "9fdec5ec-c742-4d5e-9ce1-cf24fc0f8a05",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 1,
                    "comment": "Labore pariatur perspiciatis magnam eum aut."
                }
            ]
        },
        {
            "id": "9fdec5ec-6583-4baa-be08-2adec03b7e18",
            "table": {
                "id": "9fdec5ea-a924-4cf8-a48f-91a2e03d89f7",
                "number": "2",
                "status": {
                    "key": 1,
                    "value": "AVAILABLE"
                }
            },
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 3,
                "value": "ACCEPTED"
            },
            "reviews": [
                {
                    "id": "9fdec5ec-6f47-4463-8e40-210e5eab7204",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 2,
                    "comment": "Deserunt quia at repellendus inventore aspernatur consequuntur voluptates."
                },
                {
                    "id": "9fdec5ec-79bc-46e1-9dcf-b61a054c8731",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 5,
                    "comment": "Sapiente alias quo recusandae id est."
                },
                {
                    "id": "9fdec5ec-82f6-4df7-b147-5c17e0e9ec5e",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 1,
                    "comment": "Ut facilis temporibus nihil consequatur et non."
                }
            ]
        },
        {
            "id": "9fdec5ec-2b32-42f7-b7a8-a435e65f07e2",
            "table": {
                "id": "9fdec5ea-a7ec-432e-8f48-749b8a9fd5a7",
                "number": "6",
                "status": {
                    "key": 1,
                    "value": "AVAILABLE"
                }
            },
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 4,
                "value": "PREPARING"
            },
            "reviews": [
                {
                    "id": "9fdec5ec-2fc5-46bc-9632-90fed551a42c",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 3,
                    "comment": "Et nostrum possimus molestiae alias."
                },
                {
                    "id": "9fdec5ec-340c-4365-96d9-694830ac926e",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 1,
                    "comment": "Hic dicta odit suscipit quam culpa doloremque et."
                },
                {
                    "id": "9fdec5ec-37ad-478c-8406-e24281d30b59",
                    "customer": "9fdec5e9-6a23-4f8a-8310-148447a08022",
                    "rating": 2,
                    "comment": "Repudiandae aut non cupiditate."
                }
            ]
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders-with-reviews

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 6

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 10

Show Panel Details

requires authentication

This endpoint lets you show all show panel details for specific restaurant

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/panel" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/panel"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5f3-ba62-48cd-a3d5-cd03214b2734",
            "number": "9",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "updated_at": "2025-09-13T19:25:26.000000Z",
            "order": {
                "id": "9fdec5f4-9222-469a-8dbc-121c661c4633",
                "total_amount": 23423,
                "final_amount": 5797,
                "currency": {
                    "key": 3,
                    "value": "AED"
                },
                "status": {
                    "key": 2,
                    "value": "PENDING"
                },
                "payments": null,
                "paid_amount": 0,
                "created_at": "2025-09-13T19:25:26.000000Z",
                "updated_at": "2025-09-13T19:25:26.000000Z"
            }
        },
        {
            "id": "9fdec5f4-44df-4f60-b878-d3835e24f7e9",
            "number": "5",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "updated_at": "2025-09-13T19:25:26.000000Z",
            "order": null
        },
        {
            "id": "9fdec5f4-45fe-4ac6-ae3c-82451d06a862",
            "number": "8",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "updated_at": "2025-09-13T19:25:26.000000Z",
            "order": null
        },
        {
            "id": "9fdec5f4-4703-4729-a348-c474f58afd5a",
            "number": "4",
            "status": {
                "key": 3,
                "value": "LOCK"
            },
            "updated_at": "2025-09-13T19:25:26.000000Z",
            "order": null
        },
        {
            "id": "9fdec5f4-47f6-48dd-ac0f-cc3032b9ae77",
            "number": "9",
            "status": {
                "key": 4,
                "value": "RESERVED"
            },
            "updated_at": "2025-09-13T19:25:26.000000Z",
            "order": null
        },
        {
            "id": "9fdec5f4-48f4-4a45-af3d-0cadc89baacc",
            "number": "10",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "updated_at": "2025-09-13T19:25:26.000000Z",
            "order": null
        },
        {
            "id": "9fdec5f4-5ff4-4763-b8ec-1151ed611d1c",
            "number": "4",
            "status": {
                "key": 4,
                "value": "RESERVED"
            },
            "updated_at": "2025-09-13T19:25:26.000000Z",
            "order": {
                "id": "9fdec5f4-ca6c-4351-85fb-4d794fabe4f1",
                "total_amount": 3014,
                "final_amount": 75803,
                "currency": {
                    "key": 3,
                    "value": "AED"
                },
                "status": {
                    "key": 2,
                    "value": "PENDING"
                },
                "payments": null,
                "paid_amount": 0,
                "created_at": "2025-09-13T19:25:27.000000Z",
                "updated_at": "2025-09-13T19:25:27.000000Z"
            }
        }
    ],
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/panel

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Staff

APIs for Staff Management

Retrieve all staff members for a specific restaurant.

requires authentication

This endpoint allows you to fetch a list of all staff members associated with a particular restaurant.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff?page=8&per_page=9&filter%5Bid%5D=aperiam&filter%5Bbranch_id%5D=sit&filter%5Buser_id%5D=laboriosam&filter%5Baccess_level%5D=autem&sort=quia&filter%5Bsearch%5D=et" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff"
);

const params = {
    "page": "8",
    "per_page": "9",
    "filter[id]": "aperiam",
    "filter[branch_id]": "sit",
    "filter[user_id]": "laboriosam",
    "filter[access_level]": "autem",
    "sort": "quia",
    "filter[search]": "et",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "8521f7bc-65cf-43c7-ac1f-884aeb5cca43",
            "branch": {
                "id": "58c7bc59-03bb-4395-8568-74b8231cebeb",
                "name": "Prof. Broderick Bailey DVM"
            },
            "restaurant": {
                "id": "9fdec63b-1a83-46f5-acaf-eb2b4772bfd5",
                "name": "Howell Group"
            },
            "user": {
                "id": "9fdec63b-884b-45b6-8f88-195a234220a6",
                "name": "Neoma Kuhlman",
                "first_name": "Neoma",
                "last_name": "Kuhlman",
                "password": "$2y$04$zkLmrq50dDEVb8BvMDmFW..0iZDmynlI8nQjqkgHpJCHIm8YN/lOm",
                "phone": "+1 (479) 892-8781",
                "blocked": false,
                "is_active": false
            },
            "role": {
                "id": "9fdec63b-5236-4894-ba20-4a2b21e4652d",
                "name": "BRANCH_WAITER",
                "description": "Restaurant BRANCH_WAITER - Role with branch-related privileges."
            },
            "created_at": "2025-09-13T19:26:14.000000Z"
        },
        {
            "id": "7e7bdf33-2eff-43ee-bfc6-6bb169bd3016",
            "branch": {
                "id": "58c7bc59-03bb-4395-8568-74b8231cebeb",
                "name": "Prof. Broderick Bailey DVM"
            },
            "restaurant": {
                "id": "9fdec63b-1a83-46f5-acaf-eb2b4772bfd5",
                "name": "Howell Group"
            },
            "user": {
                "id": "9fdec63b-8693-401f-865a-0a2912ee76e7",
                "name": "Stephany Boehm",
                "first_name": "Stephany",
                "last_name": "Boehm",
                "password": "$2y$04$1C9LfRBb7zaNxpgQRnsVJeWnj0qJjQLEjsbRs/PTp.cjfgsw1UyQG",
                "phone": "+1-762-570-8810",
                "blocked": false,
                "is_active": false
            },
            "role": {
                "id": "9fdec63b-5236-4894-ba20-4a2b21e4652d",
                "name": "BRANCH_WAITER",
                "description": "Restaurant BRANCH_WAITER - Role with branch-related privileges."
            },
            "created_at": "2025-09-13T19:26:14.000000Z"
        },
        {
            "id": "7047a0c4-41eb-4b49-bbf1-dd22ebe515ae",
            "branch": {
                "id": "58c7bc59-03bb-4395-8568-74b8231cebeb",
                "name": "Prof. Broderick Bailey DVM"
            },
            "restaurant": {
                "id": "9fdec63b-1a83-46f5-acaf-eb2b4772bfd5",
                "name": "Howell Group"
            },
            "user": {
                "id": "9fdec63b-7ff6-4fd0-82a2-1074b871b752",
                "name": "Elouise Boehm",
                "first_name": "Elouise",
                "last_name": "Boehm",
                "password": "$2y$04$.awXMf4X9P6Q4WCxKzUELOJOEnnD3Q8QxKd22NQq3FnQCbRkNlOVm",
                "phone": "+1-445-631-1475",
                "blocked": false,
                "is_active": false
            },
            "role": {
                "id": "9fdec63b-5236-4894-ba20-4a2b21e4652d",
                "name": "BRANCH_WAITER",
                "description": "Restaurant BRANCH_WAITER - Role with branch-related privileges."
            },
            "created_at": "2025-09-13T19:26:13.000000Z"
        },
        {
            "id": "6dec2557-db5e-4fea-b68e-b9afbfd7188a",
            "branch": {
                "id": "58c7bc59-03bb-4395-8568-74b8231cebeb",
                "name": "Prof. Broderick Bailey DVM"
            },
            "restaurant": {
                "id": "9fdec63b-1a83-46f5-acaf-eb2b4772bfd5",
                "name": "Howell Group"
            },
            "user": {
                "id": "9fdec63b-8132-4db7-8e7e-f69b2d679134",
                "name": "Filiberto Abshire",
                "first_name": "Filiberto",
                "last_name": "Abshire",
                "password": "$2y$04$GOPdnvyacsR3XmDBFcvQq.5sWFQfuIk8Ox9uySzin3LgUMUyE4qAC",
                "phone": "+1-956-219-4471",
                "blocked": false,
                "is_active": false
            },
            "role": {
                "id": "9fdec63b-5236-4894-ba20-4a2b21e4652d",
                "name": "BRANCH_WAITER",
                "description": "Restaurant BRANCH_WAITER - Role with branch-related privileges."
            },
            "created_at": "2025-09-13T19:26:13.000000Z"
        },
        {
            "id": "3fd8d1bc-5455-4f03-82cd-841b5ea7334d",
            "branch": {
                "id": "58c7bc59-03bb-4395-8568-74b8231cebeb",
                "name": "Prof. Broderick Bailey DVM"
            },
            "restaurant": {
                "id": "9fdec63b-1a83-46f5-acaf-eb2b4772bfd5",
                "name": "Howell Group"
            },
            "user": {
                "id": "9fdec63b-8535-48ae-99e1-611132a73ecb",
                "name": "Mose Watsica",
                "first_name": "Mose",
                "last_name": "Watsica",
                "password": "$2y$04$0.HDlshxkjB3MO2vVaHcSOECik2M1e8uD2Dln9n4H/VmMqfmNSDdG",
                "phone": "+1.937.554.5518",
                "blocked": false,
                "is_active": false
            },
            "role": {
                "id": "9fdec63b-5236-4894-ba20-4a2b21e4652d",
                "name": "BRANCH_WAITER",
                "description": "Restaurant BRANCH_WAITER - Role with branch-related privileges."
            },
            "created_at": "2025-09-13T19:26:13.000000Z"
        }
    ],
    "meta": {
        "pagination": {
            "total": 16,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/staff

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 8

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 9

filter[id]   string  optional  

Field to filter items by id. Example: aperiam

filter[branch_id]   string  optional  

Field to filter items by branch_id. Example: sit

filter[user_id]   string  optional  

Field to filter items by user_id. Example: laboriosam

filter[access_level]   string  optional  

Field to filter items by access_level,created_at,updated_at. Example: autem

sort   string  optional  

Field to sort items by access_level. Example: quia

filter[search]   string  optional  

Field to perform a custom search. Example: et

Add a member to the staff of a specific branch within a restaurant.

requires authentication

This endpoint allows you to add a new member to the staff of a specific branch within a restaurant.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"voluptas\",
    \"first_name\": \"omdkeokcwlyexkfkn\",
    \"last_name\": \"lpljwovj\",
    \"password\": \"h20Z2_@x<0^JcW0zR?\",
    \"role_id\": \"repudiandae\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone": "voluptas",
    "first_name": "omdkeokcwlyexkfkn",
    "last_name": "lpljwovj",
    "password": "h20Z2_@x<0^JcW0zR?",
    "role_id": "repudiandae"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec640-e09b-40b0-bc02-c94fa6d795b4",
        "branch": {
            "id": "e5b43ff6-5cb9-4345-876f-41c1e5d99b99",
            "name": "Prof. Trevion Sporer"
        },
        "restaurant": {
            "id": "9fdec640-58d3-42ec-8159-8da88d92654f",
            "name": "Klocko LLC"
        },
        "user": {
            "id": "9fdec640-dd5e-47b8-afce-fd6384ff2a2b",
            "name": "Razan khoulani",
            "first_name": "Razan",
            "last_name": "khoulani",
            "password": "$2y$04$OGXXalMiB1vvvmD3QEBMQuz99.VpaSau.dKUVVafgCSn48Pzf1isu",
            "phone": "+971585244756",
            "blocked": false,
            "is_active": false
        },
        "role": {
            "id": "9fdec640-a46b-4caf-a3c7-6376f96c9e8f",
            "name": "BRANCH_WAITER",
            "description": "Some description"
        },
        "created_at": "2025-09-13T19:26:16.000000Z"
    },
    "message": "The staff member has been added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/staff

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

phone   string   

Example: voluptas

first_name   string   

Must not be greater than 255 characters. Example: omdkeokcwlyexkfkn

last_name   string   

Must not be greater than 255 characters. Example: lpljwovj

password   string   

Must be at least 6 characters. Example: h20Z2_@x<0^JcW0zR?

role_id   string   

The id of an existing record in the roles table. Example: repudiandae

Show a specific member of the staff in a specific branch of a restaurant.

requires authentication

This endpoint allows you to retrieve information about a specific member of the staff in a particular branch of a restaurant.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "d21855a7-0f3e-4088-b831-ff5bc82e75d3",
        "branch": {
            "id": "8072eccf-2bb6-4cb8-9049-f548ef57c316",
            "name": "Devin Grimes PhD"
        },
        "restaurant": {
            "id": "9fdec63c-d76a-410f-9789-c1dd07dbb6d4",
            "name": "White-Osinski"
        },
        "user": {
            "id": "9fdec63d-1ada-4bd4-92a4-c11e716a0677",
            "name": "Clara Graham",
            "first_name": "Clara",
            "last_name": "Graham",
            "password": "$2y$04$aXko413zIBYy4Xmf3psiyu2N8MtWqPMPHNhiNSU9iZjbOHMcAJhvO",
            "phone": "+1 (351) 739-5745",
            "blocked": false,
            "is_active": false
        },
        "role": {
            "id": "9fdec63d-17be-4271-b721-70c64af2324f",
            "name": "BRANCH_WAITER",
            "description": "Restaurant BRANCH_WAITER - Role with branch-related privileges."
        },
        "created_at": "2025-09-13T19:26:14.000000Z"
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/staff/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the staff. Example: 9fdec6fe-d7df-4f01-8d91-da38273dc426

Update a member in the staff of a specific branch within a restaurant.

requires authentication

This endpoint allows you to update a member in the staff of a specific branch within a restaurant.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"dgneieiqrscrfnlwga\",
    \"last_name\": \"fmoatv\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "dgneieiqrscrfnlwga",
    "last_name": "fmoatv"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "e31b2b79-70a2-4433-be33-0f707be957bb",
        "branch": {
            "id": "82a5f90e-225b-4370-99dd-460b7f8d68b6",
            "name": "Agustin Wintheiser IV"
        },
        "restaurant": {
            "id": "9fdec644-be23-4a3c-a1c5-4866ddaab205",
            "name": "Reinger Group"
        },
        "user": {
            "id": "9fdec644-f871-498e-a057-de4df36ffedc",
            "name": "Razan Khoulani",
            "first_name": "Razan",
            "last_name": "Khoulani",
            "password": "$2y$04$YWMkegw1Kez5cgkxrAHwVuN7DIb9Gk9tkhNiusckCOpGuP3/ndhH2",
            "phone": "+971582222222",
            "blocked": false,
            "is_active": false
        },
        "role": {
            "id": "9fdec644-fefd-45fb-8089-0017e90e05a5",
            "name": "BRANCH_ADMIN",
            "description": "Restaurant ADMIN - Role with branch-related privileges."
        },
        "created_at": "2025-09-13T19:26:19.000000Z"
    },
    "message": "The staff member has been updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/staff/{id}

PATCH api/v1/restaurants/{restaurant_id}/branches/{branch_id}/staff/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the staff. Example: 9fdec6fe-d7df-4f01-8d91-da38273dc426

Body Parameters

branch_id   string  optional  

The id of an existing record in the branches table.

phone   string  optional  
first_name   string  optional  

Must not be greater than 255 characters. Example: dgneieiqrscrfnlwga

last_name   string  optional  

Must not be greater than 255 characters. Example: fmoatv

role_id   string  optional  

The id of an existing record in the roles table.

Delete a specific member from a staff within a specific restaurant branch.

requires authentication

This endpoint allows you to delete a specific member from a staff within a specific restaurant branch.

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The staff member has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/staff/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the staff. Example: 9fdec6fe-d7df-4f01-8d91-da38273dc426

Block a specific member from a staff within a specific restaurant branch.

requires authentication

This endpoint allows you to block a specific member from a staff within a specific restaurant branch.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426/block" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426/block"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The staff member has been blocked successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/staff/{staff_id}/block

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

staff_id   string   

The ID of the staff. Example: 9fdec6fe-d7df-4f01-8d91-da38273dc426

Un Block a specific member from a staff within a specific restaurant branch.

requires authentication

This endpoint allows you to un block a specific member from a staff within a specific restaurant branch.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426/unblock" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426/unblock"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The staff member has been successfully unblocked.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/staff/{staff_id}/unblock

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

staff_id   string   

The ID of the staff. Example: 9fdec6fe-d7df-4f01-8d91-da38273dc426

Reset password for a specific member from a staff within a specific restaurant branch.

requires authentication

This endpoint allows you to reset password for a specific member from a staff within a specific restaurant branch.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426/reset-password" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"new_password\": \"txjvyxvatwpsfgazsrkrtaakoqizqoliiuqtszocpceaxjofndpcbeveavninqmyc\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/staff/9fdec6fe-d7df-4f01-8d91-da38273dc426/reset-password"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "new_password": "txjvyxvatwpsfgazsrkrtaakoqizqoliiuqtszocpceaxjofndpcbeveavninqmyc"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Password has been changed successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/staff/{staff_id}/reset-password

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

staff_id   string   

The ID of the staff. Example: 9fdec6fe-d7df-4f01-8d91-da38273dc426

Body Parameters

new_password   string   

Must be at least 6 characters. Example: txjvyxvatwpsfgazsrkrtaakoqizqoliiuqtszocpceaxjofndpcbeveavninqmyc

Menus

APIs for Menus Management

Show all Menus

requires authentication

This endpoint lets you show all Menus for specific branch for restaurant

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus?page=8&per_page=17&filter%5Btitle%5D=velit&filter%5Bsearch%5D=rerum&sort=esse" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus"
);

const params = {
    "page": "8",
    "per_page": "17",
    "filter[title]": "velit",
    "filter[search]": "rerum",
    "sort": "esse",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5fe-be94-436f-9e43-b33967efd015",
            "branch_name": "Elizabeth Huels",
            "branch_name_ar": "Deven Lindgren",
            "branch_logo": "http://localhost/storage/restaurants/branch.png",
            "title": "Odit vero molestiae labore.",
            "title_ar": "Quaerat suscipit nisi tempora.",
            "description": "Dolor repellat nesciunt odit dolorem ea cumque. Excepturi ex quae dolore aut ea. Exercitationem commodi et aut ad. Sapiente et molestias omnis et ducimus dicta.",
            "description_ar": "Occaecati ut ab tempore repellendus quis qui. Quo molestiae a quaerat pariatur repellat aut. Numquam sequi earum sed fuga dolore molestiae. Quam expedita molestias soluta tempora optio praesentium.",
            "status": {
                "key": 2,
                "value": "INACTIVE"
            },
            "qrcode": null,
            "link": null,
            "menu_categories": []
        },
        {
            "id": "9fdec5fe-bd19-4955-8b3f-9fcb9a262415",
            "branch_name": "Elizabeth Huels",
            "branch_name_ar": "Deven Lindgren",
            "branch_logo": "http://localhost/storage/restaurants/branch.png",
            "title": "Sunt sit et.",
            "title_ar": "Deleniti dolores est et.",
            "description": "Dolore expedita blanditiis sapiente quo et. Quia consequatur quae qui temporibus aspernatur in. Amet aut accusantium harum eligendi esse. Amet expedita rerum quasi aut ex voluptatem hic.",
            "description_ar": "Laborum doloremque est facilis id quas at. Vel nam quam odio qui iure non. Quas laboriosam quis dicta adipisci vel iusto.",
            "status": {
                "key": 2,
                "value": "INACTIVE"
            },
            "qrcode": null,
            "link": null,
            "menu_categories": []
        },
        {
            "id": "9fdec5fe-bb78-4c3a-8a63-21370726ec3c",
            "branch_name": "Elizabeth Huels",
            "branch_name_ar": "Deven Lindgren",
            "branch_logo": "http://localhost/storage/restaurants/branch.png",
            "title": "Voluptatum eligendi.",
            "title_ar": "Temporibus est accusamus dolores.",
            "description": "Est sit earum delectus autem officiis quia. Voluptates sit voluptates eius exercitationem et qui. Sit a quisquam dolores dolores assumenda.",
            "description_ar": "Voluptas voluptas officia quod consequatur amet omnis id. Ipsam optio eligendi minima provident ipsam rerum dicta.",
            "status": {
                "key": 2,
                "value": "INACTIVE"
            },
            "qrcode": null,
            "link": null,
            "menu_categories": []
        },
        {
            "id": "9fdec5fe-b9ce-4227-af2a-ed9ba0d481c0",
            "branch_name": "Elizabeth Huels",
            "branch_name_ar": "Deven Lindgren",
            "branch_logo": "http://localhost/storage/restaurants/branch.png",
            "title": "Reprehenderit omnis quisquam architecto.",
            "title_ar": "Quaerat qui qui.",
            "description": "Maiores eligendi quo fugiat sed fugit. Sit qui voluptatem vel aliquam rem facilis voluptas excepturi. Harum et quisquam voluptas molestiae atque. Animi et quia quas eaque voluptas neque tempore.",
            "description_ar": "Eum vel eligendi deleniti. Ullam minus explicabo eius sapiente. Officiis nihil voluptate officiis nulla eligendi.",
            "status": {
                "key": 2,
                "value": "INACTIVE"
            },
            "qrcode": null,
            "link": null,
            "menu_categories": [
                {
                    "id": "9fdec5fe-d852-473a-832c-aa600fdbc85f",
                    "title": "Quia aliquid maxime in nam ex incidunt.",
                    "title_ar": "Architecto ad animi vero officia repellat.",
                    "description": "Adipisci harum corrupti necessitatibus. Odio neque tempora ipsa sint veniam voluptate iste nobis. Non temporibus rem necessitatibus similique delectus repudiandae.",
                    "description_ar": "Dolor aspernatur deserunt eaque libero quod eaque. Omnis aliquid rerum sed aut et eos sapiente. Saepe nam nemo voluptatem itaque blanditiis labore.",
                    "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
                    "menu_items": [
                        {
                            "id": "9fdec5ff-0684-4fdf-9a20-817cda7fe2e3",
                            "menu_category": {
                                "menu_category_title": "Quia aliquid maxime in nam ex incidunt.",
                                "menu_category_id": "9fdec5fe-d852-473a-832c-aa600fdbc85f"
                            },
                            "menu_title": "Reprehenderit omnis quisquam architecto.",
                            "title": "Sit ut recusandae facere velit.",
                            "title_ar": "Commodi quo ut voluptatem animi aut necessitatibus.",
                            "type_label": "Medium",
                            "type_label_ar": "وسط",
                            "description": "Ipsum velit quia aut assumenda consequatur voluptatem. Corrupti quo voluptatem est quos aut eveniet cum. Deserunt sequi nostrum qui dolorum iusto est sit. Voluptatem fugiat corporis qui enim qui fuga est.",
                            "description_ar": "Perferendis unde corrupti omnis ea doloremque est. Et corrupti corporis architecto et. Consequatur est aut reiciendis aut eveniet. Reprehenderit quo soluta quo totam facere velit et.",
                            "available_quantity": 92,
                            "image": "http://localhost/storage/restaurants/menu_item.png",
                            "price": 791,
                            "cost": 558,
                            "currency": {
                                "key": 3,
                                "value": "AED"
                            },
                            "status": {
                                "key": 1,
                                "value": "AVAILABLE"
                            },
                            "sub_items": null
                        }
                    ]
                }
            ]
        }
    ],
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 8

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 17

filter[title]   string  optional  

Field to filter items by title. Example: velit

filter[search]   string  optional  

Field to filter items by title. Example: rerum

sort   string  optional  

Field to sort items by title. Example: esse

Add New Menu.

requires authentication

This endpoint allows you to add a new Menu of a specific branch within a restaurant.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"uajbutxizthhkofbh\",
    \"title_ar\": \"ntxmlkfzkviqmnhu\",
    \"description\": \"Consequatur expedita a adipisci voluptatem quas eius.\",
    \"description_ar\": \"qfqsk\",
    \"status\": 2
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "uajbutxizthhkofbh",
    "title_ar": "ntxmlkfzkviqmnhu",
    "description": "Consequatur expedita a adipisci voluptatem quas eius.",
    "description_ar": "qfqsk",
    "status": 2
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec60f-94bd-4057-a2c3-ace5e05edc0c",
        "branch_name": "Dexter Rutherford",
        "branch_name_ar": "Tressie Hand",
        "branch_logo": "http://localhost/storage/restaurants/branch.png",
        "title": "menu title",
        "title_ar": "قائمة الطعام",
        "description": "description",
        "description_ar": "description",
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "qrcode": "http://localhost/storage/restaurants/9fdec60f-3730-40ed-b280-5674e2b3c4dd/944f37ee-78db-49ef-9c77-db4f1b530691/menus/qr_68c5c538e3cfb.svg",
        "link": "http://localhost/a/9fdec60f-96dc-4da0-8d90-6922a2c8382d",
        "menu_categories": []
    },
    "message": "The Menu has been added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

title   string   

Must not be greater than 255 characters. Example: uajbutxizthhkofbh

title_ar   string   

Must not be greater than 255 characters. Example: ntxmlkfzkviqmnhu

description   string  optional  

Must not be greater than 255 characters. Example: Consequatur expedita a adipisci voluptatem quas eius.

description_ar   string  optional  

Must not be greater than 255 characters. Example: qfqsk

settings   object  optional  
status   integer   

Example: 2

Must be one of:
  • 1
  • 2

Show a specific menu.

requires authentication

This endpoint allows you to retrieve information about a menu for a particular branch of a restaurant.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec60d-b9bb-417c-b7a1-bcdeaf689cd9",
        "branch_name": "Jason West DDS",
        "branch_name_ar": "Eriberto Gutmann",
        "branch_logo": "http://localhost/storage/restaurants/branch.png",
        "title": "Voluptatem nihil officiis et qui.",
        "title_ar": "Atque ea dolore.",
        "description": "Sapiente numquam ut a. Est sit deleniti officiis quia dolore. Omnis ut provident ipsa voluptas cumque quo. Eligendi rerum debitis iste adipisci accusamus minus.",
        "description_ar": "Ratione sint et non eos velit cum quo. Consequuntur tenetur quia adipisci natus numquam. Veniam consequatur similique sunt. Eius facilis dicta magni sequi.",
        "status": {
            "key": 2,
            "value": "INACTIVE"
        },
        "qrcode": null,
        "link": null,
        "menu_categories": [
            {
                "id": "9fdec60e-0ded-480d-9d21-1f28aea81505",
                "title": "Menu Category one",
                "title_ar": "Menu Category one",
                "description": "Menu Category one description",
                "description_ar": "Menu Category one description",
                "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
                "menu_items": [
                    {
                        "id": "9fdec60e-1465-4bab-9f7c-074301a0771c",
                        "menu_category": {
                            "menu_category_title": "Menu Category one",
                            "menu_category_id": "9fdec60e-0ded-480d-9d21-1f28aea81505"
                        },
                        "menu_title": "Voluptatem nihil officiis et qui.",
                        "title": "Tabbouleh",
                        "title_ar": "Tabbouleh",
                        "type_label": "Medium",
                        "type_label_ar": "وسط",
                        "description": "Parsley, tomatoes, onions, bulgur, lemon juice and olive oil",
                        "description_ar": null,
                        "available_quantity": 10,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 27,
                        "cost": 28,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        },
                        "sub_items": null
                    }
                ]
            },
            {
                "id": "9fdec60e-0efe-429a-b532-e4615532bad9",
                "title": "Menu Category one",
                "title_ar": "Menu Category one",
                "description": "Menu Category one description",
                "description_ar": "Menu Category one description",
                "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
                "menu_items": [
                    {
                        "id": "9fdec60e-15ff-42f7-a61e-e8d37e62f1dc",
                        "menu_category": {
                            "menu_category_title": "Menu Category one",
                            "menu_category_id": "9fdec60e-0efe-429a-b532-e4615532bad9"
                        },
                        "menu_title": "Voluptatem nihil officiis et qui.",
                        "title": "Tabbouleh",
                        "title_ar": "Tabbouleh",
                        "type_label": "Medium",
                        "type_label_ar": "وسط",
                        "description": "Parsley, tomatoes, onions, bulgur, lemon juice and olive oil",
                        "description_ar": null,
                        "available_quantity": 10,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 27,
                        "cost": 28,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        },
                        "sub_items": null
                    }
                ]
            },
            {
                "id": "9fdec60e-0ff8-43e1-a3e9-68ece7432429",
                "title": "Menu Category one",
                "title_ar": "Menu Category one",
                "description": "Menu Category one description",
                "description_ar": "Menu Category one description",
                "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
                "menu_items": [
                    {
                        "id": "9fdec60e-17c3-4c8b-963f-2b0b9301aabb",
                        "menu_category": {
                            "menu_category_title": "Menu Category one",
                            "menu_category_id": "9fdec60e-0ff8-43e1-a3e9-68ece7432429"
                        },
                        "menu_title": "Voluptatem nihil officiis et qui.",
                        "title": "Tabbouleh",
                        "title_ar": "Tabbouleh",
                        "type_label": "Medium",
                        "type_label_ar": "وسط",
                        "description": "Parsley, tomatoes, onions, bulgur, lemon juice and olive oil",
                        "description_ar": null,
                        "available_quantity": 10,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 27,
                        "cost": 28,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        },
                        "sub_items": null
                    }
                ]
            },
            {
                "id": "9fdec60e-1127-43e8-bd4e-6e9785cf128c",
                "title": "Menu Category one",
                "title_ar": "Menu Category one",
                "description": "Menu Category one description",
                "description_ar": "Menu Category one description",
                "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
                "menu_items": [
                    {
                        "id": "9fdec60e-1966-44ba-9d08-42155561034d",
                        "menu_category": {
                            "menu_category_title": "Menu Category one",
                            "menu_category_id": "9fdec60e-1127-43e8-bd4e-6e9785cf128c"
                        },
                        "menu_title": "Voluptatem nihil officiis et qui.",
                        "title": "Tabbouleh",
                        "title_ar": "Tabbouleh",
                        "type_label": "Medium",
                        "type_label_ar": "وسط",
                        "description": "Parsley, tomatoes, onions, bulgur, lemon juice and olive oil",
                        "description_ar": null,
                        "available_quantity": 10,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 27,
                        "cost": 28,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        },
                        "sub_items": null
                    }
                ]
            },
            {
                "id": "9fdec60e-128d-4029-a70f-fa4786d304d0",
                "title": "Menu Category one",
                "title_ar": "Menu Category one",
                "description": "Menu Category one description",
                "description_ar": "Menu Category one description",
                "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
                "menu_items": [
                    {
                        "id": "9fdec60e-1b04-46d3-b256-16ba7a603d90",
                        "menu_category": {
                            "menu_category_title": "Menu Category one",
                            "menu_category_id": "9fdec60e-128d-4029-a70f-fa4786d304d0"
                        },
                        "menu_title": "Voluptatem nihil officiis et qui.",
                        "title": "Tabbouleh",
                        "title_ar": "Tabbouleh",
                        "type_label": "Medium",
                        "type_label_ar": "وسط",
                        "description": "Parsley, tomatoes, onions, bulgur, lemon juice and olive oil",
                        "description_ar": null,
                        "available_quantity": 10,
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 27,
                        "cost": 28,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        },
                        "sub_items": null
                    }
                ]
            }
        ]
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

Update specific Menu .

requires authentication

This endpoint allows you to update a Menu of a specific branch within a restaurant.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"khczxnfvvdgpne\",
    \"title_ar\": \"ulqtryxrqmepsqjzsyxzbp\",
    \"description\": \"Eius facere nobis voluptas inventore nihil qui earum.\",
    \"description_ar\": \"uaxawcebaadxhznylhbdgmld\",
    \"status\": 2
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "khczxnfvvdgpne",
    "title_ar": "ulqtryxrqmepsqjzsyxzbp",
    "description": "Eius facere nobis voluptas inventore nihil qui earum.",
    "description_ar": "uaxawcebaadxhznylhbdgmld",
    "status": 2
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec613-4676-41b2-ab2a-ffbcad04f100",
        "branch_name": "Neil O'Keefe",
        "branch_name_ar": "Candelario Friesen DDS",
        "branch_logo": "http://localhost/storage/restaurants/branch.png",
        "title": "new menu title",
        "title_ar": "Dolores nihil rerum.",
        "description": "Non voluptatem natus dolores ea accusantium enim. Similique et corrupti voluptas est quibusdam fuga delectus illo. Sed earum non est optio aut dolorum veritatis recusandae. Labore sapiente ipsum aliquam voluptatem porro reprehenderit. Dolor voluptas ab laborum repellendus facilis error ea.",
        "description_ar": "Dolorem accusamus dolor blanditiis sed unde. Eveniet voluptatem asperiores cupiditate ab autem. Dolorum et qui amet iure nostrum aut. Magni id saepe delectus.",
        "status": {
            "key": 2,
            "value": "INACTIVE"
        },
        "qrcode": "http://localhost/storage/restaurants/9fdec612-f8cf-43dc-a092-8426e071bc12/f058fe7a-29d8-4758-b38b-5aabb8ce41f9/menus/qr_68c5c53b269fe.svg",
        "link": "http://localhost/a/0b5e002d-b46f-47ae-9997-99539532b4e4",
        "menu_categories": []
    },
    "message": "The Menu has been updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{id}

PATCH api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

Body Parameters

title   string  optional  

Must not be greater than 255 characters. Example: khczxnfvvdgpne

title_ar   string  optional  

Must not be greater than 255 characters. Example: ulqtryxrqmepsqjzsyxzbp

description   string  optional  

Must not be greater than 255 characters. Example: Eius facere nobis voluptas inventore nihil qui earum.

description_ar   string  optional  

Must not be greater than 255 characters. Example: uaxawcebaadxhznylhbdgmld

settings   object  optional  
status   integer  optional  

Example: 2

Must be one of:
  • 1
  • 2
qrcode   string  optional  

Delete a specific menu.

requires authentication

This endpoint allows you to delete a specific menu within a specific restaurant branch.

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The menu has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

Upload specific file

requires authentication

This endpoint lets restaurants admin upload specific file

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/import-file" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file\": \"maxime\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/import-file"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "file": "maxime"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Menu items imported successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/import-file

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

file   string   

Example: maxime

Generate a QR code for a Menu.

requires authentication

This endpoint allows you to generate a QR code for a specific menu in branch.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/qr" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "dots_shape=japanese"\
    --form "border_shape=rounded-square"\
    --form "isGradient=1"\
    --form "isRadialGradient=1"\
    --form "logo=@/tmp/phpNnGNca" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/qr"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('dots_shape', 'japanese');
body.append('border_shape', 'rounded-square');
body.append('isGradient', '1');
body.append('isRadialGradient', '1');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "qr_code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<svg xmlns=\"http://www.w3.org/2000/svg\" class=\"qr-svg qrcode\" viewBox=\"0 0 65 65\" preserveAspectRatio=\"xMidYMid\">\n<defs>    <radialGradient id=\"gradient1\">\n        <stop offset=\"0%\" stop-color=\"#534e9c\"/>\n        <stop offset=\"100%\" stop-color=\"#7a4e9c\"/>\n    </radialGradient>\n    <style><![CDATA[\n        .dark { fill: url(#gradient1); }\n        .qr-finder-dark { fill: #7a4e9c; }\n        svg.qr-svg { background-color: #fff; }\n    ]]></style>\n</defs>\n<path class=\"qr-darkmodule dark qrcode\" d=\"M12 53 h1v1h-1z\"/>\n<path class=\"qr-data-dark dark qrcode\" d=\"M15 4 h1v1h-1z M16 4 h1v1h-1z M18 4 h1v1h-1z M19 4 h1v1h-1z M20 4 h1v1h-1z M21 4 h1v1h-1z M24 4 h1v1h-1z M27 4 h1v1h-1z M31 4 h1v1h-1z M36 4 h1v1h-1z M37 4 h1v1h-1z M40 4 h1v1h-1z M43 4 h1v1h-1z M46 4 h1v1h-1z M48 4 h1v1h-1z M13 5 h1v1h-1z M15 5 h1v1h-1z M18 5 h1v1h-1z M19 5 h1v1h-1z M20 5 h1v1h-1z M22 5 h1v1h-1z M24 5 h1v1h-1z M25 5 h1v1h-1z M26 5 h1v1h-1z M27 5 h1v1h-1z M28 5 h1v1h-1z M29 5 h1v1h-1z M32 5 h1v1h-1z M38 5 h1v1h-1z M41 5 h1v1h-1z M42 5 h1v1h-1z M43 5 h1v1h-1z M44 5 h1v1h-1z M48 5 h1v1h-1z M15 6 h1v1h-1z M16 6 h1v1h-1z M19 6 h1v1h-1z M21 6 h1v1h-1z M22 6 h1v1h-1z M23 6 h1v1h-1z M26 6 h1v1h-1z M27 6 h1v1h-1z M31 6 h1v1h-1z M32 6 h1v1h-1z M33 6 h1v1h-1z M34 6 h1v1h-1z M35 6 h1v1h-1z M37 6 h1v1h-1z M41 6 h1v1h-1z M44 6 h1v1h-1z M45 6 h1v1h-1z M47 6 h1v1h-1z M48 6 h1v1h-1z M14 7 h1v1h-1z M15 7 h1v1h-1z M16 7 h1v1h-1z M17 7 h1v1h-1z M20 7 h1v1h-1z M21 7 h1v1h-1z M22 7 h1v1h-1z M24 7 h1v1h-1z M26 7 h1v1h-1z M27 7 h1v1h-1z M29 7 h1v1h-1z M30 7 h1v1h-1z M32 7 h1v1h-1z M33 7 h1v1h-1z M35 7 h1v1h-1z M37 7 h1v1h-1z M41 7 h1v1h-1z M42 7 h1v1h-1z M44 7 h1v1h-1z M45 7 h1v1h-1z M46 7 h1v1h-1z M47 7 h1v1h-1z M48 7 h1v1h-1z M49 7 h1v1h-1z M14 8 h1v1h-1z M15 8 h1v1h-1z M19 8 h1v1h-1z M20 8 h1v1h-1z M21 8 h1v1h-1z M26 8 h1v1h-1z M28 8 h1v1h-1z M37 8 h1v1h-1z M40 8 h1v1h-1z M42 8 h1v1h-1z M45 8 h1v1h-1z M46 8 h1v1h-1z M48 8 h1v1h-1z M49 8 h1v1h-1z M13 9 h1v1h-1z M17 9 h1v1h-1z M18 9 h1v1h-1z M21 9 h1v1h-1z M23 9 h1v1h-1z M25 9 h1v1h-1z M26 9 h1v1h-1z M27 9 h1v1h-1z M28 9 h1v1h-1z\nM29 9 h1v1h-1z M35 9 h1v1h-1z M38 9 h1v1h-1z M39 9 h1v1h-1z M41 9 h1v1h-1z M44 9 h1v1h-1z M47 9 h1v1h-1z M48 9 h1v1h-1z M13 11 h1v1h-1z M15 11 h1v1h-1z M16 11 h1v1h-1z M18 11 h1v1h-1z M19 11 h1v1h-1z M23 11 h1v1h-1z M26 11 h1v1h-1z M27 11 h1v1h-1z M28 11 h1v1h-1z M36 11 h1v1h-1z M38 11 h1v1h-1z M41 11 h1v1h-1z M42 11 h1v1h-1z M45 11 h1v1h-1z M46 11 h1v1h-1z M48 11 h1v1h-1z M49 11 h1v1h-1z M50 11 h1v1h-1z M51 11 h1v1h-1z M14 12 h1v1h-1z M16 12 h1v1h-1z M17 12 h1v1h-1z M19 12 h1v1h-1z M23 12 h1v1h-1z M27 12 h1v1h-1z M29 12 h1v1h-1z M35 12 h1v1h-1z M36 12 h1v1h-1z M46 12 h1v1h-1z M47 12 h1v1h-1z M49 12 h1v1h-1z M51 12 h1v1h-1z M52 12 h1v1h-1z M4 13 h1v1h-1z M6 13 h1v1h-1z M9 13 h1v1h-1z M12 13 h1v1h-1z M13 13 h1v1h-1z M14 13 h1v1h-1z M15 13 h1v1h-1z M16 13 h1v1h-1z M20 13 h1v1h-1z M28 13 h1v1h-1z M29 13 h1v1h-1z M30 13 h1v1h-1z M31 13 h1v1h-1z M32 13 h1v1h-1z M35 13 h1v1h-1z M36 13 h1v1h-1z M37 13 h1v1h-1z M38 13 h1v1h-1z M39 13 h1v1h-1z M42 13 h1v1h-1z M45 13 h1v1h-1z M46 13 h1v1h-1z M47 13 h1v1h-1z M48 13 h1v1h-1z M49 13 h1v1h-1z M52 13 h1v1h-1z M53 13 h1v1h-1z M54 13 h1v1h-1z M55 13 h1v1h-1z M58 13 h1v1h-1z M4 14 h1v1h-1z M5 14 h1v1h-1z M6 14 h1v1h-1z M8 14 h1v1h-1z M9 14 h1v1h-1z M11 14 h1v1h-1z M12 14 h1v1h-1z M13 14 h1v1h-1z M18 14 h1v1h-1z M19 14 h1v1h-1z M21 14 h1v1h-1z M24 14 h1v1h-1z M25 14 h1v1h-1z M26 14 h1v1h-1z M29 14 h1v1h-1z M31 14 h1v1h-1z M32 14 h1v1h-1z M33 14 h1v1h-1z M35 14 h1v1h-1z M38 14 h1v1h-1z M39 14 h1v1h-1z M41 14 h1v1h-1z M42 14 h1v1h-1z M44 14 h1v1h-1z M45 14 h1v1h-1z M48 14 h1v1h-1z M49 14 h1v1h-1z M52 14 h1v1h-1z M56 14 h1v1h-1z\nM58 14 h1v1h-1z M59 14 h1v1h-1z M60 14 h1v1h-1z M4 15 h1v1h-1z M5 15 h1v1h-1z M7 15 h1v1h-1z M8 15 h1v1h-1z M18 15 h1v1h-1z M20 15 h1v1h-1z M21 15 h1v1h-1z M22 15 h1v1h-1z M24 15 h1v1h-1z M25 15 h1v1h-1z M27 15 h1v1h-1z M30 15 h1v1h-1z M32 15 h1v1h-1z M33 15 h1v1h-1z M36 15 h1v1h-1z M37 15 h1v1h-1z M39 15 h1v1h-1z M40 15 h1v1h-1z M41 15 h1v1h-1z M42 15 h1v1h-1z M43 15 h1v1h-1z M47 15 h1v1h-1z M51 15 h1v1h-1z M52 15 h1v1h-1z M53 15 h1v1h-1z M55 15 h1v1h-1z M57 15 h1v1h-1z M58 15 h1v1h-1z M4 16 h1v1h-1z M5 16 h1v1h-1z M6 16 h1v1h-1z M11 16 h1v1h-1z M12 16 h1v1h-1z M13 16 h1v1h-1z M14 16 h1v1h-1z M15 16 h1v1h-1z M16 16 h1v1h-1z M18 16 h1v1h-1z M19 16 h1v1h-1z M20 16 h1v1h-1z M21 16 h1v1h-1z M23 16 h1v1h-1z M24 16 h1v1h-1z M28 16 h1v1h-1z M30 16 h1v1h-1z M31 16 h1v1h-1z M32 16 h1v1h-1z M34 16 h1v1h-1z M35 16 h1v1h-1z M40 16 h1v1h-1z M41 16 h1v1h-1z M42 16 h1v1h-1z M43 16 h1v1h-1z M44 16 h1v1h-1z M45 16 h1v1h-1z M47 16 h1v1h-1z M48 16 h1v1h-1z M49 16 h1v1h-1z M51 16 h1v1h-1z M52 16 h1v1h-1z M54 16 h1v1h-1z M56 16 h1v1h-1z M58 16 h1v1h-1z M59 16 h1v1h-1z M4 17 h1v1h-1z M5 17 h1v1h-1z M6 17 h1v1h-1z M8 17 h1v1h-1z M12 17 h1v1h-1z M15 17 h1v1h-1z M20 17 h1v1h-1z M22 17 h1v1h-1z M23 17 h1v1h-1z M24 17 h1v1h-1z M25 17 h1v1h-1z M26 17 h1v1h-1z M31 17 h1v1h-1z M33 17 h1v1h-1z M35 17 h1v1h-1z M38 17 h1v1h-1z M39 17 h1v1h-1z M42 17 h1v1h-1z M45 17 h1v1h-1z M48 17 h1v1h-1z M51 17 h1v1h-1z M53 17 h1v1h-1z M54 17 h1v1h-1z M57 17 h1v1h-1z M4 18 h1v1h-1z M5 18 h1v1h-1z M6 18 h1v1h-1z M8 18 h1v1h-1z M12 18 h1v1h-1z M13 18 h1v1h-1z M16 18 h1v1h-1z M17 18 h1v1h-1z M20 18 h1v1h-1z\nM23 18 h1v1h-1z M24 18 h1v1h-1z M25 18 h1v1h-1z M27 18 h1v1h-1z M31 18 h1v1h-1z M34 18 h1v1h-1z M41 18 h1v1h-1z M42 18 h1v1h-1z M43 18 h1v1h-1z M46 18 h1v1h-1z M47 18 h1v1h-1z M49 18 h1v1h-1z M53 18 h1v1h-1z M54 18 h1v1h-1z M56 18 h1v1h-1z M59 18 h1v1h-1z M5 19 h1v1h-1z M7 19 h1v1h-1z M8 19 h1v1h-1z M9 19 h1v1h-1z M11 19 h1v1h-1z M12 19 h1v1h-1z M13 19 h1v1h-1z M15 19 h1v1h-1z M21 19 h1v1h-1z M25 19 h1v1h-1z M26 19 h1v1h-1z M28 19 h1v1h-1z M29 19 h1v1h-1z M33 19 h1v1h-1z M34 19 h1v1h-1z M35 19 h1v1h-1z M36 19 h1v1h-1z M38 19 h1v1h-1z M41 19 h1v1h-1z M42 19 h1v1h-1z M46 19 h1v1h-1z M48 19 h1v1h-1z M51 19 h1v1h-1z M53 19 h1v1h-1z M54 19 h1v1h-1z M55 19 h1v1h-1z M56 19 h1v1h-1z M57 19 h1v1h-1z M59 19 h1v1h-1z M7 20 h1v1h-1z M8 20 h1v1h-1z M11 20 h1v1h-1z M13 20 h1v1h-1z M16 20 h1v1h-1z M17 20 h1v1h-1z M18 20 h1v1h-1z M19 20 h1v1h-1z M21 20 h1v1h-1z M24 20 h1v1h-1z M25 20 h1v1h-1z M26 20 h1v1h-1z M28 20 h1v1h-1z M29 20 h1v1h-1z M30 20 h1v1h-1z M36 20 h1v1h-1z M39 20 h1v1h-1z M40 20 h1v1h-1z M42 20 h1v1h-1z M46 20 h1v1h-1z M47 20 h1v1h-1z M54 20 h1v1h-1z M55 20 h1v1h-1z M57 20 h1v1h-1z M58 20 h1v1h-1z M60 20 h1v1h-1z M4 21 h1v1h-1z M7 21 h1v1h-1z M9 21 h1v1h-1z M11 21 h1v1h-1z M14 21 h1v1h-1z M15 21 h1v1h-1z M17 21 h1v1h-1z M21 21 h1v1h-1z M22 21 h1v1h-1z M23 21 h1v1h-1z M25 21 h1v1h-1z M27 21 h1v1h-1z M29 21 h1v1h-1z M32 21 h1v1h-1z M33 21 h1v1h-1z M34 21 h1v1h-1z M35 21 h1v1h-1z M37 21 h1v1h-1z M38 21 h1v1h-1z M39 21 h1v1h-1z M45 21 h1v1h-1z M46 21 h1v1h-1z M48 21 h1v1h-1z M49 21 h1v1h-1z M50 21 h1v1h-1z M51 21 h1v1h-1z M52 21 h1v1h-1z M53 21 h1v1h-1z M55 21 h1v1h-1z\nM56 21 h1v1h-1z M57 21 h1v1h-1z M58 21 h1v1h-1z M59 21 h1v1h-1z M60 21 h1v1h-1z M4 22 h1v1h-1z M5 22 h1v1h-1z M8 22 h1v1h-1z M9 22 h1v1h-1z M11 22 h1v1h-1z M12 22 h1v1h-1z M16 22 h1v1h-1z M17 22 h1v1h-1z M18 22 h1v1h-1z M20 22 h1v1h-1z M21 22 h1v1h-1z M23 22 h1v1h-1z M24 22 h1v1h-1z M25 22 h1v1h-1z M29 22 h1v1h-1z M31 22 h1v1h-1z M36 22 h1v1h-1z M38 22 h1v1h-1z M41 22 h1v1h-1z M44 22 h1v1h-1z M46 22 h1v1h-1z M49 22 h1v1h-1z M52 22 h1v1h-1z M53 22 h1v1h-1z M55 22 h1v1h-1z M56 22 h1v1h-1z M58 22 h1v1h-1z M60 22 h1v1h-1z M5 23 h1v1h-1z M6 23 h1v1h-1z M7 23 h1v1h-1z M8 23 h1v1h-1z M12 23 h1v1h-1z M14 23 h1v1h-1z M17 23 h1v1h-1z M20 23 h1v1h-1z M22 23 h1v1h-1z M24 23 h1v1h-1z M25 23 h1v1h-1z M28 23 h1v1h-1z M29 23 h1v1h-1z M30 23 h1v1h-1z M31 23 h1v1h-1z M32 23 h1v1h-1z M33 23 h1v1h-1z M34 23 h1v1h-1z M36 23 h1v1h-1z M41 23 h1v1h-1z M42 23 h1v1h-1z M44 23 h1v1h-1z M45 23 h1v1h-1z M48 23 h1v1h-1z M52 23 h1v1h-1z M55 23 h1v1h-1z M58 23 h1v1h-1z M4 24 h1v1h-1z M5 24 h1v1h-1z M11 24 h1v1h-1z M12 24 h1v1h-1z M13 24 h1v1h-1z M20 24 h1v1h-1z M21 24 h1v1h-1z M22 24 h1v1h-1z M23 24 h1v1h-1z M41 24 h1v1h-1z M44 24 h1v1h-1z M47 24 h1v1h-1z M51 24 h1v1h-1z M53 24 h1v1h-1z M54 24 h1v1h-1z M55 24 h1v1h-1z M56 24 h1v1h-1z M57 24 h1v1h-1z M58 24 h1v1h-1z M60 24 h1v1h-1z M5 25 h1v1h-1z M6 25 h1v1h-1z M8 25 h1v1h-1z M12 25 h1v1h-1z M15 25 h1v1h-1z M17 25 h1v1h-1z M18 25 h1v1h-1z M20 25 h1v1h-1z M42 25 h1v1h-1z M43 25 h1v1h-1z M44 25 h1v1h-1z M45 25 h1v1h-1z M47 25 h1v1h-1z M48 25 h1v1h-1z M50 25 h1v1h-1z M52 25 h1v1h-1z M53 25 h1v1h-1z M55 25 h1v1h-1z M56 25 h1v1h-1z M58 25 h1v1h-1z\nM59 25 h1v1h-1z M8 26 h1v1h-1z M9 26 h1v1h-1z M13 26 h1v1h-1z M16 26 h1v1h-1z M19 26 h1v1h-1z M22 26 h1v1h-1z M23 26 h1v1h-1z M43 26 h1v1h-1z M45 26 h1v1h-1z M46 26 h1v1h-1z M48 26 h1v1h-1z M50 26 h1v1h-1z M51 26 h1v1h-1z M52 26 h1v1h-1z M54 26 h1v1h-1z M55 26 h1v1h-1z M58 26 h1v1h-1z M60 26 h1v1h-1z M7 27 h1v1h-1z M8 27 h1v1h-1z M11 27 h1v1h-1z M15 27 h1v1h-1z M16 27 h1v1h-1z M18 27 h1v1h-1z M20 27 h1v1h-1z M22 27 h1v1h-1z M44 27 h1v1h-1z M48 27 h1v1h-1z M49 27 h1v1h-1z M50 27 h1v1h-1z M52 27 h1v1h-1z M56 27 h1v1h-1z M57 27 h1v1h-1z M58 27 h1v1h-1z M4 28 h1v1h-1z M5 28 h1v1h-1z M9 28 h1v1h-1z M14 28 h1v1h-1z M15 28 h1v1h-1z M16 28 h1v1h-1z M17 28 h1v1h-1z M20 28 h1v1h-1z M23 28 h1v1h-1z M42 28 h1v1h-1z M45 28 h1v1h-1z M48 28 h1v1h-1z M49 28 h1v1h-1z M54 28 h1v1h-1z M58 28 h1v1h-1z M59 28 h1v1h-1z M60 28 h1v1h-1z M6 29 h1v1h-1z M7 29 h1v1h-1z M9 29 h1v1h-1z M11 29 h1v1h-1z M12 29 h1v1h-1z M15 29 h1v1h-1z M16 29 h1v1h-1z M18 29 h1v1h-1z M19 29 h1v1h-1z M23 29 h1v1h-1z M41 29 h1v1h-1z M42 29 h1v1h-1z M44 29 h1v1h-1z M45 29 h1v1h-1z M48 29 h1v1h-1z M52 29 h1v1h-1z M53 29 h1v1h-1z M54 29 h1v1h-1z M56 29 h1v1h-1z M57 29 h1v1h-1z M58 29 h1v1h-1z M59 29 h1v1h-1z M60 29 h1v1h-1z M5 30 h1v1h-1z M6 30 h1v1h-1z M7 30 h1v1h-1z M16 30 h1v1h-1z M21 30 h1v1h-1z M46 30 h1v1h-1z M51 30 h1v1h-1z M57 30 h1v1h-1z M60 30 h1v1h-1z M6 31 h1v1h-1z M7 31 h1v1h-1z M14 31 h1v1h-1z M15 31 h1v1h-1z M16 31 h1v1h-1z M17 31 h1v1h-1z M18 31 h1v1h-1z M41 31 h1v1h-1z M44 31 h1v1h-1z M45 31 h1v1h-1z M50 31 h1v1h-1z M51 31 h1v1h-1z M57 31 h1v1h-1z M58 31 h1v1h-1z M4 32 h1v1h-1z M5 32 h1v1h-1z\nM7 32 h1v1h-1z M16 32 h1v1h-1z M17 32 h1v1h-1z M21 32 h1v1h-1z M23 32 h1v1h-1z M44 32 h1v1h-1z M48 32 h1v1h-1z M57 32 h1v1h-1z M59 32 h1v1h-1z M6 33 h1v1h-1z M7 33 h1v1h-1z M15 33 h1v1h-1z M16 33 h1v1h-1z M17 33 h1v1h-1z M19 33 h1v1h-1z M20 33 h1v1h-1z M23 33 h1v1h-1z M41 33 h1v1h-1z M42 33 h1v1h-1z M46 33 h1v1h-1z M47 33 h1v1h-1z M48 33 h1v1h-1z M50 33 h1v1h-1z M57 33 h1v1h-1z M58 33 h1v1h-1z M4 34 h1v1h-1z M7 34 h1v1h-1z M14 34 h1v1h-1z M16 34 h1v1h-1z M20 34 h1v1h-1z M41 34 h1v1h-1z M42 34 h1v1h-1z M45 34 h1v1h-1z M47 34 h1v1h-1z M48 34 h1v1h-1z M50 34 h1v1h-1z M4 35 h1v1h-1z M6 35 h1v1h-1z M8 35 h1v1h-1z M9 35 h1v1h-1z M11 35 h1v1h-1z M12 35 h1v1h-1z M15 35 h1v1h-1z M18 35 h1v1h-1z M19 35 h1v1h-1z M20 35 h1v1h-1z M22 35 h1v1h-1z M41 35 h1v1h-1z M42 35 h1v1h-1z M43 35 h1v1h-1z M46 35 h1v1h-1z M47 35 h1v1h-1z M49 35 h1v1h-1z M50 35 h1v1h-1z M51 35 h1v1h-1z M52 35 h1v1h-1z M54 35 h1v1h-1z M55 35 h1v1h-1z M56 35 h1v1h-1z M57 35 h1v1h-1z M58 35 h1v1h-1z M59 35 h1v1h-1z M4 36 h1v1h-1z M6 36 h1v1h-1z M8 36 h1v1h-1z M11 36 h1v1h-1z M13 36 h1v1h-1z M15 36 h1v1h-1z M16 36 h1v1h-1z M18 36 h1v1h-1z M43 36 h1v1h-1z M44 36 h1v1h-1z M45 36 h1v1h-1z M49 36 h1v1h-1z M52 36 h1v1h-1z M54 36 h1v1h-1z M56 36 h1v1h-1z M57 36 h1v1h-1z M60 36 h1v1h-1z M4 37 h1v1h-1z M6 37 h1v1h-1z M7 37 h1v1h-1z M8 37 h1v1h-1z M11 37 h1v1h-1z M12 37 h1v1h-1z M13 37 h1v1h-1z M14 37 h1v1h-1z M16 37 h1v1h-1z M17 37 h1v1h-1z M18 37 h1v1h-1z M19 37 h1v1h-1z M21 37 h1v1h-1z M22 37 h1v1h-1z M23 37 h1v1h-1z M42 37 h1v1h-1z M43 37 h1v1h-1z M44 37 h1v1h-1z M46 37 h1v1h-1z M48 37 h1v1h-1z M49 37 h1v1h-1z\nM52 37 h1v1h-1z M56 37 h1v1h-1z M59 37 h1v1h-1z M60 37 h1v1h-1z M4 38 h1v1h-1z M5 38 h1v1h-1z M8 38 h1v1h-1z M9 38 h1v1h-1z M11 38 h1v1h-1z M16 38 h1v1h-1z M23 38 h1v1h-1z M41 38 h1v1h-1z M42 38 h1v1h-1z M43 38 h1v1h-1z M47 38 h1v1h-1z M48 38 h1v1h-1z M49 38 h1v1h-1z M51 38 h1v1h-1z M53 38 h1v1h-1z M57 38 h1v1h-1z M58 38 h1v1h-1z M60 38 h1v1h-1z M4 39 h1v1h-1z M6 39 h1v1h-1z M7 39 h1v1h-1z M11 39 h1v1h-1z M12 39 h1v1h-1z M14 39 h1v1h-1z M17 39 h1v1h-1z M20 39 h1v1h-1z M21 39 h1v1h-1z M22 39 h1v1h-1z M23 39 h1v1h-1z M41 39 h1v1h-1z M42 39 h1v1h-1z M44 39 h1v1h-1z M45 39 h1v1h-1z M48 39 h1v1h-1z M50 39 h1v1h-1z M51 39 h1v1h-1z M52 39 h1v1h-1z M56 39 h1v1h-1z M58 39 h1v1h-1z M59 39 h1v1h-1z M4 40 h1v1h-1z M5 40 h1v1h-1z M7 40 h1v1h-1z M13 40 h1v1h-1z M17 40 h1v1h-1z M18 40 h1v1h-1z M21 40 h1v1h-1z M23 40 h1v1h-1z M41 40 h1v1h-1z M46 40 h1v1h-1z M48 40 h1v1h-1z M50 40 h1v1h-1z M51 40 h1v1h-1z M57 40 h1v1h-1z M59 40 h1v1h-1z M60 40 h1v1h-1z M5 41 h1v1h-1z M6 41 h1v1h-1z M7 41 h1v1h-1z M8 41 h1v1h-1z M9 41 h1v1h-1z M13 41 h1v1h-1z M15 41 h1v1h-1z M18 41 h1v1h-1z M19 41 h1v1h-1z M20 41 h1v1h-1z M21 41 h1v1h-1z M22 41 h1v1h-1z M27 41 h1v1h-1z M33 41 h1v1h-1z M36 41 h1v1h-1z M38 41 h1v1h-1z M40 41 h1v1h-1z M44 41 h1v1h-1z M46 41 h1v1h-1z M52 41 h1v1h-1z M53 41 h1v1h-1z M58 41 h1v1h-1z M59 41 h1v1h-1z M60 41 h1v1h-1z M6 42 h1v1h-1z M11 42 h1v1h-1z M13 42 h1v1h-1z M14 42 h1v1h-1z M16 42 h1v1h-1z M17 42 h1v1h-1z M23 42 h1v1h-1z M25 42 h1v1h-1z M28 42 h1v1h-1z M30 42 h1v1h-1z M32 42 h1v1h-1z M35 42 h1v1h-1z M40 42 h1v1h-1z M41 42 h1v1h-1z M45 42 h1v1h-1z M48 42 h1v1h-1z\nM50 42 h1v1h-1z M54 42 h1v1h-1z M56 42 h1v1h-1z M57 42 h1v1h-1z M60 42 h1v1h-1z M4 43 h1v1h-1z M5 43 h1v1h-1z M8 43 h1v1h-1z M9 43 h1v1h-1z M11 43 h1v1h-1z M13 43 h1v1h-1z M15 43 h1v1h-1z M16 43 h1v1h-1z M17 43 h1v1h-1z M20 43 h1v1h-1z M21 43 h1v1h-1z M23 43 h1v1h-1z M26 43 h1v1h-1z M27 43 h1v1h-1z M28 43 h1v1h-1z M31 43 h1v1h-1z M33 43 h1v1h-1z M36 43 h1v1h-1z M37 43 h1v1h-1z M39 43 h1v1h-1z M41 43 h1v1h-1z M44 43 h1v1h-1z M45 43 h1v1h-1z M46 43 h1v1h-1z M48 43 h1v1h-1z M50 43 h1v1h-1z M52 43 h1v1h-1z M54 43 h1v1h-1z M56 43 h1v1h-1z M58 43 h1v1h-1z M5 44 h1v1h-1z M7 44 h1v1h-1z M8 44 h1v1h-1z M9 44 h1v1h-1z M11 44 h1v1h-1z M13 44 h1v1h-1z M16 44 h1v1h-1z M18 44 h1v1h-1z M19 44 h1v1h-1z M26 44 h1v1h-1z M27 44 h1v1h-1z M29 44 h1v1h-1z M30 44 h1v1h-1z M31 44 h1v1h-1z M32 44 h1v1h-1z M34 44 h1v1h-1z M35 44 h1v1h-1z M36 44 h1v1h-1z M37 44 h1v1h-1z M39 44 h1v1h-1z M40 44 h1v1h-1z M43 44 h1v1h-1z M45 44 h1v1h-1z M47 44 h1v1h-1z M51 44 h1v1h-1z M53 44 h1v1h-1z M54 44 h1v1h-1z M55 44 h1v1h-1z M56 44 h1v1h-1z M59 44 h1v1h-1z M7 45 h1v1h-1z M11 45 h1v1h-1z M12 45 h1v1h-1z M13 45 h1v1h-1z M14 45 h1v1h-1z M17 45 h1v1h-1z M18 45 h1v1h-1z M19 45 h1v1h-1z M20 45 h1v1h-1z M21 45 h1v1h-1z M22 45 h1v1h-1z M23 45 h1v1h-1z M24 45 h1v1h-1z M30 45 h1v1h-1z M31 45 h1v1h-1z M32 45 h1v1h-1z M34 45 h1v1h-1z M35 45 h1v1h-1z M39 45 h1v1h-1z M40 45 h1v1h-1z M41 45 h1v1h-1z M42 45 h1v1h-1z M44 45 h1v1h-1z M45 45 h1v1h-1z M46 45 h1v1h-1z M48 45 h1v1h-1z M50 45 h1v1h-1z M51 45 h1v1h-1z M52 45 h1v1h-1z M55 45 h1v1h-1z M56 45 h1v1h-1z M59 45 h1v1h-1z M60 45 h1v1h-1z M11 46 h1v1h-1z M12 46 h1v1h-1z\nM13 46 h1v1h-1z M14 46 h1v1h-1z M15 46 h1v1h-1z M16 46 h1v1h-1z M17 46 h1v1h-1z M18 46 h1v1h-1z M21 46 h1v1h-1z M23 46 h1v1h-1z M28 46 h1v1h-1z M29 46 h1v1h-1z M31 46 h1v1h-1z M32 46 h1v1h-1z M33 46 h1v1h-1z M34 46 h1v1h-1z M39 46 h1v1h-1z M41 46 h1v1h-1z M42 46 h1v1h-1z M44 46 h1v1h-1z M50 46 h1v1h-1z M51 46 h1v1h-1z M52 46 h1v1h-1z M54 46 h1v1h-1z M55 46 h1v1h-1z M57 46 h1v1h-1z M59 46 h1v1h-1z M60 46 h1v1h-1z M4 47 h1v1h-1z M8 47 h1v1h-1z M9 47 h1v1h-1z M13 47 h1v1h-1z M14 47 h1v1h-1z M17 47 h1v1h-1z M19 47 h1v1h-1z M20 47 h1v1h-1z M21 47 h1v1h-1z M22 47 h1v1h-1z M25 47 h1v1h-1z M31 47 h1v1h-1z M32 47 h1v1h-1z M33 47 h1v1h-1z M37 47 h1v1h-1z M39 47 h1v1h-1z M41 47 h1v1h-1z M42 47 h1v1h-1z M43 47 h1v1h-1z M44 47 h1v1h-1z M46 47 h1v1h-1z M47 47 h1v1h-1z M48 47 h1v1h-1z M49 47 h1v1h-1z M50 47 h1v1h-1z M57 47 h1v1h-1z M60 47 h1v1h-1z M7 48 h1v1h-1z M8 48 h1v1h-1z M13 48 h1v1h-1z M14 48 h1v1h-1z M16 48 h1v1h-1z M17 48 h1v1h-1z M23 48 h1v1h-1z M24 48 h1v1h-1z M28 48 h1v1h-1z M29 48 h1v1h-1z M30 48 h1v1h-1z M33 48 h1v1h-1z M34 48 h1v1h-1z M35 48 h1v1h-1z M36 48 h1v1h-1z M38 48 h1v1h-1z M39 48 h1v1h-1z M40 48 h1v1h-1z M43 48 h1v1h-1z M44 48 h1v1h-1z M45 48 h1v1h-1z M46 48 h1v1h-1z M48 48 h1v1h-1z M51 48 h1v1h-1z M52 48 h1v1h-1z M53 48 h1v1h-1z M55 48 h1v1h-1z M58 48 h1v1h-1z M60 48 h1v1h-1z M11 49 h1v1h-1z M13 49 h1v1h-1z M14 49 h1v1h-1z M17 49 h1v1h-1z M20 49 h1v1h-1z M22 49 h1v1h-1z M23 49 h1v1h-1z M25 49 h1v1h-1z M27 49 h1v1h-1z M32 49 h1v1h-1z M34 49 h1v1h-1z M35 49 h1v1h-1z M37 49 h1v1h-1z M42 49 h1v1h-1z M43 49 h1v1h-1z M46 49 h1v1h-1z M50 49 h1v1h-1z M51 49 h1v1h-1z\nM53 49 h1v1h-1z M54 49 h1v1h-1z M56 49 h1v1h-1z M58 49 h1v1h-1z M12 50 h1v1h-1z M15 50 h1v1h-1z M17 50 h1v1h-1z M18 50 h1v1h-1z M21 50 h1v1h-1z M23 50 h1v1h-1z M26 50 h1v1h-1z M28 50 h1v1h-1z M30 50 h1v1h-1z M31 50 h1v1h-1z M32 50 h1v1h-1z M35 50 h1v1h-1z M37 50 h1v1h-1z M39 50 h1v1h-1z M40 50 h1v1h-1z M41 50 h1v1h-1z M42 50 h1v1h-1z M43 50 h1v1h-1z M46 50 h1v1h-1z M47 50 h1v1h-1z M49 50 h1v1h-1z M50 50 h1v1h-1z M54 50 h1v1h-1z M55 50 h1v1h-1z M58 50 h1v1h-1z M59 50 h1v1h-1z M60 50 h1v1h-1z M14 51 h1v1h-1z M16 51 h1v1h-1z M18 51 h1v1h-1z M22 51 h1v1h-1z M23 51 h1v1h-1z M24 51 h1v1h-1z M27 51 h1v1h-1z M29 51 h1v1h-1z M30 51 h1v1h-1z M31 51 h1v1h-1z M32 51 h1v1h-1z M33 51 h1v1h-1z M38 51 h1v1h-1z M39 51 h1v1h-1z M47 51 h1v1h-1z M49 51 h1v1h-1z M50 51 h1v1h-1z M51 51 h1v1h-1z M52 51 h1v1h-1z M54 51 h1v1h-1z M55 51 h1v1h-1z M56 51 h1v1h-1z M57 51 h1v1h-1z M58 51 h1v1h-1z M59 51 h1v1h-1z M11 52 h1v1h-1z M13 52 h1v1h-1z M14 52 h1v1h-1z M17 52 h1v1h-1z M21 52 h1v1h-1z M25 52 h1v1h-1z M26 52 h1v1h-1z M27 52 h1v1h-1z M28 52 h1v1h-1z M38 52 h1v1h-1z M39 52 h1v1h-1z M42 52 h1v1h-1z M44 52 h1v1h-1z M45 52 h1v1h-1z M47 52 h1v1h-1z M48 52 h1v1h-1z M49 52 h1v1h-1z M51 52 h1v1h-1z M58 52 h1v1h-1z M13 53 h1v1h-1z M14 53 h1v1h-1z M15 53 h1v1h-1z M16 53 h1v1h-1z M17 53 h1v1h-1z M21 53 h1v1h-1z M27 53 h1v1h-1z M29 53 h1v1h-1z M37 53 h1v1h-1z M38 53 h1v1h-1z M41 53 h1v1h-1z M42 53 h1v1h-1z M43 53 h1v1h-1z M45 53 h1v1h-1z M48 53 h1v1h-1z M49 53 h1v1h-1z M51 53 h1v1h-1z M57 53 h1v1h-1z M59 53 h1v1h-1z M13 54 h1v1h-1z M20 54 h1v1h-1z M24 54 h1v1h-1z M27 54 h1v1h-1z M28 54 h1v1h-1z M36 54 h1v1h-1z\nM40 54 h1v1h-1z M44 54 h1v1h-1z M46 54 h1v1h-1z M47 54 h1v1h-1z M49 54 h1v1h-1z M14 55 h1v1h-1z M15 55 h1v1h-1z M21 55 h1v1h-1z M24 55 h1v1h-1z M29 55 h1v1h-1z M36 55 h1v1h-1z M39 55 h1v1h-1z M41 55 h1v1h-1z M46 55 h1v1h-1z M48 55 h1v1h-1z M50 55 h1v1h-1z M57 55 h1v1h-1z M60 55 h1v1h-1z M13 56 h1v1h-1z M19 56 h1v1h-1z M20 56 h1v1h-1z M22 56 h1v1h-1z M23 56 h1v1h-1z M25 56 h1v1h-1z M27 56 h1v1h-1z M28 56 h1v1h-1z M35 56 h1v1h-1z M38 56 h1v1h-1z M39 56 h1v1h-1z M40 56 h1v1h-1z M42 56 h1v1h-1z M46 56 h1v1h-1z M47 56 h1v1h-1z M49 56 h1v1h-1z M51 56 h1v1h-1z M57 56 h1v1h-1z M58 56 h1v1h-1z M13 57 h1v1h-1z M15 57 h1v1h-1z M16 57 h1v1h-1z M18 57 h1v1h-1z M19 57 h1v1h-1z M21 57 h1v1h-1z M22 57 h1v1h-1z M26 57 h1v1h-1z M27 57 h1v1h-1z M29 57 h1v1h-1z M31 57 h1v1h-1z M33 57 h1v1h-1z M34 57 h1v1h-1z M35 57 h1v1h-1z M36 57 h1v1h-1z M37 57 h1v1h-1z M38 57 h1v1h-1z M41 57 h1v1h-1z M42 57 h1v1h-1z M43 57 h1v1h-1z M45 57 h1v1h-1z M46 57 h1v1h-1z M48 57 h1v1h-1z M50 57 h1v1h-1z M51 57 h1v1h-1z M53 57 h1v1h-1z M54 57 h1v1h-1z M55 57 h1v1h-1z M13 58 h1v1h-1z M14 58 h1v1h-1z M19 58 h1v1h-1z M21 58 h1v1h-1z M23 58 h1v1h-1z M24 58 h1v1h-1z M26 58 h1v1h-1z M27 58 h1v1h-1z M29 58 h1v1h-1z M30 58 h1v1h-1z M31 58 h1v1h-1z M32 58 h1v1h-1z M33 58 h1v1h-1z M34 58 h1v1h-1z M37 58 h1v1h-1z M41 58 h1v1h-1z M42 58 h1v1h-1z M43 58 h1v1h-1z M44 58 h1v1h-1z M46 58 h1v1h-1z M52 58 h1v1h-1z M54 58 h1v1h-1z M56 58 h1v1h-1z M57 58 h1v1h-1z M59 58 h1v1h-1z M60 58 h1v1h-1z M13 59 h1v1h-1z M15 59 h1v1h-1z M18 59 h1v1h-1z M23 59 h1v1h-1z M26 59 h1v1h-1z M27 59 h1v1h-1z M29 59 h1v1h-1z M32 59 h1v1h-1z M35 59 h1v1h-1z\nM38 59 h1v1h-1z M41 59 h1v1h-1z M42 59 h1v1h-1z M43 59 h1v1h-1z M46 59 h1v1h-1z M47 59 h1v1h-1z M53 59 h1v1h-1z M54 59 h1v1h-1z M57 59 h1v1h-1z M59 59 h1v1h-1z M60 59 h1v1h-1z M13 60 h1v1h-1z M15 60 h1v1h-1z M18 60 h1v1h-1z M20 60 h1v1h-1z M21 60 h1v1h-1z M23 60 h1v1h-1z M24 60 h1v1h-1z M26 60 h1v1h-1z M27 60 h1v1h-1z M28 60 h1v1h-1z M29 60 h1v1h-1z M30 60 h1v1h-1z M32 60 h1v1h-1z M33 60 h1v1h-1z M34 60 h1v1h-1z M35 60 h1v1h-1z M37 60 h1v1h-1z M38 60 h1v1h-1z M39 60 h1v1h-1z M43 60 h1v1h-1z M44 60 h1v1h-1z M45 60 h1v1h-1z M46 60 h1v1h-1z M52 60 h1v1h-1z M54 60 h1v1h-1z M55 60 h1v1h-1z M58 60 h1v1h-1z\"/>\n<path class=\"qr-alignment-dark dark qrcode\" d=\"M30 8 h1v1h-1z M31 8 h1v1h-1z M32 8 h1v1h-1z M33 8 h1v1h-1z M34 8 h1v1h-1z M30 9 h1v1h-1z M34 9 h1v1h-1z M30 10 h1v1h-1z M32 10 h1v1h-1z M34 10 h1v1h-1z M30 11 h1v1h-1z M34 11 h1v1h-1z M30 12 h1v1h-1z M31 12 h1v1h-1z M32 12 h1v1h-1z M33 12 h1v1h-1z M34 12 h1v1h-1z M8 30 h1v1h-1z M9 30 h1v1h-1z M10 30 h1v1h-1z M11 30 h1v1h-1z M12 30 h1v1h-1z M52 30 h1v1h-1z M53 30 h1v1h-1z M54 30 h1v1h-1z M55 30 h1v1h-1z M56 30 h1v1h-1z M8 31 h1v1h-1z M12 31 h1v1h-1z M52 31 h1v1h-1z M56 31 h1v1h-1z M8 32 h1v1h-1z M10 32 h1v1h-1z M12 32 h1v1h-1z M52 32 h1v1h-1z M54 32 h1v1h-1z M56 32 h1v1h-1z M8 33 h1v1h-1z M12 33 h1v1h-1z M52 33 h1v1h-1z M56 33 h1v1h-1z M8 34 h1v1h-1z M9 34 h1v1h-1z M10 34 h1v1h-1z M11 34 h1v1h-1z M12 34 h1v1h-1z M52 34 h1v1h-1z M53 34 h1v1h-1z M54 34 h1v1h-1z M55 34 h1v1h-1z M56 34 h1v1h-1z M30 52 h1v1h-1z M31 52 h1v1h-1z M32 52 h1v1h-1z M33 52 h1v1h-1z M34 52 h1v1h-1z M52 52 h1v1h-1z M53 52 h1v1h-1z M54 52 h1v1h-1z M55 52 h1v1h-1z M56 52 h1v1h-1z M30 53 h1v1h-1z M34 53 h1v1h-1z M52 53 h1v1h-1z M56 53 h1v1h-1z M30 54 h1v1h-1z M32 54 h1v1h-1z M34 54 h1v1h-1z M52 54 h1v1h-1z M54 54 h1v1h-1z M56 54 h1v1h-1z M30 55 h1v1h-1z M34 55 h1v1h-1z M52 55 h1v1h-1z M56 55 h1v1h-1z M30 56 h1v1h-1z M31 56 h1v1h-1z M32 56 h1v1h-1z M33 56 h1v1h-1z M34 56 h1v1h-1z M52 56 h1v1h-1z M53 56 h1v1h-1z M54 56 h1v1h-1z M55 56 h1v1h-1z M56 56 h1v1h-1z\"/>\n<path class=\"qr-timing-dark dark qrcode\" d=\"M12 10 h1v1h-1z M14 10 h1v1h-1z M16 10 h1v1h-1z M18 10 h1v1h-1z M20 10 h1v1h-1z M22 10 h1v1h-1z M24 10 h1v1h-1z M26 10 h1v1h-1z M28 10 h1v1h-1z M36 10 h1v1h-1z M38 10 h1v1h-1z M40 10 h1v1h-1z M42 10 h1v1h-1z M44 10 h1v1h-1z M46 10 h1v1h-1z M48 10 h1v1h-1z M50 10 h1v1h-1z M52 10 h1v1h-1z M10 12 h1v1h-1z M10 14 h1v1h-1z M10 16 h1v1h-1z M10 18 h1v1h-1z M10 20 h1v1h-1z M10 22 h1v1h-1z M10 24 h1v1h-1z M10 26 h1v1h-1z M10 28 h1v1h-1z M10 36 h1v1h-1z M10 38 h1v1h-1z M10 40 h1v1h-1z M10 42 h1v1h-1z M10 44 h1v1h-1z M10 46 h1v1h-1z M10 48 h1v1h-1z M10 50 h1v1h-1z M10 52 h1v1h-1z\"/>\n<path class=\"qr-format-dark dark qrcode\" d=\"M12 6 h1v1h-1z M12 7 h1v1h-1z M7 12 h1v1h-1z M8 12 h1v1h-1z M11 12 h1v1h-1z M57 12 h1v1h-1z M58 12 h1v1h-1z M12 54 h1v1h-1z M12 56 h1v1h-1z M12 57 h1v1h-1z\"/>\n<path class=\"qr-version-dark dark qrcode\" d=\"M50 4 h1v1h-1z M51 4 h1v1h-1z M51 5 h1v1h-1z M50 6 h1v1h-1z M51 6 h1v1h-1z M51 7 h1v1h-1z M51 8 h1v1h-1z M50 9 h1v1h-1z M4 50 h1v1h-1z M6 50 h1v1h-1z M9 50 h1v1h-1z M4 51 h1v1h-1z M5 51 h1v1h-1z M6 51 h1v1h-1z M7 51 h1v1h-1z M8 51 h1v1h-1z\"/>\n<path class=\"qr-finder-dark dark qrcode\" d=\"M4,4 m2 0h3a2 2 0 012 2v3a2 2 0 01-2 2h-3a2 2 0 01-2-2v-3a2 2 0 012-2zm0 1a1 1 0 00-1 1v3a1 1 0 001 1h3a1 1 0 001-1v-3a1 1 0 00-1-1zm1 1h1a1 1 0 011 1v1a1 1 0 01-1 1h-1a1 1 0 01-1-1v-1a1 1 0 011-1Z M4,54 m2 0h3a2 2 0 012 2v3a2 2 0 01-2 2h-3a2 2 0 01-2-2v-3a2 2 0 012-2zm0 1a1 1 0 00-1 1v3a1 1 0 001 1h3a1 1 0 001-1v-3a1 1 0 00-1-1zm1 1h1a1 1 0 011 1v1a1 1 0 01-1 1h-1a1 1 0 01-1-1v-1a1 1 0 011-1Z M54,4 m2 0h3a2 2 0 012 2v3a2 2 0 01-2 2h-3a2 2 0 01-2-2v-3a2 2 0 012-2zm0 1a1 1 0 00-1 1v3a1 1 0 001 1h3a1 1 0 001-1v-3a1 1 0 00-1-1zm1 1h1a1 1 0 011 1v1a1 1 0 01-1 1h-1a1 1 0 01-1-1v-1a1 1 0 011-1Z\"/>\n<g transform=\"translate(24.375 24.375) scale(0.25)\" class=\"qr-logo dark\">\n\t<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"63\" height=\"63\">\n    <image href=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAIAAAACUFjqAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAADUlEQVQYlWNgGAWkAwABNgABxYufBwAAAABJRU5ErkJggg==\" width=\"63\" height=\"63\"/>\n</svg>\n</g>\n</svg>\n"
    },
    "message": "success",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/qr

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

Body Parameters

dots_color   string  optional  
dots_shape   string  optional  

Example: japanese

Must be one of:
  • circular
  • square
  • dot
  • japanese
  • pointed-edge-cut
  • pointed-smooth
  • star
  • rounded-in-smooth
  • diamond
  • mosaic
  • circle-zebra-vertical
border_shape   string  optional  

Example: rounded-square

Must be one of:
  • circular
  • square
  • rounded-square
  • rounded-rectangle
  • square-with-dot
  • squircle
  • clipped-corner-square
  • inner-rounded-rectangle
  • thick-bordered-circle
  • tilted-square
qr_bg_color   string  optional  
border_color   string  optional  
isGradient   boolean  optional  

Example: true

isRadialGradient   boolean  optional  

Example: true

second_dots_color   string  optional  

This field is required when gradient is true.

logo   file  optional  

Must be an image. Must not be greater than 255 kilobytes. Example: /tmp/phpNnGNca

Area

APIs for Area Management

Show all areas in specific branch

requires authentication

This endpoint lets you show all areas in specific branch

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas?page=4&per_page=8&filter%5Bstatus%5D=voluptatem&sort=vel&filter%5Bsearch%5D=fugit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas"
);

const params = {
    "page": "4",
    "per_page": "8",
    "filter[status]": "voluptatem",
    "sort": "vel",
    "filter[search]": "fugit",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5da-b756-4ee4-ad43-1ae72b2b9a56",
            "branch": {
                "id": "d34bb274-a9b7-442e-8323-f64f17046b3c"
            },
            "name": "Kathryn Conroy",
            "name_ar": "Trisha Fritsch",
            "restaurant_tables": null,
            "tables_count": 6,
            "floor_number": 1,
            "status": {
                "key": 2,
                "value": "INACTIVE"
            },
            "opening_hours": {
                "key": "12 PM - 6 PM",
                "value": "AFTERNOON"
            },
            "assigned_staff": [
                {
                    "id": "cff6c7c5-f442-4188-bd47-c40684dffbd9",
                    "name": "Raphael Conn"
                },
                {
                    "id": "148b9c12-716b-4322-95f5-73cefe60588d",
                    "name": "Liza Kilback"
                },
                {
                    "id": "931c601d-ea15-45f1-8f4c-160fc194c60c",
                    "name": "Estelle Beier"
                }
            ]
        },
        {
            "id": "9fdec5da-b626-4aa5-9ce8-00cb340f37d0",
            "branch": {
                "id": "d34bb274-a9b7-442e-8323-f64f17046b3c"
            },
            "name": "Mrs. Vivianne Dickinson MD",
            "name_ar": "Prof. Koby Collins",
            "restaurant_tables": null,
            "tables_count": 7,
            "floor_number": 3,
            "status": {
                "key": 2,
                "value": "INACTIVE"
            },
            "opening_hours": {
                "key": "9 AM - 12 PM",
                "value": "MORNING"
            },
            "assigned_staff": [
                {
                    "id": "cff6c7c5-f442-4188-bd47-c40684dffbd9",
                    "name": "Raphael Conn"
                },
                {
                    "id": "148b9c12-716b-4322-95f5-73cefe60588d",
                    "name": "Liza Kilback"
                },
                {
                    "id": "931c601d-ea15-45f1-8f4c-160fc194c60c",
                    "name": "Estelle Beier"
                }
            ]
        },
        {
            "id": "9fdec5da-b4f1-44da-abbb-11e6e8ae0e64",
            "branch": {
                "id": "d34bb274-a9b7-442e-8323-f64f17046b3c"
            },
            "name": "Easton Kirlin",
            "name_ar": "Rhett Howell",
            "restaurant_tables": null,
            "tables_count": 10,
            "floor_number": 1,
            "status": {
                "key": 1,
                "value": "ACTIVE"
            },
            "opening_hours": {
                "key": "6 PM - 9 PM",
                "value": "EVENING"
            },
            "assigned_staff": [
                {
                    "id": "cff6c7c5-f442-4188-bd47-c40684dffbd9",
                    "name": "Raphael Conn"
                },
                {
                    "id": "148b9c12-716b-4322-95f5-73cefe60588d",
                    "name": "Liza Kilback"
                },
                {
                    "id": "931c601d-ea15-45f1-8f4c-160fc194c60c",
                    "name": "Estelle Beier"
                }
            ]
        },
        {
            "id": "9fdec5da-b3d1-41eb-920e-7bb44b89747e",
            "branch": {
                "id": "d34bb274-a9b7-442e-8323-f64f17046b3c"
            },
            "name": "Amani Rempel",
            "name_ar": "Mr. Garry Howell",
            "restaurant_tables": null,
            "tables_count": 8,
            "floor_number": 3,
            "status": {
                "key": 2,
                "value": "INACTIVE"
            },
            "opening_hours": {
                "key": "9 AM - 12 PM",
                "value": "MORNING"
            },
            "assigned_staff": [
                {
                    "id": "cff6c7c5-f442-4188-bd47-c40684dffbd9",
                    "name": "Raphael Conn"
                },
                {
                    "id": "148b9c12-716b-4322-95f5-73cefe60588d",
                    "name": "Liza Kilback"
                },
                {
                    "id": "931c601d-ea15-45f1-8f4c-160fc194c60c",
                    "name": "Estelle Beier"
                }
            ]
        },
        {
            "id": "9fdec5da-b1e5-4abe-96f6-a3639379306c",
            "branch": {
                "id": "d34bb274-a9b7-442e-8323-f64f17046b3c"
            },
            "name": "Dr. Beth Beatty",
            "name_ar": "Blaze Stokes",
            "restaurant_tables": null,
            "tables_count": 7,
            "floor_number": 2,
            "status": {
                "key": 3,
                "value": "MAINTENANCE"
            },
            "opening_hours": {
                "key": "6 PM - 9 PM",
                "value": "EVENING"
            },
            "assigned_staff": [
                {
                    "id": "cff6c7c5-f442-4188-bd47-c40684dffbd9",
                    "name": "Raphael Conn"
                },
                {
                    "id": "148b9c12-716b-4322-95f5-73cefe60588d",
                    "name": "Liza Kilback"
                },
                {
                    "id": "931c601d-ea15-45f1-8f4c-160fc194c60c",
                    "name": "Estelle Beier"
                }
            ]
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/areas

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 4

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 8

filter[status]   string  optional  

Field to filter items by status. Example: voluptatem

sort   string  optional  

Field to sort items by tables_count. Example: vel

filter[search]   string  optional  

Field to perform a custom search. Example: fugit

Add Area

requires authentication

This endpoint lets you add Area

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ppagdlzjolgirxtotmgoug\",
    \"name_ar\": \"poszziowinlbiuzzhyeiiaiz\",
    \"status\": 1,
    \"opening_hours\": \"9 AM - 12 PM\",
    \"restaurant_tables\": [
        {
            \"id\": \"non\"
        }
    ],
    \"floor_number\": 79
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ppagdlzjolgirxtotmgoug",
    "name_ar": "poszziowinlbiuzzhyeiiaiz",
    "status": 1,
    "opening_hours": "9 AM - 12 PM",
    "restaurant_tables": [
        {
            "id": "non"
        }
    ],
    "floor_number": 79
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5db-6356-4bfb-8f9c-8b3d6bca6ce7",
        "branch": {
            "id": "7af64064-675a-4fc9-9615-05fe3f4f3d9a"
        },
        "name": "Main Area",
        "name_ar": "المنطقة الرئيسية",
        "restaurant_tables": [
            {
                "id": "9fdec5db-3d7e-4cd6-8a6e-8b89a3930634",
                "number": "3",
                "status": {
                    "key": 2,
                    "value": "OCCUPIED"
                }
            },
            {
                "id": "9fdec5db-3f66-4317-942e-14c41eb1b23f",
                "number": "3",
                "status": {
                    "key": 4,
                    "value": "RESERVED"
                }
            },
            {
                "id": "9fdec5db-417e-47d5-b5af-c2ba34fc6e67",
                "number": "5",
                "status": {
                    "key": 4,
                    "value": "RESERVED"
                }
            }
        ],
        "tables_count": 3,
        "floor_number": 1,
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "opening_hours": {
            "key": "9 AM - 10 PM",
            "value": "ALL_TIMES"
        },
        "assigned_staff": null
    },
    "message": "The Area has been added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/areas

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

name   string   

Must not be greater than 255 characters. Example: ppagdlzjolgirxtotmgoug

name_ar   string   

Must not be greater than 255 characters. Example: poszziowinlbiuzzhyeiiaiz

status   integer  optional  

Example: 1

Must be one of:
  • 1
  • 2
  • 3
  • 4
opening_hours   string  optional  

Example: 9 AM - 12 PM

Must be one of:
  • 9 AM - 12 PM
  • 12 PM - 6 PM
  • 6 PM - 9 PM
  • 9 PM - 12 AM
  • 9 AM - 10 PM
restaurant_tables   object[]   

Must have at least 1 items.

id   string   

The id of an existing record in the restaurant_tables table. Example: non

floor_number   number  optional  

Must be at least 0. Example: 79

Show Specific Area

requires authentication

This endpoint lets you show specific Area

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5da-406e-4876-bc28-d1d5e1506c0f",
        "branch": {
            "id": "c9dcaa74-ffd4-4a16-9a8d-0783e7afadf0"
        },
        "name": "Freeman Crooks",
        "name_ar": "Marisa Toy III",
        "restaurant_tables": [
            {
                "id": "9fdec5da-87ca-4e8a-a701-67e577e0a6f5",
                "number": "4",
                "status": {
                    "key": 1,
                    "value": "AVAILABLE"
                }
            },
            {
                "id": "9fdec5da-8955-46a6-97e6-9dcbae59fd76",
                "number": "3",
                "status": {
                    "key": 2,
                    "value": "OCCUPIED"
                }
            },
            {
                "id": "9fdec5da-8ae8-43f3-98ed-66e9332741f5",
                "number": "2",
                "status": {
                    "key": 4,
                    "value": "RESERVED"
                }
            }
        ],
        "tables_count": 8,
        "floor_number": 3,
        "status": {
            "key": 3,
            "value": "MAINTENANCE"
        },
        "opening_hours": {
            "key": "9 AM - 12 PM",
            "value": "MORNING"
        },
        "assigned_staff": [
            {
                "id": "38594b5c-844c-492e-bca5-3161b56c3915",
                "name": "Sigmund Schultz"
            },
            {
                "id": "e6ea6b6b-9611-43e6-9f2d-6fbb69bdc0ed",
                "name": "Philip Gulgowski"
            },
            {
                "id": "4720022e-0819-4307-8c45-621ae05b7d07",
                "name": "Estell Bruen"
            }
        ]
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/areas/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the area. Example: 9fdec6fe-926d-49f1-9333-41fc5a95d4d2

Update Specific Area

requires authentication

This endpoint lets you update specific area

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"jzqymvnhpsjrjkyr\",
    \"name_ar\": \"okixkgrurrjqfy\",
    \"status\": 4,
    \"opening_hours\": \"9 PM - 12 AM\",
    \"floor_number\": 35
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "jzqymvnhpsjrjkyr",
    "name_ar": "okixkgrurrjqfy",
    "status": 4,
    "opening_hours": "9 PM - 12 AM",
    "floor_number": 35
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5dc-0857-4c4b-be66-f72512fec325",
        "branch": {
            "id": "14482449-1f2b-49e4-bc75-e27b67c81404"
        },
        "name": "area test",
        "name_ar": "منطقة",
        "restaurant_tables": [
            {
                "id": "9fdec5dc-0acc-434a-a404-1253cd9e0a17",
                "number": "5",
                "status": {
                    "key": 4,
                    "value": "RESERVED"
                }
            },
            {
                "id": "9fdec5dc-0d1e-422d-9908-3d5284444850",
                "number": "3",
                "status": {
                    "key": 1,
                    "value": "AVAILABLE"
                }
            },
            {
                "id": "9fdec5dc-0f6a-4454-818d-eca2d80f787e",
                "number": "4",
                "status": {
                    "key": 3,
                    "value": "LOCK"
                }
            },
            {
                "id": "9fdec5dc-11d6-464a-a6c6-445d99b00b65",
                "number": "9",
                "status": {
                    "key": 1,
                    "value": "AVAILABLE"
                }
            }
        ],
        "tables_count": 4,
        "floor_number": 2,
        "status": {
            "key": 1,
            "value": "ACTIVE"
        },
        "opening_hours": {
            "key": "9 AM - 10 PM",
            "value": "ALL_TIMES"
        },
        "assigned_staff": null
    },
    "message": "The Area has been updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/areas/{id}

PATCH api/v1/restaurants/{restaurant_id}/branches/{branch_id}/areas/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the area. Example: 9fdec6fe-926d-49f1-9333-41fc5a95d4d2

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: jzqymvnhpsjrjkyr

name_ar   string  optional  

Must not be greater than 255 characters. Example: okixkgrurrjqfy

status   integer  optional  

Example: 4

Must be one of:
  • 1
  • 2
  • 3
  • 4
opening_hours   string  optional  

Example: 9 PM - 12 AM

Must be one of:
  • 9 AM - 12 PM
  • 12 PM - 6 PM
  • 6 PM - 9 PM
  • 9 PM - 12 AM
  • 9 AM - 10 PM
floor_number   number  optional  

Must be at least 0. Example: 35

restaurant_tables   object[]  optional  
id   string  optional  

The id of an existing record in the restaurant_tables table.

Delete Specific Area

requires authentication

This endpoint lets you delete specific area

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Area has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/areas/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the area. Example: 9fdec6fe-926d-49f1-9333-41fc5a95d4d2

Delete Specific Table From Specific Area

requires authentication

This endpoint lets you delete specific table from specific area

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2/delete-table" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2/delete-table"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5d6-ca27-40b2-9616-74d57863cf99",
        "branch": {
            "id": "36f61570-d858-4401-a181-71096749af25"
        },
        "name": "June Robel",
        "name_ar": "Chanelle Schamberger V",
        "restaurant_tables": [
            {
                "id": "9fdec5d7-2ff0-471e-aa5e-95d806cb40de",
                "number": "4",
                "status": {
                    "key": 2,
                    "value": "OCCUPIED"
                }
            }
        ],
        "tables_count": 1,
        "floor_number": 1,
        "status": {
            "key": 3,
            "value": "MAINTENANCE"
        },
        "opening_hours": {
            "key": "9 PM - 12 AM",
            "value": "NIGHT"
        },
        "assigned_staff": [
            {
                "id": "c9416da0-3382-4c9a-9ec1-b3873994698d",
                "name": "Marisa Tremblay"
            },
            {
                "id": "c9e6d846-65c5-44fd-ad82-2adaab9f3fd1",
                "name": "Judy Runte"
            },
            {
                "id": "7da597a0-d26a-47a3-b469-b45239cb83a6",
                "name": "Alexys Watsica"
            }
        ]
    },
    "message": "Tables have been deleted from the area successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/areas/{area_id}/delete-table

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

area_id   string   

The ID of the area. Example: 9fdec6fe-926d-49f1-9333-41fc5a95d4d2

Body Parameters

restaurant_tables   object[]  optional  
id   string  optional  

The id of an existing record in the restaurant_tables table.

Table

APIs for Tables Management

Show all tables for a specific branch of restaurant.

requires authentication

This endpoint allows you to Show all tables for a specific branch of restaurant.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables?page=19&per_page=16&filter%5Bid%5D=tempore&filter%5Bstatus%5D=sed&filter%5Bnumber%5D=velit&filter%5Bchairs_count%5D=qui&sort=sit&filter%5Bsearch%5D=veritatis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables"
);

const params = {
    "page": "19",
    "per_page": "16",
    "filter[id]": "tempore",
    "filter[status]": "sed",
    "filter[number]": "velit",
    "filter[chairs_count]": "qui",
    "sort": "sit",
    "filter[search]": "veritatis",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec648-a149-428d-bb2a-10b4590d5df5",
            "number": "011",
            "branch": {
                "id": "0ed11ceb-a9d2-4a7e-ba1f-b9372347717a"
            },
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "image": "http://localhost/storage/restaurants/image.png",
            "qrcode": "http://localhost/storage/restaurants/tmp/phpjemOeJ",
            "chairs_count": 8,
            "additional_notes": "Dignissimos assumenda et dolorem omnis numquam repellendus.",
            "link": "http://localhost/a/99bf47b0-e92d-4ebc-878a-0f179a3ea187",
            "assigned_status": {
                "key": 2,
                "value": "UNASSIGNED"
            },
            "order": null
        },
        {
            "id": "9fdec649-f3d2-4ad5-9eee-4b5bf6a329ec",
            "number": "012",
            "branch": {
                "id": "0ed11ceb-a9d2-4a7e-ba1f-b9372347717a"
            },
            "status": {
                "key": 2,
                "value": "OCCUPIED"
            },
            "image": "http://localhost/storage/restaurants/image.png",
            "qrcode": "http://localhost/storage/restaurants/tmp/phpjemOeJ",
            "chairs_count": 3,
            "additional_notes": "Quo fuga tempora non quisquam.",
            "link": "http://localhost/a/19c1af31-d3d2-4151-bc58-6af7ec9051da",
            "assigned_status": {
                "key": 2,
                "value": "UNASSIGNED"
            },
            "order": null
        },
        {
            "id": "9fdec649-de75-4b2a-a20c-6468ab15eb93",
            "number": "013",
            "branch": {
                "id": "0ed11ceb-a9d2-4a7e-ba1f-b9372347717a"
            },
            "status": {
                "key": 4,
                "value": "RESERVED"
            },
            "image": "http://localhost/storage/restaurants/image.png",
            "qrcode": "http://localhost/storage/restaurants/tmp/phpjemOeJ",
            "chairs_count": 6,
            "additional_notes": "Ut eveniet dolore aliquid ut.",
            "link": "http://localhost/a/b36a4afa-e23a-4c53-bc2d-47058ac545e8",
            "assigned_status": {
                "key": 2,
                "value": "UNASSIGNED"
            },
            "order": null
        },
        {
            "id": "9fdec649-1520-4813-b3bd-9a319822ad10",
            "number": "014",
            "branch": {
                "id": "0ed11ceb-a9d2-4a7e-ba1f-b9372347717a"
            },
            "status": {
                "key": 3,
                "value": "LOCK"
            },
            "image": "http://localhost/storage/restaurants/image.png",
            "qrcode": "http://localhost/storage/restaurants/tmp/phpjemOeJ",
            "chairs_count": 6,
            "additional_notes": "Tempora dolorum quia facere eum consectetur.",
            "link": "http://localhost/a/582350c8-1160-4c85-a2d5-2a545d99cfb5",
            "assigned_status": {
                "key": 2,
                "value": "UNASSIGNED"
            },
            "order": null
        },
        {
            "id": "9fdec649-b09f-4321-b07c-c00aaa10bc01",
            "number": "015",
            "branch": {
                "id": "0ed11ceb-a9d2-4a7e-ba1f-b9372347717a"
            },
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "image": "http://localhost/storage/restaurants/image.png",
            "qrcode": "http://localhost/storage/restaurants/tmp/phpjemOeJ",
            "chairs_count": 6,
            "additional_notes": "Debitis aut officia reiciendis.",
            "link": "http://localhost/a/9f53f9b7-3967-4e13-92da-04df97435005",
            "assigned_status": {
                "key": 2,
                "value": "UNASSIGNED"
            },
            "order": null
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 19

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 16

filter[id]   string  optional  

Field to filter items by id. Example: tempore

filter[status]   string  optional  

Field to filter items by status. Example: sed

filter[number]   string  optional  

Field to filter items by number. Example: velit

filter[chairs_count]   string  optional  

Field to filter items by chairs_count. Example: qui

sort   string  optional  

Field to sort items by number ,status. Example: sit

filter[search]   string  optional  

Field to perform a custom search. Example: veritatis

Add new table in a specific branch within a restaurant.

requires authentication

This endpoint allows you to add a new table in a specific branch within a restaurant.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tables\": [
        {
            \"number\": \"wubr\",
            \"chairs_count\": 65
        }
    ]
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "tables": [
        {
            "number": "wubr",
            "chairs_count": 65
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec656-7541-4e76-ab62-f0d791d7b730",
            "number": "15",
            "chairs_count": 4
        },
        {
            "id": "9fdec656-fa9b-4e77-8e3b-968e0bc2c8db",
            "number": "16",
            "chairs_count": 10
        },
        {
            "id": "9fdec657-77a6-443d-bcdb-4ad64e988808",
            "number": "17",
            "chairs_count": 8
        },
        {
            "id": "9fdec657-e925-4b36-b0d2-b29d9a0ae384",
            "number": "18",
            "chairs_count": 4
        }
    ],
    "message": "The tables have been added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

tables   object[]   
number   string   

Must not be greater than 4 characters. Example: wubr

chairs_count   number   

Must be at least 0. Example: 65

Show a specific table in a specific branch of a restaurant.

requires authentication

This endpoint allows you show a specific table in a specific branch of a restaurant.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec64c-923e-4376-ad78-ef1b027baa04",
        "number": "3",
        "branch": {
            "id": "ba9d9e21-8db1-4627-baa0-c70dad9610e3"
        },
        "status": {
            "key": 1,
            "value": "AVAILABLE"
        },
        "image": "http://localhost/storage/restaurants/image.png",
        "qrcode": "http://localhost/storage/restaurants/qr.png",
        "chairs_count": 6,
        "additional_notes": "Harum aliquid aspernatur consequatur ut id consequatur illo.",
        "link": "http://localhost/a/fb4a6b43-b623-41bd-b48d-d38f745b4006",
        "assigned_status": {
            "key": 2,
            "value": "UNASSIGNED"
        },
        "order": null
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Update the details of a table within a specific branch of a restaurant.

requires authentication

This endpoint allows you to update the details of a table within a specific branch of a restaurant.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "number=vsfdnni"\
    --form "chairs_count=67"\
    --form "status=3"\
    --form "additional_notes=voluptas"\
    --form "image=@/tmp/phpGaDnOb" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('number', 'vsfdnni');
body.append('chairs_count', '67');
body.append('status', '3');
body.append('additional_notes', 'voluptas');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec655-3acf-43e7-8518-e15da157888d",
        "number": "111",
        "branch": {
            "id": "b616b3ba-da91-493c-9583-f9ac7bff280f"
        },
        "status": {
            "key": 1,
            "value": "AVAILABLE"
        },
        "image": "http://localhost/storage/restaurants/image.png",
        "qrcode": "http://localhost/storage/restaurants/9fdec655-16b8-4ae2-9785-ef392a1c3885/b616b3ba-da91-493c-9583-f9ac7bff280f/tables/qr_68c5c56669f84.svg",
        "chairs_count": 5,
        "additional_notes": "this table is available now",
        "link": "http://localhost/a/ddf963a3-27b0-46e9-a139-271ea61423e4",
        "assigned_status": {
            "key": 2,
            "value": "UNASSIGNED"
        },
        "order": null
    },
    "message": "The table has been updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{id}

PATCH api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Body Parameters

number   string  optional  

Must not be greater than 255 characters. Example: vsfdnni

chairs_count   number  optional  

Must be at least 0. Example: 67

status   integer  optional  

Example: 3

Must be one of:
  • 1
  • 2
  • 3
  • 4
qrcode   string  optional  
image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpGaDnOb

additional_notes   string  optional  

Example: voluptas

Delete a specific table from a specific restaurant branch.

requires authentication

This endpoint allows you to delete a specific table from a specific restaurant branch.

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The table has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Update the status of a specific restaurant table to available.

requires authentication

This endpoint lets you update the status of a specific restaurant table to available.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/mark-status-available" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/mark-status-available"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The table status has been updated to available.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{restaurant_table_id}/mark-status-available

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

restaurant_table_id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Update the status of a specific restaurant table to occupied.

requires authentication

This endpoint lets you update the status of a specific restaurant table to occupied.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/mark-status-occupied" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/mark-status-occupied"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The table status has been updated to occupied.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{restaurant_table_id}/mark-status-occupied

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

restaurant_table_id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Update the status of a specific restaurant table to reserved.

requires authentication

This endpoint lets you update the status of a specific restaurant table to reserved.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/mark-status-reserved" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/mark-status-reserved"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The table status has been updated to reserved.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{restaurant_table_id}/mark-status-reserved

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

restaurant_table_id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Update the status of a specific restaurant table to locked.

requires authentication

This endpoint lets you update the status of a specific restaurant table to locked.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/mark-status-locked" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/mark-status-locked"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The table status has been updated to locked.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{restaurant_table_id}/mark-status-locked

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

restaurant_table_id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Generate a QR code for a restaurant table.

requires authentication

This endpoint allows you to generate a QR code for a specific restaurant table.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/qr" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "dots_shape=dot"\
    --form "border_shape=square-with-dot"\
    --form "isGradient=1"\
    --form "isRadialGradient="\
    --form "logo=@/tmp/phpcdHgdn" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/qr"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('dots_shape', 'dot');
body.append('border_shape', 'square-with-dot');
body.append('isGradient', '1');
body.append('isRadialGradient', '');
body.append('logo', document.querySelector('input[name="logo"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "qr_code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<svg xmlns=\"http://www.w3.org/2000/svg\" class=\"qr-svg qrcode\" viewBox=\"0 0 65 65\" preserveAspectRatio=\"xMidYMid\">\n<defs>    <radialGradient id=\"gradient1\">\n        <stop offset=\"0%\" stop-color=\"#534e9c\"/>\n        <stop offset=\"100%\" stop-color=\"#7a4e9c\"/>\n    </radialGradient>\n    <style><![CDATA[\n        .dark { fill: url(#gradient1); }\n        .qr-finder-dark { fill: #7a4e9c; }\n        svg.qr-svg { background-color: #fff; }\n    ]]></style>\n</defs>\n<path class=\"qr-darkmodule dark qrcode\" d=\"M12 53 h1v1h-1z\"/>\n<path class=\"qr-data-dark dark qrcode\" d=\"M14 4 h1v1h-1z M16 4 h1v1h-1z M17 4 h1v1h-1z M19 4 h1v1h-1z M20 4 h1v1h-1z M23 4 h1v1h-1z M25 4 h1v1h-1z M27 4 h1v1h-1z M28 4 h1v1h-1z M29 4 h1v1h-1z M30 4 h1v1h-1z M31 4 h1v1h-1z M32 4 h1v1h-1z M33 4 h1v1h-1z M34 4 h1v1h-1z M35 4 h1v1h-1z M37 4 h1v1h-1z M38 4 h1v1h-1z M39 4 h1v1h-1z M40 4 h1v1h-1z M41 4 h1v1h-1z M42 4 h1v1h-1z M43 4 h1v1h-1z M44 4 h1v1h-1z M45 4 h1v1h-1z M46 4 h1v1h-1z M47 4 h1v1h-1z M15 5 h1v1h-1z M17 5 h1v1h-1z M19 5 h1v1h-1z M22 5 h1v1h-1z M23 5 h1v1h-1z M26 5 h1v1h-1z M27 5 h1v1h-1z M28 5 h1v1h-1z M30 5 h1v1h-1z M31 5 h1v1h-1z M32 5 h1v1h-1z M33 5 h1v1h-1z M37 5 h1v1h-1z M38 5 h1v1h-1z M44 5 h1v1h-1z M47 5 h1v1h-1z M49 5 h1v1h-1z M14 6 h1v1h-1z M15 6 h1v1h-1z M16 6 h1v1h-1z M17 6 h1v1h-1z M20 6 h1v1h-1z M21 6 h1v1h-1z M22 6 h1v1h-1z M25 6 h1v1h-1z M27 6 h1v1h-1z M28 6 h1v1h-1z M29 6 h1v1h-1z M31 6 h1v1h-1z M33 6 h1v1h-1z M34 6 h1v1h-1z M35 6 h1v1h-1z M36 6 h1v1h-1z M37 6 h1v1h-1z M38 6 h1v1h-1z M45 6 h1v1h-1z M48 6 h1v1h-1z M13 7 h1v1h-1z M15 7 h1v1h-1z M16 7 h1v1h-1z M20 7 h1v1h-1z M21 7 h1v1h-1z M22 7 h1v1h-1z M25 7 h1v1h-1z M27 7 h1v1h-1z M29 7 h1v1h-1z M30 7 h1v1h-1z M31 7 h1v1h-1z M33 7 h1v1h-1z M35 7 h1v1h-1z M38 7 h1v1h-1z M41 7 h1v1h-1z M43 7 h1v1h-1z M45 7 h1v1h-1z M46 7 h1v1h-1z M47 7 h1v1h-1z M14 8 h1v1h-1z M17 8 h1v1h-1z M18 8 h1v1h-1z M19 8 h1v1h-1z M20 8 h1v1h-1z M24 8 h1v1h-1z M25 8 h1v1h-1z M26 8 h1v1h-1z M27 8 h1v1h-1z M29 8 h1v1h-1z M36 8 h1v1h-1z M37 8 h1v1h-1z M39 8 h1v1h-1z M40 8 h1v1h-1z M46 8 h1v1h-1z M49 8 h1v1h-1z M14 9 h1v1h-1z\nM15 9 h1v1h-1z M17 9 h1v1h-1z M18 9 h1v1h-1z M19 9 h1v1h-1z M20 9 h1v1h-1z M23 9 h1v1h-1z M28 9 h1v1h-1z M35 9 h1v1h-1z M37 9 h1v1h-1z M41 9 h1v1h-1z M43 9 h1v1h-1z M45 9 h1v1h-1z M47 9 h1v1h-1z M48 9 h1v1h-1z M49 9 h1v1h-1z M15 11 h1v1h-1z M16 11 h1v1h-1z M17 11 h1v1h-1z M20 11 h1v1h-1z M24 11 h1v1h-1z M25 11 h1v1h-1z M26 11 h1v1h-1z M27 11 h1v1h-1z M36 11 h1v1h-1z M43 11 h1v1h-1z M46 11 h1v1h-1z M47 11 h1v1h-1z M50 11 h1v1h-1z M51 11 h1v1h-1z M16 12 h1v1h-1z M19 12 h1v1h-1z M20 12 h1v1h-1z M26 12 h1v1h-1z M27 12 h1v1h-1z M37 12 h1v1h-1z M38 12 h1v1h-1z M41 12 h1v1h-1z M44 12 h1v1h-1z M45 12 h1v1h-1z M49 12 h1v1h-1z M50 12 h1v1h-1z M51 12 h1v1h-1z M52 12 h1v1h-1z M4 13 h1v1h-1z M7 13 h1v1h-1z M8 13 h1v1h-1z M9 13 h1v1h-1z M15 13 h1v1h-1z M16 13 h1v1h-1z M18 13 h1v1h-1z M19 13 h1v1h-1z M24 13 h1v1h-1z M25 13 h1v1h-1z M26 13 h1v1h-1z M28 13 h1v1h-1z M30 13 h1v1h-1z M35 13 h1v1h-1z M37 13 h1v1h-1z M38 13 h1v1h-1z M39 13 h1v1h-1z M43 13 h1v1h-1z M44 13 h1v1h-1z M46 13 h1v1h-1z M47 13 h1v1h-1z M50 13 h1v1h-1z M52 13 h1v1h-1z M53 13 h1v1h-1z M56 13 h1v1h-1z M58 13 h1v1h-1z M60 13 h1v1h-1z M4 14 h1v1h-1z M5 14 h1v1h-1z M8 14 h1v1h-1z M11 14 h1v1h-1z M14 14 h1v1h-1z M15 14 h1v1h-1z M19 14 h1v1h-1z M21 14 h1v1h-1z M25 14 h1v1h-1z M26 14 h1v1h-1z M27 14 h1v1h-1z M29 14 h1v1h-1z M31 14 h1v1h-1z M32 14 h1v1h-1z M36 14 h1v1h-1z M37 14 h1v1h-1z M41 14 h1v1h-1z M44 14 h1v1h-1z M45 14 h1v1h-1z M49 14 h1v1h-1z M51 14 h1v1h-1z M52 14 h1v1h-1z M54 14 h1v1h-1z M56 14 h1v1h-1z M57 14 h1v1h-1z M58 14 h1v1h-1z M59 14 h1v1h-1z M4 15 h1v1h-1z M5 15 h1v1h-1z M9 15 h1v1h-1z\nM13 15 h1v1h-1z M15 15 h1v1h-1z M18 15 h1v1h-1z M19 15 h1v1h-1z M24 15 h1v1h-1z M26 15 h1v1h-1z M30 15 h1v1h-1z M31 15 h1v1h-1z M36 15 h1v1h-1z M37 15 h1v1h-1z M40 15 h1v1h-1z M41 15 h1v1h-1z M42 15 h1v1h-1z M44 15 h1v1h-1z M45 15 h1v1h-1z M47 15 h1v1h-1z M49 15 h1v1h-1z M50 15 h1v1h-1z M52 15 h1v1h-1z M53 15 h1v1h-1z M56 15 h1v1h-1z M58 15 h1v1h-1z M4 16 h1v1h-1z M8 16 h1v1h-1z M9 16 h1v1h-1z M13 16 h1v1h-1z M14 16 h1v1h-1z M17 16 h1v1h-1z M19 16 h1v1h-1z M26 16 h1v1h-1z M27 16 h1v1h-1z M28 16 h1v1h-1z M29 16 h1v1h-1z M30 16 h1v1h-1z M31 16 h1v1h-1z M33 16 h1v1h-1z M34 16 h1v1h-1z M36 16 h1v1h-1z M37 16 h1v1h-1z M38 16 h1v1h-1z M39 16 h1v1h-1z M40 16 h1v1h-1z M43 16 h1v1h-1z M49 16 h1v1h-1z M50 16 h1v1h-1z M52 16 h1v1h-1z M54 16 h1v1h-1z M57 16 h1v1h-1z M58 16 h1v1h-1z M59 16 h1v1h-1z M4 17 h1v1h-1z M7 17 h1v1h-1z M8 17 h1v1h-1z M11 17 h1v1h-1z M13 17 h1v1h-1z M15 17 h1v1h-1z M17 17 h1v1h-1z M18 17 h1v1h-1z M19 17 h1v1h-1z M20 17 h1v1h-1z M23 17 h1v1h-1z M26 17 h1v1h-1z M33 17 h1v1h-1z M36 17 h1v1h-1z M39 17 h1v1h-1z M41 17 h1v1h-1z M44 17 h1v1h-1z M45 17 h1v1h-1z M47 17 h1v1h-1z M49 17 h1v1h-1z M51 17 h1v1h-1z M55 17 h1v1h-1z M57 17 h1v1h-1z M60 17 h1v1h-1z M4 18 h1v1h-1z M6 18 h1v1h-1z M11 18 h1v1h-1z M12 18 h1v1h-1z M13 18 h1v1h-1z M15 18 h1v1h-1z M24 18 h1v1h-1z M25 18 h1v1h-1z M26 18 h1v1h-1z M27 18 h1v1h-1z M30 18 h1v1h-1z M31 18 h1v1h-1z M32 18 h1v1h-1z M34 18 h1v1h-1z M35 18 h1v1h-1z M37 18 h1v1h-1z M38 18 h1v1h-1z M42 18 h1v1h-1z M43 18 h1v1h-1z M46 18 h1v1h-1z M49 18 h1v1h-1z M50 18 h1v1h-1z M54 18 h1v1h-1z M59 18 h1v1h-1z M5 19 h1v1h-1z M6 19 h1v1h-1z\nM9 19 h1v1h-1z M15 19 h1v1h-1z M18 19 h1v1h-1z M19 19 h1v1h-1z M20 19 h1v1h-1z M22 19 h1v1h-1z M28 19 h1v1h-1z M30 19 h1v1h-1z M31 19 h1v1h-1z M32 19 h1v1h-1z M33 19 h1v1h-1z M34 19 h1v1h-1z M35 19 h1v1h-1z M38 19 h1v1h-1z M39 19 h1v1h-1z M41 19 h1v1h-1z M44 19 h1v1h-1z M46 19 h1v1h-1z M49 19 h1v1h-1z M50 19 h1v1h-1z M51 19 h1v1h-1z M53 19 h1v1h-1z M57 19 h1v1h-1z M59 19 h1v1h-1z M6 20 h1v1h-1z M7 20 h1v1h-1z M8 20 h1v1h-1z M9 20 h1v1h-1z M11 20 h1v1h-1z M17 20 h1v1h-1z M19 20 h1v1h-1z M22 20 h1v1h-1z M25 20 h1v1h-1z M26 20 h1v1h-1z M27 20 h1v1h-1z M28 20 h1v1h-1z M29 20 h1v1h-1z M33 20 h1v1h-1z M39 20 h1v1h-1z M40 20 h1v1h-1z M42 20 h1v1h-1z M43 20 h1v1h-1z M45 20 h1v1h-1z M46 20 h1v1h-1z M47 20 h1v1h-1z M48 20 h1v1h-1z M51 20 h1v1h-1z M54 20 h1v1h-1z M55 20 h1v1h-1z M58 20 h1v1h-1z M4 21 h1v1h-1z M8 21 h1v1h-1z M11 21 h1v1h-1z M13 21 h1v1h-1z M14 21 h1v1h-1z M16 21 h1v1h-1z M17 21 h1v1h-1z M19 21 h1v1h-1z M20 21 h1v1h-1z M22 21 h1v1h-1z M24 21 h1v1h-1z M26 21 h1v1h-1z M29 21 h1v1h-1z M31 21 h1v1h-1z M34 21 h1v1h-1z M35 21 h1v1h-1z M37 21 h1v1h-1z M40 21 h1v1h-1z M43 21 h1v1h-1z M46 21 h1v1h-1z M48 21 h1v1h-1z M52 21 h1v1h-1z M58 21 h1v1h-1z M59 21 h1v1h-1z M60 21 h1v1h-1z M4 22 h1v1h-1z M5 22 h1v1h-1z M6 22 h1v1h-1z M11 22 h1v1h-1z M14 22 h1v1h-1z M16 22 h1v1h-1z M21 22 h1v1h-1z M22 22 h1v1h-1z M23 22 h1v1h-1z M25 22 h1v1h-1z M26 22 h1v1h-1z M27 22 h1v1h-1z M30 22 h1v1h-1z M31 22 h1v1h-1z M32 22 h1v1h-1z M33 22 h1v1h-1z M35 22 h1v1h-1z M37 22 h1v1h-1z M38 22 h1v1h-1z M39 22 h1v1h-1z M40 22 h1v1h-1z M42 22 h1v1h-1z M45 22 h1v1h-1z M46 22 h1v1h-1z M47 22 h1v1h-1z\nM48 22 h1v1h-1z M49 22 h1v1h-1z M50 22 h1v1h-1z M51 22 h1v1h-1z M52 22 h1v1h-1z M53 22 h1v1h-1z M54 22 h1v1h-1z M55 22 h1v1h-1z M57 22 h1v1h-1z M58 22 h1v1h-1z M59 22 h1v1h-1z M4 23 h1v1h-1z M5 23 h1v1h-1z M8 23 h1v1h-1z M12 23 h1v1h-1z M13 23 h1v1h-1z M16 23 h1v1h-1z M18 23 h1v1h-1z M19 23 h1v1h-1z M20 23 h1v1h-1z M21 23 h1v1h-1z M23 23 h1v1h-1z M28 23 h1v1h-1z M32 23 h1v1h-1z M33 23 h1v1h-1z M34 23 h1v1h-1z M35 23 h1v1h-1z M37 23 h1v1h-1z M43 23 h1v1h-1z M44 23 h1v1h-1z M45 23 h1v1h-1z M47 23 h1v1h-1z M49 23 h1v1h-1z M53 23 h1v1h-1z M54 23 h1v1h-1z M58 23 h1v1h-1z M59 23 h1v1h-1z M60 23 h1v1h-1z M4 24 h1v1h-1z M6 24 h1v1h-1z M8 24 h1v1h-1z M12 24 h1v1h-1z M13 24 h1v1h-1z M14 24 h1v1h-1z M15 24 h1v1h-1z M16 24 h1v1h-1z M17 24 h1v1h-1z M21 24 h1v1h-1z M23 24 h1v1h-1z M50 24 h1v1h-1z M51 24 h1v1h-1z M54 24 h1v1h-1z M55 24 h1v1h-1z M57 24 h1v1h-1z M58 24 h1v1h-1z M59 24 h1v1h-1z M60 24 h1v1h-1z M4 25 h1v1h-1z M11 25 h1v1h-1z M13 25 h1v1h-1z M14 25 h1v1h-1z M17 25 h1v1h-1z M19 25 h1v1h-1z M21 25 h1v1h-1z M22 25 h1v1h-1z M45 25 h1v1h-1z M47 25 h1v1h-1z M52 25 h1v1h-1z M53 25 h1v1h-1z M54 25 h1v1h-1z M58 25 h1v1h-1z M59 25 h1v1h-1z M60 25 h1v1h-1z M4 26 h1v1h-1z M8 26 h1v1h-1z M11 26 h1v1h-1z M13 26 h1v1h-1z M16 26 h1v1h-1z M18 26 h1v1h-1z M19 26 h1v1h-1z M21 26 h1v1h-1z M22 26 h1v1h-1z M23 26 h1v1h-1z M42 26 h1v1h-1z M43 26 h1v1h-1z M46 26 h1v1h-1z M49 26 h1v1h-1z M50 26 h1v1h-1z M52 26 h1v1h-1z M55 26 h1v1h-1z M57 26 h1v1h-1z M58 26 h1v1h-1z M7 27 h1v1h-1z M8 27 h1v1h-1z M9 27 h1v1h-1z M11 27 h1v1h-1z M12 27 h1v1h-1z M13 27 h1v1h-1z M14 27 h1v1h-1z M16 27 h1v1h-1z\nM18 27 h1v1h-1z M19 27 h1v1h-1z M21 27 h1v1h-1z M22 27 h1v1h-1z M43 27 h1v1h-1z M45 27 h1v1h-1z M48 27 h1v1h-1z M49 27 h1v1h-1z M50 27 h1v1h-1z M51 27 h1v1h-1z M52 27 h1v1h-1z M55 27 h1v1h-1z M58 27 h1v1h-1z M8 28 h1v1h-1z M9 28 h1v1h-1z M11 28 h1v1h-1z M16 28 h1v1h-1z M18 28 h1v1h-1z M21 28 h1v1h-1z M41 28 h1v1h-1z M44 28 h1v1h-1z M47 28 h1v1h-1z M49 28 h1v1h-1z M51 28 h1v1h-1z M53 28 h1v1h-1z M56 28 h1v1h-1z M57 28 h1v1h-1z M58 28 h1v1h-1z M4 29 h1v1h-1z M5 29 h1v1h-1z M6 29 h1v1h-1z M12 29 h1v1h-1z M13 29 h1v1h-1z M15 29 h1v1h-1z M16 29 h1v1h-1z M17 29 h1v1h-1z M43 29 h1v1h-1z M44 29 h1v1h-1z M45 29 h1v1h-1z M48 29 h1v1h-1z M49 29 h1v1h-1z M52 29 h1v1h-1z M55 29 h1v1h-1z M56 29 h1v1h-1z M57 29 h1v1h-1z M58 29 h1v1h-1z M4 30 h1v1h-1z M5 30 h1v1h-1z M14 30 h1v1h-1z M16 30 h1v1h-1z M17 30 h1v1h-1z M20 30 h1v1h-1z M21 30 h1v1h-1z M23 30 h1v1h-1z M41 30 h1v1h-1z M44 30 h1v1h-1z M46 30 h1v1h-1z M50 30 h1v1h-1z M51 30 h1v1h-1z M57 30 h1v1h-1z M59 30 h1v1h-1z M60 30 h1v1h-1z M4 31 h1v1h-1z M7 31 h1v1h-1z M13 31 h1v1h-1z M15 31 h1v1h-1z M16 31 h1v1h-1z M19 31 h1v1h-1z M20 31 h1v1h-1z M41 31 h1v1h-1z M42 31 h1v1h-1z M43 31 h1v1h-1z M45 31 h1v1h-1z M48 31 h1v1h-1z M49 31 h1v1h-1z M51 31 h1v1h-1z M57 31 h1v1h-1z M58 31 h1v1h-1z M60 31 h1v1h-1z M6 32 h1v1h-1z M15 32 h1v1h-1z M16 32 h1v1h-1z M19 32 h1v1h-1z M20 32 h1v1h-1z M23 32 h1v1h-1z M42 32 h1v1h-1z M44 32 h1v1h-1z M45 32 h1v1h-1z M51 32 h1v1h-1z M59 32 h1v1h-1z M60 32 h1v1h-1z M4 33 h1v1h-1z M13 33 h1v1h-1z M14 33 h1v1h-1z M16 33 h1v1h-1z M17 33 h1v1h-1z M19 33 h1v1h-1z M21 33 h1v1h-1z M23 33 h1v1h-1z M41 33 h1v1h-1z\nM42 33 h1v1h-1z M43 33 h1v1h-1z M44 33 h1v1h-1z M45 33 h1v1h-1z M46 33 h1v1h-1z M49 33 h1v1h-1z M51 33 h1v1h-1z M58 33 h1v1h-1z M4 34 h1v1h-1z M5 34 h1v1h-1z M6 34 h1v1h-1z M7 34 h1v1h-1z M15 34 h1v1h-1z M16 34 h1v1h-1z M17 34 h1v1h-1z M21 34 h1v1h-1z M23 34 h1v1h-1z M44 34 h1v1h-1z M47 34 h1v1h-1z M51 34 h1v1h-1z M57 34 h1v1h-1z M59 34 h1v1h-1z M60 34 h1v1h-1z M4 35 h1v1h-1z M5 35 h1v1h-1z M6 35 h1v1h-1z M11 35 h1v1h-1z M12 35 h1v1h-1z M13 35 h1v1h-1z M15 35 h1v1h-1z M19 35 h1v1h-1z M20 35 h1v1h-1z M22 35 h1v1h-1z M23 35 h1v1h-1z M46 35 h1v1h-1z M48 35 h1v1h-1z M50 35 h1v1h-1z M51 35 h1v1h-1z M52 35 h1v1h-1z M53 35 h1v1h-1z M56 35 h1v1h-1z M57 35 h1v1h-1z M58 35 h1v1h-1z M60 35 h1v1h-1z M4 36 h1v1h-1z M5 36 h1v1h-1z M6 36 h1v1h-1z M13 36 h1v1h-1z M14 36 h1v1h-1z M15 36 h1v1h-1z M16 36 h1v1h-1z M18 36 h1v1h-1z M20 36 h1v1h-1z M23 36 h1v1h-1z M41 36 h1v1h-1z M43 36 h1v1h-1z M45 36 h1v1h-1z M47 36 h1v1h-1z M49 36 h1v1h-1z M50 36 h1v1h-1z M52 36 h1v1h-1z M53 36 h1v1h-1z M54 36 h1v1h-1z M57 36 h1v1h-1z M59 36 h1v1h-1z M60 36 h1v1h-1z M4 37 h1v1h-1z M8 37 h1v1h-1z M9 37 h1v1h-1z M11 37 h1v1h-1z M16 37 h1v1h-1z M17 37 h1v1h-1z M21 37 h1v1h-1z M22 37 h1v1h-1z M23 37 h1v1h-1z M46 37 h1v1h-1z M50 37 h1v1h-1z M52 37 h1v1h-1z M54 37 h1v1h-1z M55 37 h1v1h-1z M57 37 h1v1h-1z M58 37 h1v1h-1z M59 37 h1v1h-1z M4 38 h1v1h-1z M5 38 h1v1h-1z M6 38 h1v1h-1z M8 38 h1v1h-1z M11 38 h1v1h-1z M12 38 h1v1h-1z M15 38 h1v1h-1z M16 38 h1v1h-1z M18 38 h1v1h-1z M21 38 h1v1h-1z M23 38 h1v1h-1z M41 38 h1v1h-1z M43 38 h1v1h-1z M45 38 h1v1h-1z M47 38 h1v1h-1z M49 38 h1v1h-1z M53 38 h1v1h-1z\nM54 38 h1v1h-1z M4 39 h1v1h-1z M6 39 h1v1h-1z M8 39 h1v1h-1z M11 39 h1v1h-1z M12 39 h1v1h-1z M13 39 h1v1h-1z M15 39 h1v1h-1z M18 39 h1v1h-1z M22 39 h1v1h-1z M23 39 h1v1h-1z M41 39 h1v1h-1z M42 39 h1v1h-1z M43 39 h1v1h-1z M48 39 h1v1h-1z M49 39 h1v1h-1z M52 39 h1v1h-1z M55 39 h1v1h-1z M57 39 h1v1h-1z M58 39 h1v1h-1z M59 39 h1v1h-1z M4 40 h1v1h-1z M6 40 h1v1h-1z M7 40 h1v1h-1z M8 40 h1v1h-1z M11 40 h1v1h-1z M12 40 h1v1h-1z M13 40 h1v1h-1z M14 40 h1v1h-1z M15 40 h1v1h-1z M42 40 h1v1h-1z M44 40 h1v1h-1z M46 40 h1v1h-1z M47 40 h1v1h-1z M53 40 h1v1h-1z M54 40 h1v1h-1z M55 40 h1v1h-1z M56 40 h1v1h-1z M8 41 h1v1h-1z M11 41 h1v1h-1z M12 41 h1v1h-1z M15 41 h1v1h-1z M17 41 h1v1h-1z M18 41 h1v1h-1z M19 41 h1v1h-1z M21 41 h1v1h-1z M22 41 h1v1h-1z M23 41 h1v1h-1z M24 41 h1v1h-1z M25 41 h1v1h-1z M26 41 h1v1h-1z M29 41 h1v1h-1z M30 41 h1v1h-1z M31 41 h1v1h-1z M33 41 h1v1h-1z M34 41 h1v1h-1z M35 41 h1v1h-1z M36 41 h1v1h-1z M37 41 h1v1h-1z M38 41 h1v1h-1z M40 41 h1v1h-1z M41 41 h1v1h-1z M42 41 h1v1h-1z M43 41 h1v1h-1z M44 41 h1v1h-1z M46 41 h1v1h-1z M47 41 h1v1h-1z M48 41 h1v1h-1z M49 41 h1v1h-1z M52 41 h1v1h-1z M54 41 h1v1h-1z M57 41 h1v1h-1z M58 41 h1v1h-1z M5 42 h1v1h-1z M6 42 h1v1h-1z M9 42 h1v1h-1z M13 42 h1v1h-1z M16 42 h1v1h-1z M20 42 h1v1h-1z M25 42 h1v1h-1z M26 42 h1v1h-1z M28 42 h1v1h-1z M29 42 h1v1h-1z M30 42 h1v1h-1z M35 42 h1v1h-1z M36 42 h1v1h-1z M38 42 h1v1h-1z M40 42 h1v1h-1z M44 42 h1v1h-1z M45 42 h1v1h-1z M47 42 h1v1h-1z M48 42 h1v1h-1z M53 42 h1v1h-1z M54 42 h1v1h-1z M56 42 h1v1h-1z M59 42 h1v1h-1z M60 42 h1v1h-1z M4 43 h1v1h-1z M5 43 h1v1h-1z M6 43 h1v1h-1z\nM7 43 h1v1h-1z M9 43 h1v1h-1z M11 43 h1v1h-1z M12 43 h1v1h-1z M14 43 h1v1h-1z M15 43 h1v1h-1z M16 43 h1v1h-1z M17 43 h1v1h-1z M18 43 h1v1h-1z M21 43 h1v1h-1z M23 43 h1v1h-1z M24 43 h1v1h-1z M25 43 h1v1h-1z M29 43 h1v1h-1z M30 43 h1v1h-1z M32 43 h1v1h-1z M33 43 h1v1h-1z M34 43 h1v1h-1z M35 43 h1v1h-1z M39 43 h1v1h-1z M41 43 h1v1h-1z M42 43 h1v1h-1z M43 43 h1v1h-1z M45 43 h1v1h-1z M46 43 h1v1h-1z M49 43 h1v1h-1z M52 43 h1v1h-1z M55 43 h1v1h-1z M58 43 h1v1h-1z M60 43 h1v1h-1z M5 44 h1v1h-1z M6 44 h1v1h-1z M7 44 h1v1h-1z M8 44 h1v1h-1z M11 44 h1v1h-1z M12 44 h1v1h-1z M13 44 h1v1h-1z M15 44 h1v1h-1z M16 44 h1v1h-1z M19 44 h1v1h-1z M21 44 h1v1h-1z M24 44 h1v1h-1z M26 44 h1v1h-1z M31 44 h1v1h-1z M32 44 h1v1h-1z M33 44 h1v1h-1z M34 44 h1v1h-1z M35 44 h1v1h-1z M36 44 h1v1h-1z M37 44 h1v1h-1z M38 44 h1v1h-1z M40 44 h1v1h-1z M42 44 h1v1h-1z M43 44 h1v1h-1z M47 44 h1v1h-1z M48 44 h1v1h-1z M53 44 h1v1h-1z M56 44 h1v1h-1z M57 44 h1v1h-1z M59 44 h1v1h-1z M60 44 h1v1h-1z M8 45 h1v1h-1z M9 45 h1v1h-1z M11 45 h1v1h-1z M12 45 h1v1h-1z M15 45 h1v1h-1z M17 45 h1v1h-1z M18 45 h1v1h-1z M22 45 h1v1h-1z M23 45 h1v1h-1z M24 45 h1v1h-1z M25 45 h1v1h-1z M26 45 h1v1h-1z M27 45 h1v1h-1z M29 45 h1v1h-1z M33 45 h1v1h-1z M34 45 h1v1h-1z M36 45 h1v1h-1z M38 45 h1v1h-1z M40 45 h1v1h-1z M41 45 h1v1h-1z M42 45 h1v1h-1z M45 45 h1v1h-1z M46 45 h1v1h-1z M48 45 h1v1h-1z M49 45 h1v1h-1z M52 45 h1v1h-1z M55 45 h1v1h-1z M57 45 h1v1h-1z M60 45 h1v1h-1z M5 46 h1v1h-1z M6 46 h1v1h-1z M8 46 h1v1h-1z M9 46 h1v1h-1z M13 46 h1v1h-1z M14 46 h1v1h-1z M16 46 h1v1h-1z M20 46 h1v1h-1z M22 46 h1v1h-1z M24 46 h1v1h-1z\nM26 46 h1v1h-1z M27 46 h1v1h-1z M28 46 h1v1h-1z M30 46 h1v1h-1z M31 46 h1v1h-1z M33 46 h1v1h-1z M37 46 h1v1h-1z M47 46 h1v1h-1z M48 46 h1v1h-1z M52 46 h1v1h-1z M53 46 h1v1h-1z M55 46 h1v1h-1z M56 46 h1v1h-1z M59 46 h1v1h-1z M4 47 h1v1h-1z M5 47 h1v1h-1z M6 47 h1v1h-1z M7 47 h1v1h-1z M8 47 h1v1h-1z M9 47 h1v1h-1z M11 47 h1v1h-1z M12 47 h1v1h-1z M13 47 h1v1h-1z M14 47 h1v1h-1z M18 47 h1v1h-1z M20 47 h1v1h-1z M21 47 h1v1h-1z M22 47 h1v1h-1z M23 47 h1v1h-1z M24 47 h1v1h-1z M29 47 h1v1h-1z M32 47 h1v1h-1z M33 47 h1v1h-1z M35 47 h1v1h-1z M36 47 h1v1h-1z M39 47 h1v1h-1z M43 47 h1v1h-1z M44 47 h1v1h-1z M46 47 h1v1h-1z M50 47 h1v1h-1z M53 47 h1v1h-1z M54 47 h1v1h-1z M57 47 h1v1h-1z M59 47 h1v1h-1z M5 48 h1v1h-1z M7 48 h1v1h-1z M11 48 h1v1h-1z M13 48 h1v1h-1z M14 48 h1v1h-1z M15 48 h1v1h-1z M16 48 h1v1h-1z M20 48 h1v1h-1z M23 48 h1v1h-1z M26 48 h1v1h-1z M28 48 h1v1h-1z M32 48 h1v1h-1z M33 48 h1v1h-1z M34 48 h1v1h-1z M36 48 h1v1h-1z M37 48 h1v1h-1z M38 48 h1v1h-1z M39 48 h1v1h-1z M40 48 h1v1h-1z M41 48 h1v1h-1z M45 48 h1v1h-1z M46 48 h1v1h-1z M47 48 h1v1h-1z M48 48 h1v1h-1z M50 48 h1v1h-1z M51 48 h1v1h-1z M52 48 h1v1h-1z M55 48 h1v1h-1z M56 48 h1v1h-1z M58 48 h1v1h-1z M59 48 h1v1h-1z M60 48 h1v1h-1z M6 49 h1v1h-1z M7 49 h1v1h-1z M8 49 h1v1h-1z M11 49 h1v1h-1z M12 49 h1v1h-1z M13 49 h1v1h-1z M14 49 h1v1h-1z M16 49 h1v1h-1z M17 49 h1v1h-1z M18 49 h1v1h-1z M19 49 h1v1h-1z M21 49 h1v1h-1z M26 49 h1v1h-1z M27 49 h1v1h-1z M29 49 h1v1h-1z M30 49 h1v1h-1z M31 49 h1v1h-1z M34 49 h1v1h-1z M35 49 h1v1h-1z M36 49 h1v1h-1z M37 49 h1v1h-1z M38 49 h1v1h-1z M46 49 h1v1h-1z M48 49 h1v1h-1z\nM49 49 h1v1h-1z M51 49 h1v1h-1z M53 49 h1v1h-1z M55 49 h1v1h-1z M58 49 h1v1h-1z M60 49 h1v1h-1z M13 50 h1v1h-1z M15 50 h1v1h-1z M17 50 h1v1h-1z M21 50 h1v1h-1z M23 50 h1v1h-1z M26 50 h1v1h-1z M27 50 h1v1h-1z M28 50 h1v1h-1z M31 50 h1v1h-1z M32 50 h1v1h-1z M33 50 h1v1h-1z M35 50 h1v1h-1z M36 50 h1v1h-1z M40 50 h1v1h-1z M41 50 h1v1h-1z M43 50 h1v1h-1z M45 50 h1v1h-1z M46 50 h1v1h-1z M47 50 h1v1h-1z M48 50 h1v1h-1z M49 50 h1v1h-1z M50 50 h1v1h-1z M51 50 h1v1h-1z M55 50 h1v1h-1z M57 50 h1v1h-1z M58 50 h1v1h-1z M59 50 h1v1h-1z M18 51 h1v1h-1z M19 51 h1v1h-1z M20 51 h1v1h-1z M21 51 h1v1h-1z M22 51 h1v1h-1z M23 51 h1v1h-1z M24 51 h1v1h-1z M25 51 h1v1h-1z M26 51 h1v1h-1z M37 51 h1v1h-1z M38 51 h1v1h-1z M39 51 h1v1h-1z M44 51 h1v1h-1z M45 51 h1v1h-1z M47 51 h1v1h-1z M52 51 h1v1h-1z M54 51 h1v1h-1z M58 51 h1v1h-1z M59 51 h1v1h-1z M12 52 h1v1h-1z M13 52 h1v1h-1z M15 52 h1v1h-1z M16 52 h1v1h-1z M18 52 h1v1h-1z M20 52 h1v1h-1z M21 52 h1v1h-1z M22 52 h1v1h-1z M23 52 h1v1h-1z M25 52 h1v1h-1z M28 52 h1v1h-1z M29 52 h1v1h-1z M35 52 h1v1h-1z M36 52 h1v1h-1z M37 52 h1v1h-1z M38 52 h1v1h-1z M39 52 h1v1h-1z M41 52 h1v1h-1z M43 52 h1v1h-1z M49 52 h1v1h-1z M50 52 h1v1h-1z M57 52 h1v1h-1z M58 52 h1v1h-1z M59 52 h1v1h-1z M60 52 h1v1h-1z M13 53 h1v1h-1z M18 53 h1v1h-1z M19 53 h1v1h-1z M22 53 h1v1h-1z M25 53 h1v1h-1z M27 53 h1v1h-1z M29 53 h1v1h-1z M35 53 h1v1h-1z M36 53 h1v1h-1z M38 53 h1v1h-1z M39 53 h1v1h-1z M43 53 h1v1h-1z M44 53 h1v1h-1z M45 53 h1v1h-1z M47 53 h1v1h-1z M51 53 h1v1h-1z M57 53 h1v1h-1z M60 53 h1v1h-1z M14 54 h1v1h-1z M17 54 h1v1h-1z M22 54 h1v1h-1z M24 54 h1v1h-1z M26 54 h1v1h-1z\nM27 54 h1v1h-1z M28 54 h1v1h-1z M35 54 h1v1h-1z M36 54 h1v1h-1z M40 54 h1v1h-1z M41 54 h1v1h-1z M46 54 h1v1h-1z M49 54 h1v1h-1z M50 54 h1v1h-1z M59 54 h1v1h-1z M18 55 h1v1h-1z M19 55 h1v1h-1z M20 55 h1v1h-1z M22 55 h1v1h-1z M23 55 h1v1h-1z M24 55 h1v1h-1z M25 55 h1v1h-1z M26 55 h1v1h-1z M37 55 h1v1h-1z M38 55 h1v1h-1z M41 55 h1v1h-1z M42 55 h1v1h-1z M43 55 h1v1h-1z M44 55 h1v1h-1z M46 55 h1v1h-1z M49 55 h1v1h-1z M57 55 h1v1h-1z M13 56 h1v1h-1z M16 56 h1v1h-1z M18 56 h1v1h-1z M19 56 h1v1h-1z M20 56 h1v1h-1z M21 56 h1v1h-1z M24 56 h1v1h-1z M25 56 h1v1h-1z M28 56 h1v1h-1z M35 56 h1v1h-1z M36 56 h1v1h-1z M38 56 h1v1h-1z M39 56 h1v1h-1z M40 56 h1v1h-1z M45 56 h1v1h-1z M46 56 h1v1h-1z M47 56 h1v1h-1z M48 56 h1v1h-1z M50 56 h1v1h-1z M58 56 h1v1h-1z M60 56 h1v1h-1z M14 57 h1v1h-1z M18 57 h1v1h-1z M20 57 h1v1h-1z M21 57 h1v1h-1z M22 57 h1v1h-1z M25 57 h1v1h-1z M29 57 h1v1h-1z M30 57 h1v1h-1z M32 57 h1v1h-1z M34 57 h1v1h-1z M35 57 h1v1h-1z M36 57 h1v1h-1z M41 57 h1v1h-1z M42 57 h1v1h-1z M44 57 h1v1h-1z M46 57 h1v1h-1z M48 57 h1v1h-1z M49 57 h1v1h-1z M51 57 h1v1h-1z M53 57 h1v1h-1z M54 57 h1v1h-1z M56 57 h1v1h-1z M57 57 h1v1h-1z M13 58 h1v1h-1z M17 58 h1v1h-1z M18 58 h1v1h-1z M19 58 h1v1h-1z M20 58 h1v1h-1z M23 58 h1v1h-1z M24 58 h1v1h-1z M31 58 h1v1h-1z M34 58 h1v1h-1z M35 58 h1v1h-1z M36 58 h1v1h-1z M37 58 h1v1h-1z M38 58 h1v1h-1z M39 58 h1v1h-1z M43 58 h1v1h-1z M45 58 h1v1h-1z M46 58 h1v1h-1z M47 58 h1v1h-1z M48 58 h1v1h-1z M50 58 h1v1h-1z M52 58 h1v1h-1z M53 58 h1v1h-1z M16 59 h1v1h-1z M17 59 h1v1h-1z M19 59 h1v1h-1z M24 59 h1v1h-1z M25 59 h1v1h-1z M26 59 h1v1h-1z M27 59 h1v1h-1z\nM30 59 h1v1h-1z M31 59 h1v1h-1z M32 59 h1v1h-1z M36 59 h1v1h-1z M37 59 h1v1h-1z M38 59 h1v1h-1z M40 59 h1v1h-1z M46 59 h1v1h-1z M48 59 h1v1h-1z M52 59 h1v1h-1z M55 59 h1v1h-1z M57 59 h1v1h-1z M13 60 h1v1h-1z M14 60 h1v1h-1z M15 60 h1v1h-1z M17 60 h1v1h-1z M18 60 h1v1h-1z M21 60 h1v1h-1z M24 60 h1v1h-1z M27 60 h1v1h-1z M28 60 h1v1h-1z M30 60 h1v1h-1z M33 60 h1v1h-1z M34 60 h1v1h-1z M37 60 h1v1h-1z M39 60 h1v1h-1z M40 60 h1v1h-1z M42 60 h1v1h-1z M43 60 h1v1h-1z M45 60 h1v1h-1z M46 60 h1v1h-1z M47 60 h1v1h-1z M50 60 h1v1h-1z M52 60 h1v1h-1z M53 60 h1v1h-1z M54 60 h1v1h-1z M55 60 h1v1h-1z M56 60 h1v1h-1z M58 60 h1v1h-1z M59 60 h1v1h-1z\"/>\n<path class=\"qr-alignment-dark dark qrcode\" d=\"M30 8 h1v1h-1z M31 8 h1v1h-1z M32 8 h1v1h-1z M33 8 h1v1h-1z M34 8 h1v1h-1z M30 9 h1v1h-1z M34 9 h1v1h-1z M30 10 h1v1h-1z M32 10 h1v1h-1z M34 10 h1v1h-1z M30 11 h1v1h-1z M34 11 h1v1h-1z M30 12 h1v1h-1z M31 12 h1v1h-1z M32 12 h1v1h-1z M33 12 h1v1h-1z M34 12 h1v1h-1z M8 30 h1v1h-1z M9 30 h1v1h-1z M10 30 h1v1h-1z M11 30 h1v1h-1z M12 30 h1v1h-1z M52 30 h1v1h-1z M53 30 h1v1h-1z M54 30 h1v1h-1z M55 30 h1v1h-1z M56 30 h1v1h-1z M8 31 h1v1h-1z M12 31 h1v1h-1z M52 31 h1v1h-1z M56 31 h1v1h-1z M8 32 h1v1h-1z M10 32 h1v1h-1z M12 32 h1v1h-1z M52 32 h1v1h-1z M54 32 h1v1h-1z M56 32 h1v1h-1z M8 33 h1v1h-1z M12 33 h1v1h-1z M52 33 h1v1h-1z M56 33 h1v1h-1z M8 34 h1v1h-1z M9 34 h1v1h-1z M10 34 h1v1h-1z M11 34 h1v1h-1z M12 34 h1v1h-1z M52 34 h1v1h-1z M53 34 h1v1h-1z M54 34 h1v1h-1z M55 34 h1v1h-1z M56 34 h1v1h-1z M30 52 h1v1h-1z M31 52 h1v1h-1z M32 52 h1v1h-1z M33 52 h1v1h-1z M34 52 h1v1h-1z M52 52 h1v1h-1z M53 52 h1v1h-1z M54 52 h1v1h-1z M55 52 h1v1h-1z M56 52 h1v1h-1z M30 53 h1v1h-1z M34 53 h1v1h-1z M52 53 h1v1h-1z M56 53 h1v1h-1z M30 54 h1v1h-1z M32 54 h1v1h-1z M34 54 h1v1h-1z M52 54 h1v1h-1z M54 54 h1v1h-1z M56 54 h1v1h-1z M30 55 h1v1h-1z M34 55 h1v1h-1z M52 55 h1v1h-1z M56 55 h1v1h-1z M30 56 h1v1h-1z M31 56 h1v1h-1z M32 56 h1v1h-1z M33 56 h1v1h-1z M34 56 h1v1h-1z M52 56 h1v1h-1z M53 56 h1v1h-1z M54 56 h1v1h-1z M55 56 h1v1h-1z M56 56 h1v1h-1z\"/>\n<path class=\"qr-timing-dark dark qrcode\" d=\"M12 10 h1v1h-1z M14 10 h1v1h-1z M16 10 h1v1h-1z M18 10 h1v1h-1z M20 10 h1v1h-1z M22 10 h1v1h-1z M24 10 h1v1h-1z M26 10 h1v1h-1z M28 10 h1v1h-1z M36 10 h1v1h-1z M38 10 h1v1h-1z M40 10 h1v1h-1z M42 10 h1v1h-1z M44 10 h1v1h-1z M46 10 h1v1h-1z M48 10 h1v1h-1z M50 10 h1v1h-1z M52 10 h1v1h-1z M10 12 h1v1h-1z M10 14 h1v1h-1z M10 16 h1v1h-1z M10 18 h1v1h-1z M10 20 h1v1h-1z M10 22 h1v1h-1z M10 24 h1v1h-1z M10 26 h1v1h-1z M10 28 h1v1h-1z M10 36 h1v1h-1z M10 38 h1v1h-1z M10 40 h1v1h-1z M10 42 h1v1h-1z M10 44 h1v1h-1z M10 46 h1v1h-1z M10 48 h1v1h-1z M10 50 h1v1h-1z M10 52 h1v1h-1z\"/>\n<path class=\"qr-format-dark dark qrcode\" d=\"M12 4 h1v1h-1z M12 5 h1v1h-1z M12 6 h1v1h-1z M12 9 h1v1h-1z M12 11 h1v1h-1z M6 12 h1v1h-1z M7 12 h1v1h-1z M8 12 h1v1h-1z M12 12 h1v1h-1z M53 12 h1v1h-1z M54 12 h1v1h-1z M55 12 h1v1h-1z M58 12 h1v1h-1z M59 12 h1v1h-1z M60 12 h1v1h-1z M12 56 h1v1h-1z M12 57 h1v1h-1z M12 58 h1v1h-1z\"/>\n<path class=\"qr-version-dark dark qrcode\" d=\"M50 4 h1v1h-1z M51 4 h1v1h-1z M51 5 h1v1h-1z M50 6 h1v1h-1z M51 6 h1v1h-1z M51 7 h1v1h-1z M51 8 h1v1h-1z M50 9 h1v1h-1z M4 50 h1v1h-1z M6 50 h1v1h-1z M9 50 h1v1h-1z M4 51 h1v1h-1z M5 51 h1v1h-1z M6 51 h1v1h-1z M7 51 h1v1h-1z M8 51 h1v1h-1z\"/>\n<path class=\"qr-finder-dark dark qrcode\" d=\"M4,4 m2 0h3a2 2 0 012 2v3a2 2 0 01-2 2h-3a2 2 0 01-2-2v-3a2 2 0 012-2zm0 1a1 1 0 00-1 1v3a1 1 0 001 1h3a1 1 0 001-1v-3a1 1 0 00-1-1zm1 1h1a1 1 0 011 1v1a1 1 0 01-1 1h-1a1 1 0 01-1-1v-1a1 1 0 011-1Z M4,54 m2 0h3a2 2 0 012 2v3a2 2 0 01-2 2h-3a2 2 0 01-2-2v-3a2 2 0 012-2zm0 1a1 1 0 00-1 1v3a1 1 0 001 1h3a1 1 0 001-1v-3a1 1 0 00-1-1zm1 1h1a1 1 0 011 1v1a1 1 0 01-1 1h-1a1 1 0 01-1-1v-1a1 1 0 011-1Z M54,4 m2 0h3a2 2 0 012 2v3a2 2 0 01-2 2h-3a2 2 0 01-2-2v-3a2 2 0 012-2zm0 1a1 1 0 00-1 1v3a1 1 0 001 1h3a1 1 0 001-1v-3a1 1 0 00-1-1zm1 1h1a1 1 0 011 1v1a1 1 0 01-1 1h-1a1 1 0 01-1-1v-1a1 1 0 011-1Z\"/>\n<g transform=\"translate(24.375 24.375) scale(0.25)\" class=\"qr-logo dark\">\n\t<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"63\" height=\"63\">\n    <image href=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAIAAAACUFjqAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAADUlEQVQYlWNgGAWkAwABNgABxYufBwAAAABJRU5ErkJggg==\" width=\"63\" height=\"63\"/>\n</svg>\n</g>\n</svg>\n"
    },
    "message": "success",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{restaurant_table_id}/qr

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

restaurant_table_id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Body Parameters

dots_color   string  optional  
dots_shape   string  optional  

Example: dot

Must be one of:
  • circular
  • square
  • dot
  • japanese
  • pointed-edge-cut
  • pointed-smooth
  • star
  • rounded-in-smooth
  • diamond
  • mosaic
  • circle-zebra-vertical
border_shape   string  optional  

Example: square-with-dot

Must be one of:
  • circular
  • square
  • rounded-square
  • rounded-rectangle
  • square-with-dot
  • squircle
  • clipped-corner-square
  • inner-rounded-rectangle
  • thick-bordered-circle
  • tilted-square
qr_bg_color   string  optional  
border_color   string  optional  
isGradient   boolean  optional  

Example: true

isRadialGradient   boolean  optional  

Example: false

second_dots_color   string  optional  

This field is required when gradient is true.

logo   file  optional  

Must be an image. Must not be greater than 255 kilobytes. Example: /tmp/phpcdHgdn

Show the order of a specific restaurant table.

requires authentication

This endpoint lets you show to specific restaurant table.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/get-table-order" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/get-table-order"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec64a-8447-423a-b5e4-aa23cd30bd94",
        "number": "9",
        "branch": {
            "id": "84acfbef-5f20-4556-aa6c-802272879e1f"
        },
        "status": {
            "key": 1,
            "value": "AVAILABLE"
        },
        "image": "http://localhost/storage/restaurants/image.png",
        "additional_notes": "Architecto molestiae non quidem.",
        "order": null
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{restaurant_table_id}/get-table-order

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

restaurant_table_id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Payment

APIs for orders Management

Store Payment

requires authentication

This endpoint lets you add a payment

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order_id\": \"magnam\",
    \"customer_phone\": \"a\",
    \"payment_method\": 9,
    \"amount\": 40,
    \"tip_amount\": 84,
    \"status\": 1
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order_id": "magnam",
    "customer_phone": "a",
    "payment_method": 9,
    "amount": 40,
    "tip_amount": 84,
    "status": 1
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec630-d566-4962-b207-646daa390f9c",
        "customer_phone": "+1-385-927-8729",
        "order": "9fdec630-a980-4019-86b5-745cd4c1ccad",
        "table_id": "9fdec630-a608-4a36-a8e8-37300c5f3bb0",
        "payment_method": {
            "key": 3,
            "value": "CREDIT_CARD"
        },
        "status": {
            "key": 1,
            "value": "UNPAID"
        },
        "amount": 100,
        "tip_amount": 10
    },
    "message": "The Payment has been added successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/payments

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

order_id   string   

The id of an existing record in the orders table. Example: magnam

customer_phone   string   

Example: a

payment_method   integer   

Example: 9

Must be one of:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
amount   integer   

Must be at least 0. Example: 40

tip_amount   integer  optional  

Must be at least 0. Example: 84

status   integer   

Example: 1

Must be one of:
  • 1
  • 2
  • 3

Show Specific Payment

requires authentication

This endpoint lets you show specific payment

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/voluptatem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/voluptatem"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec62f-e4e5-40cd-b1d3-0540e8ee2fd2",
        "customer_phone": "865-323-5957",
        "order": "9fdec62f-e064-4ce0-b9ff-2c97559f14ce",
        "table_id": "9fdec62f-dea9-4a84-86e8-b530669aff3b",
        "payment_method": {
            "key": 5,
            "value": "DEVICE"
        },
        "status": {
            "key": 1,
            "value": "UNPAID"
        },
        "amount": 457,
        "tip_amount": 0
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/payments/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the payment. Example: voluptatem

Update Specific Payment

requires authentication

This endpoint lets you update specific payment

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/sed" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": 1
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/sed"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": 1
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec630-fc13-4702-acdb-525905d345fe",
        "customer_phone": "+1-385-927-8729",
        "order": "9fdec630-c4f9-4d6f-baa2-b82bc3e8609b",
        "table_id": "9fdec630-c05c-4ccc-a098-203a95f98c62",
        "payment_method": {
            "key": 3,
            "value": "CREDIT_CARD"
        },
        "status": {
            "key": 2,
            "value": "PAID"
        },
        "amount": 150,
        "tip_amount": 15
    },
    "message": "The Payment has been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/payments/{id}

PATCH api/v1/restaurants/{restaurant_id}/branches/{branch_id}/payments/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the payment. Example: sed

Body Parameters

status   integer  optional  

Example: 1

Must be one of:
  • 1
  • 2
  • 3

Delete Specific Payment

requires authentication

This endpoint lets you delete specific payment

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/ipsam" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/ipsam"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The payment has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/payments/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the payment. Example: ipsam

update Specific Payment Status To Accept

requires authentication

This endpoint lets you update specific payment status to fully paid (Done)

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/pariatur/mark-as-done" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/pariatur/mark-as-done"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Payment status has been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/payments/{payment_id}/mark-as-done

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

payment_id   string   

The ID of the payment. Example: pariatur

update Specific Payment Status To Prepare

requires authentication

This endpoint lets you update specific order status to prepare

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/iure/mark-as-failed" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/payments/iure/mark-as-failed"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Payment status has been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/payments/{payment_id}/mark-as-failed

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

payment_id   string   

The ID of the payment. Example: iure

Reservation

APIs for Reservation Management

Show all reservations in specific branch

requires authentication

This endpoint lets you show all reservations in specific branch

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations?page=1&per_page=15&filter%5Bstatus%5D=quaerat&sort=quo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations"
);

const params = {
    "page": "1",
    "per_page": "15",
    "filter[status]": "quaerat",
    "sort": "quo",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec636-fafa-4094-8fb3-53e0ce3c109f",
            "customer": {
                "name": "Juwan Kozey",
                "first_name": "Juwan",
                "last_name": "Kozey",
                "phone": "+1-660-609-3883"
            },
            "branch": {
                "id": "983fd736-9a67-4c4f-8ab5-aba06fca1a21",
                "name": "Kaylah Hirthe"
            },
            "reservation_time": "2005-10-18 10:55:18",
            "number_of_people": 6,
            "status": {
                "key": 2,
                "value": "CONFIRMED"
            }
        },
        {
            "id": "9fdec636-fa10-4f8b-a950-8780d2137b19",
            "customer": {
                "name": "Juwan Kozey",
                "first_name": "Juwan",
                "last_name": "Kozey",
                "phone": "+1-660-609-3883"
            },
            "branch": {
                "id": "983fd736-9a67-4c4f-8ab5-aba06fca1a21",
                "name": "Kaylah Hirthe"
            },
            "reservation_time": "2008-01-30 17:08:43",
            "number_of_people": 6,
            "status": {
                "key": 1,
                "value": "PENDING"
            }
        },
        {
            "id": "9fdec636-f92b-457c-b7e8-dc4022b9aea7",
            "customer": {
                "name": "Juwan Kozey",
                "first_name": "Juwan",
                "last_name": "Kozey",
                "phone": "+1-660-609-3883"
            },
            "branch": {
                "id": "983fd736-9a67-4c4f-8ab5-aba06fca1a21",
                "name": "Kaylah Hirthe"
            },
            "reservation_time": "1989-11-16 04:40:17",
            "number_of_people": 6,
            "status": {
                "key": 1,
                "value": "PENDING"
            }
        },
        {
            "id": "9fdec636-f84a-4a86-9211-07134ed04903",
            "customer": {
                "name": "Juwan Kozey",
                "first_name": "Juwan",
                "last_name": "Kozey",
                "phone": "+1-660-609-3883"
            },
            "branch": {
                "id": "983fd736-9a67-4c4f-8ab5-aba06fca1a21",
                "name": "Kaylah Hirthe"
            },
            "reservation_time": "2006-02-14 23:43:19",
            "number_of_people": 6,
            "status": {
                "key": 3,
                "value": "CANCELLED"
            }
        },
        {
            "id": "9fdec636-f755-47c8-92d6-b610916e36df",
            "customer": {
                "name": "Juwan Kozey",
                "first_name": "Juwan",
                "last_name": "Kozey",
                "phone": "+1-660-609-3883"
            },
            "branch": {
                "id": "983fd736-9a67-4c4f-8ab5-aba06fca1a21",
                "name": "Kaylah Hirthe"
            },
            "reservation_time": "1971-03-01 15:14:29",
            "number_of_people": 6,
            "status": {
                "key": 3,
                "value": "CANCELLED"
            }
        }
    ],
    "meta": {
        "pagination": {
            "total": 16,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/reservations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 1

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 15

filter[status]   string  optional  

Field to filter items by status. Example: quaerat

sort   string  optional  

Field to sort items by status. Example: quo

Add Reservation

requires authentication

This endpoint lets you add reservation

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"sjunhdyqkt\",
    \"last_name\": \"jwihsfdcohefbi\",
    \"phone\": \"et\",
    \"number_of_people\": 32,
    \"reservation_time\": \"2089-04-14\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "sjunhdyqkt",
    "last_name": "jwihsfdcohefbi",
    "phone": "et",
    "number_of_people": 32,
    "reservation_time": "2089-04-14"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec634-ca7c-4513-ba6d-025d9c41fb28",
        "customer": {
            "name": "John Doe",
            "first_name": "John",
            "last_name": "Doe",
            "phone": "+971581234567"
        },
        "branch": {
            "id": "86a37535-d8c1-4259-8445-4baeed9e1fbb",
            "name": "Amiya Greenholt"
        },
        "reservation_time": "2025-09-13 21:26:08",
        "number_of_people": 4,
        "status": {
            "key": 1,
            "value": "PENDING"
        }
    },
    "message": "Your reservation has been added successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/reservations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

first_name   string   

Must not be greater than 255 characters. Example: sjunhdyqkt

last_name   string   

Must not be greater than 255 characters. Example: jwihsfdcohefbi

phone   string   

Example: et

number_of_people   number   

Must be at least 1. Example: 32

reservation_time   string   

Must be a valid date. Must be a date after now. Example: 2089-04-14

Show Specific Reservation

requires authentication

This endpoint lets you show specific reservation

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations/9fdec6fe-c32a-48e8-827a-6e04c907c5bc" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations/9fdec6fe-c32a-48e8-827a-6e04c907c5bc"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec633-8f22-49d0-812a-a079c5fc7f34",
        "customer": {
            "name": "Chyna Schmeler",
            "first_name": "Chyna",
            "last_name": "Schmeler",
            "phone": "+1.912.804.6723"
        },
        "branch": {
            "id": "b695eae6-898b-424b-ae9a-d7acf33d23f1",
            "name": "Carrie Lockman"
        },
        "reservation_time": "2009-12-22 21:25:49",
        "number_of_people": 6,
        "status": {
            "key": 3,
            "value": "CANCELLED"
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/reservations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the reservation. Example: 9fdec6fe-c32a-48e8-827a-6e04c907c5bc

Update Specific Reservation

requires authentication

This endpoint lets you update specific reservation

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations/9fdec6fe-c32a-48e8-827a-6e04c907c5bc" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"qmgfbhpsfvlyomyknevds\",
    \"last_name\": \"qnygv\",
    \"number_of_people\": 43,
    \"reservation_time\": \"2041-03-25\",
    \"status\": 2
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations/9fdec6fe-c32a-48e8-827a-6e04c907c5bc"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "qmgfbhpsfvlyomyknevds",
    "last_name": "qnygv",
    "number_of_people": 43,
    "reservation_time": "2041-03-25",
    "status": 2
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec637-251d-4dc9-a938-604757710aa4",
        "customer": {
            "name": "Willis Carter",
            "first_name": "Willis",
            "last_name": "Carter",
            "phone": "+1-860-481-9574"
        },
        "branch": {
            "id": "0f23a4e3-c133-4a55-a9b3-03906c7f20ec",
            "name": "Mr. Sammie Kling"
        },
        "reservation_time": "2025-09-13 21:26:10",
        "number_of_people": 4,
        "status": {
            "key": 2,
            "value": "CONFIRMED"
        }
    },
    "message": "The Reservation has been updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/reservations/{id}

PATCH api/v1/restaurants/{restaurant_id}/branches/{branch_id}/reservations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the reservation. Example: 9fdec6fe-c32a-48e8-827a-6e04c907c5bc

Body Parameters

first_name   string  optional  

Must not be greater than 255 characters. Example: qmgfbhpsfvlyomyknevds

last_name   string  optional  

Must not be greater than 255 characters. Example: qnygv

phone   string  optional  
number_of_people   number  optional  

Must be at least 1. Example: 43

reservation_time   string  optional  

Must be a valid date. Must be a date after now. Example: 2041-03-25

status   integer  optional  

Example: 2

Must be one of:
  • 1
  • 2
  • 3

Delete Specific Reservation

requires authentication

This endpoint lets you delete specific reservation

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations/9fdec6fe-c32a-48e8-827a-6e04c907c5bc" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reservations/9fdec6fe-c32a-48e8-827a-6e04c907c5bc"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Reservation has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/reservations/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

id   string   

The ID of the reservation. Example: 9fdec6fe-c32a-48e8-827a-6e04c907c5bc

Reviews

APIs for Reviews Management

Show all reviews

requires authentication

This endpoint lets you show all reviews

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reviews?page=18&per_page=14&filter%5Bid%5D=sed&filter%5Brating%5D=commodi&sort=doloremque" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reviews"
);

const params = {
    "page": "18",
    "per_page": "14",
    "filter[id]": "sed",
    "filter[rating]": "commodi",
    "sort": "doloremque",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5e9-0e02-4073-a495-749e15a55584",
            "rating": 1,
            "comment": "Ut iste repellendus beatae et voluptas eaque odio.",
            "customer": {
                "id": "9fdec5e8-869d-4e79-8fd3-a93035b88105",
                "name": "Kris Huel",
                "image": "http://localhost/storage/customers/customer.png",
                "phone": "430-551-8295"
            },
            "order": {
                "id": "9fdec5e8-bd31-49a1-a05d-98fb894acfc1",
                "number": "Maedah_025_12"
            },
            "review_date": "2025-09-13T19:25:19.000000Z"
        },
        {
            "id": "9fdec5e9-0c6e-4efc-8102-7f76fd2284a2",
            "rating": 1,
            "comment": "Harum minus praesentium aliquam ut reiciendis non delectus.",
            "customer": {
                "id": "9fdec5e8-869d-4e79-8fd3-a93035b88105",
                "name": "Kris Huel",
                "image": "http://localhost/storage/customers/customer.png",
                "phone": "430-551-8295"
            },
            "order": {
                "id": "9fdec5e8-bd31-49a1-a05d-98fb894acfc1",
                "number": "Maedah_025_12"
            },
            "review_date": "2025-09-13T19:25:19.000000Z"
        },
        {
            "id": "9fdec5e9-0aab-406a-84da-ade09300ba3f",
            "rating": 5,
            "comment": "Magnam voluptatem et sit voluptatem libero voluptatibus rerum rerum.",
            "customer": {
                "id": "9fdec5e8-869d-4e79-8fd3-a93035b88105",
                "name": "Kris Huel",
                "image": "http://localhost/storage/customers/customer.png",
                "phone": "430-551-8295"
            },
            "order": {
                "id": "9fdec5e8-bd31-49a1-a05d-98fb894acfc1",
                "number": "Maedah_025_12"
            },
            "review_date": "2025-09-13T19:25:19.000000Z"
        },
        {
            "id": "9fdec5e9-075a-4d01-a1e5-d08e7d19c28a",
            "rating": 1,
            "comment": "Omnis sit ipsa ad qui non perferendis.",
            "customer": {
                "id": "9fdec5e8-869d-4e79-8fd3-a93035b88105",
                "name": "Kris Huel",
                "image": "http://localhost/storage/customers/customer.png",
                "phone": "430-551-8295"
            },
            "order": {
                "id": "9fdec5e8-bd31-49a1-a05d-98fb894acfc1",
                "number": "Maedah_025_12"
            },
            "review_date": "2025-09-13T19:25:19.000000Z"
        },
        {
            "id": "9fdec5e9-059d-4fb4-a4b3-26706798132b",
            "rating": 5,
            "comment": "Sint iste et nobis omnis nostrum enim iste.",
            "customer": {
                "id": "9fdec5e8-869d-4e79-8fd3-a93035b88105",
                "name": "Kris Huel",
                "image": "http://localhost/storage/customers/customer.png",
                "phone": "430-551-8295"
            },
            "order": {
                "id": "9fdec5e8-bd31-49a1-a05d-98fb894acfc1",
                "number": "Maedah_025_12"
            },
            "review_date": "2025-09-13T19:25:19.000000Z"
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/reviews

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 18

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 14

filter[id]   string  optional  

Field to filter items by id. Example: sed

filter[rating]   string  optional  

Field to filter items by rating. Example: commodi

sort   string  optional  

Field to sort items by rating. Example: doloremque

Show Specific Review

requires authentication

This endpoint lets you show specific review

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reviews/illum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reviews/illum"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5eb-2857-46bb-8619-ee6674cdb455",
        "customer": "9fdec5eb-25c8-4bb9-88f3-d6de71876191",
        "rating": 5,
        "comment": "Quod voluptatum enim ipsum molestias."
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/reviews/{review_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

review_id   string   

The ID of the review. Example: illum

Delete Specific Review .

requires authentication

This endpoint allows you to delete a specific review.

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reviews/ea" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/reviews/ea"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The review has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/reviews/{review_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

review_id   string   

The ID of the review. Example: ea

Staff_Areas

APIs for Staff Areas Management

Assign many waiters to specific area.

requires authentication

This endpoint lets you assign many waiters to specific area.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2/assign-to-staff" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"staff\": [
        {
            \"id\": \"dolore\"
        }
    ]
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/areas/9fdec6fe-926d-49f1-9333-41fc5a95d4d2/assign-to-staff"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "staff": [
        {
            "id": "dolore"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5d9-2656-46c5-ba62-0a15fee9b2df",
            "area_id": "9fdec5d8-6b12-4807-b74c-2510e10d70d9",
            "staff_id": "af10d2e5-81c8-471e-b564-94387bec60d4"
        },
        {
            "id": "9fdec5d9-2b48-4349-8700-4e4bbb84f5f6",
            "area_id": "9fdec5d8-6b12-4807-b74c-2510e10d70d9",
            "staff_id": "b3d4563b-be29-499a-b209-b09344d1b5b6"
        },
        {
            "id": "9fdec5d9-30d3-4c52-b8d6-0b889c315781",
            "area_id": "9fdec5d8-6b12-4807-b74c-2510e10d70d9",
            "staff_id": "51acc090-aeac-4acf-8e80-d96510c55548"
        }
    ],
    "message": "Staff members assigned to the area successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/areas/{area_id}/assign-to-staff

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

area_id   string   

The ID of the area. Example: 9fdec6fe-926d-49f1-9333-41fc5a95d4d2

Body Parameters

staff   object[]   

Must have at least 1 items.

id   string   

The id of an existing record in the staff table. Example: dolore

Roles

APIs for interacting with roles

Show All Role In Branch

requires authentication

This endpoint lets you show all roles in Specific branch

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/show-all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/show-all"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5ed-1bf3-423c-a302-84802d37f32f",
            "name": "Caitlyn Gislason",
            "description": "Voluptatem veniam molestiae est iure."
        },
        {
            "id": "9fdec5ed-1a9d-4e79-b084-6aba370f7909",
            "name": "Zackery Cummings",
            "description": "Tempore atque aperiam ut aut voluptatum."
        },
        {
            "id": "9fdec5ed-1955-4055-8f1a-020d486e467d",
            "name": "Prof. Caleb Volkman",
            "description": "Nemo error et iure velit maxime nostrum nisi."
        },
        {
            "id": "9fdec5ed-1823-409e-8f89-3879d9914c36",
            "name": "Prof. Savanna Durgan Sr.",
            "description": "Recusandae rerum totam repellat doloremque."
        },
        {
            "id": "9fdec5ed-1694-4067-b4f7-6293f89515df",
            "name": "Dr. Narciso Gislason",
            "description": "In vel aut asperiores quia exercitationem aut."
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/roles/show-all

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Show Specific Role In Branch

requires authentication

This endpoint lets you show specific role In Branch

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/show-role" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/show-role"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5f0-5dfa-4510-a616-8308086bbe7a",
        "name": "Ara Willms MD",
        "description": "Est nemo aliquam occaecati voluptatem."
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/roles/{role_id}/show-role

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

role_id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Add New Role

requires authentication

This endpoint lets you add role

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/add-role" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"czvflavir\",
    \"description\": \"Ipsam non quisquam eligendi et incidunt qui.\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/add-role"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "czvflavir",
    "description": "Ipsam non quisquam eligendi et incidunt qui."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5f4-1d0f-4433-bbdf-8cd192c79685",
        "name": "Name role",
        "description": "Description role"
    },
    "message": "The role added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/roles/add-role

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

name   string   

Must not be greater than 255 characters. Example: czvflavir

description   string  optional  

Must not be greater than 255 characters. Example: Ipsam non quisquam eligendi et incidunt qui.

Update specific role

requires authentication

This endpoint lets you update specific role

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/edit-role" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"hprjaaidqnwoyxly\",
    \"description\": \"Voluptatum necessitatibus velit esse autem ipsam labore optio.\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/edit-role"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "hprjaaidqnwoyxly",
    "description": "Voluptatum necessitatibus velit esse autem ipsam labore optio."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5f3-cc56-42a4-bf69-9b72ca07bcc4",
        "name": "New Name",
        "description": "Rerum minus perspiciatis consequatur."
    },
    "message": "The role updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/roles/{role_id}/edit-role

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

role_id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Body Parameters

name   string  optional  

Must not be greater than 255 characters. Example: hprjaaidqnwoyxly

description   string  optional  

Must not be greater than 255 characters. Example: Voluptatum necessitatibus velit esse autem ipsam labore optio.

Delete specific role

requires authentication

This endpoint lets you delete specific role

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/delete-role" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/delete-role"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The role deleted successfully",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/roles/{role_id}/delete-role

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

role_id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Show all permissions to specific role

requires authentication

This endpoint lets you show all permissions to specific role

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/show-permissions?page=6&per_page=1&filter=et&sort=eos" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/show-permissions"
);

const params = {
    "page": "6",
    "per_page": "1",
    "filter": "et",
    "sort": "eos",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec5ef-1992-43fc-bfad-cb79e0b26395",
            "name": "Leonel Jacobi",
            "description": "Quod dicta quis expedita possimus fugit tempora. Sed odio voluptatum est consequatur. Vel adipisci praesentium ratione hic."
        },
        {
            "id": "9fdec5ef-1abe-418d-9a5b-a1265dfc1d49",
            "name": "Forest Stroman",
            "description": "Modi error fugit labore ea nihil deserunt et ut. Repellendus adipisci alias doloribus ex tempore magni alias."
        },
        {
            "id": "9fdec5ef-1ba9-4b8f-a307-b68964cb206f",
            "name": "Marques Batz",
            "description": "Voluptate dolorum minima odio nemo culpa. Qui dolorem nulla optio vel voluptas nam facilis aut. Temporibus aliquid impedit eaque fugit laudantium."
        },
        {
            "id": "9fdec5ef-1cdd-4a48-b720-c95d54dc47bb",
            "name": "Jimmie Ruecker V",
            "description": "Voluptatem expedita sint pariatur voluptatem suscipit enim doloribus. Magnam inventore exercitationem hic ut qui vel quod. Molestiae eligendi dolores facere ullam."
        },
        {
            "id": "9fdec5ef-1e16-4baf-ad13-ddbe99eefe61",
            "name": "Dr. Sharon Wunsch Sr.",
            "description": "Qui voluptas maxime quis cum aliquam. Ex laboriosam amet et. Laudantium eligendi et omnis voluptates dolorem quasi."
        },
        {
            "id": "9fdec5ef-1f3f-4470-82ea-927fc556180a",
            "name": "Elwin Upton",
            "description": "Et id distinctio error in libero et necessitatibus sequi. Pariatur exercitationem quam sint veniam aut."
        },
        {
            "id": "9fdec5ef-2099-473c-a5ff-482b3c8fd76c",
            "name": "Prof. Clinton Hilpert III",
            "description": "Qui minima earum possimus et ratione eaque. Sunt est consequuntur mollitia. Vel exercitationem similique dolorum assumenda voluptatem."
        },
        {
            "id": "9fdec5ef-221e-4223-aef0-38eb0e114b6f",
            "name": "Ryder Robel",
            "description": "Eveniet labore explicabo sit dolor cum vel facere. Totam qui sed nostrum est odit quisquam aut."
        },
        {
            "id": "9fdec5ef-2390-4947-a92f-fbdf8ee54362",
            "name": "Anissa Franecki IV",
            "description": "Est in asperiores ea nisi. Quia voluptas doloremque est placeat natus. Sit quasi tenetur voluptatibus asperiores."
        },
        {
            "id": "9fdec5ef-24c4-4129-b5c1-fe7403e944ce",
            "name": "Dr. Madison Erdman",
            "description": "Magnam non est repellendus necessitatibus qui et et. Excepturi quaerat voluptatibus id occaecati. Error deserunt ut quae cum perspiciatis quos."
        },
        {
            "id": "9fdec5ef-25e7-4b3c-8241-89eac7d6ff3f",
            "name": "Aniya Wintheiser",
            "description": "Quia odio recusandae veritatis eos tenetur nihil nihil. Accusamus modi veniam sunt non autem. Officiis voluptate architecto repudiandae."
        },
        {
            "id": "9fdec5ef-2736-4d2e-84b0-79840f16e346",
            "name": "Courtney Jacobs",
            "description": "Molestias asperiores perferendis sed a. Expedita mollitia facere ut ratione rerum."
        },
        {
            "id": "9fdec5ef-2898-4a26-aa53-f0db3ebf48b7",
            "name": "Mrs. Maxie O'Connell",
            "description": "Natus dolores at aut cupiditate veritatis dolor dolor non. Exercitationem ducimus quo quas alias ea."
        },
        {
            "id": "9fdec5ef-29c0-49a9-b9c1-9b5c43328cda",
            "name": "Shaylee Douglas",
            "description": "Quibusdam nihil quam molestiae perspiciatis eligendi. Deleniti cupiditate sit qui sint rem ducimus. Nostrum quam dolorem sit id saepe est."
        },
        {
            "id": "9fdec5ef-2b0a-4ee1-aba0-9c872db347b3",
            "name": "Mr. Darryl Miller",
            "description": "Qui rerum pariatur sit odio quasi. Est deleniti non beatae perferendis consequatur magni mollitia."
        },
        {
            "id": "9fdec5ef-2c6f-4ac9-8494-ee85a61fe9e0",
            "name": "Mrs. Amelie Carter I",
            "description": "Dicta aut fuga aliquid debitis non sunt vitae. Architecto dolorem quis numquam quas. Sed facere architecto nam commodi."
        },
        {
            "id": "9fdec5ef-2de0-4f58-a3d7-ab73498d5e30",
            "name": "Fae Hill",
            "description": "Et qui fugit voluptate veniam consequatur eos quae dignissimos. Provident placeat possimus consequatur rerum ut labore. Commodi aperiam accusamus eum eum."
        },
        {
            "id": "9fdec5ef-2f4f-485f-ab8a-a214cc12f7f0",
            "name": "Dr. Chase Will V",
            "description": "Laudantium qui quia dolor est quis quibusdam. Ea magni adipisci rerum beatae. Facilis et qui a commodi necessitatibus vero sed."
        },
        {
            "id": "9fdec5ef-30ff-4bfd-972a-9fb79680c7ca",
            "name": "Barney Conroy",
            "description": "Architecto amet et autem ipsam. Officia ad et deserunt laboriosam dolorem et fugiat architecto."
        },
        {
            "id": "9fdec5ef-326a-4134-bad0-c6a38716fb13",
            "name": "Kaylie Spinka",
            "description": "Ea error repudiandae quia quis fugiat. Omnis nulla deleniti aut quo voluptas."
        }
    ],
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/roles/{role_id}/show-permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

role_id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 6

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 1

filter   string  optional  

Field to filter by name. Example: et

sort   string  optional  

Field to sort items by name. Example: eos

Edit rule's permissions

requires authentication

This endpoint lets you edit rule's permissions (add,update,delete)

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/add-permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"permissionIds\": [
        11
    ]
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/roles/9fdec6f9-90d4-406b-9996-ad41bceaaa6c/add-permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "permissionIds": [
        11
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "The role's permissions updated successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/roles/{role_id}/add-permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

role_id   string   

The ID of the role. Example: 9fdec6f9-90d4-406b-9996-ad41bceaaa6c

Body Parameters

permissionIds   integer[]  optional  

List of the permissions Ids.

Permissions

APIs for getting permissions

Show All Permissions

requires authentication

This endpoint lets you show all permissions

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/permissions/show-all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/permissions/show-all"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "group": "User Management",
            "permissions": [
                {
                    "id": "9fdec5fa-a9ad-4e86-b5a9-3e0dcbf4c7f9",
                    "name": "Hipolito Funk DDS"
                },
                {
                    "id": "9fdec5fa-aadb-46fe-803c-e722230d511d",
                    "name": "Amos Crooks PhD"
                },
                {
                    "id": "9fdec5fa-abfd-4b55-81f9-4a15b5757255",
                    "name": "Laney Crona"
                },
                {
                    "id": "9fdec5fa-ad47-4f71-862c-4bb1a8dfdc26",
                    "name": "Mable Cartwright"
                },
                {
                    "id": "9fdec5fa-ae80-49cd-9e29-7ed4e91266e7",
                    "name": "Mr. Hazle Goodwin"
                }
            ]
        },
        {
            "group": "Role Management",
            "permissions": [
                {
                    "id": "9fdec5fa-b360-4689-b9c0-359a00f36b5e",
                    "name": "Jayne Moen PhD"
                },
                {
                    "id": "9fdec5fa-b4bc-4d53-bf17-ceaf201c8cae",
                    "name": "Lyla Klein"
                },
                {
                    "id": "9fdec5fa-b6ee-4bc3-902c-e5a8d3bba840",
                    "name": "Marian Collins"
                },
                {
                    "id": "9fdec5fa-b80d-4728-ad80-a51f8b90974e",
                    "name": "Prof. Malcolm Heller DVM"
                },
                {
                    "id": "9fdec5fa-b90f-41f8-966c-18ec3089ca82",
                    "name": "Conner Lynch"
                }
            ]
        },
        {
            "group": "Table Management",
            "permissions": [
                {
                    "id": "9fdec5fa-bc78-47ec-b06b-eb5b14b59904",
                    "name": "Gene Gerhold DVM"
                },
                {
                    "id": "9fdec5fa-bdf4-421c-8caf-1a72ab4e2cef",
                    "name": "Maya Treutel"
                },
                {
                    "id": "9fdec5fa-bf32-4857-8c6d-a58c54cd27fc",
                    "name": "Geovany Okuneva"
                },
                {
                    "id": "9fdec5fa-c040-499e-9e99-499202abc6fd",
                    "name": "Prof. Robb Torp PhD"
                },
                {
                    "id": "9fdec5fa-c168-4213-9bd6-0734671d28f3",
                    "name": "Prof. Jonatan Roberts"
                }
            ]
        },
        {
            "group": "",
            "permissions": [
                {
                    "id": "9fdec5fb-13ac-43ad-82d9-62adddd03c38",
                    "name": "SHOW_PERMISSIONS"
                }
            ]
        }
    ]
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/permissions/show-all

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

notification

APIs for Notification Management

Show all User Notifications

requires authentication

This endpoint lets user show all notifications

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/show-all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/show-all"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "f912b268-7994-30b6-8424-60f867594b58",
            "data": {
                "type": 5,
                "order_id": "9fdec5e3-4555-45f1-a078-330e243db093",
                "branch_id": "943ad794-bf2d-419c-a415-c4217d5c3fef",
                "title": "New Order",
                "body": "You have received a new order.",
                "icon": "http://localhost/storage/icons/notifications/new-order.png"
            },
            "read": false,
            "created_at": "2025-09-13 19:25:25",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 5
        },
        {
            "id": "f6e22116-5335-3cad-8056-8826e8b70cc0",
            "data": {
                "type": 5,
                "order_id": "9fdec5e3-4555-45f1-a078-330e243db093",
                "branch_id": "943ad794-bf2d-419c-a415-c4217d5c3fef",
                "title": "New Order",
                "body": "You have received a new order.",
                "icon": "http://localhost/storage/icons/notifications/new-order.png"
            },
            "read": true,
            "created_at": "2025-09-13 19:25:25",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 10
        },
        {
            "id": "c2d7b09c-ffae-3d9e-925c-735b92c8b100",
            "data": {
                "type": 5,
                "order_id": "9fdec5e3-4555-45f1-a078-330e243db093",
                "branch_id": "943ad794-bf2d-419c-a415-c4217d5c3fef",
                "title": "New Order",
                "body": "You have received a new order.",
                "icon": "http://localhost/storage/icons/notifications/new-order.png"
            },
            "read": true,
            "created_at": "2025-09-13 19:25:25",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 5
        },
        {
            "id": "bd7323f1-8035-313d-923b-59207d07e3fa",
            "data": {
                "type": 5,
                "order_id": "9fdec5e3-4555-45f1-a078-330e243db093",
                "branch_id": "943ad794-bf2d-419c-a415-c4217d5c3fef",
                "title": "New Order",
                "body": "You have received a new order.",
                "icon": "http://localhost/storage/icons/notifications/new-order.png"
            },
            "read": true,
            "created_at": "2025-09-13 19:25:25",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 5
        },
        {
            "id": "c00f7248-bfeb-35b6-adef-2218210e7770",
            "data": {
                "type": 11,
                "table_id": "some-table-id",
                "table_number": "032",
                "branch_id": "943ad794-bf2d-419c-a415-c4217d5c3fef",
                "title": "Table 032: Unlock Request",
                "body": "A customer needs a waiter to unlock the table.",
                "icon": "http://localhost/storage/icons/notifications/unlock.png"
            },
            "read": false,
            "created_at": "2025-09-13 19:25:15",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 5
        }
    ],
    "meta": {
        "pagination": {
            "total": 5,
            "per_page": 5,
            "count": 5,
            "current_page": 1,
            "unread_count": 10
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/notifications/show-all

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Mark all notifications as read for the given user.

requires authentication

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/mark-all-as-read" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/mark-all-as-read"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Notifications updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/notifications/mark-all-as-read

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Mark the given notification as read.

requires authentication

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/recusandae/mark-as-read" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/recusandae/mark-as-read"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Notification updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/notifications/{notification_id}/mark-as-read

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

notification_id   string   

The ID of the notification. Example: recusandae

Mark Notification as done.

requires authentication

This endpoint lets you mark notification as done.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/quod/mark-as-done" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/quod/mark-as-done"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Notification marked as done successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/notifications/{notification_id}/mark-as-done

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

notification_id   string   

The ID of the notification. Example: quod

Assign specific notification to the currently authenticated user.

requires authentication

This endpoint lets you assign specific notification to the currently authenticated user.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/consequatur/assign-to-self" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/consequatur/assign-to-self"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Notification assigned to you successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/notifications/{notification_id}/assign-to-self

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

notification_id   string   

The ID of the notification. Example: consequatur

Assign specific notification to specific waiter.

requires authentication

This endpoint lets you assign specific notification to specific waiter.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/cumque/assign-to-waiter" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"staff_id\": \"ad\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/notifications/cumque/assign-to-waiter"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "staff_id": "ad"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Notification assigned to waiter successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/notifications/{notification_id}/assign-to-waiter

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

notification_id   string   

The ID of the notification. Example: cumque

Body Parameters

staff_id   string   

The id of an existing record in the staff table. Example: ad

Order

APIs for orders Management

Show all orders

requires authentication

This endpoint lets you show all orders for specific branch for restaurant

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders?page=1&per_page=5&filter%5Bid%5D=et&filter%5Brestaurant_table_id%5D=culpa&filter%5Bstatus%5D=inventore&sort=quos&filter%5Bsearch%5D=incidunt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders"
);

const params = {
    "page": "1",
    "per_page": "5",
    "filter[id]": "et",
    "filter[restaurant_table_id]": "culpa",
    "filter[status]": "inventore",
    "sort": "quos",
    "filter[search]": "incidunt",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec622-88d5-48c9-b90e-00ca797c3182",
            "number": "Maedah_025_16",
            "table": {
                "id": "9fdec618-e41c-4578-8f3f-f7c40ba8eb08",
                "number": "2",
                "status": {
                    "key": 2,
                    "value": "OCCUPIED"
                }
            },
            "items": [
                {
                    "id": "9fdec623-3891-429b-a0f8-7a436c6910a7",
                    "status": 2,
                    "notes": "Alias qui ad quo qui inventore eius recusandae.",
                    "menuItem": {
                        "id": "9fdec622-dc51-401a-b917-5a18366d4d69",
                        "title": "In eveniet enim ut dolores earum ut earum.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 755,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                },
                {
                    "id": "9fdec623-3a15-4dfa-86b0-39a74b620f0e",
                    "status": 2,
                    "notes": "Aut aut iusto voluptatibus ipsa aut voluptatum aspernatur.",
                    "menuItem": {
                        "id": "9fdec623-3629-4ee2-a35f-9af5d5aa4e04",
                        "title": "Eaque quia ipsam ratione harum enim soluta odio.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 668,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                }
            ],
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 7,
                "value": "PENDING_USER_EDIT"
            },
            "created_by": {
                "key": 2,
                "value": "WAITER"
            },
            "payments": [
                {
                    "id": "9fdec623-93b6-4ef7-b72d-7ad866ce5384",
                    "customer_phone": "267-838-0289",
                    "table_id": "9fdec618-e41c-4578-8f3f-f7c40ba8eb08",
                    "payment_method": {
                        "key": 8,
                        "value": "STRIPE"
                    },
                    "status": {
                        "key": 1,
                        "value": "UNPAID"
                    },
                    "amount": 112,
                    "tip_amount": 0
                }
            ],
            "paid_amount": 0,
            "validation_code": null,
            "additional_notes": null,
            "created_at": "2025-09-13T19:25:57.000000Z",
            "modified": false,
            "reviews": [
                {
                    "id": "9fdec623-aa83-4c71-bea8-45cd85bc4018",
                    "customer": "9fdec623-9734-49bb-bffa-da5d5c94f2d5",
                    "rating": 3,
                    "comment": "Minus cumque aspernatur vero nam eaque adipisci."
                },
                {
                    "id": "9fdec623-aec7-46c8-8653-bb70f2961dd0",
                    "customer": "9fdec623-9c9e-443a-a923-ba38589261ca",
                    "rating": 5,
                    "comment": "Dolor ut quibusdam asperiores."
                },
                {
                    "id": "9fdec623-b0ee-4fbb-955f-93b10c8d2c72",
                    "customer": "9fdec623-a51f-4a7a-92db-91c5f9b9410a",
                    "rating": 3,
                    "comment": "Minus et nobis error aliquam beatae sit suscipit."
                }
            ]
        },
        {
            "id": "9fdec621-6ccc-40ef-96c5-c8178130a4e7",
            "number": "Maedah_025_12",
            "table": {
                "id": "9fdec618-e2b3-49b4-9271-2f85f530220e",
                "number": "9",
                "status": {
                    "key": 2,
                    "value": "OCCUPIED"
                }
            },
            "items": [
                {
                    "id": "9fdec622-2239-4779-95e6-a5fd114b1ea7",
                    "status": 2,
                    "notes": "Omnis quo quos nemo.",
                    "menuItem": {
                        "id": "9fdec621-cf94-40f6-852f-2e8d533f7497",
                        "title": "Est sapiente asperiores praesentium eligendi rem.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 328,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                },
                {
                    "id": "9fdec622-239b-4c4d-a99c-6ff48f95ec01",
                    "status": 2,
                    "notes": "Voluptas enim quis alias consequatur accusamus dolor sed.",
                    "menuItem": {
                        "id": "9fdec622-2026-429f-9e9a-5c0abc6c8954",
                        "title": "Quia corrupti pariatur deleniti voluptatum.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 749,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                }
            ],
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 3,
                "value": "ACCEPTED"
            },
            "created_by": {
                "key": 2,
                "value": "WAITER"
            },
            "payments": [
                {
                    "id": "9fdec622-5304-4daa-8aae-a8606f582928",
                    "customer_phone": "479-285-8927",
                    "table_id": "9fdec618-e2b3-49b4-9271-2f85f530220e",
                    "payment_method": {
                        "key": 9,
                        "value": "CHECKOUT"
                    },
                    "status": {
                        "key": 1,
                        "value": "UNPAID"
                    },
                    "amount": 728,
                    "tip_amount": 0
                }
            ],
            "paid_amount": 0,
            "validation_code": null,
            "additional_notes": null,
            "created_at": "2025-09-13T19:25:56.000000Z",
            "modified": false,
            "reviews": [
                {
                    "id": "9fdec622-5ce4-4710-9b40-a89c77b027fa",
                    "customer": "9fdec622-5580-441e-981c-40da8e69adec",
                    "rating": 4,
                    "comment": "Hic deserunt eum dolorum velit."
                },
                {
                    "id": "9fdec622-5e1a-490c-bb9d-7bda874afbf9",
                    "customer": "9fdec622-57d4-4bb5-8f5c-5d997fdf4354",
                    "rating": 3,
                    "comment": "Earum consectetur quae laudantium repellendus."
                },
                {
                    "id": "9fdec622-5f30-4f50-ad08-80a24d69fa51",
                    "customer": "9fdec622-5ac4-4920-994e-05a17c837ce8",
                    "rating": 1,
                    "comment": "Ea vel laboriosam aut ipsam a tenetur repellendus aut."
                }
            ]
        },
        {
            "id": "9fdec620-4f66-4556-b1b6-c561434ce58e",
            "number": "Maedah_025_17",
            "table": {
                "id": "9fdec618-e154-4853-8f0e-0e5536f55ec1",
                "number": "6",
                "status": {
                    "key": 3,
                    "value": "LOCK"
                }
            },
            "items": [
                {
                    "id": "9fdec620-f3eb-48cb-90dc-e3641f4002fa",
                    "status": 2,
                    "notes": "Molestiae quasi minus autem sint dignissimos ipsam nulla facere.",
                    "menuItem": {
                        "id": "9fdec620-a688-44df-8fc9-bbba72819cee",
                        "title": "Voluptatem quia omnis quidem consequuntur.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 306,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                },
                {
                    "id": "9fdec620-f53d-4651-a429-019f75c01355",
                    "status": 2,
                    "notes": "Minus reprehenderit quis eligendi totam perspiciatis.",
                    "menuItem": {
                        "id": "9fdec620-f1e3-4088-a96d-65331e9473a4",
                        "title": "Mollitia quae laboriosam quos qui.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 768,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                }
            ],
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 8,
                "value": "CANCELLED"
            },
            "created_by": {
                "key": 2,
                "value": "WAITER"
            },
            "payments": [
                {
                    "id": "9fdec621-301c-4673-9239-89fd9f5da209",
                    "customer_phone": "770.689.7653",
                    "table_id": "9fdec618-e154-4853-8f0e-0e5536f55ec1",
                    "payment_method": {
                        "key": 6,
                        "value": "PAYPAL"
                    },
                    "status": {
                        "key": 1,
                        "value": "UNPAID"
                    },
                    "amount": 262,
                    "tip_amount": 0
                }
            ],
            "paid_amount": 0,
            "validation_code": null,
            "additional_notes": null,
            "created_at": "2025-09-13T19:25:55.000000Z",
            "modified": false,
            "reviews": [
                {
                    "id": "9fdec621-3c21-49f5-8ff7-a2c6e3a4300f",
                    "customer": "9fdec621-3336-4a16-9175-40ec88b23659",
                    "rating": 4,
                    "comment": "Et expedita iste et labore occaecati deserunt."
                },
                {
                    "id": "9fdec621-3db7-4565-b7f0-5e7a9326d97a",
                    "customer": "9fdec621-3699-492c-9079-ff368edab93f",
                    "rating": 3,
                    "comment": "Aut velit deserunt quo aut at."
                },
                {
                    "id": "9fdec621-3f20-42d9-9c28-227ddbce1b44",
                    "customer": "9fdec621-3a14-45f9-80d7-61c38c5ec5e2",
                    "rating": 5,
                    "comment": "Nihil laborum magnam corporis ut nemo voluptas."
                }
            ]
        },
        {
            "id": "9fdec61f-3bab-4826-a8bc-fa9b6d0e6179",
            "number": "Maedah_025_23",
            "table": {
                "id": "9fdec618-e00f-4634-ab52-7bdebd669454",
                "number": "6",
                "status": {
                    "key": 1,
                    "value": "AVAILABLE"
                }
            },
            "items": [
                {
                    "id": "9fdec61f-f480-4880-a396-3e1117bf387d",
                    "status": 2,
                    "notes": "Itaque eaque numquam omnis sed inventore tempora.",
                    "menuItem": {
                        "id": "9fdec61f-947c-44fa-bdb4-d898f628d1fa",
                        "title": "Earum consequuntur soluta ad.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 759,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                },
                {
                    "id": "9fdec61f-f5b6-4c91-b7b7-7d0435ac2645",
                    "status": 2,
                    "notes": "Cum sapiente beatae voluptatibus nihil.",
                    "menuItem": {
                        "id": "9fdec61f-f245-4b64-b7eb-9919361886d4",
                        "title": "Eos sit vel ut sunt laboriosam.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 492,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                }
            ],
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 3,
                "value": "ACCEPTED"
            },
            "created_by": {
                "key": 2,
                "value": "WAITER"
            },
            "payments": [
                {
                    "id": "9fdec620-2212-427c-b0ee-b9496a7a037a",
                    "customer_phone": "+1-854-609-6577",
                    "table_id": "9fdec618-e00f-4634-ab52-7bdebd669454",
                    "payment_method": {
                        "key": 4,
                        "value": "CASH"
                    },
                    "status": {
                        "key": 1,
                        "value": "UNPAID"
                    },
                    "amount": 652,
                    "tip_amount": 0
                }
            ],
            "paid_amount": 0,
            "validation_code": null,
            "additional_notes": null,
            "created_at": "2025-09-13T19:25:54.000000Z",
            "modified": false,
            "reviews": [
                {
                    "id": "9fdec620-2ba9-47d1-9294-1dcf50a9750c",
                    "customer": "9fdec620-24af-433c-83fc-fc798363a9e2",
                    "rating": 3,
                    "comment": "Eius non suscipit omnis maxime reprehenderit hic ipsum suscipit."
                },
                {
                    "id": "9fdec620-2cd1-4fa0-a527-7fa4d91851e1",
                    "customer": "9fdec620-274f-4c49-aa5f-1267ff822910",
                    "rating": 1,
                    "comment": "Numquam et dolorum occaecati aut consequuntur corrupti."
                },
                {
                    "id": "9fdec620-2df4-4fd8-a65a-ad3147da0e03",
                    "customer": "9fdec620-29fb-4a51-b3a2-02784aeb7d7a",
                    "rating": 1,
                    "comment": "Numquam sapiente et omnis sit perferendis beatae ducimus."
                }
            ]
        },
        {
            "id": "9fdec61e-39d1-46d9-8d71-ee826dd28d58",
            "number": "Maedah_025_8",
            "table": {
                "id": "9fdec618-def3-405f-b1e5-21c005a6b09d",
                "number": "5",
                "status": {
                    "key": 4,
                    "value": "RESERVED"
                }
            },
            "items": [
                {
                    "id": "9fdec61e-df4c-4440-90eb-74b12ea78da5",
                    "status": 2,
                    "notes": "Numquam nam vel consequatur voluptatibus quam ut.",
                    "menuItem": {
                        "id": "9fdec61e-8e75-4640-8f1b-a43bc595421f",
                        "title": "Sit nihil quia ut qui magni.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 807,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                },
                {
                    "id": "9fdec61e-e037-458c-b989-6c7b3758f8ef",
                    "status": 2,
                    "notes": "Non architecto aut error.",
                    "menuItem": {
                        "id": "9fdec61e-dd9c-4417-9ce6-4ebf574b9c12",
                        "title": "Temporibus voluptates doloremque placeat vero velit est quis dolore.",
                        "image": "http://localhost/storage/restaurants/menu_item.png",
                        "price": 956,
                        "currency": {
                            "key": 3,
                            "value": "AED"
                        },
                        "status": {
                            "key": 1,
                            "value": "AVAILABLE"
                        }
                    }
                }
            ],
            "total_amount": 500,
            "final_amount": 500,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 5,
                "value": "READY"
            },
            "created_by": {
                "key": 2,
                "value": "WAITER"
            },
            "payments": [
                {
                    "id": "9fdec61f-092b-43ba-899a-cf3620f5d513",
                    "customer_phone": "+1.272.200.2602",
                    "table_id": "9fdec618-def3-405f-b1e5-21c005a6b09d",
                    "payment_method": {
                        "key": 9,
                        "value": "CHECKOUT"
                    },
                    "status": {
                        "key": 1,
                        "value": "UNPAID"
                    },
                    "amount": 435,
                    "tip_amount": 0
                }
            ],
            "paid_amount": 0,
            "validation_code": null,
            "additional_notes": null,
            "created_at": "2025-09-13T19:25:54.000000Z",
            "modified": false,
            "reviews": [
                {
                    "id": "9fdec61f-1252-4b3f-adb4-4b7ec210c194",
                    "customer": "9fdec61f-0b76-4901-9267-3822ce794c97",
                    "rating": 4,
                    "comment": "Placeat ea est voluptatem nisi aliquam ab ea."
                },
                {
                    "id": "9fdec61f-1371-46c1-a8be-befd77188e9c",
                    "customer": "9fdec61f-0df6-4d8c-82af-a0e37db9113d",
                    "rating": 2,
                    "comment": "Non est itaque quisquam unde aliquid et."
                },
                {
                    "id": "9fdec61f-1498-4de5-b8ac-d9044e1c310a",
                    "customer": "9fdec61f-10b2-432b-ae2c-2cfdcc3b56d0",
                    "rating": 4,
                    "comment": "Iusto ab aut quo nisi dolorem dolorem est."
                }
            ]
        }
    ],
    "meta": {
        "pagination": {
            "total": 15,
            "per_page": 5,
            "count": 5,
            "current_page": 2
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 1

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 5

filter[id]   string  optional  

Field to filter items by id. Example: et

filter[restaurant_table_id]   string  optional  

Field to filter items by restaurant_table_id. Example: culpa

filter[status]   string  optional  

Field to filter items by status. Example: inventore

sort   string  optional  

Field to sort items by status. Example: quos

filter[search]   string  optional  

Field to perform a custom search. Example: incidunt

Add New Order

requires authentication

This endpoint lets you add new order

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/add-order" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"restaurant_table_id\": \"amet\",
    \"order_items\": [
        {
            \"id\": \"ad\",
            \"notes\": \"expedita\"
        }
    ],
    \"validation_code\": \"wi\",
    \"additional_notes\": \"et\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/add-order"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "restaurant_table_id": "amet",
    "order_items": [
        {
            "id": "ad",
            "notes": "expedita"
        }
    ],
    "validation_code": "wi",
    "additional_notes": "et"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec626-504d-4f96-8272-11330e1f09ba",
        "number": "#gjj_6_1",
        "table": {
            "id": "9fdec625-b397-430b-b7c2-9932edd88cd2",
            "number": "6",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            }
        },
        "items": [
            {
                "id": "9fdec626-5334-4f31-b8e8-43a8ebb4c1e8",
                "status": 2,
                "notes": "dfsdsfs",
                "menuItem": {
                    "id": "9fdec625-fabd-4ee0-b17c-8b200a359172",
                    "title": "shaowrma",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 10,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec626-55a8-4029-8783-d910b79d5c39",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec626-2147-46ae-8e8e-7053cf3d2da9",
                    "title": "taboulah",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 5,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec626-5804-4af9-8991-a6ff0637ccbf",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec626-2147-46ae-8e8e-7053cf3d2da9",
                    "title": "taboulah",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 5,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec626-5a7d-4533-aa5b-215ba3440add",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec626-2147-46ae-8e8e-7053cf3d2da9",
                    "title": "taboulah",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 5,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec626-5d16-4ced-8ee7-b8dfd8848611",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec625-fabd-4ee0-b17c-8b200a359172",
                    "title": "shaowrma",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 10,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            }
        ],
        "total_amount": 35,
        "final_amount": 136,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 2,
            "value": "PENDING"
        },
        "created_by": {
            "key": 2,
            "value": "WAITER"
        },
        "payments": null,
        "paid_amount": 0,
        "validation_code": "242",
        "additional_notes": "this order",
        "created_at": "2025-09-13T19:25:59.000000Z",
        "modified": false,
        "reviews": null
    },
    "message": "The order added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/add-order

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

Body Parameters

restaurant_table_id   string   

The id of an existing record in the restaurant_tables table. Example: amet

order_items   object[]   

Must have at least 1 items.

id   string   

The id of an existing record in the menu_items table. Example: ad

notes   string  optional  

Example: expedita

phone   string  optional  
validation_code   string  optional  

Must not be greater than 3 characters. Example: wi

additional_notes   string  optional  

Example: et

Show Specific Order

requires authentication

This endpoint lets you show specific order

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/corporis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/corporis"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec627-0eee-48c4-9078-5e0c687823ab",
        "number": "Maedah_025_17",
        "table": {
            "id": "9fdec626-626a-4547-8ae7-c30879ff8031",
            "number": "10",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            }
        },
        "items": [
            {
                "id": "9fdec627-d075-40cf-847c-bf48bf330d2a",
                "status": 2,
                "notes": "Ut omnis quisquam doloremque et voluptatem architecto minus.",
                "menuItem": {
                    "id": "9fdec627-70a6-4b1a-a55e-299ae8083f4b",
                    "title": "Minus consequatur ipsum similique nihil impedit consequatur porro.",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 768,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec627-d1b0-4efe-bb13-0c72f774123b",
                "status": 2,
                "notes": "Molestiae ea doloremque aut sint perferendis exercitationem dolorem.",
                "menuItem": {
                    "id": "9fdec627-ce68-4aee-9a87-e3ee560ab378",
                    "title": "Atque veniam accusamus sed et voluptas delectus.",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 810,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            }
        ],
        "total_amount": 500,
        "final_amount": 500,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 4,
            "value": "PREPARING"
        },
        "created_by": {
            "key": 1,
            "value": "CUSTOMER"
        },
        "payments": null,
        "paid_amount": 0,
        "validation_code": null,
        "additional_notes": "dddddd",
        "created_at": "2025-09-13T19:26:00.000000Z",
        "modified": false,
        "reviews": [
            {
                "id": "9fdec627-dc06-4445-b292-ae15dc76fdac",
                "customer": "9fdec627-d49f-4b85-82b6-2014ec763b40",
                "rating": 5,
                "comment": "Aut odit aut molestias expedita officia."
            },
            {
                "id": "9fdec627-dd18-46da-a607-13ffde394370",
                "customer": "9fdec627-d79d-4db1-aac2-4a193020731b",
                "rating": 4,
                "comment": "Minima molestiae esse aliquid repellat suscipit error nam."
            },
            {
                "id": "9fdec627-de90-45da-9b0d-e0f3ece76a06",
                "customer": "9fdec627-da48-41ee-a6e2-14adf4dc6e54",
                "rating": 4,
                "comment": "Natus nam sed et beatae eum deleniti perferendis."
            }
        ]
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: corporis

show all payments for specific order

requires authentication

This endpoint lets you show all payments for specific order

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/sapiente/show-order-payment" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/sapiente/show-order-payment"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec624-ea17-4473-bd65-13cb24c79f9c",
            "customer_phone": "908.558.3859",
            "table_id": "9fdec623-937c-4959-a577-10487e9d8cab",
            "payment_method": {
                "key": 9,
                "value": "CHECKOUT"
            },
            "status": {
                "key": 1,
                "value": "UNPAID"
            },
            "amount": 495,
            "tip_amount": 0
        },
        {
            "id": "9fdec624-ed9f-4af4-b0f8-c2daeabe6193",
            "customer_phone": "540.825.4134",
            "table_id": "9fdec623-937c-4959-a577-10487e9d8cab",
            "payment_method": {
                "key": 9,
                "value": "CHECKOUT"
            },
            "status": {
                "key": 1,
                "value": "UNPAID"
            },
            "amount": 803,
            "tip_amount": 0
        },
        {
            "id": "9fdec624-ef63-4bb5-ac73-77252dd61c75",
            "customer_phone": "762.223.7917",
            "table_id": "9fdec623-937c-4959-a577-10487e9d8cab",
            "payment_method": {
                "key": 4,
                "value": "CASH"
            },
            "status": {
                "key": 1,
                "value": "UNPAID"
            },
            "amount": 857,
            "tip_amount": 0
        },
        {
            "id": "9fdec624-f182-45e5-ace0-a9a44e528fc0",
            "customer_phone": "+1-726-580-8412",
            "table_id": "9fdec623-937c-4959-a577-10487e9d8cab",
            "payment_method": {
                "key": 2,
                "value": "APPLE_PAY"
            },
            "status": {
                "key": 1,
                "value": "UNPAID"
            },
            "amount": 133,
            "tip_amount": 0
        },
        {
            "id": "9fdec624-f35b-4c48-ba17-4e19546f78a7",
            "customer_phone": "(838) 274-1148",
            "table_id": "9fdec623-937c-4959-a577-10487e9d8cab",
            "payment_method": {
                "key": 4,
                "value": "CASH"
            },
            "status": {
                "key": 1,
                "value": "UNPAID"
            },
            "amount": 925,
            "tip_amount": 0
        }
    ],
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}/show-order-payment

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: sapiente

update Specific Order

requires authentication

This endpoint lets you update specific order

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/nemo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": 9,
    \"total_amount\": 80,
    \"final_amount\": 24,
    \"currency\": 3,
    \"additional_notes\": \"non\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/nemo"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": 9,
    "total_amount": 80,
    "final_amount": 24,
    "currency": 3,
    "additional_notes": "non"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec629-26e1-484a-ada9-06f43cfea19f",
        "number": "Maedah_025_8",
        "table": {
            "id": "9fdec628-cf8a-4524-a18d-4fad73938cfe",
            "number": "10",
            "status": {
                "key": 2,
                "value": "OCCUPIED"
            }
        },
        "items": [],
        "total_amount": 100,
        "final_amount": 100,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 3,
            "value": "ACCEPTED"
        },
        "created_by": {
            "key": 2,
            "value": "WAITER"
        },
        "payments": null,
        "paid_amount": 0,
        "validation_code": null,
        "additional_notes": "this order",
        "created_at": "2024-07-06T06:09:20.000000Z",
        "modified": false,
        "reviews": [
            {
                "id": "9fdec629-33f0-48e4-ae77-74f242cc1072",
                "customer": "9fdec629-2a48-46d6-8c99-e8a3b2a806f2",
                "rating": 2,
                "comment": "Est aut nisi sequi quia quia perferendis."
            },
            {
                "id": "9fdec629-354b-4e7c-88e9-1eaa77000cb8",
                "customer": "9fdec629-2e00-457c-8f68-62954c646d55",
                "rating": 5,
                "comment": "Reiciendis accusamus velit voluptatem quibusdam pariatur facilis."
            },
            {
                "id": "9fdec629-3704-4c2a-a813-de8ee421ef6d",
                "customer": "9fdec629-31b1-4e90-a1aa-ad0948887bc5",
                "rating": 5,
                "comment": "Modi doloribus reiciendis et qui laboriosam deserunt."
            }
        ]
    },
    "message": "The Order has been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: nemo

Body Parameters

restaurant_table_id   string  optional  

The id of an existing record in the restaurant_tables table.

status   integer  optional  

Example: 9

Must be one of:
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
total_amount   number  optional  

Must be at least 0. Example: 80

final_amount   number  optional  

Must be at least 0. Example: 24

currency   integer  optional  

Example: 3

Must be one of:
  • 1
  • 2
  • 3
  • 4
additional_notes   string  optional  

Example: non

update Specific Order Status To Accept

requires authentication

This endpoint lets you update specific order status

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/quod/mark-status-accept" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/quod/mark-status-accept"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Order status has been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}/mark-status-accept

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: quod

update Specific Order Status To Prepare

requires authentication

This endpoint lets you update specific order status to prepare

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/enim/mark-status-preparing" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/enim/mark-status-preparing"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Order status has been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}/mark-status-preparing

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: enim

update Specific Order Restaurant Table

requires authentication

This endpoint lets you update specific order restaurant table

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/id/change_table" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/id/change_table"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The Order table has been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}/change_table

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: id

Body Parameters

restaurant_table_id   string  optional  

The id of an existing record in the restaurant_tables table.

Delete Specific Order

requires authentication

This endpoint lets you delete specific order

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/voluptatum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/voluptatum"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The order has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: voluptatum

OrderItems

APIs for orderItems Management

Delete many items in order.

requires authentication

This endpoint lets you delete Specific many items in order

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/qui/order-items/delete-items" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/qui/order-items/delete-items"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec61e-0cc3-4df3-b7e3-d7447434abdc",
        "number": "Maedah_025_12",
        "table": {
            "id": "9fdec61d-5d18-4505-9d9f-3873aa192c2c",
            "number": "10",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            }
        },
        "items": [
            {
                "id": "9fdec61f-c9fc-4c6f-b2b8-4f46bc128e28",
                "status": 2,
                "notes": "Ipsam est adipisci quis labore sint asperiores cupiditate.",
                "menuItem": {
                    "id": "9fdec61f-6425-407a-a152-95ed8391e7c9",
                    "title": "Aut omnis impedit voluptas deserunt dolorem molestias.",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 490,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec61f-cb46-4366-bca3-ea002fb4bf8e",
                "status": 2,
                "notes": "Quasi aut aut ut saepe vel.",
                "menuItem": {
                    "id": "9fdec61f-c82a-4a08-9a21-2752475ae84b",
                    "title": "Tenetur corrupti temporibus neque illum.",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 482,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            }
        ],
        "total_amount": 200,
        "final_amount": 230,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 4,
            "value": "PREPARING"
        },
        "created_by": {
            "key": 2,
            "value": "WAITER"
        },
        "payments": null,
        "paid_amount": 0,
        "validation_code": null,
        "additional_notes": null,
        "created_at": "2025-09-13T19:25:54.000000Z",
        "modified": true,
        "reviews": [
            {
                "id": "9fdec61e-17b2-4895-bdfc-195a2e75f0c7",
                "customer": "9fdec61e-100c-4461-a435-fb962a9b9e0d",
                "rating": 1,
                "comment": "Nisi deserunt praesentium ut quo."
            },
            {
                "id": "9fdec61e-18ea-4938-9785-14129fcb3d11",
                "customer": "9fdec61e-1306-41f4-a5fd-36e7189f8a19",
                "rating": 2,
                "comment": "Possimus quo repudiandae aut non fugiat reiciendis est."
            },
            {
                "id": "9fdec61e-1a4a-4816-8695-0c9301fbc774",
                "customer": "9fdec61e-1629-4704-8def-b95033b91382",
                "rating": 1,
                "comment": "Ea est voluptas vero."
            }
        ]
    },
    "message": "The Order Items have been deleted successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}/order-items/delete-items

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: qui

Delete the specified order item.

requires authentication

This endpoint lets you delete Specific OrderItem from order

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/ullam/order-items/et" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/ullam/order-items/et"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec61b-c99d-4e7b-ae2c-e8257c6cdf08",
        "number": "Maedah_025_9",
        "table": {
            "id": "9fdec61b-05da-4e99-8dac-1cb5ed236a87",
            "number": "2",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            }
        },
        "items": [
            {
                "id": "9fdec61c-7b6c-47a8-9ac5-bec026fd86a6",
                "status": 2,
                "notes": "Unde quia sint rerum nihil eligendi.",
                "menuItem": {
                    "id": "9fdec61b-76c0-4f8c-a244-dd5fa24d4005",
                    "title": "Sed quidem in perferendis quisquam libero eaque.",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 50,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec61c-e4bf-4ff0-870b-0350427f7463",
                "status": 2,
                "notes": "Quis nihil voluptatibus distinctio odio labore amet numquam.",
                "menuItem": {
                    "id": "9fdec61b-9e33-4426-a999-f8ce859447e6",
                    "title": "Porro magnam ut quae aliquam.",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 75,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            }
        ],
        "total_amount": 125,
        "final_amount": 151,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 4,
            "value": "PREPARING"
        },
        "created_by": {
            "key": 1,
            "value": "CUSTOMER"
        },
        "payments": null,
        "paid_amount": 0,
        "validation_code": null,
        "additional_notes": null,
        "created_at": "2025-09-13T19:25:52.000000Z",
        "modified": true,
        "reviews": null
    },
    "message": "The Order Item has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}/order-items/{order_item_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: ullam

order_item_id   string   

The ID of the order item. Example: et

update OrderItem of Specific Order

requires authentication

This endpoint lets you update OrderItem of Specific Order

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/et/order-items/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"notes\": \"magni\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/et/order-items/ut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "notes": "magni"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec624-8cf2-40f9-b6da-f76bcd2babe4",
        "number": "Maedah_025_10",
        "table": {
            "id": "9fdec623-b8cc-4318-ab0d-b63b99afc715",
            "number": "3",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            }
        },
        "items": [
            {
                "id": "9fdec624-8f66-43a9-81cd-03e9a6ab0eed",
                "status": 1,
                "notes": "note one",
                "menuItem": {
                    "id": "9fdec624-5153-49aa-90b7-544f8d5f4853",
                    "title": "tabbouleh",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 50,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            }
        ],
        "total_amount": 50,
        "final_amount": 152,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 2,
            "value": "PENDING"
        },
        "created_by": {
            "key": 2,
            "value": "WAITER"
        },
        "payments": null,
        "paid_amount": 0,
        "validation_code": null,
        "additional_notes": null,
        "created_at": "2025-09-13T19:25:58.000000Z",
        "modified": true,
        "reviews": [
            {
                "id": "9fdec624-9b71-42b8-8edb-7bcb2735471d",
                "customer": "9fdec624-9298-4cde-b455-ba4ed2841178",
                "rating": 2,
                "comment": "Accusantium cupiditate aut repellat dolorum placeat maxime."
            },
            {
                "id": "9fdec624-9ceb-4c9d-b563-530879861a39",
                "customer": "9fdec624-95c8-48cf-b532-8d40f47606d5",
                "rating": 3,
                "comment": "Commodi minima facere ut beatae possimus."
            },
            {
                "id": "9fdec624-9e3b-4e9e-9618-886604964ee7",
                "customer": "9fdec624-98e8-4c3e-8a69-4651d4b8d482",
                "rating": 1,
                "comment": "Magni quas architecto hic provident aut."
            }
        ]
    },
    "message": "The Order Item has been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}/order-items/{order_item_id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: et

order_item_id   string   

The ID of the order item. Example: ut

Body Parameters

id   string  optional  

The id of an existing record in the order_items table.

menu_item_id   string  optional  

The id of an existing record in the menu_items table.

notes   string  optional  

Example: magni

Add new Item to Specific Order

requires authentication

This endpoint lets you add new item to Specific Order

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/beatae/order-items/add-order-item" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order_items\": [
        {
            \"id\": \"maxime\",
            \"notes\": \"quisquam\"
        }
    ]
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/beatae/order-items/add-order-item"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "order_items": [
        {
            "id": "maxime",
            "notes": "quisquam"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec61f-c47f-4c6d-a356-d802fdc3753c",
        "number": "Maedah_025_8",
        "table": {
            "id": "9fdec61f-0651-4e8e-9ea7-abac6e01e835",
            "number": "5",
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            }
        },
        "items": [
            {
                "id": "9fdec61f-c633-4231-97f3-0c1a6d3fde7d",
                "status": 1,
                "notes": null,
                "menuItem": {
                    "id": "9fdec61f-7474-47c3-8197-1efa599a7ab3",
                    "title": "shawarma",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 100,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec61f-e3a9-48e2-b53a-067b791b9aef",
                "status": 2,
                "notes": "dfsdsfs",
                "menuItem": {
                    "id": "9fdec61f-7474-47c3-8197-1efa599a7ab3",
                    "title": "shawarma",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 100,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec61f-e5d9-48eb-b318-b15beaac7746",
                "status": 2,
                "notes": "dddd",
                "menuItem": {
                    "id": "9fdec61f-a374-4be5-8262-85564c524da1",
                    "title": "tabbouleh",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 50,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec61f-e826-47d1-a393-20960d621c90",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec61f-a374-4be5-8262-85564c524da1",
                    "title": "tabbouleh",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 50,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec61f-ea60-44f8-b6bd-b85b1029e124",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec61f-a374-4be5-8262-85564c524da1",
                    "title": "tabbouleh",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 50,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            },
            {
                "id": "9fdec61f-ecc2-401e-bffb-9ad09b3af74d",
                "status": 2,
                "notes": null,
                "menuItem": {
                    "id": "9fdec61f-7474-47c3-8197-1efa599a7ab3",
                    "title": "shawarma",
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 100,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            }
        ],
        "total_amount": 450,
        "final_amount": 572,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 7,
            "value": "PENDING_USER_EDIT"
        },
        "created_by": {
            "key": 1,
            "value": "CUSTOMER"
        },
        "payments": null,
        "paid_amount": 0,
        "validation_code": null,
        "additional_notes": null,
        "created_at": "2025-09-13T19:25:55.000000Z",
        "modified": true,
        "reviews": null
    },
    "message": "The order updated successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}/order-items/add-order-item

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: beatae

Body Parameters

order_items   object[]  optional  
id   string   

The id of an existing record in the menu_items table. Example: maxime

notes   string  optional  

Example: quisquam

update Specific status of OrderItem

requires authentication

This endpoint lets you update Specific status of OrderItem

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/reiciendis/order-items/consequatur/change-status" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": 2
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/orders/reiciendis/order-items/consequatur/change-status"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "status": 2
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "status": {
            "key": 3,
            "value": "READY"
        }
    },
    "message": "The Order Item Status has been updated successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/orders/{order_id}/order-items/{order_item_id}/change-status

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

order_id   string   

The ID of the order. Example: reiciendis

order_item_id   string   

The ID of the order item. Example: consequatur

Body Parameters

status   integer  optional  

Example: 2

Must be one of:
  • 1
  • 2
  • 3

StaffTables

APIs for StaffTables Management

Assign a table to specific waiters.

requires authentication

This endpoint lets you assign specific tabled to the currently authenticated user.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/assign-to-staff" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"staff\": [
        {
            \"id\": \"ratione\"
        }
    ]
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/assign-to-staff"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "staff": [
        {
            "id": "ratione"
        }
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec641-3a20-4778-a28f-7ff443420fcd",
            "staff_id": "95b75067-3505-4da9-8dce-e90aeda95376",
            "restaurant_table_id": "9fdec640-b184-4147-9ce8-d1e0016cc4f9"
        },
        {
            "id": "9fdec641-3d61-4761-bb8d-b80e325c3d62",
            "staff_id": "6b482270-e1bc-4c7e-9b5b-c524bc1917f8",
            "restaurant_table_id": "9fdec640-b184-4147-9ce8-d1e0016cc4f9"
        },
        {
            "id": "9fdec641-40e6-4255-ba9d-abc19417abd7",
            "staff_id": "2ca9e750-f5cd-4f47-9cba-b1cea3b2b5f0",
            "restaurant_table_id": "9fdec640-b184-4147-9ce8-d1e0016cc4f9"
        }
    ],
    "message": "Staff members assigned to the table successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{restaurant_table_id}/assign-to-staff

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

restaurant_table_id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

Body Parameters

staff   object[]   

Must have at least 1 items.

id   string   

The id of an existing record in the staff table. Example: ratione

Assign a table to the currently authenticated user.

requires authentication

This endpoint lets you assign specific table to many waiters .

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/assign-to-self" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/restaurant-tables/9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693/assign-to-self"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Table assigned to you successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/restaurant-tables/{restaurant_table_id}/assign-to-self

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

restaurant_table_id   string   

The ID of the restaurant table. Example: 9fdec6fe-9ee5-4ca2-b536-aaf28b5c0693

MenuCategory

APIs for managing menu categories within menus.

Show all menu categories in a specific menu of a branch for a restaurant.

requires authentication

This endpoint allows you to retrieve all menu categories for a specific menu within a branch of a restaurant.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories?page=8&per_page=13&filter%5Btitle%5D=ipsum&filter%5Bsearch%5D=dicta&sort=voluptates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories"
);

const params = {
    "page": "8",
    "per_page": "13",
    "filter[title]": "ipsum",
    "filter[search]": "dicta",
    "sort": "voluptates",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec603-d3c1-4766-a7d6-639d6ae448f9",
            "title": "Est enim quo excepturi natus sed.",
            "title_ar": "Deleniti corrupti quis aliquid distinctio incidunt.",
            "description": "Saepe earum facilis voluptatem rerum. Molestiae earum voluptatum corporis consequuntur autem pariatur. Eaque est repellendus error. Qui accusantium ab sit. Aut est qui doloremque nihil et saepe.",
            "description_ar": "Vel atque natus quaerat repellat. Id distinctio nobis aspernatur aut in molestiae qui. Et sed sed adipisci enim culpa in. Magni et autem fugit placeat quae quis rerum. Sint molestiae veritatis et.",
            "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
            "menu_items": []
        },
        {
            "id": "9fdec603-d243-48f4-9526-16232f639583",
            "title": "Voluptatem aut adipisci quia quisquam necessitatibus cupiditate omnis.",
            "title_ar": "Aut a rem quod quasi rem quis corporis.",
            "description": "Accusantium corporis ex optio suscipit velit ipsa quo. Alias ratione est sint dolor facere quis. Libero nisi sint provident eos dolores.",
            "description_ar": "Rerum laudantium quibusdam impedit. Cum quo voluptatibus sunt vel vel molestiae. In velit nisi consequatur et itaque perspiciatis non impedit. Incidunt voluptatem illum possimus unde nam.",
            "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
            "menu_items": []
        },
        {
            "id": "9fdec603-d0bf-4229-a563-f8e3e96a1854",
            "title": "Fugit ad in provident repellat voluptas.",
            "title_ar": "Sed omnis voluptates veritatis possimus maiores voluptatem nihil.",
            "description": "Quisquam asperiores qui praesentium sequi sit eveniet. Laborum iste aliquid ut mollitia. Aut molestias et aut quaerat neque beatae quidem. Maiores eos fugit voluptas.",
            "description_ar": "Ea quam harum beatae nesciunt distinctio. Nisi hic sunt minus vel cumque. Consectetur similique aliquam sequi suscipit earum aut.",
            "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
            "menu_items": []
        },
        {
            "id": "9fdec603-cebd-452b-9cd5-1ac77cee02ec",
            "title": "Quae nesciunt totam quidem corporis ut quaerat ea.",
            "title_ar": "Et ratione quidem quia vitae.",
            "description": "Quidem suscipit illum eaque dolor. Porro repellendus quasi sapiente libero maxime minima. Nisi architecto nostrum dolore nihil exercitationem nam et error.",
            "description_ar": "Vel dolorem a quo esse corporis vitae. Aut ab et nemo omnis nesciunt necessitatibus sapiente et. Eum aut ipsum porro deserunt ut id quasi. Ipsum nesciunt dolor officiis et quis porro sint.",
            "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
            "menu_items": []
        },
        {
            "id": "9fdec603-ccd8-49fc-a22a-25697d275e16",
            "title": "Omnis qui iure eligendi enim id non vel.",
            "title_ar": "Odio cumque eaque libero cumque et.",
            "description": "Ea voluptatem officia sed aspernatur in est rerum. Doloremque voluptate tempora placeat eum sit enim labore qui. In totam est libero voluptas temporibus.",
            "description_ar": "Earum earum qui tempore voluptas dolor vero. Consequatur aut eveniet at saepe eaque libero. Quo et assumenda in. Repellat sed delectus nam.",
            "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
            "menu_items": []
        }
    ],
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 8

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 13

filter[title]   string  optional  

Field to filter items by title. Example: ipsum

filter[search]   string  optional  

Field to filter items by title. Example: dicta

sort   string  optional  

Field to sort items by title. Example: voluptates

Add a menu category to a specific menu within a branch of a restaurant.

requires authentication

This endpoint allows you to add a new menu category to a specific menu within a branch of a restaurant.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=tdrrfrbshjk"\
    --form "title_ar=udmsfbttsahtuacper"\
    --form "description=Fugiat voluptatem eum saepe aliquam eligendi libero autem."\
    --form "description_ar=sswwwnegianqui"\
    --form "image=@/tmp/phpopmpmA" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'tdrrfrbshjk');
body.append('title_ar', 'udmsfbttsahtuacper');
body.append('description', 'Fugiat voluptatem eum saepe aliquam eligendi libero autem.');
body.append('description_ar', 'sswwwnegianqui');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec603-def9-4750-931b-3a57bcdfc5dc",
        "title": "menu title",
        "title_ar": "menu title",
        "description": "this menu category",
        "description_ar": "this menu category",
        "image": "http://localhost/storage/restaurants/9fdec603-56a2-4652-a9dd-770d53c3823b/1ccc1f40-e554-4c12-ba57-cced8f9a126b/9fdec603-bcf3-416c-b89f-779a2cf7de77/BFqjM459tX17c7vajmJoZew6nbTYlryC47jSinXB.jpg",
        "menu_items": []
    },
    "message": "The menu category has been added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

Body Parameters

menu_categories_id   string  optional  

The id of an existing record in the menu_categories table.

title   string   

Must not be greater than 255 characters. Example: tdrrfrbshjk

title_ar   string   

Must not be greater than 255 characters. Example: udmsfbttsahtuacper

description   string  optional  

Must not be greater than 255 characters. Example: Fugiat voluptatem eum saepe aliquam eligendi libero autem.

description_ar   string  optional  

Must not be greater than 255 characters. Example: sswwwnegianqui

image   file   

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpopmpmA

Show details of a menu category in a menu within a specific branch of a restaurant.

requires authentication

This endpoint allows you to retrieve detailed information about a menu category within a specific menu of a branch in a restaurant.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec601-c934-4a22-aef0-09a7ca4db5e9",
        "title": "Explicabo est quidem est veniam dolor.",
        "title_ar": "In eaque quam maiores eos aut et ea.",
        "description": "Quis accusantium et quo quidem. Nihil et labore est quisquam quo itaque ab. Minima consequuntur ipsam eaque eaque.",
        "description_ar": "Delectus aut et aut. Molestiae aut est dolorum ea consequatur rem. Tenetur vel consectetur consequatur quia et quod. Quia libero itaque dignissimos sit quo.",
        "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
        "menu_items": []
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

id   string   

The ID of the menu category. Example: 9fdec6fe-f54d-4c11-8fa7-cefae9664d18

Update a menu category of a specific menu within a branch of a restaurant.

requires authentication

This endpoint allows you to update a menu category of a specific menu within a branch of a restaurant.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=wfxcvnxnuvkfqrthvgcvwvku"\
    --form "title_ar=tkenvxlumxhszvvtgzfejixki"\
    --form "description=Rerum tempora illo sit est qui."\
    --form "description_ar=ordubjqekoo"\
    --form "image=@/tmp/phpjmpOpi" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'wfxcvnxnuvkfqrthvgcvwvku');
body.append('title_ar', 'tkenvxlumxhszvvtgzfejixki');
body.append('description', 'Rerum tempora illo sit est qui.');
body.append('description_ar', 'ordubjqekoo');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec605-aab2-4c74-a546-0e7c82543146",
        "title": "new menu category title",
        "title_ar": "Consequatur sed eligendi eos aut.",
        "description": "Incidunt accusantium mollitia hic repudiandae iure ut labore ut. Est voluptas ea voluptatem qui. Quia inventore facilis sapiente earum soluta non odio.",
        "description_ar": "Reprehenderit quis est sed temporibus fugiat fugiat dignissimos. Sunt distinctio porro excepturi sunt quidem omnis. Odit exercitationem deleniti praesentium. In animi magni repellendus voluptatibus totam ipsam voluptas.",
        "image": "http://localhost/storage/restaurants/menu_category_image.jpg",
        "menu_items": []
    },
    "message": "The menu category has been updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{id}

PATCH api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

id   string   

The ID of the menu category. Example: 9fdec6fe-f54d-4c11-8fa7-cefae9664d18

Body Parameters

menu_categories_id   string  optional  

The id of an existing record in the menu_categories table.

title   string  optional  

Must not be greater than 255 characters. Example: wfxcvnxnuvkfqrthvgcvwvku

title_ar   string  optional  

Must not be greater than 255 characters. Example: tkenvxlumxhszvvtgzfejixki

description   string  optional  

Must not be greater than 255 characters. Example: Rerum tempora illo sit est qui.

description_ar   string  optional  

Must not be greater than 255 characters. Example: ordubjqekoo

image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpjmpOpi

Delete a specific menu category within a specific restaurant branch.

requires authentication

This endpoint allows you to delete a specific menu category within a specific restaurant branch.

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The menu category has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

id   string   

The ID of the menu category. Example: 9fdec6fe-f54d-4c11-8fa7-cefae9664d18

MenuItem

APIs for managing menu items within menu categories.

Show all menu items within a specific menu category.

requires authentication

This endpoint allows you to retrieve all menu items within a specific category in a menu of a branch for a restaurant.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items?page=10&per_page=8&filter%5Bid%5D=dolor&filter%5Btitle%5D=vel&filter%5Bprice%5D=accusantium&filter%5Bstatus%5D=illo&filter%5Bsearch%5D=quas&sort=soluta" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items"
);

const params = {
    "page": "10",
    "per_page": "8",
    "filter[id]": "dolor",
    "filter[title]": "vel",
    "filter[price]": "accusantium",
    "filter[status]": "illo",
    "filter[search]": "quas",
    "sort": "soluta",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "9fdec60b-cd3b-4bd4-911c-12bb374ce531",
            "menu_category": {
                "menu_category_title": "Optio esse facilis qui culpa eum.",
                "menu_category_id": "9fdec60a-d678-4a39-8cab-102ca6773608"
            },
            "menu_title": "Placeat beatae beatae porro.",
            "title": "Ratione qui ad dolorem ipsum delectus cum vero neque.",
            "title_ar": "Qui est non ipsum.",
            "type_label": "Medium",
            "type_label_ar": "وسط",
            "description": "Nulla assumenda velit doloremque consequuntur sit. Quod quia quia omnis deleniti. Commodi voluptas est enim non aut reprehenderit recusandae.",
            "description_ar": "Et aliquid in architecto quos. Ullam sit dolorum unde qui. Dolores illum voluptates natus reiciendis nam. Modi nesciunt voluptas molestias laudantium consequatur dolores labore.",
            "available_quantity": 6,
            "image": "http://localhost/storage/restaurants/menu_item.png",
            "price": 547,
            "cost": 704,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "sub_items": [
                {
                    "id": "9fdec60e-9e36-470c-b754-5e251488ddb5",
                    "title": "Esse magnam voluptas ea totam.",
                    "title_ar": "Asperiores qui nulla commodi rerum nesciunt et.",
                    "type_label": "Medium",
                    "description": "Vel adipisci maiores quia ipsa voluptas ut ipsam. Minus nemo impedit commodi vel sunt corporis et. Ad hic mollitia dolor.",
                    "description_ar": "Nostrum repellendus quia optio voluptas. Et reiciendis aliquid accusantium omnis laboriosam recusandae ea. Velit quia consequatur omnis et non laborum. Est excepturi est at accusamus error nam et facere.",
                    "available_quantity": 1,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 392,
                    "cost": 958,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60e-9ffd-40ad-b9de-2e70c4870363",
                    "title": "Aut possimus tempora qui id amet quidem aut.",
                    "title_ar": "Et dolor quos aspernatur aut facilis reiciendis et.",
                    "type_label": "Medium",
                    "description": "Corrupti et exercitationem alias aut natus soluta velit. Et ex commodi omnis praesentium quisquam. Beatae earum quibusdam illo non numquam repellendus magnam.",
                    "description_ar": "Voluptatem sit sint laborum deleniti et. Placeat optio enim quia fuga excepturi ullam et. Neque earum quibusdam deleniti quidem voluptatem non sed.",
                    "available_quantity": 41,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 552,
                    "cost": 353,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60e-a1a2-4e2b-850b-030a3f8335d2",
                    "title": "Quas sequi accusantium molestias sit veritatis magni.",
                    "title_ar": "Fugit ipsa aut debitis.",
                    "type_label": "Medium",
                    "description": "Ab nihil consequatur dolore aperiam perferendis. Similique odio quia sed quibusdam laborum. Qui rerum sit voluptate hic sed quibusdam.",
                    "description_ar": "Harum aliquam consequatur ipsa rem. Ipsam asperiores voluptate occaecati repellat ab sed dolorum. Quasi laborum hic repudiandae quisquam ut possimus. Incidunt velit blanditiis consectetur eaque alias odio sequi. Minima laboriosam occaecati est laborum laudantium error.",
                    "available_quantity": 69,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 603,
                    "cost": 884,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            ]
        },
        {
            "id": "9fdec60b-cc30-48bd-89f1-e0c4eea3dca2",
            "menu_category": {
                "menu_category_title": "Optio esse facilis qui culpa eum.",
                "menu_category_id": "9fdec60a-d678-4a39-8cab-102ca6773608"
            },
            "menu_title": "Placeat beatae beatae porro.",
            "title": "Voluptatem accusantium dignissimos nostrum.",
            "title_ar": "Pariatur dolor ut dolorum praesentium qui asperiores consequuntur.",
            "type_label": "Medium",
            "type_label_ar": "وسط",
            "description": "Voluptatem dolores distinctio at. Asperiores voluptates nostrum sit. Voluptatibus odit quo reiciendis ipsa debitis.",
            "description_ar": "Et deleniti fugiat voluptate et voluptas deleniti vitae mollitia. Soluta aut deleniti modi ipsa accusantium.",
            "available_quantity": 77,
            "image": "http://localhost/storage/restaurants/menu_item.png",
            "price": 364,
            "cost": 355,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "sub_items": [
                {
                    "id": "9fdec60e-16e3-4cd4-943a-0aee3fc4d90a",
                    "title": "Natus et exercitationem aliquam illo.",
                    "title_ar": "Quia est non iste delectus doloribus explicabo vitae.",
                    "type_label": "Medium",
                    "description": "Earum maiores nisi odio est mollitia. Aut voluptas unde et sapiente doloribus. Sapiente aut soluta voluptatum sunt. Culpa molestias minima voluptatem earum et quae.",
                    "description_ar": "Omnis et dolorem dolorem quia ut. Tenetur exercitationem amet recusandae excepturi aut est repellendus. Eos ipsum cumque laudantium eveniet optio. Nihil eligendi vero perferendis.",
                    "available_quantity": 88,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 779,
                    "cost": 866,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60e-18fe-41b1-b15d-d76bb9a4607f",
                    "title": "Nihil ut rerum doloremque in sequi ut in cupiditate.",
                    "title_ar": "Neque at eos repudiandae ut libero qui.",
                    "type_label": "Medium",
                    "description": "Et fuga incidunt dolores eius labore qui praesentium. Hic dolore blanditiis qui quasi distinctio iure animi. Sit et et ipsa quas. Consequuntur doloremque velit voluptas cum aut.",
                    "description_ar": "Aut molestiae quia omnis facilis cupiditate accusamus molestias. Hic quis voluptas dolor suscipit aut. Animi eveniet asperiores quisquam ex sed quam error excepturi.",
                    "available_quantity": 72,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 982,
                    "cost": 359,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60e-1b2e-4635-b212-957677a2c7c8",
                    "title": "Voluptatem delectus deleniti voluptatem fugit ut saepe saepe repudiandae.",
                    "title_ar": "Et esse possimus ullam earum harum.",
                    "type_label": "Medium",
                    "description": "Voluptates quis blanditiis voluptatem et ut id voluptates exercitationem. Corporis sint mollitia culpa aut neque. Non dolorem velit velit distinctio sit ut.",
                    "description_ar": "Ut ipsum voluptatem beatae voluptatem. Rerum sint consequatur sed est explicabo non consectetur. Temporibus praesentium corporis tempora consequatur magni ipsam est. Consequatur molestias facilis sit voluptatibus quo eius praesentium.",
                    "available_quantity": 74,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 735,
                    "cost": 465,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            ]
        },
        {
            "id": "9fdec60b-cb09-4328-ba23-8bd56f054b18",
            "menu_category": {
                "menu_category_title": "Optio esse facilis qui culpa eum.",
                "menu_category_id": "9fdec60a-d678-4a39-8cab-102ca6773608"
            },
            "menu_title": "Placeat beatae beatae porro.",
            "title": "Rerum quia molestias est veniam quia rem culpa iste.",
            "title_ar": "Porro unde quo quidem.",
            "type_label": "Medium",
            "type_label_ar": "وسط",
            "description": "Beatae rem architecto quo non vero impedit. Autem qui laudantium reiciendis dolores quibusdam. Officiis omnis nesciunt eum rerum aut vel exercitationem est. Et soluta sint fugit et saepe.",
            "description_ar": "At itaque est dignissimos quia nisi est maxime. Tenetur est et molestiae laudantium. Delectus eum dolore officiis nihil non assumenda.",
            "available_quantity": 50,
            "image": "http://localhost/storage/restaurants/menu_item.png",
            "price": 561,
            "cost": 975,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "sub_items": [
                {
                    "id": "9fdec60d-8871-4555-9307-cedb239ace0a",
                    "title": "Cumque velit qui pariatur sequi.",
                    "title_ar": "Repellat incidunt explicabo saepe accusantium iusto.",
                    "type_label": "Medium",
                    "description": "Fugit vel aut consequatur quisquam rem doloribus totam. Accusantium quisquam sint non neque voluptate.",
                    "description_ar": "Maiores consequuntur rerum natus amet quos ducimus eaque. Sit omnis fugiat est et porro. Hic voluptatem in velit unde consequatur voluptas modi.",
                    "available_quantity": 12,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 805,
                    "cost": 936,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60d-8abb-4a1a-9de4-9517f3b3f014",
                    "title": "Ex qui enim sint quidem rerum reprehenderit omnis.",
                    "title_ar": "Nemo nisi vero in.",
                    "type_label": "Medium",
                    "description": "Expedita voluptatem dolores minus nam dicta. Dolor consectetur eos laboriosam veniam reiciendis. Molestias quasi voluptas facere dolore cupiditate est possimus. Eos odit quasi quia id velit consequatur et id.",
                    "description_ar": "Est labore voluptatibus et nemo voluptatem suscipit. Adipisci dolorem autem molestiae neque aspernatur. Consequatur id earum sit et libero impedit laboriosam.",
                    "available_quantity": 72,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 967,
                    "cost": 271,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60d-8ca2-4ab0-9cb3-0fa1325b5b6d",
                    "title": "Quo nemo et inventore odio quidem qui qui cupiditate.",
                    "title_ar": "Illo natus atque facilis repudiandae possimus at et.",
                    "type_label": "Medium",
                    "description": "Voluptas a optio sed eum molestias. Nulla deserunt et exercitationem sit totam. Eum aliquam iusto dolorem in nesciunt doloremque.",
                    "description_ar": "A libero est architecto dolor. Delectus optio esse cum ducimus odio numquam et. Ut possimus sint voluptas. Voluptas sit ea hic numquam consequatur.",
                    "available_quantity": 73,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 832,
                    "cost": 702,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            ]
        },
        {
            "id": "9fdec60b-c9d8-475e-9606-f16ec3798621",
            "menu_category": {
                "menu_category_title": "Optio esse facilis qui culpa eum.",
                "menu_category_id": "9fdec60a-d678-4a39-8cab-102ca6773608"
            },
            "menu_title": "Placeat beatae beatae porro.",
            "title": "Officia sed commodi praesentium aut consequatur quis voluptatem.",
            "title_ar": "Iste ut perspiciatis libero quis non.",
            "type_label": "Medium",
            "type_label_ar": "وسط",
            "description": "Rerum eum molestias non nobis quibusdam et illo. Atque recusandae est voluptatem cumque deleniti voluptatem. Qui voluptatibus illum veritatis at voluptas. Iste et accusamus quibusdam provident.",
            "description_ar": "Consequatur eaque assumenda quibusdam sapiente perferendis aspernatur. Dolorem voluptates molestias aperiam. Sit illum modi at labore. Laborum eveniet omnis consequatur.",
            "available_quantity": 62,
            "image": "http://localhost/storage/restaurants/menu_item.png",
            "price": 402,
            "cost": 377,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "sub_items": [
                {
                    "id": "9fdec60c-d770-4ff9-a5ce-f9bdb01b26a2",
                    "title": "Iste delectus laborum ut soluta quod.",
                    "title_ar": "Amet voluptatem non expedita provident non nulla impedit ipsum.",
                    "type_label": "Medium",
                    "description": "Fuga non quasi voluptas aperiam. Molestiae dicta at consectetur quasi repudiandae ut. Molestias quo earum et est. Voluptas explicabo repellat optio.",
                    "description_ar": "Commodi voluptatem sit rem. Sint ut qui accusamus dolorem ut sequi. Earum ut laboriosam debitis dolorem officiis.",
                    "available_quantity": 80,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 842,
                    "cost": 294,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60c-d905-4ca2-9470-13189ced20ef",
                    "title": "Voluptate vel tempore consequatur suscipit blanditiis repellendus.",
                    "title_ar": "Tenetur dolorum id ipsa voluptatibus iste mollitia.",
                    "type_label": "Medium",
                    "description": "Tempore blanditiis beatae voluptatibus qui aspernatur occaecati eos. Et nihil est temporibus distinctio. Dicta tempora beatae ullam praesentium aut harum non non.",
                    "description_ar": "Officiis excepturi dolores voluptate sed quia dignissimos. Molestiae error fugit consequatur non quidem nulla excepturi. Vel harum expedita vel suscipit libero rem et unde. Nemo iure aut ipsum doloremque accusantium. Ipsa id voluptate odio sit enim dolorem deserunt minus.",
                    "available_quantity": 36,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 158,
                    "cost": 349,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60c-da38-44a2-a755-640f5baceb2d",
                    "title": "Temporibus voluptatem vel quae id ea omnis deleniti mollitia.",
                    "title_ar": "Ea est voluptatibus perspiciatis labore quibusdam adipisci.",
                    "type_label": "Medium",
                    "description": "Quod vero aut ipsam deserunt fuga. Laboriosam ut maxime maxime quo beatae occaecati. Qui delectus repudiandae repellat dolor nulla. Sint corrupti maxime quas consequuntur.",
                    "description_ar": "Quasi quibusdam maiores iure est officia est. Est occaecati excepturi non veniam autem.",
                    "available_quantity": 29,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 122,
                    "cost": 519,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            ]
        },
        {
            "id": "9fdec60b-c890-47ed-9b3b-e7c03a9566cd",
            "menu_category": {
                "menu_category_title": "Optio esse facilis qui culpa eum.",
                "menu_category_id": "9fdec60a-d678-4a39-8cab-102ca6773608"
            },
            "menu_title": "Placeat beatae beatae porro.",
            "title": "Modi omnis sunt sed et debitis consequatur sed repellendus.",
            "title_ar": "Temporibus et quia et porro natus ut sit repudiandae.",
            "type_label": "Medium",
            "type_label_ar": "وسط",
            "description": "Magnam rerum aut libero minus. Laudantium aut perspiciatis aut necessitatibus aut. Alias quia fugit et laudantium magni eum neque. Eligendi aut ut incidunt est impedit eum repellat.",
            "description_ar": "Animi sint harum totam laboriosam sapiente minima. Cum sunt quaerat illo. Aspernatur odit ut occaecati facilis est.",
            "available_quantity": 16,
            "image": "http://localhost/storage/restaurants/menu_item.png",
            "price": 580,
            "cost": 848,
            "currency": {
                "key": 3,
                "value": "AED"
            },
            "status": {
                "key": 1,
                "value": "AVAILABLE"
            },
            "sub_items": [
                {
                    "id": "9fdec60c-4111-43f6-9e8d-0408d55ee99f",
                    "title": "Consequatur qui eaque molestiae provident.",
                    "title_ar": "Voluptatibus quia soluta impedit sit quia.",
                    "type_label": "Medium",
                    "description": "Quidem et ex nam eaque doloremque suscipit sed. Sed sint dolores et quisquam totam esse. Id tempore ipsam ipsa. Fuga ut quis est et commodi.",
                    "description_ar": "Officia in voluptate illo sed similique quibusdam. Quaerat tenetur dolorem optio labore. Totam vel et sapiente sunt similique doloremque. Est autem quia possimus nulla aperiam autem labore.",
                    "available_quantity": 64,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 334,
                    "cost": 910,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60c-4267-4f9e-98b3-0349a926b5cb",
                    "title": "Et vitae animi eum sapiente ipsum nostrum eum omnis.",
                    "title_ar": "Commodi omnis nulla omnis.",
                    "type_label": "Medium",
                    "description": "Autem omnis atque quia harum esse sit. Excepturi asperiores aliquam doloremque rerum earum velit exercitationem. Nobis dolores voluptatum voluptatem earum fuga ut soluta. Fugiat nihil eos est nobis dolores.",
                    "description_ar": "Officiis magnam dolores voluptatibus ut voluptatum animi optio. Deleniti eum occaecati facilis consectetur. Perspiciatis nulla quis id dolorem. Aut est quo et et nam itaque provident.",
                    "available_quantity": 3,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 794,
                    "cost": 680,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                },
                {
                    "id": "9fdec60c-4385-4528-9c0e-822c45a11c23",
                    "title": "Nulla autem provident rerum vel.",
                    "title_ar": "Natus a consectetur facilis deleniti.",
                    "type_label": "Medium",
                    "description": "Recusandae tempore non nostrum. Ipsam non quae accusamus nesciunt earum et. Pariatur assumenda nisi excepturi quidem vitae sapiente.",
                    "description_ar": "In maxime rerum officiis repellendus quasi. Rerum dolore minus ratione sed dolor laudantium. Cum optio officia architecto vero placeat rem voluptatum. Consectetur doloribus eum placeat rerum.",
                    "available_quantity": 81,
                    "image": "http://localhost/storage/restaurants/menu_item.png",
                    "price": 675,
                    "cost": 713,
                    "currency": {
                        "key": 3,
                        "value": "AED"
                    },
                    "status": {
                        "key": 1,
                        "value": "AVAILABLE"
                    }
                }
            ]
        }
    ],
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{menu_category_id}/menu-items

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

menu_category_id   string   

The ID of the menu category. Example: 9fdec6fe-f54d-4c11-8fa7-cefae9664d18

Query Parameters

page   integer  optional  

Field to select page. Defaults to '1'. Example: 10

per_page   integer  optional  

Field to select items per page. Defaults to '15'. Example: 8

filter[id]   string  optional  

Field to filter items by title. Example: dolor

filter[title]   string  optional  

Field to filter items by title. Example: vel

filter[price]   string  optional  

Field to filter items by price. Example: accusantium

filter[status]   string  optional  

Field to filter items by status. Example: illo

filter[search]   string  optional  

Field to filter items by title. Example: quas

sort   string  optional  

Field to sort items by title,price,status. Example: soluta

Add a menu item to a specific menu category.

requires authentication

This endpoint allows you to add a new menu item to a specific menu category within a branch of a restaurant.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=xpryeqnkwudggutqpiibiwc"\
    --form "title_ar=oxx"\
    --form "description=Accusantium est aperiam et ut reiciendis."\
    --form "description_ar=pnowuskhfxkpozrkb"\
    --form "status=1"\
    --form "available_quantity=42"\
    --form "cost=69"\
    --form "price=43"\
    --form "currency=2"\
    --form "type_label=et"\
    --form "image=@/tmp/phpKGHlKP" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'xpryeqnkwudggutqpiibiwc');
body.append('title_ar', 'oxx');
body.append('description', 'Accusantium est aperiam et ut reiciendis.');
body.append('description_ar', 'pnowuskhfxkpozrkb');
body.append('status', '1');
body.append('available_quantity', '42');
body.append('cost', '69');
body.append('price', '43');
body.append('currency', '2');
body.append('type_label', 'et');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec60c-171e-4b88-b516-fcb9636b7fea",
        "menu_category": {
            "menu_category_title": "Placeat officiis culpa dolorem quasi assumenda harum.",
            "menu_category_id": "9fdec60b-c567-4181-b131-c4fdac8fb386"
        },
        "menu_title": "Ex possimus sunt amet dolor.",
        "title": "item title",
        "title_ar": "item title",
        "type_label": "S",
        "type_label_ar": null,
        "description": "this menu item",
        "description_ar": "this menu item",
        "available_quantity": null,
        "image": "http://localhost/storage/restaurants/9fdec60b-5c5f-4942-a78c-ae0820df160b/77c375a9-c9b4-4215-982f-906916e56490/9fdec60b-a9df-4e45-b9e3-3fa018196f2b/9fdec60b-c567-4181-b131-c4fdac8fb386d3CAJm4i3rBBlreH111NxFQjUqPhpg8RJ759je2y.jpg",
        "price": "2720",
        "cost": "2400",
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 1,
            "value": "AVAILABLE"
        },
        "sub_items": null
    },
    "message": "The menu item has been added successfully",
    "status_code": 200
}
 

Request      

POST api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{menu_category_id}/menu-items

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

menu_category_id   string   

The ID of the menu category. Example: 9fdec6fe-f54d-4c11-8fa7-cefae9664d18

Body Parameters

parent_id   string  optional  

The id of an existing record in the menu_items table.

title   string   

Must not be greater than 255 characters. Example: xpryeqnkwudggutqpiibiwc

title_ar   string   

Must not be greater than 255 characters. Example: oxx

description   string  optional  

Must not be greater than 255 characters. Example: Accusantium est aperiam et ut reiciendis.

description_ar   string  optional  

Must not be greater than 255 characters. Example: pnowuskhfxkpozrkb

image   file   

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpKGHlKP

status   integer  optional  

Example: 1

Must be one of:
  • 1
  • 2
  • 3
available_quantity   number  optional  

Must be at least 0. Example: 42

cost   number   

Must be at least 0. Example: 69

price   number   

Must be at least 0. Example: 43

currency   integer  optional  

Example: 2

Must be one of:
  • 1
  • 2
  • 3
  • 4
type_label   string  optional  

Example: et

Show details of a menu item in a specific menu category.

requires authentication

This endpoint allows you to retrieve detailed information about menu item in a specific menu category within a specific menu of a branch in a restaurant.

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items/9fdec6fe-fb0c-4946-a855-0dbc160552ce" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items/9fdec6fe-fb0c-4946-a855-0dbc160552ce"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec60a-cc18-4fee-8d40-61b4fd55e85c",
        "menu_category": {
            "menu_category_title": "Molestiae libero pariatur sunt et itaque.",
            "menu_category_id": "9fdec60a-98bb-410c-82c2-5bd36bde5bf4"
        },
        "menu_title": "Nemo et ut sunt.",
        "title": "Atque ut laborum quod cumque nisi repellat dicta.",
        "title_ar": "Molestiae error est explicabo quidem autem.",
        "type_label": "Medium",
        "type_label_ar": "وسط",
        "description": "Ducimus porro alias dolorem enim eveniet cumque sed possimus. Vel dolorem non est. Ea numquam quia veniam cumque deserunt neque adipisci expedita.",
        "description_ar": "Ea sed quibusdam consequatur mollitia. Suscipit voluptatem et dolorum ut earum qui quis. Quos provident aut molestiae. Eos error nisi architecto cum tempore. Est dolor laborum quia architecto harum dolorem rem laudantium.",
        "available_quantity": 33,
        "image": "http://localhost/storage/restaurants/menu_item.png",
        "price": 594,
        "cost": 222,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 1,
            "value": "AVAILABLE"
        },
        "sub_items": null
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{menu_category_id}/menu-items/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

menu_category_id   string   

The ID of the menu category. Example: 9fdec6fe-f54d-4c11-8fa7-cefae9664d18

id   string   

The ID of the menu item. Example: 9fdec6fe-fb0c-4946-a855-0dbc160552ce

Update a menu item within a specific menu category of a menu.

requires authentication

This endpoint allows you to update a menu item within a specific menu category of a menu in a branch of a restaurant.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items/9fdec6fe-fb0c-4946-a855-0dbc160552ce" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "title=vsac"\
    --form "title_ar=nvxflpikdqxvvonslkegw"\
    --form "description=Magni distinctio eum cupiditate et aut qui."\
    --form "description_ar=utfeynhyuds"\
    --form "status=1"\
    --form "available_quantity=53"\
    --form "cost=23"\
    --form "price=80"\
    --form "currency=3"\
    --form "type_label=ut"\
    --form "image=@/tmp/phpPklNmk" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items/9fdec6fe-fb0c-4946-a855-0dbc160552ce"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('title', 'vsac');
body.append('title_ar', 'nvxflpikdqxvvonslkegw');
body.append('description', 'Magni distinctio eum cupiditate et aut qui.');
body.append('description_ar', 'utfeynhyuds');
body.append('status', '1');
body.append('available_quantity', '53');
body.append('cost', '23');
body.append('price', '80');
body.append('currency', '3');
body.append('type_label', 'ut');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec60f-63c3-4e3b-aa85-8515d01798fd",
        "menu_category": {
            "menu_category_title": "menu category two title",
            "menu_category_id": "9fdec60f-2b76-4e28-ab1a-c0b4186c8ca4"
        },
        "menu_title": "Earum reiciendis est dolorem.",
        "title": "new menu item title",
        "title_ar": "Sit blanditiis molestiae assumenda molestias illo consequatur.",
        "type_label": "Medium",
        "type_label_ar": "وسط",
        "description": "A dolorem libero sed sit itaque quia. Qui voluptas facere enim non illo pariatur rerum. Id labore numquam debitis laudantium eveniet.",
        "description_ar": "Rerum qui voluptatem dolorem et quam. Explicabo praesentium quibusdam magnam nihil accusamus. Fugit omnis omnis sint quod modi omnis beatae. Perferendis doloribus aliquid magni ea repellat et laborum.",
        "available_quantity": 25,
        "image": "http://localhost/storage/restaurants/menu_item.png",
        "price": 366,
        "cost": 309,
        "currency": {
            "key": 3,
            "value": "AED"
        },
        "status": {
            "key": 1,
            "value": "AVAILABLE"
        },
        "sub_items": null
    },
    "message": "The menu item has been updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{menu_category_id}/menu-items/{id}

PATCH api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{menu_category_id}/menu-items/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

menu_category_id   string   

The ID of the menu category. Example: 9fdec6fe-f54d-4c11-8fa7-cefae9664d18

id   string   

The ID of the menu item. Example: 9fdec6fe-fb0c-4946-a855-0dbc160552ce

Body Parameters

parent_id   string  optional  

The id of an existing record in the menu_items table.

menu_category_id   string  optional  

The id of an existing record in the menu_categories table.

title   string  optional  

Must not be greater than 255 characters. Example: vsac

title_ar   string  optional  

Must not be greater than 255 characters. Example: nvxflpikdqxvvonslkegw

description   string  optional  

Must not be greater than 255 characters. Example: Magni distinctio eum cupiditate et aut qui.

description_ar   string  optional  

Must not be greater than 255 characters. Example: utfeynhyuds

image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpPklNmk

status   integer  optional  

Example: 1

Must be one of:
  • 1
  • 2
  • 3
available_quantity   number  optional  

Must be at least 0. Example: 53

cost   number  optional  

Must be at least 0. Example: 23

price   number  optional  

Must be at least 0. Example: 80

currency   integer  optional  

Example: 3

Must be one of:
  • 1
  • 2
  • 3
  • 4
type_label   string  optional  

Example: ut

Delete a specific menu item within a specific menu category.

requires authentication

This endpoint allows you to delete a specific menu item within a particular menu category of a menu in a branch of a restaurant.

Example request:
curl --request DELETE \
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items/9fdec6fe-fb0c-4946-a855-0dbc160552ce" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/restaurants/9fdec6fc-6c74-4966-b838-757d2f4a42a2/branches/9fdec6fc-74d3-4328-9b4a-00c674c7a65e/menus/9fdec6fe-ec3c-4a43-83b1-b940f610031a/menu-categories/9fdec6fe-f54d-4c11-8fa7-cefae9664d18/menu-items/9fdec6fe-fb0c-4946-a855-0dbc160552ce"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "The menu item has been deleted successfully.",
    "status_code": 200
}
 

Request      

DELETE api/v1/restaurants/{restaurant_id}/branches/{branch_id}/menus/{menu_id}/menu-categories/{menu_category_id}/menu-items/{id}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

restaurant_id   string   

The ID of the restaurant. Example: 9fdec6fc-6c74-4966-b838-757d2f4a42a2

branch_id   string   

The ID of the branch. Example: 9fdec6fc-74d3-4328-9b4a-00c674c7a65e

menu_id   string   

The ID of the menu. Example: 9fdec6fe-ec3c-4a43-83b1-b940f610031a

menu_category_id   string   

The ID of the menu category. Example: 9fdec6fe-f54d-4c11-8fa7-cefae9664d18

id   string   

The ID of the menu item. Example: 9fdec6fe-fb0c-4946-a855-0dbc160552ce

User

APIs for User Management

Auth management

APIs for login, register and all about auth

Request email OTP

requires authentication

This endpoint lets you send OTP through email

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/request-email-otp" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/request-email-otp"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Code is sent successfully",
    "status_code": 200
}
 

Request      

POST api/v1/auth/request-email-otp

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Validate email

requires authentication

This endpoint lets you verify email using otp code

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/verify-otp/email" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"otp_code\": \"tempora\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/verify-otp/email"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "otp_code": "tempora"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "token_type": "bearer",
        "access_token": "CJfnVFnhkSbb6dOEnfmYtkxbM5DOc1qBj1HKJ3c6",
        "access_expires_at": "2025-10-13T19:24:56.000000Z",
        "profile": {
            "id": "9fdec5c5-89bf-49a4-b0be-ff22321fc0bc",
            "first_name": "Shanie",
            "last_name": "Mertz",
            "email": "johndoe@example.com",
            "phone": "+1.351.746.9548",
            "is_active": false,
            "image": "http://localhost/storage/users/user.png",
            "has_verified_email": true,
            "has_verified_phone": true,
            "permissions": null,
            "associated_companies": null,
            "dashboard": null,
            "staff": null
        }
    },
    "message": "Email verified successfully",
    "status_code": 200
}
 

Request      

POST api/v1/auth/verify-otp/email

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

otp_code   string   

Example: tempora

Request Otp Code

requires authentication

This endpoint lets you request otp code

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/request-phone-otp" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"delectus\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/request-phone-otp"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone": "delectus"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Code is sent successfully",
    "retry_after": 60
}
 

Request      

POST api/v1/auth/request-phone-otp

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

phone   string   

Example: delectus

Validate phone

requires authentication

This endpoint lets you verify phone using otp code

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/verify-otp/phone" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"otp_code\": \"porro\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/verify-otp/phone"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "otp_code": "porro"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "token_type": "bearer",
        "access_token": "QiyFXdhjU6Izu6p8vqg68cMpdcfXVDupLFRwNjt1",
        "access_expires_at": "2025-10-13T19:24:56.000000Z",
        "profile": {
            "id": "9fdec5c6-019b-4ee4-ad55-7ad6a28143a7",
            "first_name": "Esteban",
            "last_name": "Champlin",
            "email": "pkub@example.com",
            "phone": "+963994635477",
            "is_active": false,
            "image": "http://localhost/storage/users/user.png",
            "has_verified_email": true,
            "has_verified_phone": true,
            "permissions": null,
            "associated_companies": null,
            "dashboard": null,
            "staff": null
        }
    },
    "message": "Phone verified successfully",
    "status_code": 200
}
 

Request      

POST api/v1/auth/verify-otp/phone

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

otp_code   string   

Example: porro

Update user

requires authentication

This endpoint lets you update user's information

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/update/eos" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "first_name=fjthlkvmltfxb"\
    --form "last_name=xvtyqwzkpa"\
    --form "email=meggie75@example.org"\
    --form "image=@/tmp/phpOcfKjn" 
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/update/eos"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('first_name', 'fjthlkvmltfxb');
body.append('last_name', 'xvtyqwzkpa');
body.append('email', 'meggie75@example.org');
body.append('image', document.querySelector('input[name="image"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9fdec5c4-eafe-4d9f-b68d-1ba342a31b4b",
        "first_name": "TESTER",
        "last_name": "TESTER",
        "email": "test@gmail.com",
        "phone": "05012345678",
        "is_active": false,
        "image": "http://localhost/storage/users/68c5c507c2522.jpg",
        "has_verified_email": true,
        "has_verified_phone": true,
        "permissions": null,
        "associated_companies": null,
        "dashboard": null,
        "staff": null
    },
    "message": "Your information updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/auth/update/{user}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

user   string   

Example: eos

Body Parameters

first_name   string  optional  

Must not be greater than 255 characters. Example: fjthlkvmltfxb

last_name   string  optional  

Must not be greater than 255 characters. Example: xvtyqwzkpa

email   string  optional  

Must be a valid email address. Must not be greater than 255 characters. Example: meggie75@example.org

image   file  optional  

Must be an image. Must not be greater than 2048 kilobytes. Example: /tmp/phpOcfKjn

Show user's profile

requires authentication

This endpoint lets you show user's authenticated profile

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/auth/profile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/profile"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": {
        "id": "9bc245ec-2aaa-4c28-a301-95d779757251",
        "first_name": "Test1",
        "last_name": "Test1",
        "email": "test1@gmail.com",
        "phone": "+9639487222",
        "is_active": true,
        "image": "http://localhost/storage/users/user.png",
        "has_verified_email": true,
        "has_verified_phone": true,
        "permissions": null,
        "associated_companies": null,
        "dashboard": null,
        "staff": null
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/auth/profile

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Login

This endpoint lets you log in with specific user

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"et\",
    \"password\": \";\\\"mhYzmNrHqR:7\",
    \"udid\": \"odio\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone": "et",
    "password": ";\"mhYzmNrHqR:7",
    "udid": "odio"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "token_type": "bearer",
        "access_token": "kaOJBqqYsSAhyaFZvKzGRStxZuqtU4ZNTCOCHDvz",
        "access_expires_at": "2025-10-13T19:24:53.000000Z",
        "profile": {
            "id": "9fdec5c0-67e5-4278-b8b5-cc4f3e10f20b",
            "first_name": "Frida",
            "last_name": "Hayes",
            "email": "test@gmail.com",
            "phone": "+919885544774",
            "is_active": true,
            "image": "http://localhost/storage/users/user.png",
            "has_verified_email": true,
            "has_verified_phone": true,
            "permissions": [
                {
                    "name": "INDEX_USER"
                }
            ],
            "associated_companies": [
                {
                    "id": "04e97c52-c984-45de-8870-f02c85f72b30",
                    "name": "Isobel Koelpin",
                    "restaurants": null
                },
                {
                    "id": "d42306f6-8d57-44a3-9fcf-0c8e091ca23d",
                    "name": "Blanche Stamm IV",
                    "restaurants": [
                        {
                            "id": "9fdec5c0-a406-467b-b825-15b49513b66f",
                            "name": "Baumbach-Kshlerin",
                            "slug": "baumbach-kshlerin",
                            "branches": [
                                {
                                    "id": "cceb96d4-78a5-49b4-89e6-37b40743d17d",
                                    "name": "Ursula Haag",
                                    "slug": "repellendus-facere-ex-sit-repellat-consectetur-et",
                                    "active_menu": null
                                }
                            ]
                        },
                        {
                            "id": "9fdec5c0-b0b9-415d-916e-a6940d9e21a2",
                            "name": "Bauch LLC",
                            "slug": "bauch-llc",
                            "branches": null
                        }
                    ]
                }
            ],
            "dashboard": [
                {
                    "id": "142afe26-d893-48c1-a1f7-8f50ac30893f",
                    "name": "Admin Dashboard"
                },
                {
                    "id": "373a0bb9-5c20-4102-bf35-23ebe6fb45e7",
                    "name": "Staff Dashboard"
                },
                {
                    "id": "5d0567bc-57c9-461f-9eb7-7be5dc64817f",
                    "name": "project Dashboard"
                }
            ],
            "staff": null
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

POST api/v1/auth/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

phone   string   

Example: et

password   string   

Must be at least 6 characters. Example: ;"mhYzmNrHqR:7

udid   string  optional  

Example: odio

fcm_token   string  optional  

This field is required when udid is present.

Restaurant Login

This endpoint lets you log in with specific user

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/restaurant-login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"molestiae\",
    \"password\": \"Rn;ngWDd2\\\\#FPa1[+bO`\",
    \"udid\": \"ut\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/restaurant-login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone": "molestiae",
    "password": "Rn;ngWDd2\\#FPa1[+bO`",
    "udid": "ut"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "data": {
        "token_type": "bearer",
        "access_token": "MkQAfwo6b8Qf5p8t1RD3mhWmpZKqRlKTV3TXAXpV",
        "access_expires_at": "2025-10-13T19:24:56.000000Z",
        "profile": {
            "id": "9fdec5c5-ecd4-4610-9be5-e150fe736a05",
            "first_name": "Frida",
            "last_name": "Hayes",
            "email": "test@gmail.com",
            "phone": "+919885544774",
            "is_active": true,
            "image": "http://localhost/storage/users/user.png",
            "has_verified_email": true,
            "has_verified_phone": true,
            "permissions": [
                {
                    "name": "INDEX_USER"
                }
            ],
            "associated_companies": [
                {
                    "id": "1973bcfb-e294-43a0-895e-e529add84f98",
                    "name": "Augustus Leannon",
                    "restaurants": null
                },
                {
                    "id": "2dda0dd2-27aa-4848-bcf2-3d436dbc9080",
                    "name": "Vickie Beer",
                    "restaurants": [
                        {
                            "id": "9fdec5c6-2e4e-4605-8506-887a0db8c10d",
                            "name": "Yost and Sons",
                            "slug": "yost-and-sons",
                            "branches": [
                                {
                                    "id": "67654cc9-be32-4f7a-bab4-9066b2678810",
                                    "name": "Keeley Will DVM",
                                    "slug": "voluptates-nemo-vitae-modi-nesciunt-iste-est",
                                    "active_menu": null
                                }
                            ]
                        },
                        {
                            "id": "9fdec5c6-3af2-4e12-86dd-0ddda67e8b0e",
                            "name": "Kshlerin, Murazik and Hayes",
                            "slug": "kshlerin-murazik-and-hayes",
                            "branches": null
                        }
                    ]
                }
            ],
            "dashboard": [
                {
                    "id": "15341e84-f6a5-4daa-aa56-e8804c06250a",
                    "name": "project Dashboard"
                },
                {
                    "id": "42c0c107-b536-429f-a544-3ad7d971cfa4",
                    "name": "Staff Dashboard"
                },
                {
                    "id": "823c5178-83be-4900-a605-eb8066da8301",
                    "name": "Admin Dashboard"
                }
            ],
            "staff": null
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

POST api/v1/auth/restaurant-login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

phone   string   

Example: molestiae

password   string   

Must be at least 6 characters. Example: `Rn;ngWDd2#FPa1[+bO``

udid   string  optional  

Example: ut

fcm_token   string  optional  

This field is required when udid is present.

Logout

requires authentication

This endpoint lets you log out

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/auth/logout?token=sit&udid=explicabo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/logout"
);

const params = {
    "token": "sit",
    "udid": "explicabo",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Successfully logged out",
    "status_code": 200
}
 

Request      

GET api/v1/auth/logout

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

token   string   

User's token. Example: sit

udid   string  optional  

User's device udid. Example: explicabo

Body Parameters

udid   string  optional  

Request forget password

This endpoint lets you update request forget password OTP

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/request-forget-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"fugit\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/request-forget-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "phone": "fugit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Password reset Code sent successfully",
    "status_code": 200
}
 

Request      

POST api/v1/auth/request-forget-password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

phone   string   

The phone of an existing record in the users table. Example: fugit

Forget password

This endpoint lets you update user password with OTP verification

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/forget-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"otp_code\": \"880365\",
    \"password\": \"BA4dGJLBff(7s\'\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/forget-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "otp_code": "880365",
    "password": "BA4dGJLBff(7s'"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Password reset successful",
    "status_code": 200
}
 

Request      

POST api/v1/auth/forget-password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

phone   string  optional  

The phone of an existing record in the users table.

otp_code   string   

Must be 6 digits. Example: 880365

password   string   

Must be at least 6 characters. Example: BA4dGJLBff(7s'

notification

APIs for Notification Management

Show all User Notifications

requires authentication

This endpoint lets user show all notifications

Example request:
curl --request GET \
    --get "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "data": [
        {
            "id": "ff8b1f02-ae51-3c89-ad79-aa6b374bd24a",
            "data": {
                "type": 5,
                "order_id": "9fdec5c0-8f16-48dc-bf31-e83a7121776a",
                "title": "New Order",
                "body": "You have received a new order.",
                "icon": "http://localhost/storage/icons/notifications/new-order.png"
            },
            "read": true,
            "created_at": "2025-09-13 19:25:03",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 5
        },
        {
            "id": "fc9f967f-571e-3186-ae07-8c392fdbe749",
            "data": {
                "type": 5,
                "order_id": "9fdec5c0-8f16-48dc-bf31-e83a7121776a",
                "title": "New Order",
                "body": "You have received a new order.",
                "icon": "http://localhost/storage/icons/notifications/new-order.png"
            },
            "read": true,
            "created_at": "2025-09-13 19:25:03",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 5
        },
        {
            "id": "fb85b79b-2f34-3c27-bc3d-7197b07af24c",
            "data": {
                "type": 5,
                "order_id": "9fdec5c0-8f16-48dc-bf31-e83a7121776a",
                "title": "New Order",
                "body": "You have received a new order.",
                "icon": "http://localhost/storage/icons/notifications/new-order.png"
            },
            "read": true,
            "created_at": "2025-09-13 19:25:03",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 10
        },
        {
            "id": "b4829b77-da0a-3ec1-8ec3-016fd4436497",
            "data": {
                "type": 11,
                "table_id": "some-table-id",
                "table_number": "032",
                "title": "Table 032: Unlock Request",
                "body": "A customer needs a waiter to unlock the table.",
                "icon": "http://localhost/storage/icons/notifications/unlock.png"
            },
            "read": true,
            "created_at": "2025-09-13 19:25:03",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 5
        },
        {
            "id": "a21f6d2a-9084-3406-94f7-b4b91933b372",
            "data": {
                "type": 5,
                "order_id": "9fdec5c0-8f16-48dc-bf31-e83a7121776a",
                "title": "New Order",
                "body": "You have received a new order.",
                "icon": "http://localhost/storage/icons/notifications/new-order.png"
            },
            "read": true,
            "created_at": "2025-09-13 19:25:03",
            "assigned_to": null,
            "status": {
                "key": 1,
                "value": "PENDING"
            },
            "repetition_count": 5
        }
    ],
    "meta": {
        "pagination": {
            "total": 7,
            "per_page": 5,
            "count": 5,
            "current_page": 1,
            "unread_count": 10
        }
    },
    "message": "success",
    "status_code": 200
}
 

Request      

GET api/v1/auth/notifications

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Mark all notifications as read for the given user.

requires authentication

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/mark-all-as-read" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/mark-all-as-read"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Notifications updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/auth/notifications/mark-all-as-read

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Mark the given notification as read.

requires authentication

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/fugit/mark-as-read" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/fugit/mark-as-read"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Notification updated successfully",
    "status_code": 200
}
 

Request      

PUT api/v1/auth/notifications/{notification_id}/mark-as-read

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

notification_id   string   

The ID of the notification. Example: fugit

Mark Notification as done.

requires authentication

This endpoint lets you mark notification as done.

Example request:
curl --request PUT \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/vel/mark-as-done" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/vel/mark-as-done"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Notification marked as done successfully.",
    "status_code": 200
}
 

Request      

PUT api/v1/auth/notifications/{notification_id}/mark-as-done

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

notification_id   string   

The ID of the notification. Example: vel

Assign specific notification to the currently authenticated user.

requires authentication

This endpoint lets you assign specific notification to the currently authenticated user.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/a/assign-to-self" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/a/assign-to-self"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Notification assigned to you successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/auth/notifications/{notification_id}/assign-to-self

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

notification_id   string   

The ID of the notification. Example: a

Assign specific notification to specific waiter.

requires authentication

This endpoint lets you assign specific notification to specific waiter.

Example request:
curl --request POST \
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/numquam/assign-to-waiter" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"staff_id\": \"sit\"
}"
const url = new URL(
    "https://api-dev-maedah.alebdaa.net/api/v1/auth/notifications/numquam/assign-to-waiter"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "staff_id": "sit"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Notification assigned to waiter successfully.",
    "status_code": 200
}
 

Request      

POST api/v1/auth/notifications/{notification_id}/assign-to-waiter

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

notification_id   string   

The ID of the notification. Example: numquam

Body Parameters

staff_id   string   

The id of an existing record in the staff table. Example: sit

Enums

Area Status

ACTIVE: 1

INACTIVE: 2

MAINTENANCE: 3

RESERVED: 4

Opening Hours

MORNING: 9 AM - 12 PM

AFTERNOON: 12 PM - 6 PM

EVENING: 6 PM - 9 PM

NIGHT: 9 PM - 12 AM

ALL_TIMES: 9 AM - 10 PM

Branch Status

ACTIVE: 1

INACTIVE: 2

ON_HOLD: 3

Branch User Access Level

BRANCH_ADMIN: 1

BRANCH_WAITER: 2

KITCHEN_MANGER: 3

CLIENT_ADMIN: 4

Company Status

ACTIVE: 1

INACTIVE: 2

ON_HOLD: 3

Fee Type

PERCENT: 1

FIXED: 2

Currency Type

USD: 1

EUR: 2

AED: 3

SAR: 4

AVAILABLE: 1

UNAVAILABLE: 2

SOON: 3

ACTIVE: 1

INACTIVE: 2

Model Name

Order: Order

MenuItem: MenuItem

Notification Status

PENDING: 1

ASSIGNED: 2

DONE: 3

Notification Type

Order Creator Type

CUSTOMER: 1

WAITER: 2

Order Item Status

PENDING: 1

PREPARING: 2

READY: 3

Order Status

DRAFT: 1

PENDING: 2

ACCEPTED: 3

PREPARING: 4

READY: 5

FULLY_PAID: 6

PENDING_USER_EDIT: 7

CANCELLED: 8

PARTIALLY_PAID: 9

Checkout Environment Type

SANDBOX: 1

PRODUCTION: 2

Payment Method

GOOGLE_PAY: 1

APPLE_PAY: 2

CREDIT_CARD: 3

CASH: 4

DEVICE: 5

PAYPAL: 6

AMAZON_PAY: 7

STRIPE: 8

CHECKOUT: 9

Payment Status

UNPAID: 1

PAID: 2

FAILED: 3

Permission Type

INDEX_USER: INDEX_USER

SHOW_USER: SHOW_USER

STORE_USER: STORE_USER

UPDATE_USER: UPDATE_USER

DELETE_USER: DELETE_USER

SHOW_ROLE: SHOW_ROLE

STORE_ROLE: STORE_ROLE

DELETE_ROLE: DELETE_ROLE

UPDATE_ROLE: UPDATE_ROLE

INDEX_ROLE: INDEX_ROLE

EDIT_ROLE_PERMISSION: EDIT_ROLE_PERMISSION

SHOW_ROLE_PERMISSION: SHOW_ROLE_PERMISSION

SHOW_USER_ROLE: SHOW_USER_ROLE

EDIT_USER_ROLE: EDIT_USER_ROLE

SHOW_PERMISSIONS: SHOW_PERMISSIONS

SEND_USER_EMAIL_OTP: SEND_USER_EMAIL_OTP

INDEX_RESTAURANT: INDEX_RESTAURANT

SHOW_RESTAURANT: SHOW_RESTAURANT

STORE_RESTAURANT: STORE_RESTAURANT

UPDATE_RESTAURANT: UPDATE_RESTAURANT

DELETE_RESTAURANT: DELETE_RESTAURANT

INDEX_COMPANY: INDEX_COMPANY

SHOW_COMPANY: SHOW_COMPANY

SHOW_COMPANY_ANALYTICS: SHOW_COMPANY_ANALYTICS

STORE_COMPANY: STORE_COMPANY

DELETE_COMPANY: DELETE_COMPANY

UPDATE_COMPANY: UPDATE_COMPANY

INDEX_BRANCH: INDEX_BRANCH

SHOW_BRANCH: SHOW_BRANCH

STORE_BRANCH: STORE_BRANCH

UPDATE_BRANCH: UPDATE_BRANCH

GET_BRANCH_SETTING: GET_BRANCH_SETTING

UPDATE_BRANCH_SETTING: UPDATE_BRANCH_SETTING

STORE_BRANCH_SETTINGS: STORE_BRANCH_SETTINGS

DELETE_BRANCH: DELETE_BRANCH

INDEX_STAFF: INDEX_STAFF

SHOW_STAFF: SHOW_STAFF

STORE_STAFF: STORE_STAFF

UPDATE_STAFF: UPDATE_STAFF

DELETE_STAFF: DELETE_STAFF

BLOCK_STAFF: BLOCK_STAFF

UN_BLOCK_STAFF: UN_BLOCK_STAFF

INDEX_MENU: INDEX_MENU

SHOW_MENU: SHOW_MENU

STORE_MENU: STORE_MENU

UPDATE_MENU: UPDATE_MENU

DELETE_MENU: DELETE_MENU

INDEX_MENU_ITEM: INDEX_MENU_ITEM

SHOW_MENU_ITEM: SHOW_MENU_ITEM

STORE_MENU_ITEM: STORE_MENU_ITEM

UPDATE_MENU_ITEM: UPDATE_MENU_ITEM

DELETE_MENU_ITEM: DELETE_MENU_ITEM

INDEX_MENU_CATEGORY: INDEX_MENU_CATEGORY

SHOW_MENU_CATEGORY: SHOW_MENU_CATEGORY

STORE_MENU_CATEGORY: STORE_MENU_CATEGORY

UPDATE_MENU_CATEGORY: UPDATE_MENU_CATEGORY

DELETE_MENU_CATEGORY: DELETE_MENU_CATEGORY

INDEX_PAYMENT: INDEX_PAYMENT

SHOW_PAYMENT: SHOW_PAYMENT

STORE_PAYMENT: STORE_PAYMENT

UPDATE_PAYMENT: UPDATE_PAYMENT

DELETE_PAYMENT: DELETE_PAYMENT

INDEX_RESTAURANT_TABLE: INDEX_RESTAURANT_TABLE

SHOW_RESTAURANT_TABLE: SHOW_RESTAURANT_TABLE

STORE_RESTAURANT_TABLE: STORE_RESTAURANT_TABLE

UPDATE_RESTAURANT_TABLE: UPDATE_RESTAURANT_TABLE

UPDATE_RESTAURANT_TABLE_AVAILABLE: UPDATE_RESTAURANT_TABLE_AVAILABLE

UPDATE_RESTAURANT_TABLE_OCCUPIED: UPDATE_RESTAURANT_TABLE_OCCUPIED

UPDATE_RESTAURANT_TABLE_RESERVED: UPDATE_RESTAURANT_TABLE_RESERVED

UPDATE_RESTAURANT_TABLE_LOCK: UPDATE_RESTAURANT_TABLE_LOCK

SHOW_RESTAURANT_TABLE_ORDER: SHOW_RESTAURANT_TABLE_ORDER

DELETE_RESTAURANT_TABLE: DELETE_RESTAURANT_TABLE

GENERATE_QR_CODE: GENERATE_QR_CODE

INDEX_ORDER: INDEX_ORDER

SHOW_ORDER: SHOW_ORDER

DELETE_ORDER: DELETE_ORDER

UPDATE_ORDER: UPDATE_ORDER

STORE_ORDER: STORE_ORDER

UPDATE_ORDER_ITEM: UPDATE_ORDER_ITEM

DELETE_ORDER_ITEM: DELETE_ORDER_ITEM

STORE_ORDER_ITEM: STORE_ORDER_ITEM

UPDATE_ACCEPT_ORDER: UPDATE_ACCEPT_ORDER

UPDATE_PREPARING_ORDER: UPDATE_PREPARING_ORDER

UPDATE_ORDER_TABLE: UPDATE_ORDER_TABLE

UPDATE_DONE_PAYMENT: UPDATE_DONE_PAYMENT

UPDATE_FAILED_PAYMENT: UPDATE_FAILED_PAYMENT

SHOW_PANEL: SHOW_PANEL

SHOW_ORDER_PAYMENT: SHOW_ORDER_PAYMENT

DELETE_ORDER_ITEMS: DELETE_ORDER_ITEMS

INDEX_REVIEW: INDEX_REVIEW

SHOW_REVIEW: SHOW_REVIEW

DELETE_REVIEW: DELETE_REVIEW

INDEX_ORDERS_WITH_REVIEWS: INDEX_ORDERS_WITH_REVIEWS

UPDATE_TERMS_AND_CONDITIONS: UPDATE_TERMS_AND_CONDITIONS

SHOW_TERMS_AND_CONDITIONS: SHOW_TERMS_AND_CONDITIONS

ASSIGN_NOTIFICATION_FOR_USER: ASSIGN_NOTIFICATION_FOR_USER

ASSIGN_NOTIFICATION_FOR_SELF: ASSIGN_NOTIFICATION_FOR_SELF

INDEX_AREA: INDEX_AREA

SHOW_AREA: SHOW_AREA

STORE_AREA: STORE_AREA

UPDATE_AREA: UPDATE_AREA

DELETE_AREA: DELETE_AREA

ASSIGN_STAFF_TO_AREA: ASSIGN_STAFF_TO_AREA

MARK_NOTIFICATION_AS_DONE: MARK_NOTIFICATION_AS_DONE

ASSIGN_TABLE_TO_STAFF: ASSIGN_TABLE_TO_STAFF

ASSIGN_TABLE_TO_SELF: ASSIGN_TABLE_TO_SELF

DELETE_TABLE_FROM_AREA: DELETE_TABLE_FROM_AREA

RESET_PASSWORD: RESET_PASSWORD

INDEX_NOTIFICATION: INDEX_NOTIFICATION

MARK_ALL_AS_READ: MARK_ALL_AS_READ

MARK_AS_READ: MARK_AS_READ

INDEX_RESERVATION: INDEX_RESERVATION

SHOW_RESERVATION: SHOW_RESERVATION

STORE_RESERVATION: STORE_RESERVATION

UPDATE_RESERVATION: UPDATE_RESERVATION

DELETE_RESERVATION: DELETE_RESERVATION

Reservation Status

PENDING: 1

CONFIRMED: 2

CANCELLED: 3

Assigned Table Status

ASSIGNED: 1

UNASSIGNED: 2

Restaurant Table Status

AVAILABLE: 1

OCCUPIED: 2

LOCK: 3

RESERVED: 4

Restaurant Status

ACTIVE: 1

INACTIVE: 2

ON_HOLD: 3

Review Google Type

ALWAYS_VIEW: 1

NEVER_VIEW: 2

BASED_ON_THE_STARS_NUMBER: 3

Role Type

SUPER_ADMIN: SUPER_ADMIN

DATABASE: DATABASE

OPERATION: OPERATION

COMPANY_OWNER: COMPANY_OWNER

BRANCH_ADMIN: BRANCH_ADMIN

BRANCH_WAITER: BRANCH_WAITER

KITCHEN_MANGER: KITCHEN_MANGER

CLIENT_ADMIN: CLIENT_ADMIN

MENU_ADMIN: MENU_ADMIN