Skip to main content

System

1 API call in this section.

System health and information endpoints

Health Check​

Express Shipping / Configuration / System
GET/express-shipping/

API: Health Check

Endpoint

GET /express-shipping/ or GET /express-shipping/health

Purpose

Check API health status and get list of available endpoints. No authentication required.

None required (optional Bearer token for tenant-specific info)

Business Logic

  1. Return current service status and timestamp

  2. Include authentication status if credentials provided

  3. List all available API endpoints with descriptions

  4. Include service version and build information

Response (No Authentication)

Note

This endpoint has no error responses - it always returns 200 OK with service status.

Query parameters

ParameterTypeDescription
languageOptionalstring

Preferred language for response messages (en, ar, ku) (string, optional): Preferred language for response messages

Example: en

Staging
Request
curl
1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/express-shipping/?language=en"

Response examples

200OK
Response body
json
1{2  "success": true,3  "message": "Express Shipping API is running",4  "timestamp": "2024-01-27T15:30:00Z",5  "version": "1.0.0",6  "build": "2024.01.27.001",7  "tenant_id": "tenant_12345",8  "endpoints": [9    "POST /express-shipping/customer/register - Register customer with comprehensive address",10    "POST /express-shipping/customer/verify-otp - Verify OTP sent to phone",11    "POST /express-shipping/customer/resend-otp - Resend OTP to phone",12    "GET /express-shipping/customer/{customer_id} - Get customer details",13    "POST /express-shipping/order/extract - Extract data from invoice document",14    "POST /express-shipping/order/confirm - Confirm and create order after review",15    "GET /express-shipping/order/track/{tracking_number} - Track package by tracking number",16    "GET /express-shipping/order/list?customer_id=xxx - List customer packages",17    "GET /express-shipping/config - Get tenant express shipping configuration",18    "PUT /express-shipping/config - Update tenant express shipping configuration",19    "GET /express-shipping/services - List available express shipping services"20  ],21  "service_status": {22    "database": "connected",23    "ai_service": "available",24    "sms_service": "available",25    "email_service": "available",26    "storage": "available"27  }28}