Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
- Start Here 🚀
- Overview to Zid Apps
- Authorization
- Responses
- Webhooks
- Rate Limiting
- APIs
- Orders
- Abandoned Carts
- Products
- Inventories
- Shipping
- Marketing
- Gift Cards
- Coupons
- Bundle Offers
- Loyalty Program
- Calculate Loyalty Points for Order
- Retrieve Store Loyalty Status
- Activate Loyalty Program
- Retrieve Loyalty Program Status
- Set Points Expiration Rules
- Update Cashback Rule
- Update Cashback Rule Status
- Create Points Redemption Method
- Update Points Redemption Method
- Delete Points Redemption Method
- Update Redemption Method Status
- Retrieve Customer Loyalty Summary
- List Loyalty Data
- List Customer Points History
- Retrieve Manager Loyalty Info Page
- Update Loyalty Info Page
- Adjust Customer Points
- Customers
- Store Settings
- Countries and Cities
- Webhook
- Orders
- Store Events
Retrieve Customer
GET
https://api.zid.sa/v1/managers/store/customers/{customer_id}
🔑Scopes
customers.read - Customers ReadRequest
Path Params
Header Params
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.zid.sa/v1/managers/store/customers/37' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en'Responses
🟢200OK
application/json
Body
Examples
{
"status": "object",
"customer": {
"id": 1111,
"name": "John Doe",
"email": "john.doe@example.com",
"mobile": "966500000005",
"gender": "male",
"birth_date": null,
"verified": true,
"is_active": true,
"is_cod_enabled": true,
"type": "individual",
"business_name": null,
"tax_number": null,
"commercial_registration": null,
"source": null,
"points": {
"id": "01e0db29-919b-46bb-bf6f-607868ca2866",
"external_id": "11111111",
"store_id": "f0f70668-6275-4b07-ad8d-7a8dba6d4707",
"customer_id": 1111,
"loyalty_provider": "gameball",
"points": 0,
"pending_points": 0,
"total_positive_points": 0,
"total_negative_points": 0,
"created_at": "2025-05-05T14:47:36.000000Z",
"updated_at": "2026-01-08T12:22:47.000000Z",
"deleted_at": null,
"pending_negative_points": 0,
"status": 7
},
"order_total_payments": "1295.82000000000000",
"last_order_date": null,
"created_at": "2022-05-24T20:50:42.000000Z",
"updated_at": "2025-09-01T19:23:45.000000Z",
"city": {
"id": 71,
"national_id": 18,
"name": "Jeddah",
"priority": 9,
"country_id": 184,
"country_name": "Saudi Arabia",
"country_code": "SA",
"ar_name": "جدة",
"en_name": "Jeddah"
},
"nickname": "John Doe",
"pivotEmail": "john.doe@example.com",
"pivotMobile": "966500000005",
"order_counts": 2,
"total_payments": 1091.8,
"orders_cost_average": 545.9,
"orders": [
{
"id": 20568781,
"invoice_number": 20568781,
"code": "FO6rFdEZ2f",
"store_id": 3,
"order_url": "https://osama.zid.store/o/FO6rFdEZ2f/inv",
"store_name": "Osama Store123",
"shipping_method_code": "custom",
"store_url": "https://osama.zid.store/",
"order_status": {
"name": "New",
"code": "new"
},
"display_status": {
"id": 1,
"code": "new",
"color": "#3498db",
"name": "New"
},
"currency_code": "SAR",
"customer": {
"id": 5835,
"name": "Tes",
"email": "a.alkallas@zid.sa",
"mobile": "966500000005",
"note": "",
"verified": 1,
"type": "individual"
},
"has_different_consignee": 0,
"is_guest_customer": 0,
"is_gift_order": 0,
"gift_card_details": null,
"is_quick_checkout_order": false,
"order_total": "631.12000000000000",
"order_total_string": "631.12 SAR",
"has_different_transaction_currency": false,
"transaction_reference": null,
"transaction_amount": 631.12,
"transaction_amount_string": "631.12 SAR",
"issue_date": "08-03-2023 | 04:39 م",
"payment_status": "paid",
"is_potential_fraud": false,
"source": "Store",
"source_code": "catalog",
"is_reseller_transaction": false,
"created_at": "2023-03-08 13:39:39",
"updated_at": "2023-03-08 13:39:46",
"is_on_demand": false,
"import_id": null,
"tags": [],
"requires_shipping": true,
"should_merchant_set_shipping_method": false,
"shipping": {
"method": {
"id": null,
"name": "ABCD",
"code": "custom",
"estimated_delivery_time": null,
"icon": "https://media.zid.store/static/delivery.png",
"is_system_option": false,
"waybill": null,
"had_errors_while_fetching_waybill": false,
"waybill_tracking_id": null,
"has_waybill_and_packing_list": false,
"tracking": {
"number": null,
"status": null,
"url": null
},
"courier": null,
"return_shipment": null,
"packages_count": null
},
"address": {
"formatted_address": null,
"street": "Bb",
"district": "Aa",
"lat": null,
"lng": null,
"short_address": null,
"meta": {
"buyer": {
"name": "Tes",
"type": "individual",
"email": "a.alkallas@zid.sa",
"telephone": "966500000005"
}
},
"city": {
"id": 1,
"name": "Riyadh"
},
"country": {
"id": 184,
"name": "Saudi Arabia"
}
}
},
"payment": {
"method": {
"name": "E-payment/Mazeed",
"code": "prepaid_mazeed",
"type": "prepaid"
}
},
"cod_confirmed": false,
"reverse_order_label_request": null,
"reverse_order_label_requests": []
},
{
"id": 37524024,
"invoice_number": 37524024,
"code": "H8xA2V7HsX",
"store_id": 3,
"order_url": "https://osama.zid.store/o/H8xA2V7HsX/inv",
"store_name": "rhurg",
"shipping_method_code": "zid_zidship.level_4",
"store_url": "https://osama.zid.store/",
"order_status": {
"name": "Ready",
"code": "ready"
},
"display_status": {
"id": 17,
"code": "ready",
"color": "#2ecc71",
"name": "Ready"
},
"currency_code": "SAR",
"customer": {
"id": 5835,
"name": "albaat",
"email": "manal.ali1413@gmail.com",
"mobile": "966550427396",
"note": "",
"verified": 1,
"type": "individual"
},
"has_different_consignee": 0,
"is_guest_customer": 0,
"is_gift_order": 0,
"gift_card_details": null,
"is_quick_checkout_order": false,
"order_total": "664.70000000000000",
"order_total_string": "664.70 SAR",
"has_different_transaction_currency": false,
"transaction_reference": null,
"transaction_amount": 664.7,
"transaction_amount_string": "664.70 SAR",
"issue_date": "05-06-2024 | 11:06 ص",
"payment_status": "paid",
"is_potential_fraud": false,
"source": "Merchant Admin",
"source_code": "md",
"is_reseller_transaction": false,
"created_at": "2024-06-05 08:06:39",
"updated_at": "2024-12-24 04:59:07",
"is_on_demand": false,
"import_id": null,
"tags": [],
"requires_shipping": true,
"should_merchant_set_shipping_method": false,
"shipping": {
"method": {
"id": 432510,
"name": "No rush",
"code": "zid_zidship",
"estimated_delivery_time": "1–5 business days",
"icon": "https://media.zidship.com/thumbs/servicelevel/367b39bc-1f48-4117-a881-bdb548fda705-thumbnail-370x370.png",
"is_system_option": true,
"waybill": null,
"had_errors_while_fetching_waybill": false,
"waybill_tracking_id": null,
"has_waybill_and_packing_list": false,
"tracking": {
"number": null,
"status": null,
"url": null
},
"order_shipping_status": "Pickup hold",
"inventory_address": [],
"courier": {
"name": {
"ar": "أرامكس",
"en": "Aramex"
},
"code": "Aramex",
"logo": "https://media.zidship.com/courier/33ab91e3-d8ba-4b25-a306-61c8922ed97b.png",
"identifier": "ARAMEX"
},
"return_shipment": null,
"packages_count": 1
},
"address": {
"formatted_address": "N/A",
"street": "kkk",
"district": "kkk",
"lat": null,
"lng": null,
"short_address": null,
"meta": {
"city_name": null,
"postcode": null,
"building_number": null,
"additional_number": null
},
"city": {
"id": 71,
"name": "Jeddah"
},
"country": {
"id": 184,
"name": "Saudi Arabia"
}
}
},
"payment": {
"method": {
"name": "Cash on Delivery",
"code": "zid_cod",
"type": "zid_cod"
}
},
"cod_confirmed": true,
"reverse_order_label_request": null,
"reverse_order_label_requests": []
}
]
},
"message": {
"type": "object",
"code": null,
"name": null,
"description": null
}
}🟠404Not Found
🟠401Unauthenticated
Modified at 2026-01-25 12:41:48