System Modules

3 API calls in this section.

List System Modules

System Configuration / System Modules

GET/system-modules

Retrieve a list of system modules. Requires super admin access.

Query parameters

Parameter	Type	Description
languageOptional	string	Language code for response localization (Optional, default: en) Language code for localized response messages (e.g., 'en') Language code for response localization (Optional, default: en) Language code for localized response messages (e.g., 'en') Example: en

Headers

Parameter	Type	Description
AuthorizationRequired	string	Bearer token for authentication (required) Bearer token for authentication (required) Example: Bearer {{access_token}}
X-API-Key	string	Alternative authentication method using API key Alternative authentication method using API key

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/system-modules?language=en" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "X-API-Key: "

Response examples

200 · Success Response401 · Error - Unauthorized500 · Error - Internal Server Error

200OK

Response body

json

1{2  "success": true,3  "message": "System modules retrieved successfully",4  "modules": [5    {6      "id": "1",7      "name": "User Management",8      "description": "User management module for creating and managing users",9      "version": "1.0.0",10      "is_active": true,11      "is_enabled": true,12      "created_at": "2023-01-01T00:00:00Z",13      "updated_at": "2023-01-01T00:00:00Z"14    },15    {16      "id": "2",17      "name": "Role Management",18      "description": "Role management module for creating and managing roles",19      "version": "1.0.0",20      "is_active": true,21      "is_enabled": true,22      "created_at": "2023-01-01T00:00:00Z",23      "updated_at": "2023-01-01T00:00:00Z"24    }25  ]26}

Get System Module

System Configuration / System Modules

GET/system-modules/:moduleCode

Retrieve details of a specific system module by its module code. Includes full configuration including settings schema, default settings, features, dependencies, and UI config.

Path parameters

Parameter	Type	Description
moduleCodeRequired	string	Code of the module to retrieve (e.g., delivery, warehouse, storefront) Code of the system module to retrieve (e.g., 'storefront', 'delivery', 'warehouse') Code of the module to retrieve (e.g., delivery, warehouse, storefront) Code of the system module to retrieve (e.g., 'storefront', 'delivery', 'warehouse') Example: storefront

Query parameters

Parameter	Type	Description
languageOptional	string	Language code for response localization (Optional, default: en) Language code for localized response messages (e.g., 'en') Language code for response localization (Optional, default: en) Language code for localized response messages (e.g., 'en') Example: en

Headers

Parameter	Type	Description
AuthorizationRequired	string	Bearer token for authentication (required) Bearer token for authentication (required) Example: Bearer {{access_token}}
X-API-Key	string	Alternative authentication method using API key Alternative authentication method using API key

Staging

Request

curl

1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/system-modules/${MODULECODE}?language=en" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "X-API-Key: "

Response examples

200Success (200 OK)

Response body

json

1{2  "success": true,3  "message": "Module retrieved successfully",4  "module": {5    "id": "uuid",6    "module_code": "storefront",7    "name": "Store front",8    "description": "E-commerce storefront module",9    "version": "1.0.0",10    "dependencies": [11      "warehouse"12    ],13    "features": [14      "product_catalog",15      "shopping_cart"16    ],17    "is_active": true,18    "is_enabled": true,19    "settings_schema": {},20    "default_settings": {},21    "icon": "https://...",22    "ui_config": {},23    "name_multilingual": {24      "en": "Store front",25      "ar": "واجهة المتجر"26    },27    "description_multilingual": {28      "en": "E-commerce...",29      "ar": "..."30    }31  },32  "payment_methods": []33}

Update System Module

System Configuration / System Modules

PUT/system-modules/:moduleCode

Update a system module. Requires super admin access. Supports updating module properties including name, description, version, active status, and enabled status.

Path parameters

Parameter	Type	Description
moduleCodeRequired	string	Code of the module to update (e.g., delivery, warehouse, storefront) Code of the system module to update (e.g., 'delivery', 'warehouse', 'storefront') Code of the module to update (e.g., delivery, warehouse, storefront) Code of the system module to update (e.g., 'delivery', 'warehouse', 'storefront') Example: storefront

Query parameters

Parameter	Type	Description
languageOptional	string	Language code for response localization (Optional, default: en) Language code for localized response messages (e.g., 'en') Language code for response localization (Optional, default: en) Language code for localized response messages (e.g., 'en') Example: en

Headers

Parameter	Type	Description
AuthorizationRequired	string	Bearer token for authentication (required) Bearer token for authentication (required) Example: Bearer {{access_token}}
Content-TypeRequired	string	application/json (required) application/json (required) Example: application/json
X-API-Key	string	Alternative authentication method using API key Alternative authentication method using API key

Body parameters

Parameter	Type	Description
name	object	—
name.en	string	—
name.ar	string	—
description	object	—
description.en	string	—
description.ar	string	—
version	string	—
features	array<string>	—
dependencies	array<string>	—
default_settings	object	—
default_settings.setting1	string	—
default_settings.setting2	boolean	—

Show 5 more body fields

Additional body parameters

Parameter	Type	Description
ui_config	object	—
ui_config.dashboard_widgets	array<string>	—
ui_config.menu_position	number	—
is_active	boolean	—
is_enabled	boolean	—

Staging

Request

curl

1curl --globoff --request PUT "https://staging-api.ondi.io/functions/v1/system-modules/${MODULECODE}?language=en" \2  --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3  --header "Content-Type: application/json" \4  --header "X-API-Key: " \5  --data-raw '{6  "name": {7    "en": "Updated Module Name",8    "ar": "اسم الوحدة المحدث"9  },10  "description": {11    "en": "Updated description",12    "ar": "الوصف المحدث"13  },14  "version": "1.0.1",15  "features": [16    "new_feature",17    "existing_feature"18  ],19  "dependencies": [20    "other_module"21  ],22  "default_settings": {23    "setting1": "value1",24    "setting2": true25  },26  "ui_config": {27    "dashboard_widgets": [28      "widget1",29      "widget2"30    ],31    "menu_position": 132  },33  "is_active": true,34  "is_enabled": true35}'

Other request examples (1)

Request example 1

json

1{2  "name": "Updated Module Name",3  "description": "Updated description",4  "version": "1.0.1",5  "is_active": true,6  "is_enabled": true7}

Response examples

200 · Success Response401 · Error - Unauthorized404 · Error - Module Not Found500 · Error - Internal Server Error

200OK

Response body

json

1{2  "success": true,3  "message": "System module updated successfully",4  "module": {5    "id": "1",6    "name": "Updated Module Name",7    "description": "Updated description",8    "version": "1.0.1",9    "is_active": true,10    "is_enabled": true,11    "created_at": "2023-01-01T00:00:00Z",12    "updated_at": "2023-06-15T12:30:45Z"13  }14}