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

GEThttps://api.omise.co/customers

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

---

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

▼

---

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

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

▼

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

▼

---

การตอบกลับ

200

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

ออบเจ็กต์รายการที่มีออบเจ็กต์ลูกค้าและข้อมูลการแบ่งหน้า

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

• object - ประเภทออบเจ็กต์ (เป็น "list" เสมอ)
• data - อาร์เรย์ของออบเจ็กต์ลูกค้า
• 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 ไม่ถูกต้อง

---

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

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,
    },
})

---

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

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

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

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

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

---

ลองใช้งาน

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

▼