แสดงรายการ sub-merchants ทั้งหมด

GEThttps://api.omise.co/sub_merchants

ดึงรายการ sub-merchants ทั้งหมดแบบแบ่งหน้าที่อยู่ภายใต้บัญชีแพลตฟอร์มของคุณ ผลลัพธ์สามารถกรองตามช่วงวันที่ สถานะ และเรียงลำดับตามเวลา

---

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

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

▼

`limit`INTEGER(optional)

จำนวนระเบียนที่จะส่งคืนต่อหน้า

Example:20

Constraints:ต่ำสุด: 1, สูงสุด: 100

Default:20

`offset`INTEGER(optional)

จำนวนระเบียนที่จะข้ามก่อนส่งคืนผลลัพธ์ ใช้สำหรับการแบ่งหน้า

Example:0

Default:0

`order`STRING(optional)

ลำดับการเรียงผลลัพธ์ตามวันที่สร้าง

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

`status`STRING(optional)

กรอง sub-merchants ตามสถานะ

Example:"active"

Values:pending, active, suspended, deactivated, rejected

`from`STRING(optional)

กรอง sub-merchants ที่สร้างในหรือหลังจากวันที่และเวลา UTC นี้ รูปแบบ ISO 8601

Example:"2025-01-01T00:00:00Z"

`to`STRING(optional)

กรอง sub-merchants ที่สร้างในหรือก่อนวันที่และเวลา UTC นี้ รูปแบบ ISO 8601

Example:"2025-12-31T23:59:59Z"

---

การตอบกลับ

200

คำขอสำเร็จ

ดึงรายการ sub-merchants สำเร็จ ส่งคืนรายการแบบแบ่งหน้าพร้อมข้อมูลเมตา

โครงสร้างการตอบกลับ:

• object - เป็น "list" เสมอ
• data - อาร์เรย์ของ sub-merchant objects
• total - จำนวน sub-merchants ทั้งหมดที่ตรงกับตัวกรอง
• limit - จำนวนระเบียนต่อหน้า
• offset - ออฟเซ็ตการแบ่งหน้าปัจจุบัน
• from, to - ตัวกรองวันที่ที่ใช้

400

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

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

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

• รูปแบบวันที่ไม่ถูกต้องสำหรับ from หรือ to
• ค่า order ไม่ถูกต้อง
• ค่า status ไม่ถูกต้อง
• offset หรือ limit เป็นค่าลบ
• limit เกินค่าสูงสุด (100)

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 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

sub_merchants = Omise::SubMerchant.list(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

sub_merchants = omise.SubMerchant.retrieve(limit=20, offset=0)

Node.js

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

const subMerchants = await omise.subMerchants.list({
  limit: 20,
  offset: 0
});

PHP

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

$subMerchants = OmiseSubMerchant::retrieve([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<SubMerchant> subMerchants = client.subMerchants()
    .list(new ScopedList.Options()
        .limit(20)
        .offset(0));

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var subMerchants = await client.SubMerchants.List(new ListOptions
{
    Limit = 20,
    Offset = 0
});

Go

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

subMerchants, _ := client.SubMerchants().List(&operations.ListSubMerchants{
    Limit:  20,
    Offset: 0,
})

---

การแบ่งหน้า

ใช้พารามิเตอร์ limit และ offset เพื่อแบ่งหน้าผลลัพธ์:

# หน้าแรก (0-19)
curl https://api.omise.co/sub_merchants?limit=20&offset=0 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

# หน้าที่สอง (20-39)
curl https://api.omise.co/sub_merchants?limit=20&offset=20 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

---

การกรองตามสถานะ

กรอง sub-merchants ตามสถานะการตรวจสอบ:

# แสดงเฉพาะ sub-merchants ที่ใช้งานอยู่
curl https://api.omise.co/sub_merchants?status=active \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

# แสดง sub-merchants ที่รอดำเนินการ
curl https://api.omise.co/sub_merchants?status=pending \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

---

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

▼

ทดลองใช้งาน

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

▼

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