Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Check coverage and save a customer’s address
POST /external-partner/customers/is-location-covered
| Header | Value |
|---|---|
API-KEY | Your partner API key |
Idempotency-Key | Unique UUID |
multipart/form-data
| Field | Type | Required | Constraints |
|---|---|---|---|
lat | float | ✅ | Between -90 and 90 |
long | float | ✅ | Between -180 and 180 |
{
"success": true,
"data": {
"is_covered": true
},
"status_code": 200
}
is_covered is false, stop the flow and show an out-of-coverage message.
POST /external-partner/customers/address
| Header | Value |
|---|---|
Authorization | Bearer {customer_token} |
Idempotency-Key | Unique UUID |
multipart/form-data
| Field | Type | Required | Notes |
|---|---|---|---|
lat | float | ✅ | |
long | float | ✅ | |
street_area | string | ✅ | Max 255 chars |
apartment_number | string | ❌ | |
building_number | string | ❌ | |
home_type | string | ❌ | Max 255 chars |
notes | string | ❌ | Delivery notes, max 500 chars |
delivery | string | ❌ | call_when_arrive or pick_up_deliver |
{
"success": true,
"data": {
"id": 2069,
"lat": 24.83138,
"long": 46.68362,
"street_area": "King Fahd District",
"apartment_number": null,
"building_number": null,
"home_type": null,
"notes": null,
"delivery": null,
"is_served": true
},
"status_code": 200
}