วิธีใช้ API ยอดขาย (Sales API)
API
OAuth
ยอดขาย
KPI
Analytics
Android
iOS
averageTicket
terminalId
วัตถุประสงค์ของคู่มือนี้
คู่มือนี้สรุปวิธีดึงยอดขายของทั้งบัญชีธุรกิจ/ร้านค้าเฉพาะ/เครื่อง POS เฉพาะ โดยใช้API ยอดขาย (Sales API)ของ ReceiptRoller เป็นคู่มือที่เป็นจุดเริ่มต้นเมื่อต้องการสร้าง「แดชบอร์ดยอดขาย」จากแอปมือถือหรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
ข้อกำหนดเบื้องต้น
- ได้รับ access token ผ่าน OAuth 2.0 authorization code flow เรียบร้อยแล้ว
- สโคปของแอปมี
sales.read - ได้ ID ของบัญชีธุรกิจและร้านค้ามาล่วงหน้าแล้ว(ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS)
- Base URL:
https://receiptroller.io
รายการเอนด์พอยต์
| เอนด์พอยต์ | วัตถุประสงค์ | ฟิลเตอร์หลัก |
|---|---|---|
GET /api/v1/sales/kpis | KPI ของเดือนปัจจุบัน(ยอดขาย・จำนวนธุรกรรม・ยอดเฉลี่ยต่อบิล)และเทียบกับเดือนก่อน | organizationId, storeId?, terminalId? |
GET /api/v1/sales/trend | เทรนด์รายเดือน(ค่าเริ่มต้น 12 เดือน สูงสุด 60 เดือน) | organizationId, storeId?, months, terminalId? |
GET /api/v1/sales/products | ยอดขายรายสินค้า+การวิเคราะห์ ABC+อัตรากำไรขั้นต้น | organizationId, storeId, since, until, category, search, sortBy, terminalId? |
GET /api/v1/sales/visitors | การวิเคราะห์การเข้าร้าน(ช่วงเวลา・วันในสัปดาห์・อัตราคอนเวอร์ชัน・ลูกค้าใหม่/ลูกค้าเก่า) | organizationId, storeId, since, until, terminalId? |
GET /api/v1/sales/multi-trend | ซ้อนทับเทรนด์รายเดือนของหลายร้าน(สูงสุด 10 ร้าน) | organizationId, storeIds(คั่นด้วยจุลภาค), months |
GET /api/v1/sales/advice | คำแนะนำ AI(การ์ดของแผง Intelligence) | organizationId, storeId?, severity?, category? |
GET /api/v1/sales/forecast | พยากรณ์ยอด ณ สิ้นเดือน | organizationId, storeId? |
GET /api/v1/sales/churn | คะแนนความเสี่ยงลูกค้าเลิกใช้(RFM-lite) | organizationId, storeId, lookbackDays |
GET /api/v1/sales/recommendations | แนะนำสินค้าให้ลูกค้ารายบุคคล | organizationId, storeId, customerId, topN, lookbackDays |
ยอดขายของทั้งบัญชีธุรกิจ(KPI)
เมื่อต้องการดึง「ตัวเลขของเดือนนี้」ของบัญชีธุรกิจที่เลือกอยู่ ให้เรียก kpis โดยไม่ต้องใส่ storeId
GET /api/v1/sales/kpis?organizationId={organizationId}
Authorization: Bearer {access_token}
โครงสร้างการตอบกลับ
ฟิลด์ตัวเลขทุกตัวจะคืนค่าเป็นชนิดซ้อนร่วมกันชื่อ KpiValue ฝั่งไคลเอนต์ไม่จำเป็นต้องคำนวณอัตราเทียบเดือนก่อนหรืออัตราการเพิ่มขึ้น/ลดลงใหม่
{
"organizationId": "0aa2...e7b1",
"currentMonth": "2026-06",
"previousMonth": "2026-05",
"totalStores": { "current": 12, "previous": 12, "changePercent": 0.0 },
"totalStaff": { "current": 87, "previous": 84, "changePercent": 3.6 },
"totalProducts": { "current": 1450, "previous": 1410, "changePercent": 2.8 },
"totalCustomers": { "current": 8920, "previous": 8650, "changePercent": 3.1 },
"totalRevenue": { "current": 3850000, "previous": 3520000, "changePercent": 9.4 },
"totalTransactions": { "current": 1240, "previous": 1180, "changePercent": 5.1 },
"aver…
วันที่เผยแพร่: 2569-06-01
วันที่อัปเดต: 2569-07-06
หมวดหมู่
แท็ก
API (22)
OAuth (15)
Android (10)
iOS (9)
Webhook (8)
api (7)
oauth (5)
getting-started (4)
การลงทะเบียนแอป (4)
การแก้ปัญหา (4)
บทความที่เกี่ยวข้อง
-
วิธีใช้ Reservations APIคู่มือ Reservations API ของ ReceiptRoller (/api/v1/reservations) อธิบายการทำ CRUD และอัปเดตสถานะการจอง การดึง・สร้าง・สร้างชุดของช่องจอง (สล็อต) การดึงข้อมูลโต๊ะ (โต๊ะ・ห้องส่วนตัว・เคาน์เตอร์) ที่ลงทะเบียนไว้ในเลย์เอาต์ร้าน และสถิติการจอง
-
วิธีใช้ In-Store Media Display API (Display API)ภาพรวมของ In-Store Android Display API ของ ReceiptRoller (/api/v1/displays/*) และขั้นตอนการจับคู่・heartbeat・การดึงเพลย์ลิสต์・การรายงานผลการเล่น คู่มือเริ่มต้นสำหรับสร้างแอปเล่นมีเดียลูปบนเครื่อง Android แบบ POS ควบคู่หรือเครื่องไซเนจของร้าน
-
การเชื่อมต่อข้อมูลการซื้อและใบเสร็จอธิบายโครงสร้างข้อมูลการซื้อและใบเสร็จที่ ReceiptRoller จัดการ วิธีการดึงข้อมูล สโคปที่เกี่ยวข้อง Webhook และกรณีการใช้งานที่พบบ่อย
-
สารบัญความช่วยเหลือสำหรับนักพัฒนาสารบัญความช่วยเหลือสำหรับนักพัฒนา ReceiptRoller รวบรวมตั้งแต่การสมัครเป็นนักพัฒนา การลงทะเบียนแอปพลิเคชัน การยืนยันตัวตน OAuth และสโคป คู่มือการพัฒนา (แอปวอลเล็ต, Webhook สำหรับร้านค้า, Survey API) คู่มือแยกตามโดเมนข้อมูล การใช้งานและความปลอดภัย คอมมูนิตี ไปจนถึงการแก้ปัญหา
-
ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POSคู่มือสรุปขั้นตอนการดึงรายการบัญชีธุรกิจที่ผู้ใช้สังกัด ร้านค้าภายใต้บัญชีนั้น และเครื่อง POS ของแต่ละร้านผ่าน REST API จากแอปมือถือ/แอปเซิร์ฟเวอร์ของ ReceiptRoller