Get Customer by ID

This endpoint retrieves the details of a certain customer using the Customer's ID.

🔑Scopes

customers.read - Customers Read

Request

Path Params

customer_id

string

required

ID of the customer to retrieve

Example:

8737297

Header Params

Authorization

string

required

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.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

X-Manager-Token

string

required

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.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Requested customer's details

application/json

Body

status

string

optional

An object representing the status of the response.

customer

object

optional

An object containing detailed information about the customer.

integer

optional

The unique identifier for the customer.

Example:

107

name

string

optional

The full name of the customer.

Example:

Mohammed Badawi

string

optional

The customer’s email address.

Example:

mohammed.badawi@gmail.com

mobile

string

optional

The customer’s mobile number, including country code.

Example:

966501234567

gender

string

optional

The gender of the customer, typically "male" or "female".

Example:

male

birth_date

string

optional

The birth date of the customer in "YYYY-MM-DD" format.

Example:

1989-12-31

verified

boolean

optional

true if Customer had completed identity verification.

Default:

true

is_active

boolean

optional

false if the Merchant had deactivated/banned the Customer from the given store.

Default:

false

is_cod_enabled

boolean

optional

Is the cash on delivery option allowed by the Merchant for the Customer.

Default:

true

type

string

optional

The type of customer, such as "individual" or "business".

Example:

individual

business_name

string | null

optional

The name of the business if the customer is a business account; otherwise, null.

tax_number

string | null

optional

The tax number associated with the business, if applicable.

commercial_registration

string | null

optional

The commercial registration number of the business, if applicable.

order_total_payments

string

required

The total value of all orders placed by the customer, expressed in the store's base currency.

Example:

0.00

last_order_date

string

required

The date of the customer's most recent order, regardless of order status.

Example:

2025-01-26 17:27:38

city

object

optional

An object with details about the customer’s city.

nickname

string

optional

A nickname for the customer, if available.

Example:

Momo Bibi

pivotEmail

string

optional

Another reference to the customer's email, possibly for additional linkage or verification.

Example:

mohammed.badawi@gmail.com

pivotMobile

string

optional

Another reference to the customer's mobile number, possibly for verification.

Example:

966501234567

order_counts

integer

optional

The total number of orders placed by the customer.

Example:

total_payments

number

optional

The total amount the customer has paid across all orders.

Example:

15076.72655859143

orders_cost_average

number

optional

The average cost per order for this customer.

Example:

655.5098503735404

orders

array [object {30}]

optional

An array of objects, each representing an order placed by the customer.

message

object

optional

Contains any message associated with the response.

type

string

optional

Type of message, if any.

code

string | null

optional

Message code, if applicable.

name

string | null

optional

Message name or title.

description

string | null

optional

A description of the message.

Example

{
    "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
    }
}

🟠401Unauthorized

🟠404Customer Not Found