Zid Docs
Merchant APIPayment APIAppsThemes
Merchant APIPayment APIAppsThemes
Help Center
Slack
  1. Customers
  • Start Here 🚀
  • Overview to Zid Apps
  • Authorization
  • Responses
  • Webhooks
  • Rate Limiting
  • APIs
    • Orders
      • Update Order by ID
      • Get Order Credit Notes
      • Get Order by ID
      • List of Orders
      • Order Notes
    • Reverse Orders
      • Reverse Order Reasons
      • Create Reverse Orders
      • Create Reverse Orders Waybill
      • Add Reverse Order Reasons
    • Carts
      • Get Abandoned Cart Details
      • List Abandoned Carts
    • Products
      • Managing Products
        • Get a Product by ID
        • Retrieve a list of products
        • Create a new product
        • Update an existing product.
        • Bulk update of products using their IDs or SKUs
        • Delete a product.
        • Product Setting
      • Digital Vouchers
        • Product Vouchers
        • Order Voucher
        • Add Product Voucher
        • Import Vouchers
        • Export Vouchers
        • Update Product Voucher
        • Remove Product Voucher
      • Product Categories
        • Get Single Category Details
        • Get all categories
        • Create Store Category
        • Update a Store Category
        • Add a product to a certain category
        • Publish/Unpublish a Category
        • Detach Category from All Products
        • Remove Category from Product
      • Product Badge
        • Product Badge
      • Product Attributes
        • Get Product Attributes
        • Get Product Attributes
        • Retrieve a product attribute
        • Add a New Product Attribute
        • Add a New Product Attribute
        • Update a product attribute
        • Delete a product attribute
      • Product Attribute Presets
        • Get attribute presets
        • Create Attribute Preset
        • Update Attribute Preset
        • Delete an attribute preset
      • Product Customizations
        • Add Product Variants
        • Insert Custom Options to a Product
        • Insert Custom User-Input Fields to a Product
      • Product Manual Sorting
        • Set Custom Product Order
        • Reset the manual sorting of all products
      • Product Images
        • Get List of images of a product.
        • Add an image to a product
        • Update a product Image Order
        • Delete a product image
      • Product Notifications
        • Availability Notification Stats
        • Availability Notifications Settings
        • List Availability Notifications
        • Add Availability Notification
        • Save Availability Notifications Settings
        • Manually Send Availability Notification Email
        • Export Availability Notifications
      • Product Import
        • Email All Products to Store Owner
        • Import Products via CSV or xlsx File
      • Product Stock (Multi-Inventory)
        • Get Product Stock by ID
        • List Product Stocks
        • Add Product Stock
        • Update Single Product Stock
        • Bulk Update Product Stocks
      • Product Questions & Answers
        • Get Question
        • Get Answer
        • Get All Questions
        • List Question Answers
        • Create Question
        • Create Answer
        • Update Question
        • Update Answer
        • Delete Question
        • Delete Answer
      • Product Reviews
        • List Reviews
        • New Reviews Total
      • Digital Products
        • Create Downloadable Product
        • Generate an Upload URL
        • Upload File to S3
        • Create Product Downloadables
        • Get Product Downloadables
        • Delete Product Downloadables
        • Get Store Downloadables
        • Create Store Downloadables
        • Delete Store Downloadables
    • Inventories
      • Get Store Location by ID
      • List Store Locations
      • Add a New Location
      • Update a Location by ID
      • Update Products Stock by Location ID
    • Shipping
      • List Store Delivery Options
      • Add Shipping Option
    • Marketing
      • Gift Cards
        • Add gift card to the cart
        • Remove gift card from the cart
      • Coupons
        • Create a New Coupon
        • List Coupons
        • Get Coupon Details
        • Update Coupon
        • Delete Coupon
      • Bundle Offers
        • Retrieve all Bundle Offers
      • Loyalty Program
        • Loyalty Program Points per Order
        • Store Loyalty Status
        • Info Page
        • Loyalty Program Activation
        • Loyalty Status
        • Set Points Expiration
        • Cashback Rule Method Update
        • Cashback Rule Method Update Status
        • Add Points Redemption Method
        • Update Points Redemption Method
        • Delete Points Redemption Method
        • Toggle Redemption Method Status
        • Show Loyalty Points Info for Specific Customer
        • List Data
        • Customer Points History
        • Info Page - Managers
        • Update Info Page
        • Adjust Customer Points
    • Customers
      • List of Customers
        GET
      • Get Customer by ID
        GET
    • Store Settings
      • 📄 User Roles and Permissions
      • Get Manager's Profile
      • List of Payment Method
    • Countries and Cities
      • Retrieve Store Operating Countries
      • Retrieve Cities by Country ID
      • Countries List
    • Webhook
      • List of Webhooks
      • Create a Webhook
      • Delete a Webhook by OriginalId
      • Delete a Webhook by Subscriber
  • Store Events
    • Order
    • Product
    • Abandoned Cart
    • Customer
    • Product Category
  1. Customers

Get Customer by ID

GET
https://api.zid.sa/v1/managers/store/customers/{customer_id}
This endpoint retrieves the details of a certain customer using the Customer's ID.
🔑Scopes
customers.read - Customers Read

Request

Path Params

Header Params

Request 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/8737297' \
--header 'Authorization: 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' \
--header 'X-Manager-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Accept-Language;'

Responses

🟢200Requested customer's details
application/json
Body

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
Modified at 2025-02-04 05:36:55
Previous
List of Customers
Next
Store Settings
Built with