👤 Customers
Fields
| Name | Type | Description |
|---|---|---|
id | string | The unique identifier for the customer (e.g., cus_...). |
full_name | string | The customer's full name. |
phone_number | string | The primary identifier for login, in international format (e.g., +966...). |
email | string | Optional. The customer's email address. |
saved_addresses | array | A list of the customer's saved delivery locations with enhanced address details. See structure below. |
favorite_merchant_ids | array | A list of ids for the Merchants the customer has favorited. |
favorite_item_ids | array | A list of ids for the global Items the customer has liked (captures core preference). |
is_active | boolean | When false, the customer should not be able to log in, place orders, or search. |
updated_at | string | The timestamp of the last modification (ISO 8601 UTC). |
Structure of saved_addresses Object
| Name | Type | Description |
|---|---|---|
tag | string | User-defined label for the address (e.g., "Home", "Office"). |
house_number | string | House/building number (e.g., "123", "45A"). |
building_name | string | Optional. Name of the building (e.g., "Al-Fahad Tower"). |
street | string | Street name without house number (e.g., "Olaya Street"). |
area | string | Optional. Area/neighborhood name (e.g., "Olaya"). |
city | string | City name. |
postal_code | string | Optional. Postal/ZIP code. |
country | string | Country code (ISO 3166-1 alpha-2). |
location | object | Precise geographic coordinates (latitude, longitude). |
Sample JSON
{
"id": "cus_a1b2c3d4",
"full_name": "Fatima Al-Fahad",
"phone_number": "+966551234567",
"email": "fatima.alfahad@example.com",
"saved_addresses": [
{
"tag": "Home",
"house_number": "123",
"building_name": "Al-Fahad Tower",
"street": "Olaya Street",
"area": "Olaya",
"city": "Riyadh",
"postal_code": "12345",
"country": "SA",
"location": { "latitude": 24.7136, "longitude": 46.6753 }
},
{
"tag": "Office",
"house_number": "456",
"building_name": "King Abdullah Financial District",
"street": "KAFD",
"area": "KAFD",
"city": "Riyadh",
"postal_code": "13519",
"country": "SA",
"location": { "latitude": 24.7625, "longitude": 46.6418 }
}
],
"favorite_merchant_ids": [
"mer_riyadh_burger_house",
"mer_tamimi_riyadh"
],
"favorite_item_ids": [
"item_rbh_classic_burger",
"item_almarai_milk_1l"
],
"is_active": true,
"updated_at": "2025-10-16T10:30:00Z"
}