System

1 API call in this section.

Health Check

Express Shipping / Configuration / System

GET/express-shipping/?language=en

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. Authentication: None required (optional Bearer token for tenant-specific info) Query Parameters: - language (string, optional): Preferred language for response messages 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.

Most OnDi APIs require an authenticated session or service token. Public endpoints are marked by their path and module context.

Request

curl

1curl --request GET "$ONDI_BASE_URL/express-shipping/?language=en" \2  --header "Authorization: Bearer $ONDI_ACCESS_TOKEN"

Query parameters

languageOptional

query string

en

Preferred language for response messages (en, ar, ku)

Responses

Success Response - Authenticated200OK

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}

Success Response - No Authentication200OK

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  "tenant_id": "not-authenticated",7  "endpoints": [8    "POST /express-shipping/customer/register - Register customer with comprehensive address",9    "POST /express-shipping/customer/verify-otp - Verify OTP sent to phone",10    "POST /express-shipping/customer/resend-otp - Resend OTP to phone",11    "GET /express-shipping/customer/{customer_id} - Get customer details",12    "POST /express-shipping/order/extract - Extract data from invoice document",13    "POST /express-shipping/order/confirm - Confirm and create order after review",14    "GET /express-shipping/order/track/{tracking_number} - Track package by tracking number",15    "GET /express-shipping/order/list?customer_id=xxx - List customer packages",16    "GET /express-shipping/config - Get tenant express shipping configuration",17    "PUT /express-shipping/config - Update tenant express shipping configuration",18    "GET /express-shipping/services - List available express shipping services"19  ]20}

Success Response (200 OK)200

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": "authenticated_tenant_id",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}