Survey API และการฝังในใบเสร็จ
ฟีเจอร์ Survey ของ ReceiptRoller ให้ร้านค้ารวบรวมคำตอบผ่าน QR / ลิงก์ / การฝังในใบเสร็จดิจิทัล และแจกคูปองกลับได้ตามต้องการ บทความนี้ครอบคลุม consumer API สาธารณะ เพย์โหลดการฝังในใบเสร็จ และกฎการกำหนดกลุ่มเป้าหมาย
ตัวอย่าง API ที่ใช้บ่อย
แนะนำตัวอย่างการเรียกเอนด์พอยต์ที่ใช้บ่อยของ API ReceiptRoller (ดึงใบเสร็จ・รายการร้าน・สร้างสินค้า・ลงทะเบียน Webhook) ด้วยคำสั่ง curl
พื้นฐานของรีเควสต์และเรสปอนส์ (JSON)
อธิบายรูปแบบรีเควสต์ของ API ReceiptRoller เฮดเดอร์ที่จำเป็น โครงสร้างเรสปอนส์ การแบ่งหน้า การกรอง และกฎของรูปแบบวันที่-เวลา
วิธีใช้ API จัดการสินค้า (Products API)
คู่มือสำหรับการดำเนินการ CRUD กับสินค้าภายใต้บัญชีธุรกิจผ่าน API จัดการสินค้าของ ReceiptRoller (/api/v1/products) เป็นบทความเริ่มต้นสำหรับการอ่านและเขียน PIM (มาสเตอร์สินค้า) จากแอป Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ API ยอดขาย (Sales API)
คู่มือสรุปภาพรวมของ API ยอดขายของ ReceiptRoller (/api/v1/sales/*) และวิธีการกรองตามบัญชีธุรกิจ・ร้านค้า・เครื่อง POS・ช่วงเวลา ครอบคลุมโครงสร้างการตอบกลับจริง (KpiValue แบบซ้อน) รวมถึง averageTicket และอายุโทเคน (8 ชั่วโมง) เป็นคู่มือเริ่มต้นสำหรับสร้างแดชบอร์ดยอดขายในแอปมือถือ Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ Reservations API
คู่มือ Reservations API ของ ReceiptRoller (/api/v1/reservations) อธิบายการทำ CRUD และอัปเดตสถานะการจอง การดึง・สร้าง・สร้างชุดของช่องจอง (สล็อต) การดึงข้อมูลโต๊ะ (โต๊ะ・ห้องส่วนตัว・เคาน์เตอร์) ที่ลงทะเบียนไว้ในเลย์เอาต์ร้าน และสถิติการจอง
รหัสข้อผิดพลาดและแนวทางการรีทราย
อธิบายรายการรหัสสถานะ HTTP และรหัสข้อผิดพลาดที่ API ของ ReceiptRoller ตอบกลับ กรณีที่ควรรีทราย และแนวทางการเว้นช่วงการรีทราย
เอนด์พอยต์และการกำหนดเวอร์ชัน
อธิบายเบส URL ของ ReceiptRoller API, นโยบายการกำหนดเวอร์ชัน, ขั้นตอนการแจ้งยกเลิกการใช้งาน และวิธีตรวจสอบเวอร์ชันปัจจุบัน
วิธีใช้ Transactions API (ฟิลด์รวม POS + OMS)
Transactions API ของ ReceiptRoller เป็น API อ่านอย่างเดียวที่รวมยอดขายจากแคชเชียร์ (PosTransactions) และคำสั่งซื้อจากระบบจัดการการขาย (OmsOrders) ไว้ในฟีดเดียว เป็นจุดเริ่มต้นเมื่อต้องการแสดงรายการ "ธุรกรรมทั้งหมดของบัญชีธุรกิจ" ในแอป Android／iOS
วิธีใช้ Business Hours API
คู่มือ Business Hours API ของ ReceiptRoller (/api/v1/stores/{storeId}/business-hours) อธิบายการดึงและอัปเดตเวลาทำการรายวัน การลงทะเบียนวันเปิดทำการพิเศษ (หยุดกะทันหัน・เปลี่ยนเวลาทำการ) การตั้งค่าเวลาทำงานที่รับได้ของร้าน (เวลางานที่เป็นเพดานของการสร้างกะ) และการตัดสินว่าขณะนี้กำลังเปิดทำการอยู่หรือไม่
วิธีใช้ Staff API
คู่มือการทำ CRUD กับพนักงาน (สตาฟฟ์) ภายใต้บัญชีธุรกิจ ผ่าน Staff API ของ ReceiptRoller (/api/v1/staff) รองรับฟิลด์ที่เข้ากันได้กับ Square Team Member (ชื่อคานะ, การมอบหมายหลายงาน, โครงสร้างค่าจ้าง)
การจำกัดอัตราการเรียก (Rate Limit) และการควบคุมปริมาณ
อธิบายหน่วยของการจำกัดอัตราการเรียก API ของ ReceiptRoller ค่าเพดานแยกตามแพลน วิธีอ่านเฮดเดอร์การตอบกลับ และรูปแบบการเขียนโค้ดเพื่อไม่ให้ชน 429
คู่มือการยืนยันตัวตน API
อธิบายวิธีการยืนยันตัวตนของ ReceiptRoller API ด้วย OAuth 2.0 authorization code flow
วิธีใช้ Orders / OMS API
คู่มือการทำ CRUD กับคำสั่งซื้อภายใต้บัญชีธุรกิจ ผ่าน Orders / OMS API ของ ReceiptRoller (/api/v1/orders) รวบรวมการสร้าง・อัปเดต・เปลี่ยนสถานะ (ยืนยัน・กำลังดำเนินการ・ยกเลิก)・ลบคำสั่งซื้อ และโฟลว์สำหรับแอป Android／iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ In-Store Media Display API (Display API)
ภาพรวมของ In-Store Android Display API ของ ReceiptRoller (/api/v1/displays/*) และขั้นตอนการจับคู่・heartbeat・การดึงเพลย์ลิสต์・การรายงานผลการเล่น คู่มือเริ่มต้นสำหรับสร้างแอปเล่นมีเดียลูปบนเครื่อง Android แบบ POS ควบคู่หรือเครื่องไซเนจของร้าน
วิธีใช้ Store Information API
คู่มือ REST API สำหรับดึงและอัปเดตข้อมูลพื้นฐานของร้านค้า (ชื่อร้าน・ประเภทร้าน・ข้อมูลติดต่อ・ที่อยู่) สามารถสร้างหน้าจอแก้ไขข้อมูลร้านค้าจากไคลเอนต์ที่ยืนยันตัวตนด้วยโทเคน เช่น แอปพนักงาน ได้
วิธีใช้ Inventory / WMS API
คู่มือการนำ Inventory / WMS API ของ ReceiptRoller ไปใช้งาน อธิบายวิธีดูและปรับสต็อกแยกตามโลเคชัน การดึงประวัติการเคลื่อนไหว OAuth สโคปที่จำเป็น การสะท้อนอัตโนมัติเมื่อเชื่อมต่อ Shopify และการใช้งานผ่าน MCP tool (wms_get_stock / wms_adjust_stock ฯลฯ)
สารบัญความช่วยเหลือสำหรับนักพัฒนา
สารบัญความช่วยเหลือสำหรับนักพัฒนา ReceiptRoller รวบรวมตั้งแต่การสมัครเป็นนักพัฒนา การลงทะเบียนแอปพลิเคชัน การยืนยันตัวตน OAuth และสโคป คู่มือการพัฒนา (แอปวอลเล็ต, Webhook สำหรับร้านค้า, Survey API) คู่มือแยกตามโดเมนข้อมูล การใช้งานและความปลอดภัย คอมมูนิตี ไปจนถึงการแก้ปัญหา
วิธีใช้ Store App Content API (ประกาศ / เพจ / ข้อมูลการเปิดทำการ)
คู่มือการใช้ /api/v1/apps/{shopId}/* สำหรับดึงคอนเทนต์ (ประกาศ / เพจ / มานิเฟสต์ / ข้อมูลการเปิดทำการ / การตั้งค่าบัตรสมาชิก) อธิบายว่า shopId เป็นค่าเดียวกับ ID ของบัญชีธุรกิจ ความแตกต่างระหว่างคอนเทนต์ระดับบัญชีธุรกิจกับระดับร้านค้า และการจัดการเรื่องการยืนยันตัวตน
วิธีดู API reference และเอกสาร
อธิบายโครงสร้างและการเลือกใช้เอกสารสำหรับนักพัฒนาของ ReceiptRoller ครอบคลุมช่องทางเข้า 4 จุด ได้แก่ ศูนย์ช่วยเหลือนักพัฒนา・หน้ารวม API・API reference แบบ Swagger・คอมมิวนิตี้นักพัฒนา และวิธีดึงข้อมูลจำเพาะ OpenAPI (openapi/v1.json) สำหรับใช้กับผู้ช่วย AI และเครื่องมือสร้างโค้ด