API Control Center

Unified dashboard for all current Khadma backend endpoints. Use credentials and route variables once, then execute any endpoint card directly.

Environment

Use HTTP or HTTPS exactly as your API host is running.

Quick Login

Token Store

Suggested mode maps automatically: admin/provider/customer/driver/none.

Route and Query Variables

Endpoint Catalog

Showing 89 endpoints in All.
GET

Live

Health | Auth: no | Token: none
http://api:8080/health/live
Open URL

Liveness probe

GET

Ready

Health | Auth: no | Token: none
http://api:8080/health/ready
Open URL

Readiness probe with DB check

POST

Register

Auth | Auth: no | Token: none
http://api:8080/api/auth/register

Create account after OTP verification

POST

Login

Auth | Auth: no | Token: none
http://api:8080/api/auth/login

Get access + refresh tokens

POST

Request OTP

Auth | Auth: no | Token: none
http://api:8080/api/auth/request-otp

Request OTP

POST

Verify OTP

Auth | Auth: no | Token: none
http://api:8080/api/auth/verify-otp

Verify OTP

POST

Refresh Token

Auth | Auth: no | Token: none
http://api:8080/api/auth/refresh-token

Rotate refresh token

GET

Get Me

Profile | Auth: yes | Token: active
http://api:8080/api/profile/me
Open URL

Get current user profile

PUT

Update Me

Profile | Auth: yes | Token: active
http://api:8080/api/profile/me

Update full name and optional password

GET

Stores by location

Catalog | Auth: no | Token: none
http://api:8080/api/catalog/stores?latitude=30.20&longitude=31.30&serviceKey=pharmacy
Open URL

Public catalog stores by geo point for selected service

GET

Store by id

Catalog | Auth: no | Token: none
http://api:8080/api/catalog/stores/?latitude=30.20&longitude=31.30
Open URL

Public store details by id and location

GET

Services

Catalog | Auth: no | Token: none
http://api:8080/api/catalog/services
Open URL

Service types (expected: pharmacy, grocery, food)

GET

Search

Catalog | Auth: no | Token: none
http://api:8080/api/catalog/search?query=milk&latitude=30.20&longitude=31.30&serviceKey=grocery&area=nasr%20city&category=coffee&store=bean&vendor=roastery
Open URL

Catalog search by optional text, location, service, area, category, store, and vendor filters

GET

Home feed

Catalog | Auth: no | Token: none
http://api:8080/api/home?latitude=30.20&longitude=31.30
Open URL

Localized home feed with services + sections

GET

Products by store

Catalog | Auth: no | Token: none
http://api:8080/api/catalog/products?storeId=
Open URL

Public products list for one store

GET

Get Cart

Cart | Auth: yes | Token: customer
http://api:8080/api/cart/get
Open URL

Get current user cart

POST

Add Item

Cart | Auth: yes | Token: customer
http://api:8080/api/cart/add-item

Add variant to cart

POST

Update Item

Cart | Auth: yes | Token: customer
http://api:8080/api/cart/update-item

Update quantity

POST

Remove Item

Cart | Auth: yes | Token: customer
http://api:8080/api/cart/remove-item

Remove line

GET

Checkout Preview

Orders | Auth: yes | Token: customer
http://api:8080/api/orders/checkout-preview?promotionCode=&rewardPointsToRedeem=0
Open URL

Preview totals and reservation with optional promotion/rewards

POST

Place Order

Orders | Auth: yes | Token: customer
http://api:8080/api/orders/place

Place order from active reservation

GET

Get Order

Orders | Auth: yes | Token: customer
http://api:8080/api/orders/
Open URL

Get order details

GET

Status History

Orders | Auth: yes | Token: customer
http://api:8080/api/orders//status-history
Open URL

Order status timeline

POST

Cancel Order

Orders | Auth: yes | Token: customer
http://api:8080/api/orders//cancel

Cancel order within allowed window

GET

List My Orders

Orders | Auth: yes | Token: customer
http://api:8080/api/orders?page=1&pageSize=20
Open URL

Paginated customer orders

GET

List Payment Methods For Store

Payments | Auth: no | Token: none
http://api:8080/api/payments/methods?includeInactive=false&storeId=
Open URL

Checkout-visible payment methods for selected store

POST

Initiate Payment

Payments | Auth: yes | Token: customer
http://api:8080/api/payments/initiate

Initiate online payment for order

GET

Get Payment Status

Payments | Auth: yes | Token: customer
http://api:8080/api/orders//pay-status
Open URL

Read current payment status for order

