ค้นหาใบเสร็จ

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

ค้นหาใบเสร็จด้วยเงื่อนไขต่างๆ endpoint นี้ช่วยให้คุณค้นหาใบเสร็จเฉพาะโดยใช้ตัวกรองเช่น ช่วงวันที่ จำนวนเงิน และคุณลักษณะใบเสร็จอื่นๆ

---

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

ค้นหา - 3 ฟิลด์พารามิเตอร์การค้นหา

▼

`query`STRING(optional)

ข้อความค้นหา ค้นหาในฟิลด์ใบเสร็จรวมถึงคำอธิบาย metadata และหมายเลขอ้างอิง

Example:"order_12345"

`scope`STRING(optional)

จำกัดการค้นหาในฟิลด์เฉพาะภายในใบเสร็จ

Example:"metadata"

`filters`OBJECT(optional)

ตัวกรองเพิ่มเติมเพื่อจำกัดผลการค้นหา สามารถรวมช่วงจำนวนเงิน สกุลเงิน และคุณลักษณะใบเสร็จอื่นๆ

Example:{"currency":"thb"}

ช่วงวันที่ - 2 ฟิลด์พารามิเตอร์ช่วงวันที่

▼

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

▼

---

การตอบกลับ

200

ค้นหาสำเร็จ

ค้นหาเสร็จสมบูรณ์ ส่งคืนรายการใบเสร็จที่ตรงกันแบบแบ่งหน้า

โครงสร้าง Response:

• object - ส่งคืน "search" เสมอ
• data - อาร์เรย์ของออบเจกต์ใบเสร็จที่ตรงกับเงื่อนไขการค้นหา
• limit - จำนวนรายการต่อหน้า
• offset - จำนวนรายการที่ถูกข้าม
• total - จำนวนใบเสร็จทั้งหมดที่ตรงกับการค้นหา
• query - คำค้นหาที่ดำเนินการ

400

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

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

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

• รูปแบบวันที่ไม่ถูกต้องในพารามิเตอร์ from/to
• รูปแบบตัวกรองไม่ถูกต้อง
• รูปแบบข้อความค้นหาไม่ถูกต้อง
• Limit เกินค่าสูงสุดที่อนุญาต

401

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

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

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

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

404

ไม่พบ

ไม่พบ endpoint การค้นหาหรือทรัพยากรที่ร้องขอ

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

• URL endpoint ไม่ถูกต้อง
• เวอร์ชัน API ไม่ถูกต้อง

5xx

เซิร์ฟเวอร์ error

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/receipts/receipts/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "query=order_12345" \
  -d "from=2025-01-01T00:00:00Z" \
  -d "limit=20"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

receipts = Omise::Receipt.search(
  query: 'order_12345',
  from: '2025-01-01T00:00:00Z',
  limit: 20
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

receipts = omise.Receipt.search(
    query='order_12345',
    from_date='2025-01-01T00:00:00Z',
    limit=20
)

Node.js

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

const receipts = await omise.receipts.search({
  query: 'order_12345',
  from: '2025-01-01T00:00:00Z',
  limit: 20
});

PHP

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

$receipts = OmiseReceipt::search([
    'query' => 'order_12345',
    'from' => '2025-01-01T00:00:00Z',
    'limit' => 20
]);

Java

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

SearchResult<Receipt> receipts = client.receipts().search()
    .query("order_12345")
    .from("2025-01-01T00:00:00Z")
    .limit(20)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var receipts = await client.Receipts.Search(new SearchOptions
{
    Query = "order_12345",
    From = DateTime.Parse("2025-01-01T00:00:00Z"),
    Limit = 20
});

Go

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

receipts, _ := client.Receipts().Search(&omise.SearchParams{
    Query: "order_12345",
    From:  "2025-01-01T00:00:00Z",
    Limit: 20,
})

---

รหัส Error และผลลัพธ์

รหัส Error ทั่วไป

รหัส	คำอธิบาย	วิธีแก้ไข
bad_request	พารามิเตอร์ขาดหายหรือไม่ถูกต้อง	ตรวจสอบค่าและรูปแบบพารามิเตอร์
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง
invalid_date_format	การตรวจสอบรูปแบบวันที่ล้มเหลว	ใช้รูปแบบ ISO 8601 (YYYY-MM-DDTHH:MM:SSZ)
invalid_query	รูปแบบคำค้นหาไม่ถูกต้อง	ตรวจสอบไวยากรณ์ข้อความค้นหา

ฟิลด์ออบเจกต์ใบเสร็จ

ฟิลด์	ประเภท	คำอธิบาย
object	string	ส่งคืน "receipt" เสมอ
id	string	ตัวระบุใบเสร็จ (rcpt_*)
livemode	boolean	ตัวบ่งชี้สภาพแวดล้อม production หรือ test
location	string	เส้นทาง API ไปยังออบเจกต์ใบเสร็จ
adjustment_transaction	string	ID ธุรกรรมการปรับปรุงที่เกี่ยวข้อง
charge_fee	integer	ค่าธรรมเนียม charge ของ Omise ในหน่วยสกุลเงินที่เล็กที่สุด
company_address	string	ที่อยู่บริษัท Omise
company_name	string	ชื่อบริษัท Omise
company_tax_id	string	เลขประจำตัวผู้เสียภาษีบริษัท Omise
credit_note	boolean	ว่านี่คือใบลดหนี้หรือไม่
currency	string	รหัส ISO 4217 3 ตัวอักษร
customer_address	string	ที่อยู่ร้านค้า
customer_email	string	อีเมลร้านค้า
customer_name	string	ชื่อร้านค้า
customer_statement_name	string	ชื่อ statement ร้านค้า
customer_tax_id	string	เลขประจำตัวผู้เสียภาษีร้านค้า
issued_on	string	วันที่ออกใบเสร็จ
number	string	เลขที่ใบเสร็จ
subtotal	integer	ยอดรวมย่อยก่อนภาษี
total	integer	ยอดรวม (คำนวณเป็น subtotal + vat - wht)
transaction_fee	integer	ค่าธรรมเนียมธุรกรรมในหน่วยสกุลเงินที่เล็กที่สุด
transfer_fee	integer	ค่าธรรมเนียมการโอนในหน่วยสกุลเงินที่เล็กที่สุด
vat	integer	จำนวน VAT
voided_fee	integer	จำนวนค่าธรรมเนียมที่ถูกยกเลิก
wht	integer	จำนวนภาษีหัก ณ ที่จ่าย
created_at	string	วันเวลา UTC ในรูปแบบ ISO 8601

---

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

▼

ลองใช้งาน

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

▼

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