Introduction

Mobile ordering and POS integration APIs. Documentation is generated from routes, controller validators, and docblocks.

POSAPIs

This documentation is generated automatically from the application routes and validation rules.

APIs are organised the same way as before:

App Related APIs — login, logout, refresh, signup
Application APIs — read (and selected write) endpoints for mobile / application clients
Shop APIs — store-only catalog writes and channel integrations (Shopify, Deliverect, …)

Whenever you add a new API route under /api/*, regenerate docs with:

php artisan scribe:generate

Base URL

http://localhost

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_TOKEN}".

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

Call POST /api/v1/login (query: username, password) or POST /api/v2/login (JSON body) to obtain a JWT. Send it as Authorization: Bearer {YOUR_AUTH_TOKEN}. Tokens expire after about one hour; use /refresh or log in again. Most routes also require a role such as store, application, or applicationReadOnly.

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/me" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/me"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "item_name": "Example Item",
            "is_active": true
        },
        {
            "id": 2,
            "item_name": "Example Item",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/plans" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/plans"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "item_name": "Example Item",
            "is_active": true
        },
        {
            "id": 2,
            "item_name": "Example Item",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Example request:

curl --request POST \
    "http://localhost/api/v1/login?username=example%40bimpos.com&password=Ex%40mple" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/login"
);

const params = {
    "username": "example@bimpos.com",
    "password": "Ex@mple",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "token_type": "bearer",
    "expires_in": 3600,
    "message": "Login Successful",
    "status": "success"
}

Example response (401):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/logout"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Successfully logged out",
    "data": {
        "id": 1,
        "logout_name": "Example Logout",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/refresh" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/refresh"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Token refreshed successfully.",
    "data": {
        "id": 1,
        "refresh_name": "Example Refresh",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/signup" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"bngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwt\",
    \"last_name\": \"ujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrb\",
    \"username\": \"chgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppi\",
    \"email\": \"hrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkb\",
    \"mobile\": 63126967,
    \"dob\": \"2022-09-10\",
    \"clientid\": \"ngzmiy\"
}"

const url = new URL(
    "http://localhost/api/v1/signup"
);

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

let body = {
    "first_name": "bngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwt",
    "last_name": "ujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrb",
    "username": "chgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppi",
    "email": "hrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkb",
    "mobile": 63126967,
    "dob": "2022-09-10",
    "clientid": "ngzmiy"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "User registered successfully.",
    "data": {
        "id": 1,
        "first_name": "bngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwt",
        "last_name": "ujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrb",
        "username": "chgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppi",
        "email": "hrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkb",
        "mobile": 63126967,
        "dob": "2022-09-10",
        "clientid": "ngzmiy"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "first_name": [
            "The first_name field is required."
        ],
        "last_name": [
            "The last_name field is required."
        ],
        "username": [
            "The username field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/signup

Body Parameters

first_name string

Validation: required|string|max:255. Must not be greater than 255 characters.

last_name string

Validation: required|string|max:255. Must not be greater than 255 characters.

username string

Validation: required|string|max:255|unique:users. Must not be greater than 255 characters.

email string

Validation: required|string|email|max:255|unique:users. Must be a valid email address. Must not be greater than 255 characters.

mobile number

Validation: required|numeric|min:000000|max:99999999. Must be at least 000000. Must not be greater than 99999999.

dob string optional

Validation: date_format:Y-m-d|before:today|nullable. Must be a valid date in the format Y-m-d. Must be a date before today.

clientid string

Validation: required|string|max:6. Must not be greater than 6 characters.

terms string optional

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/menuapp/login" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menuapp/login"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Menuapp saved successfully.",
    "data": {
        "id": 1,
        "menuapp_name": "Example Menuapp",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Example request:

curl --request POST \
    "http://localhost/api/v2/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"username\": \"example@bimpos.com\",
    \"password\": \"Ex@mple\"
}"

const url = new URL(
    "http://localhost/api/v2/login"
);

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

let body = {
    "username": "example@bimpos.com",
    "password": "Ex@mple"
};

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

Example response (200):


{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
    "token_type": "bearer",
    "expires_in": 3600,
    "message": "Login Successful",
    "status": "success"
}

Example response (401):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/menuapp/login" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/menuapp/login"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Menuapp saved successfully.",
    "data": {
        "id": 1,
        "menuapp_name": "Example Menuapp",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V1) — Actions

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Add Actions

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/actions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"TABLEID\": 16,
    \"TYPE\": \"4\",
    \"STATUS\": \"0\"
}"

const url = new URL(
    "http://localhost/api/v1/actions"
);

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

let body = {
    "TABLEID": 16,
    "TYPE": "4",
    "STATUS": "0"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Actions saved successfully.",
    "data": {
        "id": 1,
        "TABLEID": 16,
        "TYPE": "4",
        "STATUS": "0"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "TABLEID": [
            "The TABLEID field is required."
        ],
        "TYPE": [
            "The TYPE field is required."
        ],
        "STATUS": [
            "The STATUS field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Actions

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/actions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/actions"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "action_name": "Example Action",
            "is_active": true
        },
        {
            "id": 2,
            "action_name": "Example Action",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V1) — Floors

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Fetch Floor

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/floors/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/floors/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "floorid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Floors

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/floors" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"description\": \"ngzmiy\",
    \"is_default\": 1,
    \"background_color\": 16,
    \"is_active\": 1,
    \"floor_width\": 16,
    \"floor_height\": 16,
    \"branch_id\": 16,
    \"concept_id\": 16
}"

const url = new URL(
    "http://localhost/api/v1/floors"
);

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

let body = {
    "id": 16,
    "description": "ngzmiy",
    "is_default": 1,
    "background_color": 16,
    "is_active": 1,
    "floor_width": 16,
    "floor_height": 16,
    "branch_id": 16,
    "concept_id": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Floors saved successfully.",
    "data": {
        "id": 16,
        "description": "ngzmiy",
        "is_default": 1,
        "background_color": 16,
        "is_active": 1,
        "floor_width": 16,
        "floor_height": 16,
        "branch_id": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "description": [
            "The description field is required."
        ],
        "is_default": [
            "The is_default field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/floors

Body Parameters

id integer

Validation: required|integer.

description string

Validation: required|string|max:50. Must not be greater than 50 characters.

is_default integer

Validation: required|integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

background_color integer

Validation: required|integer.

is_active integer

Validation: required|integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

floor_width integer

Validation: required|integer.

floor_height integer

Validation: required|integer.

branch_id integer

Validation: required|integer.

concept_id integer

Validation: required|integer.

Fetch Section

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/sections/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/sections/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "floormapid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Floor Section

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/floors/architecto/sections/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/floors/architecto/sections/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "floorid": "architecto",
        "sectionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Sections

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/sections" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"section_id\": 16,
    \"section_type\": 16,
    \"section_left\": 16,
    \"section_top\": 16,
    \"section_width\": 16,
    \"section_height\": 16,
    \"section_name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem\",
    \"section_shapestyle\": 16,
    \"section_fillstyle\": 16,
    \"section_fillcolor\": 16,
    \"section_floor_id\": 16,
    \"font_name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem\",
    \"font_bold\": 16,
    \"font_italic\": 16,
    \"font_size\": 4326.41688,
    \"font_strike_through\": 16,
    \"font_underline\": 16,
    \"font_color\": 16,
    \"is_active\": 1
}"

const url = new URL(
    "http://localhost/api/v1/sections"
);

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

let body = {
    "section_id": 16,
    "section_type": 16,
    "section_left": 16,
    "section_top": 16,
    "section_width": 16,
    "section_height": 16,
    "section_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem",
    "section_shapestyle": 16,
    "section_fillstyle": 16,
    "section_fillcolor": 16,
    "section_floor_id": 16,
    "font_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem",
    "font_bold": 16,
    "font_italic": 16,
    "font_size": 4326.41688,
    "font_strike_through": 16,
    "font_underline": 16,
    "font_color": 16,
    "is_active": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Sections saved successfully.",
    "data": {
        "id": 1,
        "section_id": 16,
        "section_type": 16,
        "section_left": 16,
        "section_top": 16,
        "section_width": 16,
        "section_height": 16,
        "section_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "section_id": [
            "The section_id field is required."
        ],
        "section_type": [
            "The section_type field is required."
        ],
        "section_left": [
            "The section_left field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/sections

Body Parameters

section_id integer

Validation: required|integer.

section_type integer

Validation: required|integer.

section_left integer

Validation: required|integer.

section_top integer

Validation: required|integer.

section_width integer

Validation: required|integer.

section_height integer

Validation: required|integer.

section_name string

Validation: required|string|max:254. Must not be greater than 254 characters.

section_shapestyle integer

Validation: required|integer.

section_fillstyle integer

Validation: required|integer.

section_fillcolor integer

Validation: required|integer.

section_floor_id integer

Validation: required|integer.

font_name string

Validation: required|string|max:254. Must not be greater than 254 characters.

font_bold integer

Validation: required|integer.

font_italic integer

Validation: required|integer.

font_size number

Validation: required|numeric.

font_strike_through integer

Validation: required|integer.

font_underline integer

Validation: required|integer.

font_color integer

Validation: required|integer.

is_active integer

Validation: required|integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Fetch Section Tables

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/sections/architecto/tables" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/sections/architecto/tables"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "sectionmapid": "architecto"
        },
        {
            "id": 2,
            "sectionmapid": "architecto"
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Floor Tables

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/floors/architecto/tables" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/floors/architecto/tables"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "floorid": "architecto"
        },
        {
            "id": 2,
            "floorid": "architecto"
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Tables

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/tables" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"table_id\": 16,
    \"table_index\": 16,
    \"table_type\": 16,
    \"table_left\": 16,
    \"table_top\": 16,
    \"table_width\": 16,
    \"table_height\": 16,
    \"table_name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem\",
    \"table_shapestyle\": 16,
    \"table_fillstyle\": 16,
    \"table_fillcolor\": 16,
    \"section_id\": 16,
    \"font_name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem\",
    \"font_bold\": 16,
    \"font_italic\": 16,
    \"font_size\": 4326.41688,
    \"font_strike_through\": 16,
    \"font_underline\": 16,
    \"font_color\": 16,
    \"is_active\": 1
}"

const url = new URL(
    "http://localhost/api/v1/tables"
);

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

let body = {
    "table_id": 16,
    "table_index": 16,
    "table_type": 16,
    "table_left": 16,
    "table_top": 16,
    "table_width": 16,
    "table_height": 16,
    "table_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem",
    "table_shapestyle": 16,
    "table_fillstyle": 16,
    "table_fillcolor": 16,
    "section_id": 16,
    "font_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem",
    "font_bold": 16,
    "font_italic": 16,
    "font_size": 4326.41688,
    "font_strike_through": 16,
    "font_underline": 16,
    "font_color": 16,
    "is_active": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Tables saved successfully.",
    "data": {
        "id": 1,
        "table_id": 16,
        "table_index": 16,
        "table_type": 16,
        "table_left": 16,
        "table_top": 16,
        "table_width": 16,
        "table_height": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "table_id": [
            "The table_id field is required."
        ],
        "table_index": [
            "The table_index field is required."
        ],
        "table_type": [
            "The table_type field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/tables

Body Parameters

table_id integer

Validation: required|integer.

table_index integer

Validation: required|integer.

table_type integer

Validation: required|integer.

table_left integer

Validation: required|integer.

table_top integer

Validation: required|integer.

table_width integer

Validation: required|integer.

table_height integer

Validation: required|integer.

table_name string

Validation: required|string|max:254. Must not be greater than 254 characters.

table_shapestyle integer optional

Validation: integer.

table_fillstyle integer optional

Validation: integer.

table_fillcolor integer optional

Validation: integer.

section_id integer

Validation: required|integer.

font_name string optional

Validation: string|max:254. Must not be greater than 254 characters.

font_bold integer optional

Validation: integer.

font_italic integer optional

Validation: integer.

font_size number optional

Validation: numeric.

font_strike_through integer optional

Validation: integer.

font_underline integer optional

Validation: integer.

font_color integer optional

Validation: integer.

is_active integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Application APIs (V1) — General

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Fetch Charges

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/charges?branch=1&city=1&bimpos_delivery_ordertype_id=0" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/charges"
);

const params = {
    "branch": "1",
    "city": "1",
    "bimpos_delivery_ordertype_id": "0",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "branch": 1,
            "city": 1,
            "bimpos_delivery_ordertype_id": 0
        },
        {
            "id": 2,
            "branch": 1,
            "city": 1,
            "bimpos_delivery_ordertype_id": 0
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "branch": [
            "The branch field is required."
        ],
        "city": [
            "The city field is required."
        ],
        "bimpos_delivery_ordertype_id": [
            "The bimpos_delivery_ordertype_id field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

GET api/v1/charges

Query Parameters

branch integer

Validation: required|integer|min:1. Must be at least 1.

city integer

Validation: required|integer|min:1. Must be at least 1.

bimpos_delivery_ordertype_id integer

Validation: required|integer|min:1. Must be at least 1.

Fetch Update

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/updates/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/updates/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "updateid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch All Order Count

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/all/orders/count" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/all/orders/count"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "all_name": "Example All",
            "is_active": true
        },
        {
            "id": 2,
            "all_name": "Example All",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch All Order

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/all/orders/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/all/orders/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "orderid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Department Feedback

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/department/feedbacks/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/department/feedbacks/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "departmentid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Department

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/departments/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/departments/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "departmentid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Content

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/contents/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/contents/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "contentid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch App Setting

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/app/settings/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/app/settings/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "settingid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Devices

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/devices?data=%7B%22deviceIdentifier%22%3A%22bngzmi%22%2C%22deviceOS%22%3A%22yvdljn%22%2C%22deviceAppId%22%3A16%2C%22deviceAppVersion%22%3A%22ngzmiy%22%2C%22mobile%22%3A%22vdljni%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/devices"
);

const params = {
    "data": "{"deviceIdentifier":"bngzmi","deviceOS":"yvdljn","deviceAppId":16,"deviceAppVersion":"ngzmiy","mobile":"vdljni"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Devices saved successfully.",
    "data": {
        "id": 1,
        "deviceIdentifier": "bngzmi",
        "deviceOS": "yvdljn",
        "deviceAppId": 16,
        "deviceAppVersion": "ngzmiy",
        "mobile": "vdljni"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Update Device

requires authentication

Example request:

curl --request PUT \
    "http://localhost/api/v1/devices?data=%7B%22deviceIdentifier%22%3A%22bngzmi%22%2C%22mobile%22%3A%22yvdljn%22%2C%22validationCode%22%3A%22ikhway%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/devices"
);

const params = {
    "data": "{"deviceIdentifier":"bngzmi","mobile":"yvdljn","validationCode":"ikhway"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Devices updated successfully.",
    "data": {
        "id": 1,
        "deviceIdentifier": "bngzmi",
        "mobile": "yvdljn",
        "validationCode": "ikhway"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Aggregator

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/aggregators/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/aggregators/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "sourceid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V1) — Geo Addresses

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Fetch Branch

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/branches/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/branches/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "branchid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Region

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/regions/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/regions/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "regionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Branch Cities

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/branch/architecto/cities" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/branch/architecto/cities"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "branchid": "architecto"
        },
        {
            "id": 2,
            "branchid": "architecto"
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch City

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/cities/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/cities/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "cityid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Country

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/countries/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/countries/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "countryid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Branch Setting

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/branch/settings/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/branch/settings/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "settingkey": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V1) — Orders

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Fetch Order Count

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/orders/count" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/orders/count"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "order_name": "Example Order",
            "is_active": true
        },
        {
            "id": 2,
            "order_name": "Example Order",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Order

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/orders/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/orders/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "orderid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Orders

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/orders?data=%7B%22order%22%3A%7B%22orderid%22%3A%22architecto%22%2C%22orderdate%22%3A%22architecto%22%2C%22paymenttype%22%3A%22architecto%22%2C%22branchid%22%3A%22architecto%22%2C%22ordertype%22%3A%22architecto%22%2C%22deliveryCost%22%3A137449171%2C%22serviceCharge%22%3A671936806%2C%22ispaid%22%3A1%2C%22table_id%22%3A16%2C%22member%22%3A%7B%22posreference%22%3A%22architecto%22%2C%22membername%22%3A%22ngzmiyvdljnikhwayk%22%2C%22mobile%22%3A%22architecto%22%2C%22mobilevalidated%22%3A%22%22%2C%22dateofbirth%22%3A%22ngz%22%2C%22address%22%3A%7B%22posreference%22%3A%22architecto%22%2C%22description%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22addresstype%22%3A%22architecto%22%2C%22geolat%22%3A%22architecto%22%2C%22geolong%22%3A%22architecto%22%2C%22citycode%22%3A%22architecto%22%2C%22street%22%3A%22ngzmiyvdljnikhwayk%22%2C%22bldg%22%3A%22cmyuwpwlvqwrsitcps%22%2C%22floor%22%3A%22%22%2C%22phone%22%3A%2203000000%22%2C%22cityname%22%3A%22example%22%2C%22directions%22%3A%22example%22%7D%2C%22email%22%3A%22example%40bimpos.com%22%7D%2C%22items%22%3A%5B%7B%22productcode%22%3A%22cql%22%2C%22productqty%22%3A%22dzs%22%2C%22productprice%22%3A%22%22%2C%22modifiers%22%3A%5B%7B%22modifiercode%22%3A%22architecto%22%2C%22modifierqty%22%3A%22architecto%22%2C%22modifierprice%22%3A%22architecto%22%2C%22modifiers_description%22%3A%22architecto%22%7D%5D%7D%5D%2C%22sourceid%22%3A1%2C%22deviceid%22%3A1%2C%22ordertime%22%3A%2212%3A00%3A00%22%2C%22note%22%3A%22example%22%2C%22totalDiscountAmount%22%3A%22example%22%2C%22additional_info%22%3A%7B%22channel_id%22%3A1%2C%22channel_name%22%3A%22example%22%2C%22channel_order_id%22%3A1%2C%22channel_order_display_id%22%3A1%7D%7D%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/orders"
);

const params = {
    "data": "{"order":{"orderid":"architecto","orderdate":"architecto","paymenttype":"architecto","branchid":"architecto","ordertype":"architecto","deliveryCost":137449171,"serviceCharge":671936806,"ispaid":1,"table_id":16,"member":{"posreference":"architecto","membername":"ngzmiyvdljnikhwayk","mobile":"architecto","mobilevalidated":"","dateofbirth":"ngz","address":{"posreference":"architecto","description":"ngzmiyvdljnikhwaykcm","addresstype":"architecto","geolat":"architecto","geolong":"architecto","citycode":"architecto","street":"ngzmiyvdljnikhwayk","bldg":"cmyuwpwlvqwrsitcps","floor":"","phone":"03000000","cityname":"example","directions":"example"},"email":"example@bimpos.com"},"items":[{"productcode":"cql","productqty":"dzs","productprice":"","modifiers":[{"modifiercode":"architecto","modifierqty":"architecto","modifierprice":"architecto","modifiers_description":"architecto"}]}],"sourceid":1,"deviceid":1,"ordertime":"12:00:00","note":"example","totalDiscountAmount":"example","additional_info":{"channel_id":1,"channel_name":"example","channel_order_id":1,"channel_order_display_id":1}}}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Orders saved successfully.",
    "data": {
        "id": 1,
        "order": {
            "orderid": "architecto",
            "orderdate": "architecto",
            "paymenttype": "architecto",
            "branchid": "architecto",
            "ordertype": "architecto",
            "deliveryCost": 137449171,
            "serviceCharge": 671936806,
            "ispaid": 1,
            "table_id": 16,
            "member": {
                "posreference": "architecto",
                "membername": "ngzmiyvdljnikhwayk",
                "mobile": "architecto",
                "mobilevalidated": "",
                "dateofbirth": "ngz",
                "address": {
                    "posreference": "architecto",
                    "description": "ngzmiyvdljnikhwaykcm",
                    "addresstype": "architecto",
                    "geolat": "architecto",
                    "geolong": "architecto",
                    "citycode": "architecto",
                    "street": "ngzmiyvdljnikhwayk",
                    "bldg": "cmyuwpwlvqwrsitcps",
                    "floor": "",
                    "phone": "03000000",
                    "cityname": "example",
                    "directions": "example"
                },
                "email": "example@bimpos.com"
            },
            "items": [
                {
                    "productcode": "cql",
                    "productqty": "dzs",
                    "productprice": "",
                    "modifiers": [
                        {
                            "modifiercode": "architecto",
                            "modifierqty": "architecto",
                            "modifierprice": "architecto",
                            "modifiers_description": "architecto"
                        }
                    ]
                }
            ],
            "sourceid": 1,
            "deviceid": 1,
            "ordertime": "12:00:00",
            "note": "example",
            "totalDiscountAmount": "example",
            "additional_info": {
                "channel_id": 1,
                "channel_name": "example",
                "channel_order_id": 1,
                "channel_order_display_id": 1
            }
        }
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Order Status

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/order/architecto/status" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/order/architecto/status"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "orderid": "architecto"
        },
        {
            "id": 2,
            "orderid": "architecto"
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Update Order Statu

requires authentication

Example request:

curl --request PUT \
    "http://localhost/api/v1/orders/architecto/status?data=%7B%22success%22%3A%22architecto%22%2C%22branchid%22%3A%22architecto%22%2C%22postransact%22%3A%22architecto%22%2C%22status%22%3A%22architecto%22%2C%22posmemberreference%22%3A%22architecto%22%2C%22posaddressreference%22%3A%22architecto%22%2C%22ORDERID%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/orders/architecto/status"
);

const params = {
    "data": "{"success":"architecto","branchid":"architecto","postransact":"architecto","status":"architecto","posmemberreference":"architecto","posaddressreference":"architecto","ORDERID":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Orders updated successfully.",
    "data": {
        "id": 1,
        "hstransact": "architecto",
        "success": "architecto",
        "branchid": "architecto",
        "postransact": "architecto",
        "status": "architecto",
        "posmemberreference": "architecto",
        "posaddressreference": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Item Status

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/items/status" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"architecto\",
    \"success\": \"architecto\",
    \"items\": [
        {
            \"itemid\": \"architecto\",
            \"posdetailid\": \"architecto\"
        }
    ]
}"

const url = new URL(
    "http://localhost/api/v1/items/status"
);

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

let body = {
    "status": "architecto",
    "success": "architecto",
    "items": [
        {
            "itemid": "architecto",
            "posdetailid": "architecto"
        }
    ]
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Items saved successfully.",
    "data": {
        "id": 1,
        "status": "architecto",
        "success": "architecto",
        "items": [
            []
        ]
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "status": [
            "The status field is required."
        ],
        "success": [
            "The success field is required."
        ],
        "items": [
            "The items field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/items/status

Body Parameters

status string

'orderid' => ['required'],. Validation: required.

success string

Validation: required.

items object[] optional

items[].itemid string

Validation: required.

items[].posdetailid string

Validation: required.

Add Order Items

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/order/items" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"posdetailid\": \"architecto\",
    \"productcode\": \"architecto\",
    \"productqty\": \"architecto\",
    \"productprice\": \"architecto\",
    \"remark\": \"architecto\",
    \"seatnumber\": \"architecto\",
    \"isdiscount\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/v1/order/items"
);

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

let body = {
    "posdetailid": "architecto",
    "productcode": "architecto",
    "productqty": "architecto",
    "productprice": "architecto",
    "remark": "architecto",
    "seatnumber": "architecto",
    "isdiscount": "architecto"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Order saved successfully.",
    "data": {
        "id": 1,
        "posdetailid": "architecto",
        "productcode": "architecto",
        "productqty": "architecto",
        "productprice": "architecto",
        "remark": "architecto",
        "seatnumber": "architecto",
        "isdiscount": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "posdetailid": [
            "The posdetailid field is required."
        ],
        "productcode": [
            "The productcode field is required."
        ],
        "productqty": [
            "The productqty field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/order/items

Body Parameters

posdetailid string

Validation: required.

productcode string

Validation: required.

productqty string

Validation: required.

productprice string

Validation: required.

modifiers string optional

Validation: nullable.

remark string

Validation: required.

seatnumber string

Validation: required.

isdiscount string

Validation: required.

Add Tempdetail

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/tempdetail" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"UNIQUEID\": 16,
    \"TEMPTRANSACT\": 16,
    \"QUAN\": 4326.41688,
    \"PRODNUM\": 16,
    \"STATION\": 16,
    \"USERID\": 16,
    \"TIM\": \"2026-08-17T09:09:19\",
    \"PRINTED\": 16,
    \"PRICE\": 4326.41688,
    \"TAXEX\": 4326.41688,
    \"TAX\": 4326.41688,
    \"TAX2\": 4326.41688,
    \"TAX3\": 4326.41688,
    \"TABLNUM\": 16,
    \"TYPE\": 16,
    \"DESCRIPT\": \"ngzmiy\",
    \"MANUALDESCRIPT\": 16,
    \"LPRODNUM\": 16,
    \"TAXSYMB\": \"ngz\",
    \"SEATNUM\": 16,
    \"TIMCLOSED\": \"2026-08-17T09:09:19\",
    \"DISCOUNT\": 16,
    \"SEATDESCRIPT_OLD\": \"ngzmiy\",
    \"POINTS\": 16,
    \"ORDERSEQ\": 16,
    \"SPRODNUM\": 16,
    \"WHOAUTH\": 16,
    \"ITEMTYPE\": 16,
    \"PRICETYPE\": 16,
    \"AVGCOST\": 4326.41688,
    \"LASTCOST\": 4326.41688,
    \"MEMCODE\": 16,
    \"ADDRESSID\": 16,
    \"CONTACTID\": 16,
    \"PDASTATION\": 16,
    \"ITEMTAG\": \"n\",
    \"HOLDPRINT\": \"architecto\",
    \"DISCPER\": 16,
    \"DISCVALUE\": 4326.41688,
    \"UNITPRICE\": 4326.41688,
    \"HEADERDISCPER\": 4326.41688,
    \"EXPIRATION\": 16,
    \"PACKING\": 16,
    \"WEIGHT\": 16,
    \"PLDID\": 16,
    \"SERIALNUM\": \"ngzmiy\",
    \"WAR\": 16,
    \"SkuID1\": 16,
    \"SkuID2\": 16,
    \"LOYALTYID\": 16,
    \"FORBRANCHID\": 16,
    \"ISSCHEDULED\": false,
    \"TOBEDEL\": \"2026-08-17T09:09:19\",
    \"REMIND\": \"2026-08-17T09:09:19\",
    \"DOREMIND\": \"architecto\",
    \"TALLINKID\": 16,
    \"ORDERTYPE\": 16,
    \"RESTID\": \"ngzmi\",
    \"OPENDATE\": 16,
    \"ISACTIVE\": 1
}"

const url = new URL(
    "http://localhost/api/v1/tempdetail"
);

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

let body = {
    "UNIQUEID": 16,
    "TEMPTRANSACT": 16,
    "QUAN": 4326.41688,
    "PRODNUM": 16,
    "STATION": 16,
    "USERID": 16,
    "TIM": "2026-08-17T09:09:19",
    "PRINTED": 16,
    "PRICE": 4326.41688,
    "TAXEX": 4326.41688,
    "TAX": 4326.41688,
    "TAX2": 4326.41688,
    "TAX3": 4326.41688,
    "TABLNUM": 16,
    "TYPE": 16,
    "DESCRIPT": "ngzmiy",
    "MANUALDESCRIPT": 16,
    "LPRODNUM": 16,
    "TAXSYMB": "ngz",
    "SEATNUM": 16,
    "TIMCLOSED": "2026-08-17T09:09:19",
    "DISCOUNT": 16,
    "SEATDESCRIPT_OLD": "ngzmiy",
    "POINTS": 16,
    "ORDERSEQ": 16,
    "SPRODNUM": 16,
    "WHOAUTH": 16,
    "ITEMTYPE": 16,
    "PRICETYPE": 16,
    "AVGCOST": 4326.41688,
    "LASTCOST": 4326.41688,
    "MEMCODE": 16,
    "ADDRESSID": 16,
    "CONTACTID": 16,
    "PDASTATION": 16,
    "ITEMTAG": "n",
    "HOLDPRINT": "architecto",
    "DISCPER": 16,
    "DISCVALUE": 4326.41688,
    "UNITPRICE": 4326.41688,
    "HEADERDISCPER": 4326.41688,
    "EXPIRATION": 16,
    "PACKING": 16,
    "WEIGHT": 16,
    "PLDID": 16,
    "SERIALNUM": "ngzmiy",
    "WAR": 16,
    "SkuID1": 16,
    "SkuID2": 16,
    "LOYALTYID": 16,
    "FORBRANCHID": 16,
    "ISSCHEDULED": false,
    "TOBEDEL": "2026-08-17T09:09:19",
    "REMIND": "2026-08-17T09:09:19",
    "DOREMIND": "architecto",
    "TALLINKID": 16,
    "ORDERTYPE": 16,
    "RESTID": "ngzmi",
    "OPENDATE": 16,
    "ISACTIVE": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Tempdetail saved successfully.",
    "data": {
        "id": 1,
        "UNIQUEID": 16,
        "TEMPTRANSACT": 16,
        "QUAN": 4326.41688,
        "PRODNUM": 16,
        "STATION": 16,
        "USERID": 16,
        "TIM": "2026-08-17T09:09:19"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "UNIQUEID": [
            "The UNIQUEID field is required."
        ],
        "TEMPTRANSACT": [
            "The TEMPTRANSACT field is required."
        ],
        "QUAN": [
            "The QUAN field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/tempdetail

Body Parameters

UNIQUEID integer

Validation: required|integer.

TEMPTRANSACT integer optional

Validation: nullable|integer.

QUAN number optional

Validation: nullable|numeric.

PRODNUM integer optional

Validation: nullable|integer.

STATION integer optional

Validation: nullable|integer.

USERID integer optional

Validation: nullable|integer.

TIM string optional

Validation: nullable|date. Must be a valid date.

PRINTED integer optional

Validation: nullable|integer.

PRICE number optional

Validation: nullable|numeric.

TAXEX number optional

Validation: nullable|numeric.

TAX number optional

Validation: nullable|numeric.

TAX2 number optional

Validation: nullable|numeric.

TAX3 number optional

Validation: nullable|numeric.

TABLNUM integer optional

Validation: nullable|integer.

TYPE integer optional

Validation: nullable|integer.

DESCRIPT string optional

Validation: nullable|string|max:50. Must not be greater than 50 characters.

MANUALDESCRIPT integer optional

Validation: nullable|integer.

LPRODNUM integer optional

Validation: nullable|integer.

TAXSYMB string optional

Validation: nullable|string|max:3. Must not be greater than 3 characters.

SEATNUM integer optional

Validation: nullable|integer.

TIMCLOSED string optional

Validation: nullable|date. Must be a valid date.

DISCOUNT integer optional

Validation: nullable|integer.

SEATDESCRIPT_OLD string optional

Validation: nullable|string|max:50. Must not be greater than 50 characters.

POINTS integer optional

Validation: nullable|integer.

ORDERSEQ integer optional

Validation: nullable|integer.

SPRODNUM integer optional

Validation: nullable|integer.

WHOAUTH integer optional

Validation: nullable|integer.

ITEMTYPE integer optional

Validation: nullable|integer.

PRICETYPE integer optional

Validation: nullable|integer.

AVGCOST number optional

Validation: nullable|numeric.

LASTCOST number optional

Validation: nullable|numeric.

MEMCODE integer optional

Validation: nullable|integer.

ADDRESSID integer optional

Validation: nullable|integer.

CONTACTID integer optional

Validation: nullable|integer.

PDASTATION integer optional

Validation: nullable|integer.

ITEMTAG string optional

Validation: nullable|string|max:1. Must not be greater than 1 characters.

HOLDPRINT string optional

Validation: nullable|string.

DISCPER integer optional

Validation: nullable|integer.

DISCVALUE number optional

Validation: nullable|numeric.

UNITPRICE number optional

Validation: nullable|numeric.

HEADERDISCPER number optional

Validation: nullable|numeric.

EXPIRATION integer optional

Validation: nullable|integer.

PACKING integer optional

Validation: nullable|integer.

WEIGHT integer optional

Validation: nullable|integer.

PLDID integer optional

Validation: nullable|integer.

SERIALNUM string optional

Validation: nullable|string|max:50. Must not be greater than 50 characters.

WAR integer optional

Validation: nullable|integer.

SkuID1 integer optional

Validation: nullable|integer.

SkuID2 integer optional

Validation: nullable|integer.

LOYALTYID integer optional

Validation: nullable|integer.

FORBRANCHID integer optional

Validation: nullable|integer.

ISSCHEDULED boolean optional

Validation: nullable|boolean.

TOBEDEL string optional

Validation: nullable|date. Must be a valid date.

REMIND string optional

Validation: nullable|date. Must be a valid date.

DOREMIND string optional

Validation: nullable|string.

TALLINKID integer optional

Validation: nullable|integer.

ORDERTYPE integer optional

Validation: nullable|integer.

RESTID string

Validation: required|string|max:10. Must not be greater than 10 characters.

OPENDATE integer

Validation: required|integer.

ISACTIVE integer

Validation: required|integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Application APIs (V1) — Payments

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Fetch Currencytype

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/currencytypes/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/currencytypes/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "currencytypeid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Currencytypes

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/currencytypes" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"description\": \"ngzmiyvdljnikhwaykcm\",
    \"is_active\": 0
}"

const url = new URL(
    "http://localhost/api/v1/currencytypes"
);

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

let body = {
    "id": 16,
    "description": "ngzmiyvdljnikhwaykcm",
    "is_active": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Currencytypes saved successfully.",
    "data": {
        "id": 16,
        "description": "ngzmiyvdljnikhwaykcm",
        "is_active": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "description": [
            "The description field is required."
        ],
        "is_active": [
            "The is_active field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/currencytypes

Body Parameters

id integer

Validation: required|integer.

description string optional

Validation: string|max:100|nullable. Must not be greater than 100 characters.

is_active integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

Fetch Currency

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/currencies/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/currencies/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "currencyid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Currencies

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/currencies" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"description\": \"ngzmiy\",
    \"long_description\": \"vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmit\",
    \"is_default\": 1,
    \"conversion\": 4326.41688,
    \"conversion2\": 4326.41688,
    \"is_active\": 0,
    \"is_second_currency\": 0,
    \"hide_changes\": 0,
    \"decimals\": 16,
    \"account_code\": \"ngzmiyvdljnikhwaykcmyuwpwlv\",
    \"currency_mask\": \"qwrsitcpscqldzs\",
    \"show_in_pos\": 1,
    \"show_in_calc\": 1,
    \"read_only\": 0,
    \"sequence\": 16,
    \"show_credit_card_form\": 1,
    \"show_check_form\": 0,
    \"show_in_bo\": 1,
    \"goes_to_bank\": 0,
    \"type\": 16,
    \"currency_type\": 16,
    \"is_gift_voucher\": 1,
    \"caption\": \"gzmiyvdljnikhwaykcmyuwpwlvq\"
}"

const url = new URL(
    "http://localhost/api/v1/currencies"
);

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

let body = {
    "id": 16,
    "description": "ngzmiy",
    "long_description": "vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmit",
    "is_default": 1,
    "conversion": 4326.41688,
    "conversion2": 4326.41688,
    "is_active": 0,
    "is_second_currency": 0,
    "hide_changes": 0,
    "decimals": 16,
    "account_code": "ngzmiyvdljnikhwaykcmyuwpwlv",
    "currency_mask": "qwrsitcpscqldzs",
    "show_in_pos": 1,
    "show_in_calc": 1,
    "read_only": 0,
    "sequence": 16,
    "show_credit_card_form": 1,
    "show_check_form": 0,
    "show_in_bo": 1,
    "goes_to_bank": 0,
    "type": 16,
    "currency_type": 16,
    "is_gift_voucher": 1,
    "caption": "gzmiyvdljnikhwaykcmyuwpwlvq"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Currencies saved successfully.",
    "data": {
        "id": 16,
        "description": "ngzmiy",
        "long_description": "vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmit",
        "is_default": 1,
        "conversion": 4326.41688,
        "conversion2": 4326.41688,
        "is_active": 0,
        "is_second_currency": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "description": [
            "The description field is required."
        ],
        "long_description": [
            "The long_description field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/currencies

Body Parameters

id integer

Validation: required|integer.

description string

Validation: required|string|max:50. Must not be greater than 50 characters.

long_description string optional

Validation: string|max:200|nullable. Must not be greater than 200 characters.

charnge1 string optional

Validation: double|nullable.

charnge2 string optional

Validation: double|nullable.

charnge3 string optional

Validation: double|nullable.

charnge4 string optional

Validation: double|nullable.

charnge5 string optional

Validation: double|nullable.

charnge6 string optional

Validation: double|nullable.

charnge7 string optional

Validation: double|nullable.

charnge8 string optional

Validation: double|nullable.

charnge9 string optional

Validation: double|nullable.

charnge10 string optional

Validation: double|nullable.

is_default integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

conversion number optional

Validation: numeric|nullable.

conversion2 number optional

Validation: numeric|nullable.

is_active integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

is_second_currency integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

hide_changes integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

decimals integer optional

Validation: integer|nullable.

account_code string optional

Validation: string|max:30|nullable. Must not be greater than 30 characters.

currency_mask string optional

Validation: string|max:15|nullable. Must not be greater than 15 characters.

show_in_pos integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

show_in_calc integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

read_only integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

sequence integer optional

Validation: integer|nullable.

show_credit_card_form integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

show_check_form integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

show_in_bo integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

goes_to_bank integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

type integer optional

Validation: integer|nullable.

currency_type integer optional

Validation: integer|nullable.

is_gift_voucher integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

caption string optional

Validation: string|max:65,530|nullable. Must not be greater than 65 characters.

Fetch Pricelist

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/pricelists/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/pricelists/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "pricelistid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Pricelists

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/pricelists" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"currency_id\": 16,
    \"description\": \"ngzmiyvdljnikhwaykcm\",
    \"is_active\": 0,
    \"is_tax_excluded\": 0
}"

const url = new URL(
    "http://localhost/api/v1/pricelists"
);

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

let body = {
    "id": 16,
    "currency_id": 16,
    "description": "ngzmiyvdljnikhwaykcm",
    "is_active": 0,
    "is_tax_excluded": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Pricelists saved successfully.",
    "data": {
        "id": 16,
        "currency_id": 16,
        "description": "ngzmiyvdljnikhwaykcm",
        "is_active": 0,
        "is_tax_excluded": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "currency_id": [
            "The currency_id field is required."
        ],
        "description": [
            "The description field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/pricelists

Body Parameters

id integer

Validation: required|integer.

currency_id integer

Validation: required|integer.

description string

Validation: required|string|max:100. Must not be greater than 100 characters.

is_active integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

is_tax_excluded integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

Fetch Pricelistdetail

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/pricelistdetails/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/pricelistdetails/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "pricelistdetailid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Pricelistdetails

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/pricelistdetails" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"price_list_id\": 16,
    \"product_number\": 16,
    \"price\": \"architecto\",
    \"is_active\": 1
}"

const url = new URL(
    "http://localhost/api/v1/pricelistdetails"
);

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

let body = {
    "id": 16,
    "price_list_id": 16,
    "product_number": 16,
    "price": "architecto",
    "is_active": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Pricelistdetails saved successfully.",
    "data": {
        "id": 16,
        "price_list_id": 16,
        "product_number": 16,
        "price": "architecto",
        "is_active": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "price_list_id": [
            "The price_list_id field is required."
        ],
        "product_number": [
            "The product_number field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/pricelistdetails

Body Parameters

id integer

Validation: required|integer.

price_list_id integer

Validation: required|integer.

product_number integer

Validation: required|integer.

price string

Validation: required|nullable.

is_active integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

Fetch Pricelistbranche

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/pricelistbranches/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/pricelistbranches/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "pricelistbranchesid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Pricelistbranches

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/pricelistbranches" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"price_list_id\": 16,
    \"branch_id\": 16,
    \"is_active\": 1
}"

const url = new URL(
    "http://localhost/api/v1/pricelistbranches"
);

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

let body = {
    "id": 16,
    "price_list_id": 16,
    "branch_id": 16,
    "is_active": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Pricelistbranches saved successfully.",
    "data": {
        "id": 16,
        "price_list_id": 16,
        "branch_id": 16,
        "is_active": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "price_list_id": [
            "The price_list_id field is required."
        ],
        "branch_id": [
            "The branch_id field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/pricelistbranches

Body Parameters

id integer

Validation: required|integer.

price_list_id integer

Validation: required|integer.

branch_id integer

Validation: required|integer.

is_active integer

Validation: required|integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Table Payment

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/table/payment" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"orderid\": \"architecto\",
    \"source_payment_transact\": \"architecto\",
    \"tableid\": \"architecto\",
    \"branchid\": \"architecto\",
    \"paymenttype\": \"architecto\",
    \"serviceCharge\": \"architecto\",
    \"totalDiscountAmount\": \"architecto\",
    \"totalPaidAmount\": \"architecto\",
    \"sourceid\": \"architecto\",
    \"items\": \"architecto\",
    \"itemid\": \"architecto\",
    \"productqty\": \"architecto\",
    \"productprice\": \"architecto\",
    \"paidproductprice\": \"architecto\",
    \"totalproductprice\": \"architecto\",
    \"modifiers\": [
        \"architecto\"
    ],
    \"modifiercode\": \"architecto\",
    \"modifierqty\": \"architecto\",
    \"modifierprice\": \"architecto\",
    \"totalmodifierprice\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/v1/table/payment"
);

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

let body = {
    "orderid": "architecto",
    "source_payment_transact": "architecto",
    "tableid": "architecto",
    "branchid": "architecto",
    "paymenttype": "architecto",
    "serviceCharge": "architecto",
    "totalDiscountAmount": "architecto",
    "totalPaidAmount": "architecto",
    "sourceid": "architecto",
    "items": "architecto",
    "itemid": "architecto",
    "productqty": "architecto",
    "productprice": "architecto",
    "paidproductprice": "architecto",
    "totalproductprice": "architecto",
    "modifiers": [
        "architecto"
    ],
    "modifiercode": "architecto",
    "modifierqty": "architecto",
    "modifierprice": "architecto",
    "totalmodifierprice": "architecto"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Table saved successfully.",
    "data": {
        "id": 1,
        "orderid": "architecto",
        "source_payment_transact": "architecto",
        "tableid": "architecto",
        "branchid": "architecto",
        "paymenttype": "architecto",
        "serviceCharge": "architecto",
        "totalDiscountAmount": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "orderid": [
            "The orderid field is required."
        ],
        "source_payment_transact": [
            "The source_payment_transact field is required."
        ],
        "tableid": [
            "The tableid field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/table/payment

Body Parameters

orderid string

Validation: required.

source_payment_transact string

Validation: required.

tableid string

Validation: required.

branchid string

Validation: required.

paymenttype string

Validation: required.

serviceCharge string

Validation: required.

totalDiscountAmount string

Validation: required.

totalPaidAmount string

Validation: required.

sourceid string

Validation: required.

items string

Validation: required.

itemid string

Validation: required.

productqty string

Validation: required.

productprice string

Validation: required.

paidproductprice string

Validation: required.

totalproductprice string

Validation: required.

modifiers string[] optional

Validation: array.

modifiercode string

Validation: required.

modifierqty string

Validation: required.

modifierprice string

Validation: required.

totalmodifierprice string

Validation: required.

Fetch Table Invoice

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/table/architecto/invoice/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/table/architecto/invoice/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "tableid": "architecto",
        "type": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Update Table Payment Statu

requires authentication

Example request:

curl --request PUT \
    "http://localhost/api/v1/table/payment/status" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"INVOICEID\": 16,
    \"TABLEID\": 16,
    \"STATUS\": 16
}"

const url = new URL(
    "http://localhost/api/v1/table/payment/status"
);

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

let body = {
    "INVOICEID": 16,
    "TABLEID": 16,
    "STATUS": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Table updated successfully.",
    "data": {
        "id": 1,
        "INVOICEID": 16,
        "TABLEID": 16,
        "STATUS": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "INVOICEID": [
            "The INVOICEID field is required."
        ],
        "TABLEID": [
            "The TABLEID field is required."
        ],
        "STATUS": [
            "The STATUS field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Table Payment

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/table/payments/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/table/payments/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "invoiceid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V1) — Products

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Fetch Parent

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/parents/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/parents/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "parentid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Parent Categories

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/parents/architecto/categories" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/parents/architecto/categories"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": "architecto",
            "parent_name": "Example Parent",
            "is_active": true
        },
        {
            "id": "architecto",
            "parent_name": "Example Parent",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Category

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/categories/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/categories/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "catid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Product

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/product/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/product/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "productid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Product Category

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/product/architecto/category/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/product/architecto/category/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "productid": "architecto",
        "categoryid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Products

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/products" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/products"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "product_name": "Example Product",
            "is_active": true
        },
        {
            "id": 2,
            "product_name": "Example Product",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Product Stock

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/productstock/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/productstock/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "prodnum": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Question

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/questions/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questions/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": "architecto",
        "question_name": "Example Question",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Modifier

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/modifiers/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/modifiers/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "modifierid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Combo

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/combos/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/combos/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": "architecto",
        "combo_name": "Example Combo",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Gallery

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/galleries/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/galleries/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "galleryid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Comboheader

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/comboheaders/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/comboheaders/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "comboheaderid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Combodetail

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/combodetails/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/combodetails/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "combodetailid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Comboitem

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/comboitems/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/comboitems/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "comboitemid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Product Combo

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/productcombos/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/productcombos/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "productcomboid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Product Picture

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/product/pictures/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/product/pictures/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": "architecto",
        "product_name": "Example Product",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V2) — Actions

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Add Actions

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/actions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"TABLEID\": 16,
    \"TYPE\": \"4\",
    \"STATUS\": \"0\",
    \"POSSTATUS\": \"1\",
    \"ORDERID\": 16
}"

const url = new URL(
    "http://localhost/api/v2/actions"
);

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

let body = {
    "TABLEID": 16,
    "TYPE": "4",
    "STATUS": "0",
    "POSSTATUS": "1",
    "ORDERID": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Actions saved successfully.",
    "data": {
        "id": 1,
        "TABLEID": 16,
        "TYPE": "4",
        "STATUS": "0",
        "POSSTATUS": "1",
        "ORDERID": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "TABLEID": [
            "The TABLEID field is required."
        ],
        "TYPE": [
            "The TYPE field is required."
        ],
        "STATUS": [
            "The STATUS field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/actions

Body Parameters

TABLEID integer

Validation: required|integer.

TYPE string

Validation: required|in:1,2,3,4. Must be one of 1, 2, 3, or 4.

STATUS string

Validation: required|in:0,1. Must be one of 0 or 1.

POSSTATUS string

Validation: required|in:0,1. Must be one of 0 or 1.

ORDERID integer optional

Validation: integer.

Fetch Actions

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/actions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/actions"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "action_name": "Example Action",
            "is_active": true
        },
        {
            "id": 2,
            "action_name": "Example Action",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V2) — Floors

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Add Floors

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/floors" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"description\": \"ngzmiy\",
    \"is_default\": 1,
    \"background_color\": 16,
    \"is_active\": 1,
    \"floor_width\": 16,
    \"floor_height\": 16,
    \"branch_id\": 16,
    \"concept_id\": 16
}"

const url = new URL(
    "http://localhost/api/v2/floors"
);

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

let body = {
    "id": 16,
    "description": "ngzmiy",
    "is_default": 1,
    "background_color": 16,
    "is_active": 1,
    "floor_width": 16,
    "floor_height": 16,
    "branch_id": 16,
    "concept_id": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Floors saved successfully.",
    "data": {
        "id": 16,
        "description": "ngzmiy",
        "is_default": 1,
        "background_color": 16,
        "is_active": 1,
        "floor_width": 16,
        "floor_height": 16,
        "branch_id": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "description": [
            "The description field is required."
        ],
        "is_default": [
            "The is_default field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/floors

Body Parameters

id integer

Validation: required|integer.

description string

Validation: required|string|max:50. Must not be greater than 50 characters.

is_default integer

Validation: required|integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

background_color integer

Validation: required|integer.

is_active integer

Validation: required|integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

floor_width integer

Validation: required|integer.

floor_height integer

Validation: required|integer.

branch_id integer

Validation: required|integer.

concept_id integer

Validation: required|integer.

Delete Floor

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v2/floors" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/floors"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Floors deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Sections

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/sections" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"section_id\": 16,
    \"section_type\": 16,
    \"section_left\": 16,
    \"section_top\": 16,
    \"section_width\": 16,
    \"section_height\": 16,
    \"section_name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem\",
    \"section_shapestyle\": 16,
    \"section_fillstyle\": 16,
    \"section_fillcolor\": 16,
    \"section_floor_id\": 16,
    \"font_name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem\",
    \"font_bold\": 16,
    \"font_italic\": 16,
    \"font_size\": 4326.41688,
    \"font_strike_through\": 16,
    \"font_underline\": 16,
    \"font_color\": 16,
    \"is_active\": 1
}"

const url = new URL(
    "http://localhost/api/v2/sections"
);

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

let body = {
    "section_id": 16,
    "section_type": 16,
    "section_left": 16,
    "section_top": 16,
    "section_width": 16,
    "section_height": 16,
    "section_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem",
    "section_shapestyle": 16,
    "section_fillstyle": 16,
    "section_fillcolor": 16,
    "section_floor_id": 16,
    "font_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem",
    "font_bold": 16,
    "font_italic": 16,
    "font_size": 4326.41688,
    "font_strike_through": 16,
    "font_underline": 16,
    "font_color": 16,
    "is_active": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Sections saved successfully.",
    "data": {
        "id": 1,
        "section_id": 16,
        "section_type": 16,
        "section_left": 16,
        "section_top": 16,
        "section_width": 16,
        "section_height": 16,
        "section_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "section_id": [
            "The section_id field is required."
        ],
        "section_type": [
            "The section_type field is required."
        ],
        "section_left": [
            "The section_left field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/sections

Body Parameters

section_id integer

Validation: required|integer.

section_type integer

Validation: required|integer.

section_left integer

Validation: required|integer.

section_top integer

Validation: required|integer.

section_width integer

Validation: required|integer.

section_height integer

Validation: required|integer.

section_name string

Validation: required|string|max:254. Must not be greater than 254 characters.

section_shapestyle integer

Validation: required|integer.

section_fillstyle integer

Validation: required|integer.

section_fillcolor integer

Validation: required|integer.

section_floor_id integer

Validation: required|integer.

font_name string

Validation: required|string|max:254. Must not be greater than 254 characters.

font_bold integer

Validation: required|integer.

font_italic integer

Validation: required|integer.

font_size number

Validation: required|numeric.

font_strike_through integer

Validation: required|integer.

font_underline integer

Validation: required|integer.

font_color integer

Validation: required|integer.

is_active integer

Validation: required|integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Fetch Section Tables

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/sections/architecto/tables" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/sections/architecto/tables"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "sectionmapid": "architecto"
        },
        {
            "id": 2,
            "sectionmapid": "architecto"
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Floor Tables

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/floors/architecto/tables" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/floors/architecto/tables"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "floorid": "architecto"
        },
        {
            "id": 2,
            "floorid": "architecto"
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Tables

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/tables" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"table_id\": 16,
    \"table_index\": 16,
    \"table_type\": 16,
    \"table_left\": 16,
    \"table_top\": 16,
    \"table_width\": 16,
    \"table_height\": 16,
    \"table_name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem\",
    \"table_shapestyle\": 16,
    \"table_fillstyle\": 16,
    \"table_fillcolor\": 16,
    \"section_id\": 16,
    \"font_name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem\",
    \"font_bold\": 16,
    \"font_italic\": 16,
    \"font_size\": 4326.41688,
    \"font_strike_through\": 16,
    \"font_underline\": 16,
    \"font_color\": 16,
    \"is_active\": 1
}"

const url = new URL(
    "http://localhost/api/v2/tables"
);

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

let body = {
    "table_id": 16,
    "table_index": 16,
    "table_type": 16,
    "table_left": 16,
    "table_top": 16,
    "table_width": 16,
    "table_height": 16,
    "table_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem",
    "table_shapestyle": 16,
    "table_fillstyle": 16,
    "table_fillcolor": 16,
    "section_id": 16,
    "font_name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdem",
    "font_bold": 16,
    "font_italic": 16,
    "font_size": 4326.41688,
    "font_strike_through": 16,
    "font_underline": 16,
    "font_color": 16,
    "is_active": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Tables saved successfully.",
    "data": {
        "id": 1,
        "table_id": 16,
        "table_index": 16,
        "table_type": 16,
        "table_left": 16,
        "table_top": 16,
        "table_width": 16,
        "table_height": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "table_id": [
            "The table_id field is required."
        ],
        "table_index": [
            "The table_index field is required."
        ],
        "table_type": [
            "The table_type field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/tables

Body Parameters

table_id integer

Validation: required|integer.

table_index integer

Validation: required|integer.

table_type integer

Validation: required|integer.

table_left integer

Validation: required|integer.

table_top integer

Validation: required|integer.

table_width integer

Validation: required|integer.

table_height integer

Validation: required|integer.

table_name string

Validation: required|string|max:254. Must not be greater than 254 characters.

table_shapestyle integer optional

Validation: integer.

table_fillstyle integer optional

Validation: integer.

table_fillcolor integer optional

Validation: integer.

section_id integer

Validation: required|integer.

font_name string optional

Validation: string|max:254. Must not be greater than 254 characters.

font_bold integer optional

Validation: integer.

font_italic integer optional

Validation: integer.

font_size number optional

Validation: numeric.

font_strike_through integer optional

Validation: integer.

font_underline integer optional

Validation: integer.

font_color integer optional

Validation: integer.

is_active integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Table Status

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/table/status" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"TBLNUM\": 16,
    \"STATUS\": 16,
    \"NUMOFCUSTOMERS\": 16,
    \"DESCRIPT\": \"architecto\",
    \"TABLENAME\": \"architecto\",
    \"INFO\": \"architecto\",
    \"ISSPLIT\": 16,
    \"ORDERTYPE\": 16,
    \"ASKEDCHECK\": 16,
    \"TIMEOPENED\": \"2026-08-17T09:09:23\",
    \"TIMECLOSED\": \"2026-08-17T09:09:23\",
    \"MEMCODE\": 16,
    \"CONTACTID\": 16
}"

const url = new URL(
    "http://localhost/api/v2/table/status"
);

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

let body = {
    "TBLNUM": 16,
    "STATUS": 16,
    "NUMOFCUSTOMERS": 16,
    "DESCRIPT": "architecto",
    "TABLENAME": "architecto",
    "INFO": "architecto",
    "ISSPLIT": 16,
    "ORDERTYPE": 16,
    "ASKEDCHECK": 16,
    "TIMEOPENED": "2026-08-17T09:09:23",
    "TIMECLOSED": "2026-08-17T09:09:23",
    "MEMCODE": 16,
    "CONTACTID": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Table saved successfully.",
    "data": {
        "id": 1,
        "TBLNUM": 16,
        "STATUS": 16,
        "NUMOFCUSTOMERS": 16,
        "DESCRIPT": "architecto",
        "TABLENAME": "architecto",
        "INFO": "architecto",
        "ISSPLIT": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "TBLNUM": [
            "The TBLNUM field is required."
        ],
        "STATUS": [
            "The STATUS field is required."
        ],
        "NUMOFCUSTOMERS": [
            "The NUMOFCUSTOMERS field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/table/status

Body Parameters

TBLNUM integer

Validation: required|integer.

STATUS integer

Validation: required|integer.

NUMOFCUSTOMERS integer

Validation: required|integer.

DESCRIPT string

Validation: required|string.

TABLENAME string

Validation: required|string.

INFO string

Validation: required|string.

ISSPLIT integer

Validation: required|integer.

ORDERTYPE integer

Validation: required|integer.

ASKEDCHECK integer

Validation: required|integer.

TIMEOPENED string optional

Validation: sometimes|date. Must be a valid date.

TIMECLOSED string optional

Validation: sometimes|date. Must be a valid date.

MEMCODE integer optional

Validation: sometimes|integer.

CONTACTID integer optional

Validation: sometimes|integer.

Application APIs (V2) — General

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Fetch All Order

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/all/orders/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/all/orders/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "orderid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch All Order Count

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/all/order/count" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/all/order/count"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "all_name": "Example All",
            "is_active": true
        },
        {
            "id": 2,
            "all_name": "Example All",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Charges

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/charges" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/charges"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "charge_name": "Example Charge",
            "is_active": true
        },
        {
            "id": 2,
            "charge_name": "Example Charge",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Charge

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v2/charge/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/charge/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Charge deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Charge Detail

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v2/chargedetail/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/chargedetail/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Chargedetail deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Comboitem

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v2/comboitem/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/comboitem/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Comboitem deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Devices

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/devices" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"deviceIdentifier\": \"bngzmi\",
    \"deviceOS\": \"yvdljn\",
    \"deviceAppId\": 16,
    \"deviceAppVersion\": \"ngzmiy\",
    \"mobile\": \"vdljni\"
}"

const url = new URL(
    "http://localhost/api/v2/devices"
);

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

let body = {
    "deviceIdentifier": "bngzmi",
    "deviceOS": "yvdljn",
    "deviceAppId": 16,
    "deviceAppVersion": "ngzmiy",
    "mobile": "vdljni"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Devices saved successfully.",
    "data": {
        "id": 1,
        "deviceIdentifier": "bngzmi",
        "deviceOS": "yvdljn",
        "deviceAppId": 16,
        "deviceAppVersion": "ngzmiy",
        "mobile": "vdljni"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "deviceIdentifier": [
            "The deviceIdentifier field is required."
        ],
        "deviceOS": [
            "The deviceOS field is required."
        ],
        "deviceAppId": [
            "The deviceAppId field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/devices

Body Parameters

deviceIdentifier string

Validation: required|string|max:50. Must not be greater than 50 characters.

deviceOS string

Validation: required|string|max:20. Must not be greater than 20 characters.

deviceAppId integer

Validation: required|integer.

deviceAppVersion string

Validation: required|string|max:20. Must not be greater than 20 characters.

mobile string

Validation: required|string|max:20. Must not be greater than 20 characters.

Update Device

requires authentication

Example request:

curl --request PUT \
    "http://localhost/api/v2/devices" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"deviceIdentifier\": \"bngzmi\",
    \"mobile\": \"yvdljn\",
    \"validationCode\": \"ikhway\"
}"

const url = new URL(
    "http://localhost/api/v2/devices"
);

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

let body = {
    "deviceIdentifier": "bngzmi",
    "mobile": "yvdljn",
    "validationCode": "ikhway"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Devices updated successfully.",
    "data": {
        "id": 1,
        "deviceIdentifier": "bngzmi",
        "mobile": "yvdljn",
        "validationCode": "ikhway"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "deviceIdentifier": [
            "The deviceIdentifier field is required."
        ],
        "mobile": [
            "The mobile field is required."
        ],
        "validationCode": [
            "The validationCode field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

PUT api/v2/devices

Body Parameters

deviceIdentifier string

Validation: required|string|max:50. Must not be greater than 50 characters.

mobile string

Validation: required|string|max:20. Must not be greater than 20 characters.

validationCode string

Validation: required|string|max:20. Must not be greater than 20 characters.

Fetch Aggregator

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/aggregators/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/aggregators/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "sourceid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Update

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/updates/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/updates/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "updateid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V2) — Geo Addresses

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Fetch Branch

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/branches/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/branches/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "branchid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Branch Cities

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/branch/architecto/cities" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/branch/architecto/cities"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "branchid": "architecto"
        },
        {
            "id": 2,
            "branchid": "architecto"
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Country

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/countries/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/countries/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "countryid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Region

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/regions/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/regions/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "regionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch City

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/cities/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/cities/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "cityid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Branch Setting

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/branch/settings/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/branch/settings/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "settingkey": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V2) — Orders

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Add Orders

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/orders" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"order\": {
        \"orderid\": \"architecto\",
        \"orderdate\": \"architecto\",
        \"ordertime\": \"architecto\",
        \"paymenttype\": \"architecto\",
        \"branchid\": \"architecto\",
        \"ordertype\": \"architecto\",
        \"deliveryCost\": 137449171,
        \"serviceCharge\": 671936806,
        \"ispaid\": 1,
        \"table_id\": 16,
        \"member\": {
            \"posreference\": \"architecto\",
            \"membername\": \"ngzmiyvdljnikhwayk\",
            \"mobile\": \"architecto\",
            \"mobilevalidated\": \"\",
            \"dateofbirth\": \"ngz\",
            \"address\": {
                \"posreference\": \"architecto\",
                \"description\": \"ngzmiyvdljnikhwaykcm\",
                \"addresstype\": \"architecto\",
                \"geolat\": \"architecto\",
                \"geolong\": \"architecto\",
                \"citycode\": \"architecto\",
                \"street\": \"ngzmiyvdljnikhwayk\",
                \"bldg\": \"cmyuwpwlvqwrsitcps\",
                \"floor\": \"\"
            }
        },
        \"items\": [
            {
                \"productcode\": \"cql\",
                \"productqty\": \"dzs\",
                \"productprice\": \"\",
                \"modifiers\": [
                    {
                        \"modifiercode\": \"architecto\",
                        \"modifierqty\": \"architecto\",
                        \"modifierprice\": \"architecto\",
                        \"modifiers_description\": \"architecto\"
                    }
                ]
            }
        ]
    }
}"

const url = new URL(
    "http://localhost/api/v2/orders"
);

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

let body = {
    "order": {
        "orderid": "architecto",
        "orderdate": "architecto",
        "ordertime": "architecto",
        "paymenttype": "architecto",
        "branchid": "architecto",
        "ordertype": "architecto",
        "deliveryCost": 137449171,
        "serviceCharge": 671936806,
        "ispaid": 1,
        "table_id": 16,
        "member": {
            "posreference": "architecto",
            "membername": "ngzmiyvdljnikhwayk",
            "mobile": "architecto",
            "mobilevalidated": "",
            "dateofbirth": "ngz",
            "address": {
                "posreference": "architecto",
                "description": "ngzmiyvdljnikhwaykcm",
                "addresstype": "architecto",
                "geolat": "architecto",
                "geolong": "architecto",
                "citycode": "architecto",
                "street": "ngzmiyvdljnikhwayk",
                "bldg": "cmyuwpwlvqwrsitcps",
                "floor": ""
            }
        },
        "items": [
            {
                "productcode": "cql",
                "productqty": "dzs",
                "productprice": "",
                "modifiers": [
                    {
                        "modifiercode": "architecto",
                        "modifierqty": "architecto",
                        "modifierprice": "architecto",
                        "modifiers_description": "architecto"
                    }
                ]
            }
        ]
    }
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Orders saved successfully.",
    "data": {
        "id": 1,
        "order": []
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "order": [
            "The order field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/orders

Body Parameters

order object optional

order.orderid string

Validation: required.

order.orderdate string

Validation: required.

order.ordertime string

Validation: required.

order.paymenttype string

Validation: required.

order.branchid string

Validation: required.

order.ordertype string

Validation: required.

order.deliveryCost number optional

Validation: numeric|between:0,999999999.99|regex:/^\d{1,9}(\.\d{1,2})?$/. The value format is invalid. Must be between 0 and 999999999.99.

order.serviceCharge number optional

Validation: numeric|between:0,999999999.99|regex:/^\d{1,9}(\.\d{1,2})?$/. The value format is invalid. Must be between 0 and 999999999.99.

order.ispaid integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

order.table_id integer optional

Validation: integer.

order.member object optional

order.member.posreference string

Validation: required.

order.member.membername string

Validation: required|string|max:40. Must not be greater than 40 characters.

order.member.mobile string

Validation: required.

order.member.mobilevalidated string

Validation: required|max:1|min:0. Must not be greater than 1 characters. Must be at least 0 characters.

order.member.dateofbirth string optional

Validation: string|max:11. Must not be greater than 11 characters.

order.member.address object optional

order.member.address.posreference string

Validation: required.

order.member.address.description string

Validation: required|string|max:100. Must not be greater than 100 characters.

order.member.address.addresstype string

Validation: required.

order.member.address.geolat string

Validation: required.

order.member.address.geolong string

Validation: required.

order.member.address.citycode string

Validation: required.

order.member.address.street string

Validation: required|string|max:40. Must not be greater than 40 characters.

order.member.address.bldg string

Validation: required|string|max:40. Must not be greater than 40 characters.

order.member.address.floor string

Validation: required|string|max:4. Must not be greater than 4 characters.

order.items object[] optional

order.items[].productcode string

Validation: required|max:11. Must not be greater than 11 characters.

order.items[].productqty string

Validation: required|max:11. Must not be greater than 11 characters.

order.items[].productprice string

Validation: required|max:14. Must not be greater than 14 characters.

order.items[].modifiers object[] optional

order.items[].modifiers[].modifiercode string

Validation: required.

order.items[].modifiers[].modifierqty string

Validation: required.

order.items[].modifiers[].modifierprice string

Validation: required.

order.items[].modifiers[].modifiers_description string

Validation: required.

Fetch Order Status

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/order/architecto/status" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/order/architecto/status"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "orderid": "architecto"
        },
        {
            "id": 2,
            "orderid": "architecto"
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Update Order Statu

requires authentication

Example request:

curl --request PUT \
    "http://localhost/api/v2/orders/architecto/status?data=%7B%22success%22%3A%22architecto%22%2C%22branchid%22%3A%22architecto%22%2C%22postransact%22%3A%22architecto%22%2C%22status%22%3A%22architecto%22%2C%22posmemberreference%22%3A%22architecto%22%2C%22posaddressreference%22%3A%22architecto%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders/architecto/status"
);

const params = {
    "data": "{"success":"architecto","branchid":"architecto","postransact":"architecto","status":"architecto","posmemberreference":"architecto","posaddressreference":"architecto"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Orders updated successfully.",
    "data": {
        "id": 1,
        "hstransact": "architecto",
        "success": "architecto",
        "branchid": "architecto",
        "postransact": "architecto",
        "status": "architecto",
        "posmemberreference": "architecto",
        "posaddressreference": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Order Count

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/order/count" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/order/count"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "order_name": "Example Order",
            "is_active": true
        },
        {
            "id": 2,
            "order_name": "Example Order",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Order

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/orders/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/orders/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "orderid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V2) — Payments

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Add Currencytypes

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/currencytypes" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"description\": \"ngzmiyvdljnikhwaykcm\",
    \"isactive\": 0
}"

const url = new URL(
    "http://localhost/api/v2/currencytypes"
);

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

let body = {
    "id": 16,
    "description": "ngzmiyvdljnikhwaykcm",
    "isactive": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Currencytypes saved successfully.",
    "data": {
        "id": 16,
        "description": "ngzmiyvdljnikhwaykcm",
        "isactive": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "description": [
            "The description field is required."
        ],
        "isactive": [
            "The isactive field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/currencytypes

Body Parameters

id integer

Validation: required|integer.

description string optional

Validation: string|max:100|nullable. Must not be greater than 100 characters.

isactive integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

Fetch Currency

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/currencies/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/currencies/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "currencyid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Currencies

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/currencies" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"description\": \"ngzmiy\",
    \"long_description\": \"vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmit\",
    \"is_default\": 1,
    \"conversion\": 4326.41688,
    \"conversion2\": 4326.41688,
    \"is_active\": 0,
    \"is_second_currency\": 0,
    \"hide_changes\": 0,
    \"decimals\": 16,
    \"account_code\": \"ngzmiyvdljnikhwaykcmyuwpwlv\",
    \"currency_mask\": \"qwrsitcpscqldzs\",
    \"show_in_pos\": 1,
    \"show_in_calc\": 1,
    \"read_only\": 0,
    \"sequence\": 16,
    \"show_credit_card_form\": 1,
    \"show_check_form\": 0,
    \"show_in_bo\": 1,
    \"goes_to_bank\": 0,
    \"type\": 16,
    \"currency_type\": 16,
    \"is_gift_voucher\": 1,
    \"caption\": \"gzmiyvdljnikhwaykcmyuwpwlvq\"
}"

const url = new URL(
    "http://localhost/api/v2/currencies"
);

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

let body = {
    "id": 16,
    "description": "ngzmiy",
    "long_description": "vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmit",
    "is_default": 1,
    "conversion": 4326.41688,
    "conversion2": 4326.41688,
    "is_active": 0,
    "is_second_currency": 0,
    "hide_changes": 0,
    "decimals": 16,
    "account_code": "ngzmiyvdljnikhwaykcmyuwpwlv",
    "currency_mask": "qwrsitcpscqldzs",
    "show_in_pos": 1,
    "show_in_calc": 1,
    "read_only": 0,
    "sequence": 16,
    "show_credit_card_form": 1,
    "show_check_form": 0,
    "show_in_bo": 1,
    "goes_to_bank": 0,
    "type": 16,
    "currency_type": 16,
    "is_gift_voucher": 1,
    "caption": "gzmiyvdljnikhwaykcmyuwpwlvq"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Currencies saved successfully.",
    "data": {
        "id": 16,
        "description": "ngzmiy",
        "long_description": "vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmit",
        "is_default": 1,
        "conversion": 4326.41688,
        "conversion2": 4326.41688,
        "is_active": 0,
        "is_second_currency": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "description": [
            "The description field is required."
        ],
        "long_description": [
            "The long_description field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/currencies

Body Parameters

id integer

Validation: required|integer.

description string

Validation: required|string|max:50. Must not be greater than 50 characters.

long_description string optional

Validation: string|max:200|nullable. Must not be greater than 200 characters.

charnge1 string optional

Validation: double|nullable.

charnge2 string optional

Validation: double|nullable.

charnge3 string optional

Validation: double|nullable.

charnge4 string optional

Validation: double|nullable.

charnge5 string optional

Validation: double|nullable.

charnge6 string optional

Validation: double|nullable.

charnge7 string optional

Validation: double|nullable.

charnge8 string optional

Validation: double|nullable.

charnge9 string optional

Validation: double|nullable.

charnge10 string optional

Validation: double|nullable.

is_default integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

conversion number optional

Validation: numeric|nullable.

conversion2 number optional

Validation: numeric|nullable.

is_active integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

is_second_currency integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

hide_changes integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

decimals integer optional

Validation: integer|nullable.

account_code string optional

Validation: string|max:30|nullable. Must not be greater than 30 characters.

currency_mask string optional

Validation: string|max:15|nullable. Must not be greater than 15 characters.

show_in_pos integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

show_in_calc integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

read_only integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

sequence integer optional

Validation: integer|nullable.

show_credit_card_form integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

show_check_form integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

show_in_bo integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

goes_to_bank integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

type integer optional

Validation: integer|nullable.

currency_type integer optional

Validation: integer|nullable.

is_gift_voucher integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

caption string optional

Validation: string|max:65,530|nullable. Must not be greater than 65 characters.

Delete Currency

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v2/currencies/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/currencies/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Currencies deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Pricelists

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/pricelists" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"currency_id\": 16,
    \"description\": \"ngzmiyvdljnikhwaykcm\",
    \"is_active\": 0,
    \"is_tax_excluded\": 0
}"

const url = new URL(
    "http://localhost/api/v2/pricelists"
);

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

let body = {
    "id": 16,
    "currency_id": 16,
    "description": "ngzmiyvdljnikhwaykcm",
    "is_active": 0,
    "is_tax_excluded": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Pricelists saved successfully.",
    "data": {
        "id": 16,
        "currency_id": 16,
        "description": "ngzmiyvdljnikhwaykcm",
        "is_active": 0,
        "is_tax_excluded": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "currency_id": [
            "The currency_id field is required."
        ],
        "description": [
            "The description field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/pricelists

Body Parameters

id integer

Validation: required|integer.

currency_id integer

Validation: required|integer.

description string

Validation: required|string|max:100. Must not be greater than 100 characters.

is_active integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

is_tax_excluded integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

Fetch Pricelistdetail

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/pricelistdetails/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/pricelistdetails/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "pricelistdetailid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Pricelistdetails

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/pricelistdetails" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"price_list_id\": 16,
    \"product_number\": 16,
    \"price\": \"architecto\",
    \"is_active\": 1
}"

const url = new URL(
    "http://localhost/api/v2/pricelistdetails"
);

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

let body = {
    "id": 16,
    "price_list_id": 16,
    "product_number": 16,
    "price": "architecto",
    "is_active": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Pricelistdetails saved successfully.",
    "data": {
        "id": 16,
        "price_list_id": 16,
        "product_number": 16,
        "price": "architecto",
        "is_active": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "price_list_id": [
            "The price_list_id field is required."
        ],
        "product_number": [
            "The product_number field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/pricelistdetails

Body Parameters

id integer

Validation: required|integer.

price_list_id integer

Validation: required|integer.

product_number integer

Validation: required|integer.

price string

Validation: required|nullable.

is_active integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

Delete Pricelistdetail

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v2/pricelistdetails/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/pricelistdetails/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Pricelistdetails deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Pricelistbranches

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/pricelistbranches" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": 16,
    \"price_list_id\": 16,
    \"branch_id\": 16,
    \"is_active\": 1
}"

const url = new URL(
    "http://localhost/api/v2/pricelistbranches"
);

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

let body = {
    "id": 16,
    "price_list_id": 16,
    "branch_id": 16,
    "is_active": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Pricelistbranches saved successfully.",
    "data": {
        "id": 16,
        "price_list_id": 16,
        "branch_id": 16,
        "is_active": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "price_list_id": [
            "The price_list_id field is required."
        ],
        "branch_id": [
            "The branch_id field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/pricelistbranches

Body Parameters

id integer

Validation: required|integer.

price_list_id integer

Validation: required|integer.

branch_id integer

Validation: required|integer.

is_active integer

Validation: required|integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Update Table Payment Statu

requires authentication

Example request:

curl --request PUT \
    "http://localhost/api/v2/table/payment/status" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"INVOICEID\": 16,
    \"TABLEID\": 16,
    \"STATUS\": 16
}"

const url = new URL(
    "http://localhost/api/v2/table/payment/status"
);

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

let body = {
    "INVOICEID": 16,
    "TABLEID": 16,
    "STATUS": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Table updated successfully.",
    "data": {
        "id": 1,
        "INVOICEID": 16,
        "TABLEID": 16,
        "STATUS": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "INVOICEID": [
            "The INVOICEID field is required."
        ],
        "TABLEID": [
            "The TABLEID field is required."
        ],
        "STATUS": [
            "The STATUS field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Table Payment

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/table/payments/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/table/payments/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "invoiceid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Table Payment

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/table/payment" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"orderid\": \"architecto\",
    \"tableid\": \"architecto\",
    \"branchid\": \"architecto\",
    \"paymenttype\": \"architecto\",
    \"serviceCharge\": \"architecto\",
    \"totalDiscountAmount\": \"architecto\",
    \"totalPaidAmount\": \"architecto\",
    \"sourceid\": \"architecto\",
    \"items\": \"architecto\",
    \"itemid\": \"architecto\",
    \"productqty\": \"architecto\",
    \"productprice\": \"architecto\",
    \"paidproductprice\": \"architecto\",
    \"totalproductprice\": \"architecto\",
    \"modifiers\": [
        \"architecto\"
    ],
    \"modifiercode\": \"architecto\",
    \"modifierqty\": \"architecto\",
    \"modifierprice\": \"architecto\",
    \"totalmodifierprice\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/v2/table/payment"
);

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

let body = {
    "orderid": "architecto",
    "tableid": "architecto",
    "branchid": "architecto",
    "paymenttype": "architecto",
    "serviceCharge": "architecto",
    "totalDiscountAmount": "architecto",
    "totalPaidAmount": "architecto",
    "sourceid": "architecto",
    "items": "architecto",
    "itemid": "architecto",
    "productqty": "architecto",
    "productprice": "architecto",
    "paidproductprice": "architecto",
    "totalproductprice": "architecto",
    "modifiers": [
        "architecto"
    ],
    "modifiercode": "architecto",
    "modifierqty": "architecto",
    "modifierprice": "architecto",
    "totalmodifierprice": "architecto"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Table saved successfully.",
    "data": {
        "id": 1,
        "orderid": "architecto",
        "tableid": "architecto",
        "branchid": "architecto",
        "paymenttype": "architecto",
        "serviceCharge": "architecto",
        "totalDiscountAmount": "architecto",
        "totalPaidAmount": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "orderid": [
            "The orderid field is required."
        ],
        "tableid": [
            "The tableid field is required."
        ],
        "branchid": [
            "The branchid field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/table/payment

Body Parameters

orderid string

Validation: required.

tableid string

Validation: required.

branchid string

Validation: required.

paymenttype string

Validation: required.

serviceCharge string

Validation: required.

totalDiscountAmount string

Validation: required.

totalPaidAmount string

Validation: required.

sourceid string

Validation: required.

items string

Validation: required.

itemid string

Validation: required.

productqty string

Validation: required.

productprice string

Validation: required.

paidproductprice string

Validation: required.

totalproductprice string

Validation: required.

modifiers string[] optional

Validation: array.

modifiercode string

Validation: required.

modifierqty string

Validation: required.

modifierprice string

Validation: required.

totalmodifierprice string

Validation: required.

Fetch Table Invoice

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/table/architecto/invoice/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/table/architecto/invoice/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "tableid": "architecto",
        "type": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Application APIs (V2) — Products

Read (and selected write) endpoints for mobile/application clients — menus, branches, products, orders, payments.

Fetch Parent

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/parents/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/parents/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "parentid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Category

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/categories/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/categories/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "catid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Product

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/product/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/product/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "productid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Modifier

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/modifiers/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/modifiers/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "modifierid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Combo Header

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v2/combo/header/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/combo/header/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Combo deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Combo Detail

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v2/combo/detail/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/combo/detail/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Combo deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Comboitems

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/comboitems?data=%7B%22prodnum%22%3A%22architecto%22%2C%22catid%22%3A%22architecto%22%2C%22price%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22enabled%22%3A1%2C%22refcode1%22%3A%22architecto%22%2C%22istaxable1%22%3A1%2C%22istaxable2%22%3A0%2C%22istaxable3%22%3A1%2C%22isactive%22%3A0%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/comboitems"
);

const params = {
    "data": "{"prodnum":"architecto","catid":"architecto","price":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","enabled":1,"refcode1":"architecto","istaxable1":1,"istaxable2":0,"istaxable3":1,"isactive":0}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Comboitems saved successfully.",
    "data": {
        "id": 1,
        "prodnum": "architecto",
        "catid": "architecto",
        "price": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "enabled": 1,
        "refcode1": "architecto",
        "istaxable1": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Combo

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/combos/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/combos/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": "architecto",
        "combo_name": "Example Combo",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Comboheader

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/comboheaders/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/comboheaders/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "comboheaderid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Combodetail

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/combodetails/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/combodetails/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "combodetailid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Comboitem

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/comboitems/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/comboitems/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "comboitemid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Product Combo

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/productcombos/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/productcombos/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "productcomboid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Product Picture

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/product/pictures/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/product/pictures/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": "architecto",
        "product_name": "Example Product",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V1) — Deliverect

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/menu/deliverect" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menu/deliverect"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Menu saved successfully.",
    "data": {
        "id": 1,
        "menu_name": "Example Menu",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/menu/deliverect/staging" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menu/deliverect/staging"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "menu_name": "Example Menu",
            "is_active": true
        },
        {
            "id": 2,
            "menu_name": "Example Menu",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Webhook Order Deliverect

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/webhooks/orders/deliverect" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/webhooks/orders/deliverect"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Webhooks saved successfully.",
    "data": {
        "id": 1,
        "webhook_name": "Example Webhook",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Webhook Order Deliverect Stagging

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/webhooks/orders/deliverect/stagging" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/webhooks/orders/deliverect/stagging"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Webhooks saved successfully.",
    "data": {
        "id": 1,
        "webhook_name": "Example Webhook",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V1) — E-menus

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Item Orders

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/item/orders?data=%7B%22order%22%3A%7B%22orderid%22%3A%22architecto%22%2C%22orderdate%22%3A%22architecto%22%2C%22paymenttype%22%3A%22architecto%22%2C%22branchid%22%3A%22architecto%22%2C%22ordertype%22%3A%22architecto%22%2C%22deliveryCost%22%3A137449171%2C%22serviceCharge%22%3A671936806%2C%22ispaid%22%3A1%2C%22table_id%22%3A16%2C%22member%22%3A%7B%22posreference%22%3A%22architecto%22%2C%22membername%22%3A%22ngzmiyvdljnikhwayk%22%2C%22mobile%22%3A%22architecto%22%2C%22mobilevalidated%22%3A%22%22%2C%22dateofbirth%22%3A%22ngz%22%2C%22address%22%3A%7B%22posreference%22%3A%22architecto%22%2C%22description%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22addresstype%22%3A%22architecto%22%2C%22geolat%22%3A%22architecto%22%2C%22geolong%22%3A%22architecto%22%2C%22citycode%22%3A%22architecto%22%2C%22street%22%3A%22ngzmiyvdljnikhwayk%22%2C%22bldg%22%3A%22cmyuwpwlvqwrsitcps%22%2C%22floor%22%3A%22%22%2C%22phone%22%3A%2203000000%22%2C%22cityname%22%3A%22example%22%2C%22directions%22%3A%22example%22%7D%2C%22email%22%3A%22example%40bimpos.com%22%7D%2C%22items%22%3A%5B%7B%22ITEMID%22%3A%22architecto%22%2C%22productcode%22%3A%22architecto%22%2C%22productqty%22%3A%22architecto%22%2C%22productprice%22%3A%22architecto%22%2C%22modifiers%22%3A%5B%7B%22ITEMID%22%3A%22architecto%22%2C%22modifiercode%22%3A%22architecto%22%2C%22modifierqty%22%3A%22architecto%22%2C%22modifierprice%22%3A%22architecto%22%2C%22modifiers_description%22%3A%22architecto%22%7D%5D%7D%5D%2C%22scheduled_order_datetime%22%3A%222026-08-17%22%2C%22sourceid%22%3A1%2C%22deviceid%22%3A1%2C%22status%22%3A%22example%22%2C%22ordertime%22%3A%2212%3A00%3A00%22%2C%22note%22%3A%22example%22%2C%22totalDiscountAmount%22%3A%22example%22%2C%22additional_info%22%3A%7B%22channel_id%22%3A1%2C%22channel_name%22%3A%22example%22%2C%22channel_order_id%22%3A1%2C%22channel_order_display_id%22%3A1%7D%2C%22tableid%22%3A1%2C%22table_reference%22%3A%22example%22%7D%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/item/orders"
);

const params = {
    "data": "{"order":{"orderid":"architecto","orderdate":"architecto","paymenttype":"architecto","branchid":"architecto","ordertype":"architecto","deliveryCost":137449171,"serviceCharge":671936806,"ispaid":1,"table_id":16,"member":{"posreference":"architecto","membername":"ngzmiyvdljnikhwayk","mobile":"architecto","mobilevalidated":"","dateofbirth":"ngz","address":{"posreference":"architecto","description":"ngzmiyvdljnikhwaykcm","addresstype":"architecto","geolat":"architecto","geolong":"architecto","citycode":"architecto","street":"ngzmiyvdljnikhwayk","bldg":"cmyuwpwlvqwrsitcps","floor":"","phone":"03000000","cityname":"example","directions":"example"},"email":"example@bimpos.com"},"items":[{"ITEMID":"architecto","productcode":"architecto","productqty":"architecto","productprice":"architecto","modifiers":[{"ITEMID":"architecto","modifiercode":"architecto","modifierqty":"architecto","modifierprice":"architecto","modifiers_description":"architecto"}]}],"scheduled_order_datetime":"2026-08-17","sourceid":1,"deviceid":1,"status":"example","ordertime":"12:00:00","note":"example","totalDiscountAmount":"example","additional_info":{"channel_id":1,"channel_name":"example","channel_order_id":1,"channel_order_display_id":1},"tableid":1,"table_reference":"example"}}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Item saved successfully.",
    "data": {
        "id": 1,
        "order": {
            "orderid": "architecto",
            "orderdate": "architecto",
            "paymenttype": "architecto",
            "branchid": "architecto",
            "ordertype": "architecto",
            "deliveryCost": 137449171,
            "serviceCharge": 671936806,
            "ispaid": 1,
            "table_id": 16,
            "member": {
                "posreference": "architecto",
                "membername": "ngzmiyvdljnikhwayk",
                "mobile": "architecto",
                "mobilevalidated": "",
                "dateofbirth": "ngz",
                "address": {
                    "posreference": "architecto",
                    "description": "ngzmiyvdljnikhwaykcm",
                    "addresstype": "architecto",
                    "geolat": "architecto",
                    "geolong": "architecto",
                    "citycode": "architecto",
                    "street": "ngzmiyvdljnikhwayk",
                    "bldg": "cmyuwpwlvqwrsitcps",
                    "floor": "",
                    "phone": "03000000",
                    "cityname": "example",
                    "directions": "example"
                },
                "email": "example@bimpos.com"
            },
            "items": [
                {
                    "ITEMID": "architecto",
                    "productcode": "architecto",
                    "productqty": "architecto",
                    "productprice": "architecto",
                    "modifiers": [
                        {
                            "ITEMID": "architecto",
                            "modifiercode": "architecto",
                            "modifierqty": "architecto",
                            "modifierprice": "architecto",
                            "modifiers_description": "architecto"
                        }
                    ]
                }
            ],
            "scheduled_order_datetime": "2026-08-17",
            "sourceid": 1,
            "deviceid": 1,
            "status": "example",
            "ordertime": "12:00:00",
            "note": "example",
            "totalDiscountAmount": "example",
            "additional_info": {
                "channel_id": 1,
                "channel_name": "example",
                "channel_order_id": 1,
                "channel_order_display_id": 1
            },
            "tableid": 1,
            "table_reference": "example"
        }
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V1) — Floors

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Table Seats

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/table/seats" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"TBLNUM\": 16,
    \"SEATNUM\": 16,
    \"SEATDESCRIPT\": \"architecto\",
    \"NUMOFCUSTOMERS\": 16
}"

const url = new URL(
    "http://localhost/api/v1/table/seats"
);

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

let body = {
    "TBLNUM": 16,
    "SEATNUM": 16,
    "SEATDESCRIPT": "architecto",
    "NUMOFCUSTOMERS": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Table saved successfully.",
    "data": {
        "id": 1,
        "TBLNUM": 16,
        "SEATNUM": 16,
        "SEATDESCRIPT": "architecto",
        "NUMOFCUSTOMERS": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "TBLNUM": [
            "The TBLNUM field is required."
        ],
        "SEATNUM": [
            "The SEATNUM field is required."
        ],
        "SEATDESCRIPT": [
            "The SEATDESCRIPT field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/table/seats

Body Parameters

TBLNUM integer

Validation: required|integer.

SEATNUM integer

Validation: required|integer.

SEATDESCRIPT string

Validation: required|string.

NUMOFCUSTOMERS integer

Validation: required|integer.

Add Table Seats

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/table/seats/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"TBLNUM\": 16,
    \"SEATNUM\": 16
}"

const url = new URL(
    "http://localhost/api/v1/table/seats/delete"
);

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

let body = {
    "TBLNUM": 16,
    "SEATNUM": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Table saved successfully.",
    "data": {
        "id": 1,
        "TBLNUM": 16,
        "SEATNUM": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "TBLNUM": [
            "The TBLNUM field is required."
        ],
        "SEATNUM": [
            "The SEATNUM field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Table Status

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/table/status" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"TBLNUM\": 16,
    \"STATUS\": 16,
    \"NUMOFCUSTOMERS\": 16,
    \"DESCRIPT\": \"architecto\",
    \"TABLENAME\": \"architecto\",
    \"INFO\": \"architecto\",
    \"ISSPLIT\": 16,
    \"ORDERTYPE\": 16,
    \"ASKEDCHECK\": 16,
    \"TIMEOPENED\": \"2026-08-17T09:09:19\",
    \"TIMECLOSED\": \"2026-08-17T09:09:19\",
    \"MEMCODE\": 16,
    \"CONTACTID\": 16
}"

const url = new URL(
    "http://localhost/api/v1/table/status"
);

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

let body = {
    "TBLNUM": 16,
    "STATUS": 16,
    "NUMOFCUSTOMERS": 16,
    "DESCRIPT": "architecto",
    "TABLENAME": "architecto",
    "INFO": "architecto",
    "ISSPLIT": 16,
    "ORDERTYPE": 16,
    "ASKEDCHECK": 16,
    "TIMEOPENED": "2026-08-17T09:09:19",
    "TIMECLOSED": "2026-08-17T09:09:19",
    "MEMCODE": 16,
    "CONTACTID": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Table saved successfully.",
    "data": {
        "id": 1,
        "TBLNUM": 16,
        "STATUS": 16,
        "NUMOFCUSTOMERS": 16,
        "DESCRIPT": "architecto",
        "TABLENAME": "architecto",
        "INFO": "architecto",
        "ISSPLIT": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "TBLNUM": [
            "The TBLNUM field is required."
        ],
        "STATUS": [
            "The STATUS field is required."
        ],
        "NUMOFCUSTOMERS": [
            "The NUMOFCUSTOMERS field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/table/status

Body Parameters

TBLNUM integer

Validation: required|integer.

STATUS integer

Validation: required|integer.

NUMOFCUSTOMERS integer

Validation: required|integer.

DESCRIPT string

Validation: required|string.

TABLENAME string

Validation: required|string.

INFO string

Validation: required|string.

ISSPLIT integer

Validation: required|integer.

ORDERTYPE integer

Validation: required|integer.

ASKEDCHECK integer

Validation: required|integer.

TIMEOPENED string optional

Validation: sometimes|date. Must be a valid date.

TIMECLOSED string optional

Validation: sometimes|date. Must be a valid date.

MEMCODE integer optional

Validation: sometimes|integer.

CONTACTID integer optional

Validation: sometimes|integer.

Add Table Status

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/table/status/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"TBLNUM\": 16
}"

const url = new URL(
    "http://localhost/api/v1/table/status/delete"
);

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

let body = {
    "TBLNUM": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Table saved successfully.",
    "data": {
        "id": 1,
        "TBLNUM": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "TBLNUM": [
            "The TBLNUM field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Update Table

requires authentication

Example request:

curl --request PUT \
    "http://localhost/api/v1/tables" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tableid\": 16
}"

const url = new URL(
    "http://localhost/api/v1/tables"
);

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

let body = {
    "tableid": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Tables updated successfully.",
    "data": {
        "id": 1,
        "tableid": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "tableid": [
            "The tableid field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V1) — General

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Charge

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/charges/architecto?data=%7B%22id%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22isactive%22%3A1%2C%22byamount%22%3A0%2C%22bypercent%22%3A1%2C%22openpercent%22%3A1%2C%22openamount%22%3A1%2C%22customschedule%22%3A1%2C%22autoadd%22%3A0%2C%22appliedontaxex%22%3A1%2C%22tax1%22%3A%22example%22%2C%22tax2%22%3A%22example%22%2C%22tax3%22%3A%22example%22%2C%22sdate%22%3A%222026-08-17%22%2C%22edate%22%3A%222026-08-17%22%2C%22setamount%22%3A%22example%22%2C%22typ%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/charges/architecto"
);

const params = {
    "data": "{"id":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","isactive":1,"byamount":0,"bypercent":1,"openpercent":1,"openamount":1,"customschedule":1,"autoadd":0,"appliedontaxex":1,"tax1":"example","tax2":"example","tax3":"example","sdate":"2026-08-17","edate":"2026-08-17","setamount":"example","typ":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Charges saved successfully.",
    "data": {
        "id": "architecto",
        "branchid": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1,
        "byamount": 0,
        "bypercent": 1,
        "openpercent": 1,
        "openamount": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Charge Detail

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/chargedetails/architecto/architecto/architecto?data=%7B%22id%22%3A%22architecto%22%2C%22isactive%22%3A1%2C%22sectionid%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/chargedetails/architecto/architecto/architecto"
);

const params = {
    "data": "{"id":"architecto","isactive":1,"sectionid":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Chargedetails saved successfully.",
    "data": {
        "id": "architecto",
        "chargeid": "architecto",
        "branchid": "architecto",
        "regionid": "architecto",
        "isactive": 1,
        "sectionid": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/chargedetails/{chargeid}/{branchid}/{regionid}

URL Parameters

chargeid string

branchid string

regionid string

Query Parameters

data string

Full request payload as JSON in the data query parameter.

Delete Charge

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/charge/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/charge/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Charge deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Charge Detail

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/chargedetail/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/chargedetail/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Chargedetail deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Ordertypes

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/ordertypes?data=%7B%22id%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22enforcememberselection%22%3A1%2C%22opendrawer%22%3A0%2C%22printmemberdetails%22%3A1%2C%22showindispatcher%22%3A1%2C%22printinred%22%3A1%2C%22autoaddproducts%22%3A1%2C%22printmoreonprinter%22%3A0%2C%22autotaginfo%22%3A1%2C%22remindscheduledbefore%22%3A0%2C%22enableonlineordertracking%22%3A1%2C%22isdelivery%22%3A1%2C%22printtagontickets%22%3A0%2C%22printtagonlabels%22%3A0%2C%22showautoupsell%22%3A1%2C%22printinvoiceongenerateso%22%3A0%2C%22isactive%22%3A0%2C%22groupid%22%3A1%2C%22seq%22%3A%22example%22%2C%22printcopies%22%3A%22example%22%2C%22menucode%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/ordertypes"
);

const params = {
    "data": "{"id":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","enforcememberselection":1,"opendrawer":0,"printmemberdetails":1,"showindispatcher":1,"printinred":1,"autoaddproducts":1,"printmoreonprinter":0,"autotaginfo":1,"remindscheduledbefore":0,"enableonlineordertracking":1,"isdelivery":1,"printtagontickets":0,"printtagonlabels":0,"showautoupsell":1,"printinvoiceongenerateso":0,"isactive":0,"groupid":1,"seq":"example","printcopies":"example","menucode":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertypes saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "enforcememberselection": 1,
        "opendrawer": 0,
        "printmemberdetails": 1,
        "showindispatcher": 1,
        "printinred": 1,
        "autoaddproducts": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Ordertype

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/ordertype/16/architecto?data=%7B%22id%22%3A%22architecto%22%2C%22byamount%22%3A1%2C%22bypercent%22%3A0%2C%22openpercent%22%3A1%2C%22openamount%22%3A0%2C%22autoadd%22%3A0%2C%22isactive%22%3A0%2C%22sdate%22%3A%222026-08-17%22%2C%22edate%22%3A%222026-08-17%22%2C%22setamount%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/ordertype/16/architecto"
);

const params = {
    "data": "{"id":"architecto","byamount":1,"bypercent":0,"openpercent":1,"openamount":0,"autoadd":0,"isactive":0,"sdate":"2026-08-17","edate":"2026-08-17","setamount":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertype saved successfully.",
    "data": {
        "id": "architecto",
        "ordertypeid": 16,
        "chargeid": "architecto",
        "byamount": 1,
        "bypercent": 0,
        "openpercent": 1,
        "openamount": 0,
        "autoadd": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Ordertype

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/ordertype/16/architecto/architecto?data=%7B%22id%22%3A%22architecto%22%2C%22byamount%22%3A1%2C%22bypercent%22%3A0%2C%22openpercent%22%3A1%2C%22openamount%22%3A0%2C%22autoadd%22%3A0%2C%22isactive%22%3A0%2C%22sdate%22%3A%222026-08-17%22%2C%22edate%22%3A%222026-08-17%22%2C%22setamount%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/ordertype/16/architecto/architecto"
);

const params = {
    "data": "{"id":"architecto","byamount":1,"bypercent":0,"openpercent":1,"openamount":0,"autoadd":0,"isactive":0,"sdate":"2026-08-17","edate":"2026-08-17","setamount":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertype saved successfully.",
    "data": {
        "id": "architecto",
        "ordertypeid": 16,
        "chargeid": "architecto",
        "branchid": "architecto",
        "byamount": 1,
        "bypercent": 0,
        "openpercent": 1,
        "openamount": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/ordertype/{ordertypeid}/{chargeid}/{branchid}

URL Parameters

ordertypeid integer

chargeid string

branchid string

Query Parameters

data string

Full request payload as JSON in the data query parameter.

Add Ordertype

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/ordertype/16/architecto/architecto/architecto?data=%7B%22id%22%3A%22architecto%22%2C%22byamount%22%3A1%2C%22bypercent%22%3A0%2C%22openpercent%22%3A1%2C%22openamount%22%3A0%2C%22autoadd%22%3A0%2C%22isactive%22%3A0%2C%22sdate%22%3A%222026-08-17%22%2C%22edate%22%3A%222026-08-17%22%2C%22setamount%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/ordertype/16/architecto/architecto/architecto"
);

const params = {
    "data": "{"id":"architecto","byamount":1,"bypercent":0,"openpercent":1,"openamount":0,"autoadd":0,"isactive":0,"sdate":"2026-08-17","edate":"2026-08-17","setamount":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertype saved successfully.",
    "data": {
        "id": "architecto",
        "ordertypeid": 16,
        "chargeid": "architecto",
        "branchid": "architecto",
        "regionid": "architecto",
        "byamount": 1,
        "bypercent": 0,
        "openpercent": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/ordertype/{ordertypeid}/{chargeid}/{branchid}/{regionid}

URL Parameters

ordertypeid integer

chargeid string

branchid string

regionid string

Query Parameters

data string

Full request payload as JSON in the data query parameter.

Delete Ordertype

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/ordertype/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/ordertype/16"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertype deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Ordertypecharge

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/ordertypecharge/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/ordertypecharge/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertypecharge deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Ordertypechargebranch

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/ordertypechargebranch/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/ordertypechargebranch/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertypechargebranch deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Ordertypechargebranchregion

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/ordertypechargebranchregion/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/ordertypechargebranchregion/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertypechargebranchregion deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Tag

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/tag/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/tag/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Tag deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Product Tag

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/producttag/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/producttag/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Producttag deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Comboitem

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/comboitem/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/comboitem/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Comboitem deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Departments

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/departments?data=%7B%22id%22%3A%22architecto%22%2C%22name%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22email%22%3A%22yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde%22%2C%22mobile%22%3A%22mofrgg%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/departments"
);

const params = {
    "data": "{"id":"architecto","name":"ngzmiyvdljnikhwaykcm","email":"yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde","mobile":"mofrgg","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Departments saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcm",
        "email": "yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde",
        "mobile": "mofrgg",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Department

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/department/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/department/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Department deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Feedback

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/feedbacks/architecto?data=%7B%22id%22%3A%22architecto%22%2C%22mobile%22%3A%22ngzmiy%22%2C%22msg%22%3A%22vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdemofrggdrzcntxpvfaybyznkfbqoezonyqoewjbrzzabxblgvzzddqnfsrkycqdnhzrktyiixxfimbnlcqpsktxrjtqjhqcvcuphijpurfuavpadbixxveywjxjynvkqwvyoxhaakfdlwzlkdidhwnpbeedexnjzbtfsusczxslxsmdqlbmccrxlvbqqaoadotsqfahakzuocywklhwyqpxqtu%22%2C%22type%22%3A16%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/feedbacks/architecto"
);

const params = {
    "data": "{"id":"architecto","mobile":"ngzmiy","msg":"vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdemofrggdrzcntxpvfaybyznkfbqoezonyqoewjbrzzabxblgvzzddqnfsrkycqdnhzrktyiixxfimbnlcqpsktxrjtqjhqcvcuphijpurfuavpadbixxveywjxjynvkqwvyoxhaakfdlwzlkdidhwnpbeedexnjzbtfsusczxslxsmdqlbmccrxlvbqqaoadotsqfahakzuocywklhwyqpxqtu","type":16,"isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Feedbacks saved successfully.",
    "data": {
        "id": "architecto",
        "departmentid": "architecto",
        "mobile": "ngzmiy",
        "msg": "vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdemofrggdrzcntxpvfaybyznkfbqoezonyqoewjbrzzabxblgvzzddqnfsrkycqdnhzrktyiixxfimbnlcqpsktxrjtqjhqcvcuphijpurfuavpadbixxveywjxjynvkqwvyoxhaakfdlwzlkdidhwnpbeedexnjzbtfsusczxslxsmdqlbmccrxlvbqqaoadotsqfahakzuocywklhwyqpxqtu",
        "type": 16,
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Feedback

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/feedback/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/feedback/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Feedback deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Contents

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/contents?data=%7B%22id%22%3A%22architecto%22%2C%22page_title%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22page_url%22%3A%22yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde%22%2C%22isactive%22%3A0%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/contents"
);

const params = {
    "data": "{"id":"architecto","page_title":"ngzmiyvdljnikhwaykcm","page_url":"yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde","isactive":0}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Contents saved successfully.",
    "data": {
        "id": "architecto",
        "page_title": "ngzmiyvdljnikhwaykcm",
        "page_url": "yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde",
        "isactive": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Content

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/content/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/content/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Content deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add App Settings

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/app/settings?data=%7B%22id%22%3A%22architecto%22%2C%22mobilePrefix%22%3A%22ngz%22%2C%22currency%22%3A%22miy%22%2C%22showRemarksOnQuestions%22%3A1%2C%22showRemarksOnAllItems%22%3A1%2C%22androidMaintenanceMode%22%3A1%2C%22androidMinVersion%22%3A%22j%22%2C%22androidCurVersion%22%3A%22n%22%2C%22iosMinVersion%22%3A%22i%22%2C%22iosCurVersion%22%3A%22k%22%2C%22moneyFormat%22%3A%22hwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwq%22%2C%22phoneMask%22%3A%22bewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbk%22%2C%22showBigCategory%22%3A0%2C%22orderMenuCatalogId%22%3A%22architecto%22%2C%22galleryCatalogId%22%3A16%2C%22productCatalogId%22%3A16%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/app/settings"
);

const params = {
    "data": "{"id":"architecto","mobilePrefix":"ngz","currency":"miy","showRemarksOnQuestions":1,"showRemarksOnAllItems":1,"androidMaintenanceMode":1,"androidMinVersion":"j","androidCurVersion":"n","iosMinVersion":"i","iosCurVersion":"k","moneyFormat":"hwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwq","phoneMask":"bewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbk","showBigCategory":0,"orderMenuCatalogId":"architecto","galleryCatalogId":16,"productCatalogId":16,"isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "App saved successfully.",
    "data": {
        "id": "architecto",
        "mobilePrefix": "ngz",
        "currency": "miy",
        "showRemarksOnQuestions": 1,
        "showRemarksOnAllItems": 1,
        "androidMaintenanceMode": 1,
        "androidMinVersion": "j",
        "androidCurVersion": "n"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete App Setting

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/app/setting/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/app/setting/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "App deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Health

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/health" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/health"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "health_name": "Example Health",
            "is_active": true
        },
        {
            "id": 2,
            "health_name": "Example Health",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Updateid

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/updateid" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/updateid"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "updateid_name": "Example Updateid",
            "is_active": true
        },
        {
            "id": 2,
            "updateid_name": "Example Updateid",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Questiongroup Detail

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/questiongroup/details/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questiongroup/details/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "questionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Questiongroup Header

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/questiongroup/headers/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questiongroup/headers/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "questionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Admin Payment Facilities

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/admin/payment/facilities/store" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"DESCRIPT\": \"architecto\",
    \"ISACTIVE\": 1
}"

const url = new URL(
    "http://localhost/api/v1/admin/payment/facilities/store"
);

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

let body = {
    "DESCRIPT": "architecto",
    "ISACTIVE": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Admin saved successfully.",
    "data": {
        "id": 1,
        "DESCRIPT": "architecto",
        "ISACTIVE": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "DESCRIPT": [
            "The DESCRIPT field is required."
        ],
        "ISACTIVE": [
            "The ISACTIVE field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Admin Payment Facilities

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/admin/payment/facilities/show" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/admin/payment/facilities/show"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "admin_name": "Example Admin",
            "is_active": true
        },
        {
            "id": 2,
            "admin_name": "Example Admin",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Update Admin Payment Facility

requires authentication

Example request:

curl --request PUT \
    "http://localhost/api/v1/admin/payment/facilities/update" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ID\": 16,
    \"DESCRIPT\": \"architecto\",
    \"ISACTIVE\": 1
}"

const url = new URL(
    "http://localhost/api/v1/admin/payment/facilities/update"
);

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

let body = {
    "ID": 16,
    "DESCRIPT": "architecto",
    "ISACTIVE": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Admin updated successfully.",
    "data": {
        "id": 1,
        "ID": 16,
        "DESCRIPT": "architecto",
        "ISACTIVE": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "ID": [
            "The ID field is required."
        ],
        "DESCRIPT": [
            "The DESCRIPT field is required."
        ],
        "ISACTIVE": [
            "The ISACTIVE field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Admin Payment Facility

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/admin/payment/facilities/architecto/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/admin/payment/facilities/architecto/delete"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Admin deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add User Order Schedule

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/user/order/schedule/store" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"schedule\": [
        {
            \"day\": \"Friday\",
            \"delivery\": \"architecto\",
            \"takeaway\": \"architecto\"
        }
    ]
}"

const url = new URL(
    "http://localhost/api/v1/user/order/schedule/store"
);

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

let body = {
    "schedule": [
        {
            "day": "Friday",
            "delivery": "architecto",
            "takeaway": "architecto"
        }
    ]
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "User saved successfully.",
    "data": {
        "id": 1,
        "schedule": [
            []
        ]
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "schedule": [
            "The schedule field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/user/order/schedule/store

Body Parameters

schedule object[] optional

schedule[].day string

Validation: required|string|in:Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday. Must be one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday.

schedule[].delivery string

Validation: required.

schedule[].takeaway string

Validation: required.

Add Initiate Direct Payment

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/initiate/direct/payment" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/initiate/direct/payment"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Initiate saved successfully.",
    "data": {
        "id": 1,
        "initiate_name": "Example Initiate",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Webhook Omt Payment Status

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/webhook/omt/payment/status" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"session_id\": \"architecto\",
    \"transaction_id\": \"architecto\",
    \"identifier\": \"architecto\",
    \"amount\": 4326.41688,
    \"currency\": \"architecto\",
    \"payment_type\": \"architecto\",
    \"status\": \"architecto\",
    \"customer_mobile\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/v1/webhook/omt/payment/status"
);

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

let body = {
    "session_id": "architecto",
    "transaction_id": "architecto",
    "identifier": "architecto",
    "amount": 4326.41688,
    "currency": "architecto",
    "payment_type": "architecto",
    "status": "architecto",
    "customer_mobile": "architecto"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Webhook saved successfully.",
    "data": {
        "id": 1,
        "session_id": "architecto",
        "transaction_id": "architecto",
        "identifier": "architecto",
        "amount": 4326.41688,
        "currency": "architecto",
        "payment_type": "architecto",
        "status": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "session_id": [
            "The session_id field is required."
        ],
        "transaction_id": [
            "The transaction_id field is required."
        ],
        "identifier": [
            "The identifier field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/webhook/omt/payment/status

Body Parameters

session_id string

Validation: required|string.

transaction_id string

Validation: required|string.

identifier string

Validation: required|string.

amount number

Validation: required|numeric.

currency string

Validation: required|string.

payment_type string

Validation: required|string.

status string

Validation: required|string.

customer_mobile string

Validation: required|string.

Fetch Webhook Order Shopify

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/webhooks/orders/shopify" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/webhooks/orders/shopify"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Webhook Shopify Customer Data Request

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/webhooks/shopify/customers/data_request" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/webhooks/shopify/customers/data_request"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Request

GET api/v1/webhooks/shopify/customers/data_request

POST api/v1/webhooks/shopify/customers/data_request

PUT api/v1/webhooks/shopify/customers/data_request

PATCH api/v1/webhooks/shopify/customers/data_request

DELETE api/v1/webhooks/shopify/customers/data_request

OPTIONS api/v1/webhooks/shopify/customers/data_request

Fetch Webhook Shopify App Uninstalled

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/webhooks/shopify/app-uninstalled" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/webhooks/shopify/app-uninstalled"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Request

GET api/v1/webhooks/shopify/app-uninstalled

POST api/v1/webhooks/shopify/app-uninstalled

PUT api/v1/webhooks/shopify/app-uninstalled

PATCH api/v1/webhooks/shopify/app-uninstalled

DELETE api/v1/webhooks/shopify/app-uninstalled

OPTIONS api/v1/webhooks/shopify/app-uninstalled

Fetch Webhook Shopify Customer Redact

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/webhooks/shopify/customers/redact" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/webhooks/shopify/customers/redact"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Request

GET api/v1/webhooks/shopify/customers/redact

POST api/v1/webhooks/shopify/customers/redact

PUT api/v1/webhooks/shopify/customers/redact

PATCH api/v1/webhooks/shopify/customers/redact

DELETE api/v1/webhooks/shopify/customers/redact

OPTIONS api/v1/webhooks/shopify/customers/redact

Fetch Webhook Shopify Shop Redact

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/webhooks/shopify/shop/redact" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/webhooks/shopify/shop/redact"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Menuapp Categories

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/menuapp/categories" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menuapp/categories"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        },
        {
            "id": 2,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Menuapp Combo Meals

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/menuapp/combo-meals" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menuapp/combo-meals"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        },
        {
            "id": 2,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Menuapp Modifiers

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/menuapp/modifiers" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menuapp/modifiers"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        },
        {
            "id": 2,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Menuapp Orders

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/menuapp/orders" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menuapp/orders"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Menuapp saved successfully.",
    "data": {
        "id": 1,
        "menuapp_name": "Example Menuapp",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V1) — Geo Addresses

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Branches

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/branches?data=%7B%22id%22%3A%22architecto%22%2C%22name%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22phone%22%3A%22jwvlxj%22%2C%22email%22%3A%22klqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzy%22%2C%22isactive%22%3A1%2C%22openinghours%22%3A%22cttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkre%22%2C%22acceptsdelivery%22%3A1%2C%22acceptstakeaway%22%3A0%2C%22hidden%22%3A1%2C%22longitude%22%3A35.5018%2C%22latitude%22%3A33.8938%2C%22address%22%3A%22example%22%2C%22clientid%22%3A1%2C%22deliveryhours%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/branches"
);

const params = {
    "data": "{"id":"architecto","name":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","phone":"jwvlxj","email":"klqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzy","isactive":1,"openinghours":"cttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkre","acceptsdelivery":1,"acceptstakeaway":0,"hidden":1,"longitude":35.5018,"latitude":33.8938,"address":"example","clientid":1,"deliveryhours":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Branches saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "phone": "jwvlxj",
        "email": "klqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzy",
        "isactive": 1,
        "openinghours": "cttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkre",
        "acceptsdelivery": 1,
        "acceptstakeaway": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Branch Region

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/branchregion/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/branchregion/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Branchregion deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Branch

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/branch/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/branch/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Branch deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Regions

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/regions?data=%7B%22id%22%3A%22architecto%22%2C%22name%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22isactive%22%3A1%2C%22citycode%22%3A1%2C%22countrycode%22%3A1%2C%22zipcode%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/regions"
);

const params = {
    "data": "{"id":"architecto","name":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","isactive":1,"citycode":1,"countrycode":1,"zipcode":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Regions saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1,
        "citycode": 1,
        "countrycode": 1,
        "zipcode": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Region

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/region/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/region/16"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Region deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Branch Region

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/branchesregions/architecto/architecto?data=%7B%22id%22%3A%22architecto%22%2C%22name%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfy%22%2C%22isactive%22%3A0%2C%22deliverycharge%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/branchesregions/architecto/architecto"
);

const params = {
    "data": "{"id":"architecto","name":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfy","isactive":0,"deliverycharge":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Branchesregions saved successfully.",
    "data": {
        "id": "architecto",
        "branchid": "architecto",
        "regionid": "architecto",
        "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfy",
        "isactive": 0,
        "deliverycharge": "example"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Cities

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/cities?data=%7B%22id%22%3A%22architecto%22%2C%22name%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22phonecode%22%3A%22jwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbc%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/cities"
);

const params = {
    "data": "{"id":"architecto","name":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","phonecode":"jwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbc","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Cities saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "phonecode": "jwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbc",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete City

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/city/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/city/16"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "City deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Countries

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/countries?data=%7B%22id%22%3A%22architecto%22%2C%22name%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22isactive%22%3A0%2C%22phonemask%22%3A%22uwpwlv%22%2C%22smscodestart%22%3A%22qwrsitcpscqldzsnrwtu%22%2C%22phonecode%22%3A%2203000000%22%2C%22phonelength%22%3A%2203000000%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/countries"
);

const params = {
    "data": "{"id":"architecto","name":"ngzmiyvdljnikhwaykcm","isactive":0,"phonemask":"uwpwlv","smscodestart":"qwrsitcpscqldzsnrwtu","phonecode":"03000000","phonelength":"03000000"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Countries saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcm",
        "isactive": 0,
        "phonemask": "uwpwlv",
        "smscodestart": "qwrsitcpscqldzsnrwtu",
        "phonecode": "03000000",
        "phonelength": "03000000"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Country

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/country/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/country/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Country deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Branch Settings

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/branch/architecto/settings?data=%7B%22settingkey%22%3A%22bngzmiyvdljnikhwaykc%22%2C%22boolvalue%22%3A0%2C%22numvalue%22%3A16%2C%22doublevalue%22%3A%22425%22%2C%22isactive%22%3A1%2C%22stringvalue%22%3A%22example%22%2C%22id%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/branch/architecto/settings"
);

const params = {
    "data": "{"settingkey":"bngzmiyvdljnikhwaykc","boolvalue":0,"numvalue":16,"doublevalue":"425","isactive":1,"stringvalue":"example","id":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Branch saved successfully.",
    "data": {
        "id": 1,
        "branchid": "architecto",
        "settingkey": "bngzmiyvdljnikhwaykc",
        "boolvalue": 0,
        "numvalue": 16,
        "doublevalue": "425",
        "isactive": 1,
        "stringvalue": "example"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Branch Setting

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/branch/architecto/setting/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/branch/architecto/setting/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Branch deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V1) — Orders

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Item Void

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/items/void" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"posDetailId\": 16
}"

const url = new URL(
    "http://localhost/api/v1/items/void"
);

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

let body = {
    "posDetailId": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Items saved successfully.",
    "data": {
        "id": 1,
        "posDetailId": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "posDetailId": [
            "The posDetailId field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Order Schedule

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/order/schedule/show" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/order/schedule/show"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "order_name": "Example Order",
            "is_active": true
        },
        {
            "id": 2,
            "order_name": "Example Order",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V1) — Payments

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Delete Currencytype

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/currencytypes/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/currencytypes/16"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Currencytypes deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Currency

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/currencies/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/currencies/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Currencies deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Pricelist

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/pricelists/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/pricelists/16"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Pricelists deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Delete Pricelistdetail

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/pricelistdetails/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/pricelistdetails/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Pricelistdetails deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V1) — Products

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Parents

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/parents?data=%7B%22id%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/parents"
);

const params = {
    "data": "{"id":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Parents saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Parent

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/parent/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/parent/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Parent deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Category

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/categories/architecto/architecto?data=%7B%22catid%22%3A%22architecto%22%2C%22isactive%22%3A1%2C%22catname%22%3A%22example%22%2C%22descript%22%3A%22Ajax+Festival%22%2C%22descript2%22%3A%22example%22%2C%22seq%22%3A%22example%22%2C%22hidefromnavigation%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/categories/architecto/architecto"
);

const params = {
    "data": "{"catid":"architecto","isactive":1,"catname":"example","descript":"Ajax Festival","descript2":"example","seq":"example","hidefromnavigation":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Categories saved successfully.",
    "data": {
        "id": 1,
        "menuid": "architecto",
        "parentid": "architecto",
        "catid": "architecto",
        "isactive": 1,
        "catname": "example",
        "descript": "Ajax Festival",
        "descript2": "example"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Category

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/category/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/category/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Category deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Products

requires authentication

Pass product fields as a JSON object in the data query parameter. catid must exist for the authenticated client. Optional fields are persisted when present (prodnum, price, brand, modifiers, etc.).

Example request:

curl --request POST \
    "http://localhost/api/v1/products?data=%7B%22catid%22%3A1%2C%22descript%22%3A%22Ajax+Festival%22%2C%22enabled%22%3A1%2C%22refcode1%22%3A%22architecto%22%2C%22istaxable1%22%3A1%2C%22istaxable2%22%3A0%2C%22istaxable3%22%3A0%2C%22SKUID1%22%3A16%2C%22SKUID2%22%3A16%2C%22isactive%22%3A1%2C%22isproduction%22%3A0%2C%22prodnum%22%3A1003919%2C%22price%22%3A12000%2C%22descript2%22%3A%22example%22%2C%22prodinfo%22%3A%22example%22%2C%22prodinfo2%22%3A%22example%22%2C%22groupid%22%3A1%2C%22stock%22%3A%22example%22%2C%22pid%22%3A1%2C%22brand%22%3A%22example%22%2C%22country_of_origin%22%3A%22example%22%2C%22weight%22%3A%22example%22%2C%22weight_unit%22%3A%22example%22%2C%22refcode2%22%3A%22example%22%2C%22ModifiersGroupID%22%3A1%2C%22ComboGroupID%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/products"
);

const params = {
    "data": "{"catid":1,"descript":"Ajax Festival","enabled":1,"refcode1":"architecto","istaxable1":1,"istaxable2":0,"istaxable3":0,"SKUID1":16,"SKUID2":16,"isactive":1,"isproduction":0,"prodnum":1003919,"price":12000,"descript2":"example","prodinfo":"example","prodinfo2":"example","groupid":1,"stock":"example","pid":1,"brand":"example","country_of_origin":"example","weight":"example","weight_unit":"example","refcode2":"example","ModifiersGroupID":1,"ComboGroupID":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Products saved successfully.",
    "data": {
        "id": 1,
        "catid": 1,
        "descript": "Ajax Festival",
        "enabled": 1,
        "refcode1": "architecto",
        "istaxable1": 1,
        "istaxable2": 0,
        "istaxable3": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Product

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/product/architecto/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/product/architecto/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Product deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Product Pictures

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/products/architecto/pictures" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pictureid\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/v1/products/architecto/pictures"
);

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

let body = {
    "pictureid": "architecto"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Products saved successfully.",
    "data": {
        "id": 1,
        "prodnum": "architecto",
        "pictureid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "pictureid": [
            "The pictureid field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Product Picture

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/products/pictures/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/products/pictures/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Products deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Product Stock

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/product/architecto/architecto/architecto/stock?data=%7B%22stock%22%3A%22architecto%22%2C%22branchid%22%3A%22architecto%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/product/architecto/architecto/architecto/stock"
);

const params = {
    "data": "{"stock":"architecto","branchid":"architecto","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Product saved successfully.",
    "data": {
        "id": 1,
        "prodnum": "architecto",
        "variation1": "architecto",
        "variation2": "architecto",
        "stock": "architecto",
        "branchid": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/product/{prodnum}/{variation1}/{variation2}/stock

URL Parameters

prodnum string optional

variation1 string optional

variation2 string optional

Query Parameters

data string

Full request payload as JSON in the data query parameter.

Add Product Stocks

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/product/architecto/architecto/architecto/stocks?data=%7B%22stock%22%3A%22architecto%22%2C%22branchid%22%3A%22architecto%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/product/architecto/architecto/architecto/stocks"
);

const params = {
    "data": "{"stock":"architecto","branchid":"architecto","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Product saved successfully.",
    "data": {
        "id": 1,
        "prodnum": "architecto",
        "variation1": "architecto",
        "variation2": "architecto",
        "stock": "architecto",
        "branchid": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/product/{prodnum}/{variation1}/{variation2}/stocks

URL Parameters

prodnum string optional

variation1 string optional

variation2 string optional

Query Parameters

data string

Full request payload as JSON in the data query parameter.

Delete Product Stock

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/productstock/16/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/productstock/16/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Productstock deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Menus

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/menus?data=%7B%22menuid%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22isactive%22%3A1%2C%22customurl%22%3A%22example%22%2C%22seq%22%3A%22example%22%2C%22conceptid%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menus"
);

const params = {
    "data": "{"menuid":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","isactive":1,"customurl":"example","seq":"example","conceptid":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Menus saved successfully.",
    "data": {
        "id": 1,
        "menuid": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1,
        "customurl": "example",
        "seq": "example",
        "conceptid": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/menu/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menu/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Menu deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Tags

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/tags?data=%7B%22tagid%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/tags"
);

const params = {
    "data": "{"tagid":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Tags saved successfully.",
    "data": {
        "id": 1,
        "tagid": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Product Tag

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/producttags/architecto/architecto/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/producttags/architecto/architecto/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Producttags saved successfully.",
    "data": {
        "id": "architecto",
        "prodnum": "architecto",
        "tagid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Questiongroups

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/questiongroups?data=%7B%22id%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22isactive%22%3A0%2C%22conceptid%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questiongroups"
);

const params = {
    "data": "{"id":"architecto","descript":"ngzmiyvdljnikhwaykcm","isactive":0,"conceptid":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questiongroups saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcm",
        "isactive": 0,
        "conceptid": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Questiongroup

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/questiongroups/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questiongroups/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questiongroups deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Questiongroup Details

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/questiongroups/details?data=%7B%22uniqueid%22%3A%22architecto%22%2C%22questiongroupid%22%3A%22architecto%22%2C%22headerid%22%3A%22architecto%22%2C%22isactive%22%3A1%2C%22seq%22%3A%22example%22%2C%22conceptid%22%3A1%2C%22id%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questiongroups/details"
);

const params = {
    "data": "{"uniqueid":"architecto","questiongroupid":"architecto","headerid":"architecto","isactive":1,"seq":"example","conceptid":1,"id":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questiongroups saved successfully.",
    "data": {
        "id": 1,
        "uniqueid": "architecto",
        "questiongroupid": "architecto",
        "headerid": "architecto",
        "isactive": 1,
        "seq": "example",
        "conceptid": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Questiongroup Detail

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/questiongroups/details/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questiongroups/details/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questiongroups deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Questionheaders

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/questionheaders?data=%7B%22id%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22isactive%22%3A0%2C%22required%22%3A%22architecto%22%2C%22min%22%3A%22example%22%2C%22max%22%3A%22example%22%2C%22conceptid%22%3A1%2C%22fontsize%22%3A%22example%22%2C%22cols%22%3A%22example%22%2C%22searchable%22%3A%22example%22%2C%22backcolor%22%3A%22example%22%2C%22forecolor%22%3A%22example%22%2C%22enable_same_item_ordering%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questionheaders"
);

const params = {
    "data": "{"id":"architecto","descript":"ngzmiyvdljnikhwaykcm","isactive":0,"required":"architecto","min":"example","max":"example","conceptid":1,"fontsize":"example","cols":"example","searchable":"example","backcolor":"example","forecolor":"example","enable_same_item_ordering":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questionheaders saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcm",
        "isactive": 0,
        "required": "architecto",
        "min": "example",
        "max": "example",
        "conceptid": 1,
        "fontsize": "example"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Questionheader

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/questionheaders/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questionheaders/16"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questionheaders deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Questiondetails

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/questiondetails?data=%7B%22id%22%3A%22architecto%22%2C%22headerid%22%3A16%2C%22prodnum%22%3A16%2C%22sequence_order%22%3A16%2C%22isactive%22%3A1%2C%22weight%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questiondetails"
);

const params = {
    "data": "{"id":"architecto","headerid":16,"prodnum":16,"sequence_order":16,"isactive":1,"weight":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questiondetails saved successfully.",
    "data": {
        "id": "architecto",
        "headerid": 16,
        "prodnum": 16,
        "sequence_order": 16,
        "isactive": 1,
        "weight": "example"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Questiondetail

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/questiondetails/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questiondetails/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questiondetails deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Modifiers

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/modifiers?data=%7B%22prodnum%22%3A%22architecto%22%2C%22catid%22%3A%22architecto%22%2C%22price%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22enabled%22%3A1%2C%22refcode1%22%3A%22architecto%22%2C%22istaxable1%22%3A1%2C%22istaxable2%22%3A0%2C%22istaxable3%22%3A1%2C%22isactive%22%3A0%2C%22descript2%22%3A%22example%22%2C%22prodinfo%22%3A%22example%22%2C%22prodinfo2%22%3A%22example%22%2C%22groupid%22%3A1%2C%22stock%22%3A%22example%22%2C%22pid%22%3A1%2C%22brand%22%3A%22example%22%2C%22refcode2%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/modifiers"
);

const params = {
    "data": "{"prodnum":"architecto","catid":"architecto","price":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","enabled":1,"refcode1":"architecto","istaxable1":1,"istaxable2":0,"istaxable3":1,"isactive":0,"descript2":"example","prodinfo":"example","prodinfo2":"example","groupid":1,"stock":"example","pid":1,"brand":"example","refcode2":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Modifiers saved successfully.",
    "data": {
        "id": 1,
        "prodnum": "architecto",
        "catid": "architecto",
        "price": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "enabled": 1,
        "refcode1": "architecto",
        "istaxable1": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Modifier

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/modifier/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/modifier/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Modifier deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Combo Headers

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/combo/headers?data=%7B%22id%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22isactive%22%3A1%2C%22required%22%3A%22architecto%22%2C%22min%22%3A%22example%22%2C%22max%22%3A%22example%22%2C%22autoselect%22%3A%22example%22%2C%22weight%22%3A%22example%22%2C%22ccols%22%3A%22example%22%2C%22crows%22%3A%22example%22%2C%22conceptid%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/combo/headers"
);

const params = {
    "data": "{"id":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","isactive":1,"required":"architecto","min":"example","max":"example","autoselect":"example","weight":"example","ccols":"example","crows":"example","conceptid":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Combo saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1,
        "required": "architecto",
        "min": "example",
        "max": "example",
        "autoselect": "example",
        "weight": "example"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Combo Header

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/combo/header/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/combo/header/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Combo deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Combo Details

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/combo/details?data=%7B%22id%22%3A%22architecto%22%2C%22comboid%22%3A%22architecto%22%2C%22prodnum%22%3A%22architecto%22%2C%22seq%22%3A%22architecto%22%2C%22price%22%3A%22architecto%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/combo/details"
);

const params = {
    "data": "{"id":"architecto","comboid":"architecto","prodnum":"architecto","seq":"architecto","price":"architecto","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Combo saved successfully.",
    "data": {
        "id": "architecto",
        "comboid": "architecto",
        "prodnum": "architecto",
        "seq": "architecto",
        "price": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Combo Detail

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/combo/detail/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/combo/detail/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Combo deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Product Combos

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/product/combos?data=%7B%22id%22%3A%22architecto%22%2C%22prodnum%22%3A%22architecto%22%2C%22comboid%22%3A%22architecto%22%2C%22seq%22%3A%22architecto%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/product/combos"
);

const params = {
    "data": "{"id":"architecto","prodnum":"architecto","comboid":"architecto","seq":"architecto","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Product saved successfully.",
    "data": {
        "id": "architecto",
        "prodnum": "architecto",
        "comboid": "architecto",
        "seq": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Product Combo

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/product/combo/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/product/combo/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Product deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Comboitems

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/comboitems?data=%7B%22prodnum%22%3A%22architecto%22%2C%22catid%22%3A%22architecto%22%2C%22price%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22enabled%22%3A1%2C%22refcode1%22%3A%22architecto%22%2C%22istaxable1%22%3A1%2C%22istaxable2%22%3A0%2C%22istaxable3%22%3A1%2C%22isactive%22%3A0%2C%22descript2%22%3A%22example%22%2C%22prodinfo%22%3A%22example%22%2C%22prodinfo2%22%3A%22example%22%2C%22groupid%22%3A1%2C%22stock%22%3A%22example%22%2C%22pid%22%3A1%2C%22brand%22%3A%22example%22%2C%22refcode2%22%3A%22example%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/comboitems"
);

const params = {
    "data": "{"prodnum":"architecto","catid":"architecto","price":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","enabled":1,"refcode1":"architecto","istaxable1":1,"istaxable2":0,"istaxable3":1,"isactive":0,"descript2":"example","prodinfo":"example","prodinfo2":"example","groupid":1,"stock":"example","pid":1,"brand":"example","refcode2":"example"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Comboitems saved successfully.",
    "data": {
        "id": 1,
        "prodnum": "architecto",
        "catid": "architecto",
        "price": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "enabled": 1,
        "refcode1": "architecto",
        "istaxable1": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Galleries

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/galleries?data=%7B%22id%22%3A%22architecto%22%2C%22name%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22isactive%22%3A0%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/galleries"
);

const params = {
    "data": "{"id":"architecto","name":"ngzmiyvdljnikhwaykcm","isactive":0}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Galleries saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcm",
        "isactive": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Gallery

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/gallery/16" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/gallery/16"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Gallery deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Gallery Photo

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/gallery/photos/architecto?data=%7B%22id%22%3A%22architecto%22%2C%22title%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22descript%22%3A%22yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnno%22%2C%22refnum%22%3A%22qitpxn%22%2C%22minorderqty%22%3A%22architecto%22%2C%22price%22%3A%22architecto%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/gallery/photos/architecto"
);

const params = {
    "data": "{"id":"architecto","title":"ngzmiyvdljnikhwaykcm","descript":"yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnno","refnum":"qitpxn","minorderqty":"architecto","price":"architecto","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Gallery saved successfully.",
    "data": {
        "id": "architecto",
        "galleryid": "architecto",
        "title": "ngzmiyvdljnikhwaykcm",
        "descript": "yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnno",
        "refnum": "qitpxn",
        "minorderqty": "architecto",
        "price": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Delete Gallery Photo

requires authentication

Example request:

curl --request DELETE \
    "http://localhost/api/v1/gallery/photo/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/gallery/photo/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Gallery deleted successfully."
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Questiondetail

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/questiondetails/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questiondetails/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "questionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Questionheader

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v1/questionheaders/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/questionheaders/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "questionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V1) — SKUs

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Sku Family

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/sku/family" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"SKUID\": 16,
    \"DESCRIPT\": \"n\",
    \"MASK\": \"gzmiy\",
    \"LEVEL\": 16,
    \"ISACTIVE\": false,
    \"UNIT\": 16
}"

const url = new URL(
    "http://localhost/api/v1/sku/family"
);

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

let body = {
    "SKUID": 16,
    "DESCRIPT": "n",
    "MASK": "gzmiy",
    "LEVEL": 16,
    "ISACTIVE": false,
    "UNIT": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Sku saved successfully.",
    "data": {
        "id": 1,
        "SKUID": 16,
        "DESCRIPT": "n",
        "MASK": "gzmiy",
        "LEVEL": 16,
        "ISACTIVE": false,
        "UNIT": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "SKUID": [
            "The SKUID field is required."
        ],
        "DESCRIPT": [
            "The DESCRIPT field is required."
        ],
        "MASK": [
            "The MASK field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/sku/family

Body Parameters

SKUID integer

Validation: required|integer.

DESCRIPT string

Validation: required|string|max:25. Must not be greater than 25 characters.

MASK string optional

Validation: nullable|string|max:10. Must not be greater than 10 characters.

LEVEL integer optional

Validation: nullable|integer.

ISACTIVE boolean

Validation: required|boolean.

UNIT integer optional

Validation: nullable|integer.

Add Sku Details

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/sku/details" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"SKUDETAILSID\": 16,
    \"DESCRIPT\": \"ngzmiy\",
    \"BARCODEADDON\": \"vdljni\",
    \"LEVEL\": 16,
    \"MASK\": \"ngzmi\",
    \"SHORTDESCRIPT\": \"yvdlj\",
    \"RECIPEYIELD\": 4326.41688,
    \"RECIPEUNIT\": 16,
    \"RECIPEUNITCONVERSION\": 4326.41688,
    \"PARENTRECIPEUSAGEQTY\": 4326.41688,
    \"PARENTRECIPEUSAGEUNIT\": 16,
    \"PARENTRECIPEUNITCONVERSION\": 4326.41688,
    \"SKUID\": 16,
    \"ISACTIVE\": false
}"

const url = new URL(
    "http://localhost/api/v1/sku/details"
);

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

let body = {
    "SKUDETAILSID": 16,
    "DESCRIPT": "ngzmiy",
    "BARCODEADDON": "vdljni",
    "LEVEL": 16,
    "MASK": "ngzmi",
    "SHORTDESCRIPT": "yvdlj",
    "RECIPEYIELD": 4326.41688,
    "RECIPEUNIT": 16,
    "RECIPEUNITCONVERSION": 4326.41688,
    "PARENTRECIPEUSAGEQTY": 4326.41688,
    "PARENTRECIPEUSAGEUNIT": 16,
    "PARENTRECIPEUNITCONVERSION": 4326.41688,
    "SKUID": 16,
    "ISACTIVE": false
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Sku saved successfully.",
    "data": {
        "id": 1,
        "SKUDETAILSID": 16,
        "DESCRIPT": "ngzmiy",
        "BARCODEADDON": "vdljni",
        "LEVEL": 16,
        "MASK": "ngzmi",
        "SHORTDESCRIPT": "yvdlj",
        "RECIPEYIELD": 4326.41688
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "SKUDETAILSID": [
            "The SKUDETAILSID field is required."
        ],
        "DESCRIPT": [
            "The DESCRIPT field is required."
        ],
        "BARCODEADDON": [
            "The BARCODEADDON field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v1/sku/details

Body Parameters

SKUDETAILSID integer

Validation: required|integer.

DESCRIPT string

Validation: required|string|max:50. Must not be greater than 50 characters.

BARCODEADDON string optional

Validation: nullable|string|max:20. Must not be greater than 20 characters.

LEVEL integer optional

Validation: nullable|integer.

MASK string optional

Validation: nullable|string|max:10. Must not be greater than 10 characters.

SHORTDESCRIPT string optional

Validation: nullable|string|max:10. Must not be greater than 10 characters.

RECIPEYIELD number optional

Validation: nullable|numeric.

RECIPEUNIT integer optional

Validation: nullable|integer.

RECIPEUNITCONVERSION number optional

Validation: nullable|numeric.

PARENTRECIPEUSAGEQTY number optional

Validation: nullable|numeric.

PARENTRECIPEUSAGEUNIT integer optional

Validation: nullable|integer.

PARENTRECIPEUNITCONVERSION number optional

Validation: nullable|numeric.

SKUID integer

Validation: required|integer.

ISACTIVE boolean

Validation: required|boolean.

Shop APIs (V1) — Shopify

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v1/menu/shopify/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v1/menu/shopify/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Menu saved successfully.",
    "data": {
        "id": 1,
        "type": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V2) — Deliverect

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Webhook Order Deliverect

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/webhooks/orders/deliverect" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/webhooks/orders/deliverect"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Webhooks saved successfully.",
    "data": {
        "id": 1,
        "webhook_name": "Example Webhook",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Webhook Order Deliverect Stagging

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/webhooks/orders/deliverect/stagging" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/webhooks/orders/deliverect/stagging"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Webhooks saved successfully.",
    "data": {
        "id": 1,
        "webhook_name": "Example Webhook",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V2) — General

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Fetch Menuupdate

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/menuupdates/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/menuupdates/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "updateid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Ordertypes

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/ordertypes" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"descript\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu\",
    \"enforcememberselection\": 1,
    \"opendrawer\": 0,
    \"printmemberdetails\": 1,
    \"showindispatcher\": 1,
    \"printinred\": 1,
    \"autoaddproducts\": 1,
    \"printmoreonprinter\": 0,
    \"autotaginfo\": 1,
    \"remindscheduledbefore\": 0,
    \"enableonlineordertracking\": 1,
    \"isdelivery\": 1,
    \"printtagontickets\": 0,
    \"printtagonlabels\": 0,
    \"showautoupsell\": 1,
    \"printinvoiceongenerateso\": 0,
    \"isactive\": 0
}"

const url = new URL(
    "http://localhost/api/v2/ordertypes"
);

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

let body = {
    "id": "architecto",
    "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
    "enforcememberselection": 1,
    "opendrawer": 0,
    "printmemberdetails": 1,
    "showindispatcher": 1,
    "printinred": 1,
    "autoaddproducts": 1,
    "printmoreonprinter": 0,
    "autotaginfo": 1,
    "remindscheduledbefore": 0,
    "enableonlineordertracking": 1,
    "isdelivery": 1,
    "printtagontickets": 0,
    "printtagonlabels": 0,
    "showautoupsell": 1,
    "printinvoiceongenerateso": 0,
    "isactive": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertypes saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "enforcememberselection": 1,
        "opendrawer": 0,
        "printmemberdetails": 1,
        "showindispatcher": 1,
        "printinred": 1,
        "autoaddproducts": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "descript": [
            "The descript field is required."
        ],
        "enforcememberselection": [
            "The enforcememberselection field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/ordertypes

Body Parameters

id string

Validation: required.

descript string optional

Validation: string|max:255. Must not be greater than 255 characters.

enforcememberselection integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

opendrawer integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

printmemberdetails integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

showindispatcher integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

printinred integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

autoaddproducts integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

printmoreonprinter integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

autotaginfo integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

remindscheduledbefore integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

enableonlineordertracking integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

isdelivery integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

printtagontickets integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

printtagonlabels integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

showautoupsell integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

printinvoiceongenerateso integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Ordertypebychargeid

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/ordertypebychargeid" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"byamount\": 1,
    \"bypercent\": 0,
    \"openpercent\": 1,
    \"openamount\": 0,
    \"autoadd\": 0,
    \"isactive\": 0,
    \"ordertypeid\": 16,
    \"chargeid\": 16
}"

const url = new URL(
    "http://localhost/api/v2/ordertypebychargeid"
);

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

let body = {
    "id": "architecto",
    "byamount": 1,
    "bypercent": 0,
    "openpercent": 1,
    "openamount": 0,
    "autoadd": 0,
    "isactive": 0,
    "ordertypeid": 16,
    "chargeid": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertypebychargeid saved successfully.",
    "data": {
        "id": "architecto",
        "byamount": 1,
        "bypercent": 0,
        "openpercent": 1,
        "openamount": 0,
        "autoadd": 0,
        "isactive": 0,
        "ordertypeid": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "byamount": [
            "The byamount field is required."
        ],
        "bypercent": [
            "The bypercent field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/ordertypebychargeid

Body Parameters

id string

Validation: required.

byamount integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

bypercent integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

openpercent integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

openamount integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

autoadd integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

ordertypeid integer

Validation: integer|required.

chargeid integer

Validation: integer|required.

Add Ordertypebybranchid

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/ordertypebybranchid" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"byamount\": 1,
    \"bypercent\": 0,
    \"openpercent\": 1,
    \"openamount\": 0,
    \"autoadd\": 0,
    \"isactive\": 0
}"

const url = new URL(
    "http://localhost/api/v2/ordertypebybranchid"
);

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

let body = {
    "id": "architecto",
    "byamount": 1,
    "bypercent": 0,
    "openpercent": 1,
    "openamount": 0,
    "autoadd": 0,
    "isactive": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertypebybranchid saved successfully.",
    "data": {
        "id": "architecto",
        "byamount": 1,
        "bypercent": 0,
        "openpercent": 1,
        "openamount": 0,
        "autoadd": 0,
        "isactive": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "byamount": [
            "The byamount field is required."
        ],
        "bypercent": [
            "The bypercent field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/ordertypebybranchid

Body Parameters

id string

Validation: required.

byamount integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

bypercent integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

openpercent integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

openamount integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

autoadd integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Ordertypebyregionid

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/ordertypebyregionid" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"byamount\": 1,
    \"bypercent\": 0,
    \"openpercent\": 1,
    \"openamount\": 0,
    \"autoadd\": 0,
    \"isactive\": 0
}"

const url = new URL(
    "http://localhost/api/v2/ordertypebyregionid"
);

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

let body = {
    "id": "architecto",
    "byamount": 1,
    "bypercent": 0,
    "openpercent": 1,
    "openamount": 0,
    "autoadd": 0,
    "isactive": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Ordertypebyregionid saved successfully.",
    "data": {
        "id": "architecto",
        "byamount": 1,
        "bypercent": 0,
        "openpercent": 1,
        "openamount": 0,
        "autoadd": 0,
        "isactive": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "byamount": [
            "The byamount field is required."
        ],
        "bypercent": [
            "The bypercent field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/ordertypebyregionid

Body Parameters

id string

Validation: required.

byamount integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

bypercent integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

openpercent integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

openamount integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

autoadd integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Charges

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/charges?data=%7B%22id%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22isactive%22%3A1%2C%22byamount%22%3A0%2C%22bypercent%22%3A1%2C%22openpercent%22%3A1%2C%22openamount%22%3A1%2C%22customschedule%22%3A1%2C%22autoadd%22%3A0%2C%22appliedontaxex%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/charges"
);

const params = {
    "data": "{"id":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","isactive":1,"byamount":0,"bypercent":1,"openpercent":1,"openamount":1,"customschedule":1,"autoadd":0,"appliedontaxex":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Charges saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1,
        "byamount": 0,
        "bypercent": 1,
        "openpercent": 1,
        "openamount": 1,
        "customschedule": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Chargedetails

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/chargedetails?data=%7B%22id%22%3A%22architecto%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/chargedetails"
);

const params = {
    "data": "{"id":"architecto","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Chargedetails saved successfully.",
    "data": {
        "id": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Departments

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/departments" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"name\": \"ngzmiyvdljnikhwaykcm\",
    \"email\": \"yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde\",
    \"mobile\": \"mofrgg\",
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/departments"
);

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

let body = {
    "id": "architecto",
    "name": "ngzmiyvdljnikhwaykcm",
    "email": "yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde",
    "mobile": "mofrgg",
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Departments saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcm",
        "email": "yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde",
        "mobile": "mofrgg",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "name": [
            "The name field is required."
        ],
        "email": [
            "The email field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/departments

Body Parameters

id string

Validation: required.

name string

Validation: required|string|max:100. Must not be greater than 100 characters.

email string

Validation: required|string|max:200. Must not be greater than 200 characters.

mobile string

Validation: required|string|max:20. Must not be greater than 20 characters.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Feedbacks

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/feedbacks" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"mobile\": \"ngzmiy\",
    \"msg\": \"vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdemofrggdrzcntxpvfaybyznkfbqoezonyqoewjbrzzabxblgvzzddqnfsrkycqdnhzrktyiixxfimbnlcqpsktxrjtqjhqcvcuphijpurfuavpadbixxveywjxjynvkqwvyoxhaakfdlwzlkdidhwnpbeedexnjzbtfsusczxslxsmdqlbmccrxlvbqqaoadotsqfahakzuocywklhwyqpxqtu\",
    \"type\": 16,
    \"isactive\": 1,
    \"departmentid\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/v2/feedbacks"
);

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

let body = {
    "id": "architecto",
    "mobile": "ngzmiy",
    "msg": "vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdemofrggdrzcntxpvfaybyznkfbqoezonyqoewjbrzzabxblgvzzddqnfsrkycqdnhzrktyiixxfimbnlcqpsktxrjtqjhqcvcuphijpurfuavpadbixxveywjxjynvkqwvyoxhaakfdlwzlkdidhwnpbeedexnjzbtfsusczxslxsmdqlbmccrxlvbqqaoadotsqfahakzuocywklhwyqpxqtu",
    "type": 16,
    "isactive": 1,
    "departmentid": "architecto"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Feedbacks saved successfully.",
    "data": {
        "id": "architecto",
        "mobile": "ngzmiy",
        "msg": "vdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxdemofrggdrzcntxpvfaybyznkfbqoezonyqoewjbrzzabxblgvzzddqnfsrkycqdnhzrktyiixxfimbnlcqpsktxrjtqjhqcvcuphijpurfuavpadbixxveywjxjynvkqwvyoxhaakfdlwzlkdidhwnpbeedexnjzbtfsusczxslxsmdqlbmccrxlvbqqaoadotsqfahakzuocywklhwyqpxqtu",
        "type": 16,
        "isactive": 1,
        "departmentid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "mobile": [
            "The mobile field is required."
        ],
        "msg": [
            "The msg field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/feedbacks

Body Parameters

id string

Validation: required.

mobile string

Validation: required|string|max:20. Must not be greater than 20 characters.

msg string

Validation: required|string|max:500. Must not be greater than 500 characters.

type integer

Validation: required|integer.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

departmentid string

Validation: required.

Add Contents

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/contents" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"page_title\": \"ngzmiyvdljnikhwaykcm\",
    \"page_url\": \"yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde\",
    \"isactive\": 0
}"

const url = new URL(
    "http://localhost/api/v2/contents"
);

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

let body = {
    "id": "architecto",
    "page_title": "ngzmiyvdljnikhwaykcm",
    "page_url": "yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde",
    "isactive": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Contents saved successfully.",
    "data": {
        "id": "architecto",
        "page_title": "ngzmiyvdljnikhwaykcm",
        "page_url": "yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfywhzmitnadsmrvbekdxde",
        "isactive": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "page_title": [
            "The page_title field is required."
        ],
        "page_url": [
            "The page_url field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/contents

Body Parameters

id string

Validation: required.

page_title string

Validation: required|string|max:100. Must not be greater than 100 characters.

page_url string

Validation: required|string|max:200. Must not be greater than 200 characters.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add App Settings

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/app/settings" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"mobile_prefix\": \"ngz\",
    \"currency\": \"miy\",
    \"show_remarks_on_questions\": 1,
    \"show_remarks_on_all_items\": 1,
    \"android_maintenance_mode\": 1,
    \"android_min_version\": \"j\",
    \"android_cur_version\": \"n\",
    \"ios_min_version\": \"i\",
    \"ios_cur_version\": \"k\",
    \"money_format\": \"hwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwq\",
    \"phone_mask\": \"bewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbk\",
    \"show_big_category\": 0,
    \"order_menu_catalog_id\": \"architecto\",
    \"gallery_catalog_id\": 16,
    \"product_catalog_id\": 16,
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/app/settings"
);

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

let body = {
    "id": "architecto",
    "mobile_prefix": "ngz",
    "currency": "miy",
    "show_remarks_on_questions": 1,
    "show_remarks_on_all_items": 1,
    "android_maintenance_mode": 1,
    "android_min_version": "j",
    "android_cur_version": "n",
    "ios_min_version": "i",
    "ios_cur_version": "k",
    "money_format": "hwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwq",
    "phone_mask": "bewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbk",
    "show_big_category": 0,
    "order_menu_catalog_id": "architecto",
    "gallery_catalog_id": 16,
    "product_catalog_id": 16,
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "App saved successfully.",
    "data": {
        "id": "architecto",
        "mobile_prefix": "ngz",
        "currency": "miy",
        "show_remarks_on_questions": 1,
        "show_remarks_on_all_items": 1,
        "android_maintenance_mode": 1,
        "android_min_version": "j",
        "android_cur_version": "n"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "mobile_prefix": [
            "The mobile_prefix field is required."
        ],
        "currency": [
            "The currency field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/app/settings

Body Parameters

id string

Validation: required.

mobile_prefix string

Validation: required|string|max:5. Must not be greater than 5 characters.

currency string optional

Validation: string|max:3. Must not be greater than 3 characters.

show_remarks_on_questions integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

show_remarks_on_all_items integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

android_maintenance_mode integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

android_min_version string

Validation: required|string|max:12. Must not be greater than 12 characters.

android_cur_version string

Validation: required|string|max:12. Must not be greater than 12 characters.

ios_min_version string

Validation: required|string|max:12. Must not be greater than 12 characters.

ios_cur_version string

Validation: required|string|max:12. Must not be greater than 12 characters.

money_format string

Validation: required|string|max:255. Must not be greater than 255 characters.

phone_mask string

Validation: required|string|max:255. Must not be greater than 255 characters.

show_big_category integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

order_menu_catalog_id string

Validation: required.

gallery_catalog_id integer optional

Validation: integer.

product_catalog_id integer optional

Validation: integer.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Fetch Health

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/health" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/health"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "health_name": "Example Health",
            "is_active": true
        },
        {
            "id": 2,
            "health_name": "Example Health",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Updateid

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/updateid" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/updateid"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "updateid_name": "Example Updateid",
            "is_active": true
        },
        {
            "id": 2,
            "updateid_name": "Example Updateid",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Questiongroup Detail

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/questiongroup/details/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/questiongroup/details/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "questionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Questiongroup Header

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/questiongroup/headers/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/questiongroup/headers/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "questionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Webhook Order Shopify

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/webhooks/orders/shopify" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/webhooks/orders/shopify"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Webhook Shopify Customer Data Request

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/webhooks/shopify/customers/data_request" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/webhooks/shopify/customers/data_request"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Request

GET api/v2/webhooks/shopify/customers/data_request

POST api/v2/webhooks/shopify/customers/data_request

PUT api/v2/webhooks/shopify/customers/data_request

PATCH api/v2/webhooks/shopify/customers/data_request

DELETE api/v2/webhooks/shopify/customers/data_request

OPTIONS api/v2/webhooks/shopify/customers/data_request

Fetch Webhook Shopify App Uninstalled

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/webhooks/shopify/app-uninstalled" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/webhooks/shopify/app-uninstalled"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Request

GET api/v2/webhooks/shopify/app-uninstalled

POST api/v2/webhooks/shopify/app-uninstalled

PUT api/v2/webhooks/shopify/app-uninstalled

PATCH api/v2/webhooks/shopify/app-uninstalled

DELETE api/v2/webhooks/shopify/app-uninstalled

OPTIONS api/v2/webhooks/shopify/app-uninstalled

Fetch Webhook Shopify Customer Redact

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/webhooks/shopify/customers/redact" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/webhooks/shopify/customers/redact"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Request

GET api/v2/webhooks/shopify/customers/redact

POST api/v2/webhooks/shopify/customers/redact

PUT api/v2/webhooks/shopify/customers/redact

PATCH api/v2/webhooks/shopify/customers/redact

DELETE api/v2/webhooks/shopify/customers/redact

OPTIONS api/v2/webhooks/shopify/customers/redact

Fetch Webhook Shopify Shop Redact

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/webhooks/shopify/shop/redact" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/webhooks/shopify/shop/redact"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "webhook_name": "Example Webhook",
            "is_active": true
        },
        {
            "id": 2,
            "webhook_name": "Example Webhook",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Menuapp Categories

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/menuapp/categories" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/menuapp/categories"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        },
        {
            "id": 2,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Menuapp Combo Meals

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/menuapp/combo-meals" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/menuapp/combo-meals"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        },
        {
            "id": 2,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Menuapp Modifiers

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/menuapp/modifiers" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/menuapp/modifiers"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        },
        {
            "id": 2,
            "menuapp_name": "Example Menuapp",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Add Menuapp Orders

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/menuapp/orders" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/menuapp/orders"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Menuapp saved successfully.",
    "data": {
        "id": 1,
        "menuapp_name": "Example Menuapp",
        "is_active": true
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V2) — Geo Addresses

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Branchesregions

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/branchesregions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfy\",
    \"isactive\": 0,
    \"branchid\": \"architecto\",
    \"regionid\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/v2/branchesregions"
);

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

let body = {
    "id": "architecto",
    "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfy",
    "isactive": 0,
    "branchid": "architecto",
    "regionid": "architecto"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Branchesregions saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzyhcttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkrerexhqziqvndjouolkgssaaypacbpeaybeqdpmkbfy",
        "isactive": 0,
        "branchid": "architecto",
        "regionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "name": [
            "The name field is required."
        ],
        "isactive": [
            "The isactive field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/branchesregions

Body Parameters

id string

Validation: required.

name string optional

Validation: string|max:200. Must not be greater than 200 characters.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

branchid string

Validation: required.

regionid string

Validation: required.

Add Branches

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/branches" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"clientid\": \"architecto\",
    \"name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu\",
    \"phone\": \"jwvlxj\",
    \"email\": \"klqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzy\",
    \"isactive\": 1,
    \"openinghours\": \"cttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkre\",
    \"acceptsdelivery\": 1,
    \"acceptstakeaway\": 0
}"

const url = new URL(
    "http://localhost/api/v2/branches"
);

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

let body = {
    "id": "architecto",
    "clientid": "architecto",
    "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
    "phone": "jwvlxj",
    "email": "klqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzy",
    "isactive": 1,
    "openinghours": "cttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkre",
    "acceptsdelivery": 1,
    "acceptstakeaway": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Branches saved successfully.",
    "data": {
        "id": "architecto",
        "clientid": "architecto",
        "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "phone": "jwvlxj",
        "email": "klqppwqbewtnnoqitpxntltcvipojsausgioglrbchgsrzy",
        "isactive": 1,
        "openinghours": "cttwbkmkftmgosgtvnbobmzezcrcvalexqztppihrtgkkre",
        "acceptsdelivery": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "clientid": [
            "The clientid field is required."
        ],
        "name": [
            "The name field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/branches

Body Parameters

id string

Validation: required.

clientid string

Validation: required.

name string

Validation: required|string|max:255. Must not be greater than 255 characters.

phone string optional

Validation: string|max:50. Must not be greater than 50 characters.

email string optional

Validation: string|email|max:255. Must be a valid email address. Must not be greater than 255 characters.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

openinghours string optional

Validation: string|max:255. Must not be greater than 255 characters.

acceptsdelivery integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

acceptstakeaway integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Countries

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/countries" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"name\": \"ngzmiyvdljnikhwaykcm\",
    \"isactive\": 0,
    \"phonemask\": \"uwpwlv\",
    \"smscodestart\": \"qwrsitcpscqldzsnrwtu\"
}"

const url = new URL(
    "http://localhost/api/v2/countries"
);

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

let body = {
    "id": "architecto",
    "name": "ngzmiyvdljnikhwaykcm",
    "isactive": 0,
    "phonemask": "uwpwlv",
    "smscodestart": "qwrsitcpscqldzsnrwtu"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Countries saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcm",
        "isactive": 0,
        "phonemask": "uwpwlv",
        "smscodestart": "qwrsitcpscqldzsnrwtu"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "name": [
            "The name field is required."
        ],
        "isactive": [
            "The isactive field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/countries

Body Parameters

id string

Validation: required.

name string

Validation: required|string|max:100. Must not be greater than 100 characters.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

phonemask string optional

Validation: string|max:20. Must not be greater than 20 characters.

smscodestart string optional

Validation: string|max:100. Must not be greater than 100 characters.

Add Regions

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/regions" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu\",
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/regions"
);

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

let body = {
    "id": "architecto",
    "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Regions saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "name": [
            "The name field is required."
        ],
        "isactive": [
            "The isactive field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Cities

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/cities" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"name\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu\",
    \"phonecode\": \"jwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbc\",
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/cities"
);

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

let body = {
    "id": "architecto",
    "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
    "phonecode": "jwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbc",
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Cities saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "phonecode": "jwvlxjklqppwqbewtnnoqitpxntltcvipojsausgioglrbc",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "name": [
            "The name field is required."
        ],
        "phonecode": [
            "The phonecode field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/cities

Body Parameters

id string

Validation: required.

name string

Validation: required|string|max:255. Must not be greater than 255 characters.

phonecode string optional

Validation: string|max:255. Must not be greater than 255 characters.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Branch Settings

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/branch/settings" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"settingkey\": \"bngzmiyvdljnikhwaykc\",
    \"boolvalue\": 0,
    \"numvalue\": 16,
    \"doublevalue\": \"425\",
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/branch/settings"
);

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

let body = {
    "settingkey": "bngzmiyvdljnikhwaykc",
    "boolvalue": 0,
    "numvalue": 16,
    "doublevalue": "425",
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Branch saved successfully.",
    "data": {
        "id": 1,
        "settingkey": "bngzmiyvdljnikhwaykc",
        "boolvalue": 0,
        "numvalue": 16,
        "doublevalue": "425",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "settingkey": [
            "The settingkey field is required."
        ],
        "boolvalue": [
            "The boolvalue field is required."
        ],
        "numvalue": [
            "The numvalue field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/branch/settings

Body Parameters

settingkey string

Validation: required|string|max:100. Must not be greater than 100 characters.

boolvalue integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

numvalue integer optional

Validation: integer.

doublevalue string optional

Validation: regex:/^[0-9]+(\.[0-9][0-9]?)?$/. The value format is invalid.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Shop APIs (V2) — Products

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Parents

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/parents" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"descript\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu\",
    \"isactive\": 1,
    \"clientid\": \"wvlxjk\",
    \"versionid\": 16
}"

const url = new URL(
    "http://localhost/api/v2/parents"
);

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

let body = {
    "id": "architecto",
    "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
    "isactive": 1,
    "clientid": "wvlxjk",
    "versionid": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Parents saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1,
        "clientid": "wvlxjk",
        "versionid": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "descript": [
            "The descript field is required."
        ],
        "isactive": [
            "The isactive field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/parents

Body Parameters

id string

Validation: required.

descript string optional

Validation: string|max:255|nullable. Must not be greater than 255 characters.

isactive integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

clientid string optional

Validation: max:6|string. Must not be greater than 6 characters.

versionid integer optional

Validation: integer.

Add Category

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/category" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"catid\": \"architecto\",
    \"catname\": \"architecto\",
    \"descript\": \"architecto\",
    \"hidefromnavigation\": 1,
    \"isactive\": 0,
    \"menuid\": \"architecto\",
    \"parentid\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/v2/category"
);

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

let body = {
    "catid": "architecto",
    "catname": "architecto",
    "descript": "architecto",
    "hidefromnavigation": 1,
    "isactive": 0,
    "menuid": "architecto",
    "parentid": "architecto"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Category saved successfully.",
    "data": {
        "id": 1,
        "catid": "architecto",
        "catname": "architecto",
        "descript": "architecto",
        "hidefromnavigation": 1,
        "isactive": 0,
        "menuid": "architecto",
        "parentid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "catid": [
            "The catid field is required."
        ],
        "catname": [
            "The catname field is required."
        ],
        "descript": [
            "The descript field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/category

Body Parameters

catid string

Validation: required.

catname string

Validation: required.

descript string optional

Validation: string|nullable.

hidefromnavigation integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

isactive integer optional

Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

menuid string

Validation: required.

parentid string

Validation: required.

Add Products

requires authentication

Each element is validated and upserted. Set isactive to 0 to delete.

Example request:

curl --request POST \
    "http://localhost/api/v2/products" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prodnum\": \"1000606\",
    \"catid\": \"10\",
    \"descript\": \"bngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwt\",
    \"enabled\": 1,
    \"refcode1\": \"architecto\",
    \"istaxable1\": 1,
    \"istaxable2\": 0,
    \"istaxable3\": 0,
    \"SKUID1\": 1,
    \"SKUID2\": 3,
    \"isactive\": 1,
    \"isproduction\": 0
}"

const url = new URL(
    "http://localhost/api/v2/products"
);

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

let body = {
    "prodnum": "1000606",
    "catid": "10",
    "descript": "bngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwt",
    "enabled": 1,
    "refcode1": "architecto",
    "istaxable1": 1,
    "istaxable2": 0,
    "istaxable3": 0,
    "SKUID1": 1,
    "SKUID2": 3,
    "isactive": 1,
    "isproduction": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Products saved successfully.",
    "data": {
        "id": 1,
        "prodnum": "1000606",
        "catid": "10",
        "descript": "bngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwt",
        "enabled": 1,
        "refcode1": "architecto",
        "istaxable1": 1,
        "istaxable2": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "prodnum": [
            "The prodnum field is required."
        ],
        "catid": [
            "The catid field is required."
        ],
        "descript": [
            "The descript field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/products

Body Parameters

prodnum string

Product number / ID. Validation: required.

catid string

Category ID (must exist). Validation: required.

descript string optional

Product description (max 255). Validation: string|max:255. Must not be greater than 255 characters.

enabled integer optional

Enable product (0 or 1). Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

refcode1 string optional

Barcode / reference code. Validation: string.

istaxable1 integer optional

Taxable flag 1 (0 or 1). Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

istaxable2 integer optional

Taxable flag 2 (0 or 1). Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

istaxable3 integer optional

Taxable flag 3 (0 or 1). Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

SKUID1 integer optional

First SKU ID. Validation: integer.

SKUID2 integer optional

Second SKU ID. Validation: integer.

isactive integer optional

1 = active, 0 = delete if exists. Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

isproduction integer optional

Production / kitchen flag (0 or 1). Validation: integer|min:0|max:1|nullable. Must be at least 0. Must not be greater than 1.

* object

*.prodnum integer

Product number / ID.

*.catid integer

Category ID (must exist).

*.descript string optional

Product description (max 255).

*.enabled integer optional

Enable product (0 or 1).

*.SKUID1 integer optional

First SKU ID.

*.SKUID2 integer optional

Second SKU ID.

*.isactive integer optional

1 active, 0 delete if exists.

*.isproduction integer optional

Production / kitchen flag (0 or 1).

Add Product Stock

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/product/stock" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"stock\": \"architecto\",
    \"branchid\": \"architecto\",
    \"skuid1\": \"architecto\",
    \"skuid2\": \"architecto\",
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/product/stock"
);

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

let body = {
    "stock": "architecto",
    "branchid": "architecto",
    "skuid1": "architecto",
    "skuid2": "architecto",
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Product saved successfully.",
    "data": {
        "id": 1,
        "stock": "architecto",
        "branchid": "architecto",
        "skuid1": "architecto",
        "skuid2": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "stock": [
            "The stock field is required."
        ],
        "branchid": [
            "The branchid field is required."
        ],
        "skuid1": [
            "The skuid1 field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/product/stock

Body Parameters

stock string

Validation: required.

branchid string

Validation: required.

skuid1 string

Validation: required.

skuid2 string

Validation: required.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Product Stocks

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/product/stocks" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"stock\": \"architecto\",
    \"branchid\": \"architecto\",
    \"skuid1\": \"architecto\",
    \"skuid2\": \"architecto\",
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/product/stocks"
);

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

let body = {
    "stock": "architecto",
    "branchid": "architecto",
    "skuid1": "architecto",
    "skuid2": "architecto",
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Product saved successfully.",
    "data": {
        "id": 1,
        "stock": "architecto",
        "branchid": "architecto",
        "skuid1": "architecto",
        "skuid2": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "stock": [
            "The stock field is required."
        ],
        "branchid": [
            "The branchid field is required."
        ],
        "skuid1": [
            "The skuid1 field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/product/stocks

Body Parameters

stock string

Validation: required.

branchid string

Validation: required.

skuid1 string

Validation: required.

skuid2 string

Validation: required.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Menus

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/menus" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"menuid\": \"architecto\",
    \"descript\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu\",
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/menus"
);

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

let body = {
    "menuid": "architecto",
    "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Menus saved successfully.",
    "data": {
        "id": 1,
        "menuid": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "menuid": [
            "The menuid field is required."
        ],
        "descript": [
            "The descript field is required."
        ],
        "isactive": [
            "The isactive field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/menus

Body Parameters

menuid string

Validation: required.

descript string optional

Validation: string|max:255. Must not be greater than 255 characters.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Tags

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/tags?data=%7B%22tagid%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/tags"
);

const params = {
    "data": "{"tagid":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Tags saved successfully.",
    "data": {
        "id": 1,
        "tagid": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Producttags

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/producttags" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"tagid\": \"architecto\",
    \"prodnum\": \"architecto\",
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/producttags"
);

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

let body = {
    "id": "architecto",
    "tagid": "architecto",
    "prodnum": "architecto",
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Producttags saved successfully.",
    "data": {
        "id": "architecto",
        "tagid": "architecto",
        "prodnum": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "tagid": [
            "The tagid field is required."
        ],
        "prodnum": [
            "The prodnum field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/producttags

Body Parameters

id string

Validation: required.

tagid string

Validation: required.

prodnum string

Validation: required.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Modifiers

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/modifiers" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prodnum\": \"architecto\",
    \"catid\": \"architecto\",
    \"price\": \"architecto\",
    \"descript\": \"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu\",
    \"enabled\": 1,
    \"refcode1\": \"architecto\",
    \"istaxable1\": 1,
    \"istaxable2\": 0,
    \"istaxable3\": 1,
    \"isactive\": 0
}"

const url = new URL(
    "http://localhost/api/v2/modifiers"
);

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

let body = {
    "prodnum": "architecto",
    "catid": "architecto",
    "price": "architecto",
    "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
    "enabled": 1,
    "refcode1": "architecto",
    "istaxable1": 1,
    "istaxable2": 0,
    "istaxable3": 1,
    "isactive": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Modifiers saved successfully.",
    "data": {
        "id": 1,
        "prodnum": "architecto",
        "catid": "architecto",
        "price": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "enabled": 1,
        "refcode1": "architecto",
        "istaxable1": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "prodnum": [
            "The prodnum field is required."
        ],
        "catid": [
            "The catid field is required."
        ],
        "price": [
            "The price field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/modifiers

Body Parameters

prodnum string

Validation: required.

catid string

Validation: required.

price string

Validation: required.

descript string optional

Validation: string|max:255. Must not be greater than 255 characters.

enabled integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

refcode1 string optional

Validation: string.

istaxable1 integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

istaxable2 integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

istaxable3 integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Combo Headers

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/combo/headers?data=%7B%22id%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu%22%2C%22isactive%22%3A1%2C%22required%22%3A%22architecto%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/combo/headers"
);

const params = {
    "data": "{"id":"architecto","descript":"ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu","isactive":1,"required":"architecto"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Combo saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcmyuwpwlvqwrsitcpscqldzsnrwtu",
        "isactive": 1,
        "required": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Combo Details

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/combo/details?data=%7B%22id%22%3A%22architecto%22%2C%22comboid%22%3A%22architecto%22%2C%22prodnum%22%3A%22architecto%22%2C%22seq%22%3A%22architecto%22%2C%22price%22%3A%22architecto%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/combo/details"
);

const params = {
    "data": "{"id":"architecto","comboid":"architecto","prodnum":"architecto","seq":"architecto","price":"architecto","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Combo saved successfully.",
    "data": {
        "id": "architecto",
        "comboid": "architecto",
        "prodnum": "architecto",
        "seq": "architecto",
        "price": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Product Combos

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/product/combos?data=%7B%22id%22%3A%22architecto%22%2C%22prodnum%22%3A%22architecto%22%2C%22comboid%22%3A%22architecto%22%2C%22seq%22%3A%22architecto%22%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/product/combos"
);

const params = {
    "data": "{"id":"architecto","prodnum":"architecto","comboid":"architecto","seq":"architecto","isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Product saved successfully.",
    "data": {
        "id": "architecto",
        "prodnum": "architecto",
        "comboid": "architecto",
        "seq": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Galleries

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/galleries?data=%7B%22id%22%3A%22architecto%22%2C%22name%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22isactive%22%3A0%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/galleries"
);

const params = {
    "data": "{"id":"architecto","name":"ngzmiyvdljnikhwaykcm","isactive":0}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Galleries saved successfully.",
    "data": {
        "id": "architecto",
        "name": "ngzmiyvdljnikhwaykcm",
        "isactive": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Gallery Photos

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/gallery/photos" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"title\": \"ngzmiyvdljnikhwaykcm\",
    \"descript\": \"yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnno\",
    \"refnum\": \"qitpxn\",
    \"minorderqty\": \"architecto\",
    \"price\": \"architecto\",
    \"isactive\": 1,
    \"galleryid\": \"architecto\"
}"

const url = new URL(
    "http://localhost/api/v2/gallery/photos"
);

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

let body = {
    "id": "architecto",
    "title": "ngzmiyvdljnikhwaykcm",
    "descript": "yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnno",
    "refnum": "qitpxn",
    "minorderqty": "architecto",
    "price": "architecto",
    "isactive": 1,
    "galleryid": "architecto"
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Gallery saved successfully.",
    "data": {
        "id": "architecto",
        "title": "ngzmiyvdljnikhwaykcm",
        "descript": "yuwpwlvqwrsitcpscqldzsnrwtujwvlxjklqppwqbewtnno",
        "refnum": "qitpxn",
        "minorderqty": "architecto",
        "price": "architecto",
        "isactive": 1,
        "galleryid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "title": [
            "The title field is required."
        ],
        "descript": [
            "The descript field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/gallery/photos

Body Parameters

id string

Validation: required.

title string

Validation: required|string|max:100. Must not be greater than 100 characters.

descript string

Validation: required|string|max:255. Must not be greater than 255 characters.

refnum string

Validation: required|string|max:50. Must not be greater than 50 characters.

minorderqty string

Validation: required.

price string

Validation: required.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

galleryid string

Validation: required.

Add Questiongroups

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/questiongroups" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"id\": \"architecto\",
    \"descript\": \"ngzmiyvdljnikhwaykcm\",
    \"isactive\": 0
}"

const url = new URL(
    "http://localhost/api/v2/questiongroups"
);

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

let body = {
    "id": "architecto",
    "descript": "ngzmiyvdljnikhwaykcm",
    "isactive": 0
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questiongroups saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcm",
        "isactive": 0
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "id": [
            "The id field is required."
        ],
        "descript": [
            "The descript field is required."
        ],
        "isactive": [
            "The isactive field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/questiongroups

Body Parameters

id string

Validation: required.

descript string optional

Validation: string|max:100. Must not be greater than 100 characters.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Questiongroup Details

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/questiongroups/details" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uniqueid\": \"architecto\",
    \"questiongroupid\": \"architecto\",
    \"headerid\": \"architecto\",
    \"isactive\": 1
}"

const url = new URL(
    "http://localhost/api/v2/questiongroups/details"
);

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

let body = {
    "uniqueid": "architecto",
    "questiongroupid": "architecto",
    "headerid": "architecto",
    "isactive": 1
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questiongroups saved successfully.",
    "data": {
        "id": 1,
        "uniqueid": "architecto",
        "questiongroupid": "architecto",
        "headerid": "architecto",
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "uniqueid": [
            "The uniqueid field is required."
        ],
        "questiongroupid": [
            "The questiongroupid field is required."
        ],
        "headerid": [
            "The headerid field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/questiongroups/details

Body Parameters

uniqueid string

Validation: required.

questiongroupid string

Validation: required.

headerid string

Validation: required.

isactive integer optional

Validation: integer|min:0|max:1. Must be at least 0. Must not be greater than 1.

Add Questionheaders

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/questionheaders?data=%7B%22id%22%3A%22architecto%22%2C%22descript%22%3A%22ngzmiyvdljnikhwaykcm%22%2C%22isactive%22%3A0%2C%22required%22%3A%22architecto%22%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/questionheaders"
);

const params = {
    "data": "{"id":"architecto","descript":"ngzmiyvdljnikhwaykcm","isactive":0,"required":"architecto"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questionheaders saved successfully.",
    "data": {
        "id": "architecto",
        "descript": "ngzmiyvdljnikhwaykcm",
        "isactive": 0,
        "required": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Add Questiondetails

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/questiondetails?data=%7B%22id%22%3A%22architecto%22%2C%22headerid%22%3A16%2C%22prodnum%22%3A16%2C%22sequence_order%22%3A16%2C%22isactive%22%3A1%7D" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/questiondetails"
);

const params = {
    "data": "{"id":"architecto","headerid":16,"prodnum":16,"sequence_order":16,"isactive":1}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Questiondetails saved successfully.",
    "data": {
        "id": "architecto",
        "headerid": 16,
        "prodnum": 16,
        "sequence_order": 16,
        "isactive": 1
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "data": [
            "The data field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Questiondetail

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/questiondetails/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/questiondetails/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "questionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Fetch Questionheader

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/v2/questionheaders/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/v2/questionheaders/architecto"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": {
        "id": 1,
        "questionid": "architecto"
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Shop APIs (V2) — SKUs

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Add Sku Family

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/sku/family" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"SKUID\": 16,
    \"DESCRIPT\": \"n\",
    \"MASK\": \"gzmiy\",
    \"LEVEL\": 16,
    \"ISACTIVE\": false,
    \"UNIT\": 16
}"

const url = new URL(
    "http://localhost/api/v2/sku/family"
);

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

let body = {
    "SKUID": 16,
    "DESCRIPT": "n",
    "MASK": "gzmiy",
    "LEVEL": 16,
    "ISACTIVE": false,
    "UNIT": 16
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Sku saved successfully.",
    "data": {
        "id": 1,
        "SKUID": 16,
        "DESCRIPT": "n",
        "MASK": "gzmiy",
        "LEVEL": 16,
        "ISACTIVE": false,
        "UNIT": 16
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "SKUID": [
            "The SKUID field is required."
        ],
        "DESCRIPT": [
            "The DESCRIPT field is required."
        ],
        "MASK": [
            "The MASK field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/sku/family

Body Parameters

SKUID integer

Validation: required|integer.

DESCRIPT string

Validation: required|string|max:25. Must not be greater than 25 characters.

MASK string optional

Validation: nullable|string|max:10. Must not be greater than 10 characters.

LEVEL integer optional

Validation: nullable|integer.

ISACTIVE boolean

Validation: required|boolean.

UNIT integer optional

Validation: nullable|integer.

Add Sku Details

requires authentication

Example request:

curl --request POST \
    "http://localhost/api/v2/sku/details" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"SKUDETAILSID\": 16,
    \"DESCRIPT\": \"ngzmiy\",
    \"BARCODEADDON\": \"vdljni\",
    \"LEVEL\": 16,
    \"MASK\": \"ngzmi\",
    \"SHORTDESCRIPT\": \"yvdlj\",
    \"RECIPEYIELD\": 4326.41688,
    \"RECIPEUNIT\": 16,
    \"RECIPEUNITCONVERSION\": 4326.41688,
    \"PARENTRECIPEUSAGEQTY\": 4326.41688,
    \"PARENTRECIPEUSAGEUNIT\": 16,
    \"PARENTRECIPEUNITCONVERSION\": 4326.41688,
    \"SKUID\": 16,
    \"ISACTIVE\": false
}"

const url = new URL(
    "http://localhost/api/v2/sku/details"
);

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

let body = {
    "SKUDETAILSID": 16,
    "DESCRIPT": "ngzmiy",
    "BARCODEADDON": "vdljni",
    "LEVEL": 16,
    "MASK": "ngzmi",
    "SHORTDESCRIPT": "yvdlj",
    "RECIPEYIELD": 4326.41688,
    "RECIPEUNIT": 16,
    "RECIPEUNITCONVERSION": 4326.41688,
    "PARENTRECIPEUSAGEQTY": 4326.41688,
    "PARENTRECIPEUSAGEUNIT": 16,
    "PARENTRECIPEUNITCONVERSION": 4326.41688,
    "SKUID": 16,
    "ISACTIVE": false
};

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "Sku saved successfully.",
    "data": {
        "id": 1,
        "SKUDETAILSID": 16,
        "DESCRIPT": "ngzmiy",
        "BARCODEADDON": "vdljni",
        "LEVEL": 16,
        "MASK": "ngzmi",
        "SHORTDESCRIPT": "yvdlj",
        "RECIPEYIELD": 4326.41688
    }
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Example response (Example validation error (generated)):


{
    "message": "The given data was invalid.",
    "errors": {
        "SKUDETAILSID": [
            "The SKUDETAILSID field is required."
        ],
        "DESCRIPT": [
            "The DESCRIPT field is required."
        ],
        "BARCODEADDON": [
            "The BARCODEADDON field is required."
        ]
    },
    "status": "fail"
}

Received response:

Request failed with error:

Request

POST api/v2/sku/details

Body Parameters

SKUDETAILSID integer

Validation: required|integer.

DESCRIPT string

Validation: required|string|max:50. Must not be greater than 50 characters.

BARCODEADDON string optional

Validation: nullable|string|max:20. Must not be greater than 20 characters.

LEVEL integer optional

Validation: nullable|integer.

MASK string optional

Validation: nullable|string|max:10. Must not be greater than 10 characters.

SHORTDESCRIPT string optional

Validation: nullable|string|max:10. Must not be greater than 10 characters.

RECIPEYIELD number optional

Validation: nullable|numeric.

RECIPEUNIT integer optional

Validation: nullable|integer.

RECIPEUNITCONVERSION number optional

Validation: nullable|numeric.

PARENTRECIPEUSAGEQTY number optional

Validation: nullable|numeric.

PARENTRECIPEUSAGEUNIT integer optional

Validation: nullable|integer.

PARENTRECIPEUNITCONVERSION number optional

Validation: nullable|numeric.

SKUID integer

Validation: required|integer.

ISACTIVE boolean

Validation: required|boolean.

Shop APIs — SMS Verification

Store / channel write endpoints for pushing catalog data and integrating external systems (Shopify, Deliverect, etc.).

Fetch Sendsms

requires authentication

Example request:

curl --request GET \
    --get "http://localhost/api/sendsms" \
    --header "Authorization: Bearer {YOUR_AUTH_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

const url = new URL(
    "http://localhost/api/sendsms"
);

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

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

Example response (Example success response (generated)):


{
    "status": "success",
    "message": "",
    "data": [
        {
            "id": 1,
            "item_name": "Example Item",
            "is_active": true
        },
        {
            "id": 2,
            "item_name": "Example Item",
            "is_active": true
        }
    ]
}

Example response (Example unauthorized response (generated)):


{
    "message": "Unauthorized",
    "error": "Unauthorized",
    "status": "fail"
}

Received response:

Request failed with error:

Introduction

POSAPIs

Authenticating requests

App Related APIs

Fetch Current User

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Fetch Plans

Request Try it out ⚡ Cancel 🛑 Send Request 💥

App Related APIs (V1)

Login

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Query Parameters

Logout

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Refresh Token

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Register User

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Body Parameters

Login

Request Try it out ⚡ Cancel 🛑 Send Request 💥

App Related APIs (V2)

Login

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Body Parameters

Login

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Application APIs (V1) — Actions

Add Actions

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Body Parameters

Fetch Actions

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Application APIs (V1) — Floors

Fetch Floor

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Add Floors

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Body Parameters

Fetch Section

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Fetch Floor Section

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Add Sections

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Body Parameters

Fetch Section Tables

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Fetch Floor Tables

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Add Tables

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Body Parameters

Application APIs (V1) — General

Fetch Charges

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Query Parameters

Fetch Update

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Fetch All Order Count

Request Try it out ⚡ Cancel 🛑 Send Request 💥

Fetch All Order

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Fetch Department Feedback

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Fetch Department

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Fetch Content

Request Try it out ⚡ Cancel 🛑 Send Request 💥

URL Parameters

Fetch App Setting

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request

Request