GET

Get Refund Status

Payments | Auth: yes | Token: customer
http://api:8080/api/orders//refund-status
Open URL

Read refund status for order

POST

Payment Webhook Example

Payments | Auth: no | Token: none
http://api:8080/api/payments/webhook

Sandbox webhook payload for local testing

POST

Validate Promotion

Promotions | Auth: yes | Token: customer
http://api:8080/api/promotions/validate

Validate promotion code against reservation/cart

GET

Wallet

Rewards | Auth: yes | Token: customer
http://api:8080/api/rewards/wallet
Open URL

Get current reward wallet balance

POST

Redeem Preview

Rewards | Auth: yes | Token: customer
http://api:8080/api/rewards/redeem-preview

Preview reward redemption impact

POST

Upload

Media | Auth: yes | Token: active
http://api:8080/api/media/upload

Multipart upload using local file path

GET

My Stores

Vendor Read | Auth: yes | Token: provider
http://api:8080/api/vendors/me/stores
Open URL

Provider stores

GET

My Products

Vendor Read | Auth: yes | Token: provider
http://api:8080/api/vendors/me/products
Open URL

Provider products tree

POST

Create Store

Vendor Stores | Auth: yes | Token: provider
http://api:8080/api/vendors/me/stores

Create store

PUT

Update Store

Vendor Stores | Auth: yes | Token: provider
http://api:8080/api/vendors/me/stores/

Update store

DELETE

Delete Store

Vendor Stores | Auth: yes | Token: provider
http://api:8080/api/vendors/me/stores/

Soft delete store

POST

Create Category

Vendor Categories | Auth: yes | Token: provider
http://api:8080/api/vendors/me/categories

Create category

PUT

Update Category

Vendor Categories | Auth: yes | Token: provider
http://api:8080/api/vendors/me/categories/

Update category

DELETE

Delete Category

Vendor Categories | Auth: yes | Token: provider
http://api:8080/api/vendors/me/categories/

Soft delete category

POST

Create Product

Vendor Products | Auth: yes | Token: provider
http://api:8080/api/vendors/me/products

Create product

PUT

Update Product

Vendor Products | Auth: yes | Token: provider
http://api:8080/api/vendors/me/products/

Update product

DELETE

Delete Product

Vendor Products | Auth: yes | Token: provider
http://api:8080/api/vendors/me/products/

Soft delete product

POST

Create Variant

Vendor Variants | Auth: yes | Token: provider
http://api:8080/api/vendors/me/variants

Create variant

PUT

Update Variant

Vendor Variants | Auth: yes | Token: provider
http://api:8080/api/vendors/me/variants/

Update variant

DELETE

Delete Variant

Vendor Variants | Auth: yes | Token: provider
http://api:8080/api/vendors/me/variants/

Soft delete variant

POST

Create Option Group

Vendor Option Groups | Auth: yes | Token: provider
http://api:8080/api/vendors/me/option-groups

Create option group

PUT

Update Option Group

Vendor Option Groups | Auth: yes | Token: provider
http://api:8080/api/vendors/me/option-groups/

Update option group

DELETE

Delete Option Group

Vendor Option Groups | Auth: yes | Token: provider
http://api:8080/api/vendors/me/option-groups/

Soft delete group

POST

Create Option

Vendor Options | Auth: yes | Token: provider
http://api:8080/api/vendors/me/options

Create option

PUT

Update Option

Vendor Options | Auth: yes | Token: provider
http://api:8080/api/vendors/me/options/

Update option

DELETE

Delete Option

Vendor Options | Auth: yes | Token: provider
http://api:8080/api/vendors/me/options/

Soft delete option

GET

List Users

Admin Users | Auth: yes | Token: admin
http://api:8080/api/admin/users?page=1&pageSize=20
Open URL

Paginated users list

GET

List Customers

Admin Customers | Auth: yes | Token: admin
http://api:8080/api/admin/customers?page=1&pageSize=20
Open URL

Paginated customers list

GET

Get Customer

Admin Customers | Auth: yes | Token: admin
http://api:8080/api/admin/customers/
Open URL

Get one customer

POST

Create Customer

Admin Customers | Auth: yes | Token: admin
http://api:8080/api/admin/customers

Create customer

PUT

Update Customer

Admin Customers | Auth: yes | Token: admin
http://api:8080/api/admin/customers/

Update customer

DELETE

Delete Customer

Admin Customers | Auth: yes | Token: admin
http://api:8080/api/admin/customers/

Deactivate customer

GET

List Vendors

