Customer Search - Gofive OpenAPI

ใช้สำหรับ “ค้นหาลูกค้า” แบบเดียวกับ Search textbox
รองรับการพิมพ์คำบางส่วน (partial) / ไม่ต้อง exact match
ค้นข้ามประเภทได้ในครั้งเดียว (Lead/Prospect/Customer) ไม่ต้องยิงหลายรอบ
คืนผลเป็น รายการ เพื่อให้ผู้ใช้ “เลือก” แล้วค่อยไป Get detail ใน step ถัดไป (ถ้าจำเป็น)

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Example

{
    "search": "test",
    "searchIn": [
        "customerCode",
        "customerName",
        "customerTaxNo"
    ],
    "skip": 20,
    "take": 20
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "status": {
        "code": "200",
        "description": "success"
    },
    "data": {
        "customerId": 12345,
        "customerName": "Roy Franecki, DVM",
        "customerCode": "CORP-31",
        "customerState": 1,
        "customerType": 102,
        "customerStatus": 1,
        "leadStatus": 5,
        "customerPicture": "https://images.unsplash.com/photo-1612349317150-e413f6a5b16d?w=400&h=400&fit=crop",
        "customer2ndName": "Paw Health Veterinary Center",
        "customerAliases": [
            "PH Veterinary",
            "Roy's Clinic"
        ],
        "customerTaxNo": "0105564000123",
        "customerPhone": "02-123-4567",
        "customerMobile": "081-926-8635",
        "customerEmail": "[email protected]",
        "customerSocialAccount": {
            "facebook": "fb.com/pawhealth_clinic"
        },
        "customerTags": [
            "VIP",
            "Medical-Supplier"
        ],
        "addresses": {
            "addressId": 90,
            "branchCode": "HQ-01",
            "locationName": "Headquarters",
            "locationAddress": "1405 Ashly Fort Street",
            "secondaryAddress": "Suite 278",
            "locationType": 1,
            "latitude": "13.7563",
            "longitude": "100.5018",
            "subdistrict": "Pathum Wan",
            "subdistrictEN": "Pathum Wan",
            "district": "Bangkok",
            "districtEN": "Bangkok",
            "province": "กรุงเทพมหานคร",
            "provinceEN": "Bangkok",
            "zipCode": "10330"
        },
        "sourceName": "Referral by Dr. Brian",
        "customerGroupName": "Premium Partners",
        "interestsName": [
            "Animal Vaccines",
            "Surgical Equipment",
            "Dietary Supplements"
        ],
        "classificationName": "Gold Tier",
        "customFields": [
            "Active Maintenance Contract"
        ],
        "contacts": [
            {
                "contactName": "Brandi Beatty",
                "contactPicture": "https://i.pravatar.cc/400?img=32",
                "contactPhone": "02-123-4568",
                "contactMobile": "065-927-1579",
                "contactEmail": "[email protected]",
                "contactSocialAccount": {
                    "facebook": "brandi.beatty.official"
                },
                "contactPosition": "Operations Manager",
                "contactBirthdate": "1990-06-19",
                "contactNote": "ตัดสินใจเรื่องการสั่งซื้ออุปกรณ์ทั่วไป",
                "contactStatus": true,
                "tags": [
                    "Main-Contact",
                    "Purchasing"
                ]
            },
            {
                "contactName": "Dr. Julian Pouros",
                "contactPicture": "https://i.pravatar.cc/400?img=12",
                "contactPhone": "02-123-4569",
                "contactMobile": "089-908-0628",
                "contactEmail": "[email protected]",
                "contactSocialAccount": {
                    "facebook": "julian.vet.med"
                },
                "contactPosition": "Chief Veterinary Surgeon",
                "contactBirthdate": "1985-03-02",
                "contactNote": "ติดต่อเฉพาะเรื่องเคสผ่าตัดและเครื่องมือแพทย์เฉพาะทาง",
                "contactStatus": true,
                "tags": [
                    "Decision-Maker",
                    "Specialist"
                ]
            }
        ],
        "customerNote": "ลูกค้าพรีเมียม ตอบรับเร็ว สนใจเทคโนโลยีใหม่ๆ เสมอ",
        "owners": [
            "John Doe (Sales)",
            "Sarah Connor (Account Manager)"
        ],
        "primaryOwner": "John Doe (Sales)"
    }
}

🟠401User authentication required V2.