ค้นหา sub-merchants

GEThttps://api.omise.co/sub_merchants/search

ค้นหาและกรอง sub-merchants เพื่อค้นหาร้านค้าตามชื่อ อีเมล รายละเอียดธุรกิจ metadata และอื่นๆ Search API มีความสามารถในการค้นหาข้อความแบบเต็มรูปแบบในทุก sub-merchants บนแพลตฟอร์มของคุณ

---

พารามิเตอร์คำขอ

แนะนำ - 2 ฟิลด์พารามิเตอร์ที่แนะนำ

▼

`query`STRING(optional)

สตริงคำค้นหา ค้นหาในชื่อ sub-merchant อีเมล ชื่อธุรกิจ คำอธิบาย และ metadata รองรับหลายคำ (ตรรกะ AND) และการจับคู่บางส่วน

Example:"acme electronics"

`filters`OBJECT(optional)

เกณฑ์การกรองเพื่อจำกัดผลลัพธ์การค้นหา ตัวกรองทั่วไป ได้แก่ status, type, business_category และช่วงวันที่สร้าง

Example:{"status":"active","type":"business"}

การแบ่งหน้า - 3 ฟิลด์พารามิเตอร์การแบ่งหน้า

▼

---

การตอบกลับ

200

ค้นหาสำเร็จ

ค้นหาเสร็จสมบูรณ์ ส่งคืน search result object พร้อม sub-merchants ที่ตรงกันในอาร์เรย์ data

การตอบกลับประกอบด้วย:

• object - เป็น "search" เสมอ
• data - อาร์เรย์ของ sub-merchant objects ที่ตรงกับเกณฑ์การค้นหา
• total - จำนวนผลลัพธ์ทั้งหมดที่ตรงกับการค้นหา
• total_pages - จำนวนหน้าทั้งหมดที่มี
• page - หมายเลขหน้าปัจจุบัน
• per_page - จำนวนผลลัพธ์ต่อหน้า
• order - ลำดับการเรียงที่ใช้ (chronological หรือ reverse_chronological)

400

คำขอไม่ถูกต้อง

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความข้อผิดพลาดสำหรับรายละเอียด

สาเหตุทั่วไป:

• หมายเลขหน้าไม่ถูกต้อง (ต่ำกว่า 1)
• ค่า per_page ไม่ถูกต้อง (มากกว่า 100 หรือต่ำกว่า 1)
• filters object มีรูปแบบไม่ถูกต้อง
• ชื่อฟิลด์ตัวกรองไม่ถูกต้อง

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือขาดหายไป

สาเหตุทั่วไป:

• ไม่มี Authorization header
• secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบบัญชีแพลตฟอร์มหรือฟีเจอร์ sub-merchant ไม่ได้เปิดใช้งาน

สาเหตุทั่วไป:

• บัญชีไม่ใช่บัญชีแพลตฟอร์ม
• ฟีเจอร์ sub-merchant ไม่ได้เปิดใช้งาน
• ติดต่อฝ่ายสนับสนุนเพื่อเปิดใช้งานฟีเจอร์แพลตฟอร์ม

5xx

ข้อผิดพลาดเซิร์ฟเวอร์

เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ ปัญหานี้เกิดขึ้นได้น้อยแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์บริการ
• ดู การจัดการข้อผิดพลาด สำหรับคำแนะนำโดยละเอียด

---

ตัวอย่างโค้ด

cURL

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=acme electronics" \
  -d "filters[status]=active" \
  -d "filters[type]=business"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::SubMerchant.search({
  query: 'acme electronics',
  filters: {
    status: 'active',
    type: 'business'
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.SubMerchant.search(
    query='acme electronics',
    filters={
        'status': 'active',
        'type': 'business'
    }
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const results = await omise.subMerchants.search({
  query: 'acme electronics',
  filters: {
    status: 'active',
    type: 'business'
  }
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$results = OmiseSubMerchant::search([
    'query' => 'acme electronics',
    'filters' => [
        'status' => 'active',
        'type' => 'business'
    ]
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Map<String, Object> filters = new HashMap<>();
filters.put("status", "active");
filters.put("type", "business");

SearchResult<SubMerchant> results = client.subMerchants()
    .search()
    .query("acme electronics")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.SubMerchants.Search(new SearchRequest
{
    Query = "acme electronics",
    Filters = new Dictionary<string, object>
    {
        { "status", "active" },
        { "type", "business" }
    }
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

results, _ := client.SubMerchants().Search(&operations.SearchSubMerchants{
    Query: "acme electronics",
    Filters: map[string]interface{}{
        "status": "active",
        "type":   "business",
    },
})

---

ตัวอย่างการค้นหา

ค้นหาตามชื่อหรืออีเมล

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=john@example.com"

ค้นหาพร้อมตัวกรองสถานะ

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "filters[status]=pending"

ค้นหาตามหมวดหมู่ธุรกิจ

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "filters[business_category]=electronics_retail"

ค้นหาตามช่วงวันที่

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "filters[created][gte]=2025-01-01" \
  -d "filters[created][lte]=2025-03-31"

ค้นหารวมพร้อมหลายตัวกรอง

curl https://api.omise.co/sub_merchants/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "query=premium" \
  -d "filters[status]=active" \
  -d "filters[type]=business" \
  -d "filters[business_category]=electronics_retail" \
  -d "per_page=50"

---

รหัสข้อผิดพลาดและผลลัพธ์

รหัสข้อผิดพลาดทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์ขาดหายไปหรือไม่ถูกต้อง	ตรวจสอบว่าพารามิเตอร์ถูกต้อง
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
platform_not_enabled	ฟีเจอร์แพลตฟอร์มไม่ได้เปิดใช้งาน	ติดต่อฝ่ายสนับสนุนเพื่อเปิดใช้งานบัญชีแพลตฟอร์ม

ตัวเลือกตัวกรองการค้นหา

ตัวกรอง	ประเภท	คำอธิบาย
status	string	สถานะ sub-merchant (pending, active, suspended, deactivated, rejected)
type	string	ประเภท sub-merchant (individual, business)
business_category	string	รหัสหมวดหมู่ธุรกิจ
created	object	ตัวกรองช่วงวันที่ (เช่น {gte: '2025-01-01', lte: '2025-01-31'})

ฟิลด์ที่ค้นหาได้

คำค้นหาจะจับคู่กับฟิลด์ต่อไปนี้:

• name - ชื่อที่แสดงของ sub-merchant
• email - อีเมลติดต่อ
• business_name - ชื่อธุรกิจที่จดทะเบียน
• description - คำอธิบายภายใน
• metadata - ค่า metadata ที่กำหนดเอง

---

🔑ข้อมูลยืนยันตัวตน API

▼

ทดลองใช้งาน

แนะนำ - 2 ฟิลด์

▼

เพิ่มเติม - 3 ฟิลด์

▼

IP ของคุณ: ...กำลังโหลด...