แสดงรายการลูกค้าทั้งหมด

GEThttps://api.omise.co/customers

ดึงรายการลูกค้าทั้งหมดแบบแบ่งหน้าในบัญชีของคุณ พร้อมตัวกรองตามช่วงวันที่และการเรียงลำดับ

---

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

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

▼

เพิ่มเติม - 3 ฟิลด์การกรองและเรียงลำดับ

▼

---

การตอบกลับ

200

ดึงรายการลูกค้าสำเร็จ

List object ที่มี customer objects และข้อมูลการแบ่งหน้า

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

• object - ประเภท object (เป็น "list" เสมอ)
• data - Array ของ customer objects
• limit - จำนวนรายการต่อหน้า
• offset - จำนวนรายการที่ข้าม
• total - จำนวนลูกค้าทั้งหมดที่ตรงกับตัวกรอง
• order - ลำดับการเรียงที่ใช้
• from - ตัวกรองวันเริ่มต้นที่ใช้
• to - ตัวกรองวันสิ้นสุดที่ใช้

400

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

พารามิเตอร์ที่ให้มาไม่ถูกต้อง

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

• รูปแบบวันที่ไม่ถูกต้อง (ต้องเป็น ISO 8601)
• ค่า order ไม่ถูกต้อง
• Limit เกินสูงสุด (100)
• ค่า offset เป็นลบ

401

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

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

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

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

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/customers?limit=20&offset=0&order=reverse_chronological \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

customers = Omise::Customer.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customers = omise.Customer.list(
    limit=20,
    offset=0,
    order='reverse_chronological'
)

Node.js

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

const customers = await omise.customers.list({
  limit: 20,
  offset: 0,
  order: 'reverse_chronological'
});

PHP

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

$customers = OmiseCustomer::retrieve([
    'limit' => 20,
    'offset' => 0,
    'order' => 'reverse_chronological'
]);

Java

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

ScopedList<Customer> customers = client.customers().list()
    .limit(20L)
    .offset(0L)
    .order(Ordering.ReverseChronological)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var customers = await client.Customers.List(new ListRequest
{
    Limit = 20,
    Offset = 0,
    Order = Ordering.ReverseChronological
});

Go

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

customers, _ := client.Customers().List(&operations.ListCustomers{
    List: operations.List{
        Limit:  20,
        Offset: 0,
        Order:  operations.ReverseChronological,
    },
})

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์ไม่ถูกต้อง	ตรวจสอบรูปแบบวันที่และค่าพารามิเตอร์
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
invalid_parameters	พารามิเตอร์การแบ่งหน้าไม่ถูกต้อง	ตรวจสอบค่า limit และ offset

ฟิลด์การตอบกลับ List

ฟิลด์	คำอธิบาย
object	ประเภท object (เป็น "list" เสมอ)
data	Array ของ customer objects
limit	จำนวนรายการต่อหน้า
offset	จำนวนรายการที่ข้าม
total	จำนวนลูกค้าทั้งหมด
order	ลำดับการเรียงที่ใช้
from	ตัวกรองวันเริ่มต้น
to	ตัวกรองวันสิ้นสุด

---

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

▼

ลองใช้งาน

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

▼

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