Admin Vendors | Auth: yes | Token: admin
http://api:8080/api/admin/vendors
Open URL

List vendors

GET

Get Vendor

Admin Vendors | Auth: yes | Token: admin
http://api:8080/api/admin/vendors/
Open URL

Get vendor

POST

Create Vendor

Admin Vendors | Auth: yes | Token: admin
http://api:8080/api/admin/vendors

Create vendor

PUT

Update Vendor

Admin Vendors | Auth: yes | Token: admin
http://api:8080/api/admin/vendors/

Update vendor

DELETE

Delete Vendor

Admin Vendors | Auth: yes | Token: admin
http://api:8080/api/admin/vendors/

Deactivate vendor

GET

Get Feature Flags

Admin System | Auth: yes | Token: admin
http://api:8080/api/admin/feature-flags
Open URL

List feature flags

POST

Upsert Feature Flag

Admin System | Auth: yes | Token: admin
http://api:8080/api/admin/feature-flags

Create or update flag

GET

Get Configs

Admin System | Auth: yes | Token: admin
http://api:8080/api/admin/configs
Open URL

List config entries

POST

Upsert Config

Admin System | Auth: yes | Token: admin
http://api:8080/api/admin/configs

Create or update config

GET

List Payment Methods

Admin Payments | Auth: yes | Token: admin
http://api:8080/api/admin/payment-methods?includeInactive=true
Open URL

List platform payment methods

POST

Create Payment Method

Admin Payments | Auth: yes | Token: admin
http://api:8080/api/admin/payment-methods

Create payment method

PUT

Update Payment Method

Admin Payments | Auth: yes | Token: admin
http://api:8080/api/admin/payment-methods/

Update payment method

PUT

Set Payment Method Default

Admin Payments | Auth: yes | Token: admin
http://api:8080/api/admin/payment-methods//set-default

Set platform default payment method

GET

List Vendor Payment Methods

Admin Payments | Auth: yes | Token: admin
http://api:8080/api/admin/vendors//payment-methods?includeInactive=true
Open URL

List effective vendor payment methods

PUT

Upsert Vendor Payment Method

Admin Payments | Auth: yes | Token: admin
http://api:8080/api/admin/vendors//payment-methods/

Create/update vendor payment override

PUT

Set Vendor Payment Default

Admin Payments | Auth: yes | Token: admin
http://api:8080/api/admin/vendors//payment-methods//set-default

Set vendor default payment method

DELETE

Remove Vendor Payment Method

Admin Payments | Auth: yes | Token: admin
http://api:8080/api/admin/vendors//payment-methods/

Remove vendor payment override

GET

List Promotions

Admin Promotions | Auth: yes | Token: admin
http://api:8080/api/admin/promotions?includeInactive=true
Open URL

List all promotions

POST

Create Promotion

Admin Promotions | Auth: yes | Token: admin
http://api:8080/api/admin/promotions

Create promotion

PUT

Update Promotion

Admin Promotions | Auth: yes | Token: admin
http://api:8080/api/admin/promotions/

Update promotion

DELETE

Deactivate Promotion

Admin Promotions | Auth: yes | Token: admin
http://api:8080/api/admin/promotions/

Deactivate promotion

GET

Driver Status

Delivery | Auth: yes | Token: driver
http://api:8080/api/drivers/me/status
Open URL

Driver runtime status and active assignment metadata

GET

Active Assignment

Delivery | Auth: yes | Token: driver
http://api:8080/api/drivers/me/active-assignment
Open URL

Get driver's current active/offered assignment

POST

Accept Assignment

Delivery | Auth: yes | Token: driver
http://api:8080/api/drivers/me/assignments//accept

Accept offered assignment

POST

Reject Assignment

Delivery | Auth: yes | Token: driver
http://api:8080/api/drivers/me/assignments//reject

Reject offered assignment

POST

Pickup Assignment

Delivery | Auth: yes | Token: driver
http://api:8080/api/drivers/me/assignments//pickup

Mark assignment as picked up

POST

Deliver Assignment

Delivery | Auth: yes | Token: driver
http://api:8080/api/drivers/me/assignments//deliver

Mark assignment as delivered

POST

Update Driver Location

Delivery | Auth: yes | Token: driver
http://api:8080/api/drivers/me/location

Publish latest driver coordinates

GET

My Notifications

Notifications | Auth: yes | Token: active
http://api:8080/api/notifications/me?page=1&pageSize=20
Open URL

Actor-scoped notifications feed

An unhandled error has occurred. Reload ✖