Zid Docs
Get Customer by ID
GETv1/managers/store/customers/{customer_id}This endpoint retrieves the details of a certain customer using the Customer's ID.
Request
ID of the customer to retrieve
The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.
This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.
Preferred language for the response. Defaults to en if not specified.
Request samples
Responses
An object representing the status of the response.
An object containing detailed information about the customer.
The unique identifier for the customer.
The full name of the customer.
The customer’s email address.
The customer’s mobile number, including country code.
The gender of the customer, typically "male" or "female".
The birth date of the customer in "YYYY-MM-DD" format.
true if Customer had completed identity verification.
false if the Merchant had deactivated/banned the Customer from the given store.
Is the cash on delivery option allowed by the Merchant for the Customer.
The type of customer, such as "individual" or "business".
The name of the business if the customer is a business account; otherwise, null.
The tax number associated with the business, if applicable.
The commercial registration number of the business, if applicable.
An object with details about the customer’s city.
A nickname for the customer, if available.
Another reference to the customer's email, possibly for additional linkage or verification.
Another reference to the customer's mobile number, possibly for verification.
The total number of orders placed by the customer.
The total amount the customer has paid across all orders.
The average cost per order for this customer.
An array of objects, each representing an order placed by the customer.
Contains any message associated with the response.
Type of message, if any.
Message code, if applicable.
Message name or title.
A description of the message.
{
"status": "object",
"customer": {
"id": 107,
"name": "Mohammed Badawi",
"email": "mohammed.badawi@gmail.com",
"mobile": "966501234567",
"gender": "male",
"birth_date": "1989-12-31",
"verified": true,
"is_active": false,
"is_cod_enabled": true,
"type": "individual",
"business_name": null,
"tax_number": null,
"commercial_registration": null,
"city": {
"id": 1,
"national_id": 3,
"name": "Riyadh",
"priority": 10,
"country_id": 184,
"country_name": "Saudi Arabia",
"country_code": "SA",
"ar_name": "الرياض",
"en_name": "Riyadh"
},
"nickname": "Momo Bibi",
"pivotEmail": "mohammed.badawi@gmail.com",
"pivotMobile": "966501234567",
"order_counts": 23,
"total_payments": 15076.72655859143,
"orders_cost_average": 655.5098503735404,
"orders": [
{
"id": 5826659,
"code": "6IJWXOYLuR",
"store_id": 3,
"order_url": "https://zid.store/osama/o/6IJWXOYLuR/inv",
"store_name": "Osama Store 1",
"shipping_method_code": "custom",
"store_url": "https://zid.store/osama/",
"order_status": {
"name": "Delivered",
"code": "delivered"
},
"currency_code": "KWD",
"customer": {
"id": 107,
"name": "Mohammed Badawi",
"verified": 1,
"email": "mohammed.badawi@gmail.com",
"mobile": "966501234567",
"note": "",
"type": null
},
"has_different_consignee": 0,
"is_guest_customer": 0,
"order_total": "12.22750000000000",
"order_total_string": "12.228 KWD",
"has_different_transaction_currency": false,
"transaction_reference": null,
"transaction_amount": 151.58173089636205,
"transaction_amount_string": "151.58 SAR",
"issue_date": "01-03-2021 | 10:34 ص",
"payment_status": "paid",
"source": "Store",
"source_code": null,
"created_at": "2021-03-01 07:34:11",
"updated_at": "2021-03-04 11:36:37",
"tags": [],
"requires_shipping": true,
"shipping": {
"method": {
"id": null,
"name": "مندوب",
"code": "custom",
"estimated_delivery_time": null,
"icon": "https://media.zid.store/static/delivery.png",
"is_system_option": false,
"waybill": null,
"waybill_tracking_id": null,
"tracking": {
"number": null,
"status": null,
"url": null
},
"courier": null,
"return_shipment": null
}
},
"payment": {
"method": {
"name": "Bank Transfer",
"code": "zid_bank_transfer",
"type": "zid_bank_transfer",
"transaction_status": "new",
"transaction_status_name": "New"
}
},
"cod_confirmed": false,
"reverse_order_label_request": null
}
]
},
"message": {
"type": "object",
"code": null,
"name": null,
"description": null
}
}