ดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS
คู่มือสรุปขั้นตอนการดึงรายการบัญชีธุรกิจที่ผู้ใช้สังกัด ร้านค้าภายใต้บัญชีนั้น และเครื่อง POS ของแต่ละร้านผ่าน REST API จากแอปมือถือ／แอปเซิร์ฟเวอร์ของ ReceiptRoller
การแจ้งวัตถุประสงค์การใช้งาน・ปลายทางเชื่อมต่อ（POS／EC／การวิเคราะห์ ฯลฯ）
อธิบายความหมาย, วิธีเลือก, ข้อควรระวังเมื่อเปลี่ยนแปลง ของ "วัตถุประสงค์การใช้งาน" และ "หมวดหมู่ปลายทางเชื่อมต่อ"（POS／EC／การวิเคราะห์／CRM／OMS／WMS／SNS／อื่นๆ）ที่แจ้งตอนลงทะเบียนแอปในพอร์ทัลนักพัฒนาของ ReceiptRoller และความเกี่ยวข้องกับการตรวจสอบสโคปตระกูล User
CrmCustomerDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ CrmCustomerDto ซึ่งเป็นมาสเตอร์ลูกค้าของ ReceiptRoller ข้อมูลลูกค้าที่ดึงมาจาก POS（スマレジ・Square）จะถูกทำให้เป็นรูปแบบมาตรฐานตามโมเดลนี้
วิธีใช้ Transactions API (ฟิลด์รวม POS + OMS)
Transactions API ของ ReceiptRoller เป็น API อ่านอย่างเดียวที่รวมยอดขายจากแคชเชียร์ (PosTransactions) และคำสั่งซื้อจากระบบจัดการการขาย (OmsOrders) ไว้ในฟีดเดียว เป็นจุดเริ่มต้นเมื่อต้องการแสดงรายการ "ธุรกรรมทั้งหมดของบัญชีธุรกิจ" ในแอป Android／iOS
ProductDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ ProductDto ซึ่งเป็นมาสเตอร์สินค้า（PIM）ของ ReceiptRoller สรุปโครงสร้างต่าง ๆ เช่น การซิงก์แคตตาล็อกสินค้าจาก POS（Square）ต้นทุน・ราคารายร้าน・ตัวเลือกย่อย・สินค้าพรีออเดอร์
StaffDto รีเฟอเรนซ์
อธิบายฟิลด์ทั้งหมดของ StaffDto ซึ่งเป็นมาสเตอร์สตาฟ（พนักงาน）ของ ReceiptRoller สรุปโครงสร้างต่าง ๆ เช่น การผูกกับ POS（Square Team / スマレジ）การอิงร้านค้า และรูปแบบการจ้างงาน
PosTransactionDto สเปก — รีเฟอเรนซ์ฟิลด์ของข้อมูลธุรกรรม
อธิบายฟิลด์ทั้งหมดของ PosTransactionDto ซึ่งเป็นโมเดลมาตรฐานของข้อมูลธุรกรรมที่ ReceiptRoller จัดการ เป็นรีเฟอเรนซ์สำหรับนักพัฒนาและผู้ดูแลการเชื่อมต่อระบบภายนอก โดยสรุปชื่อฟิลด์・ชนิด・ความหมาย・วิธีที่แต่ละผู้ให้บริการ POS เติมค่าในแต่ละหมวด（ตัวระบุ・วันเวลา・จำนวนเงิน・รายการ・การชำระเงิน・สตาฟ・สถานะ・การเชื่อม CRM）ถูกอ้างอิงจากบทความแมปปิงของทั้ง スマレジ・Square
วิธีใช้ API ยอดขาย (Sales API)
คู่มือสรุปภาพรวมของ API ยอดขายของ ReceiptRoller (/api/v1/sales/*) และวิธีการกรองตามบัญชีธุรกิจ・ร้านค้า・เครื่อง POS・ช่วงเวลา ครอบคลุมโครงสร้างการตอบกลับจริง (KpiValue แบบซ้อน) รวมถึง averageTicket และอายุโทเคน (8 ชั่วโมง) เป็นคู่มือเริ่มต้นสำหรับสร้างแดชบอร์ดยอดขายในแอปมือถือ Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ In-Store Media Display API (Display API)
ภาพรวมของ In-Store Android Display API ของ ReceiptRoller (/api/v1/displays/*) และขั้นตอนการจับคู่・heartbeat・การดึงเพลย์ลิสต์・การรายงานผลการเล่น คู่มือเริ่มต้นสำหรับสร้างแอปเล่นมีเดียลูปบนเครื่อง Android แบบ POS ควบคู่หรือเครื่องไซเนจของร้าน
ข้อมูลหลักของสินค้า (PIM) และหมวดหมู่
อธิบายโครงสร้างข้อมูลหลักของสินค้า (PIM) หมวดหมู่ และวาเรียนต์ของ ReceiptRoller การดำเนินการแบบ CRUD การจัดการ SKU และรูปแบบการซิงค์กับ EC
วิธีใช้ Orders / OMS API
คู่มือการทำ CRUD กับคำสั่งซื้อภายใต้บัญชีธุรกิจ ผ่าน Orders / OMS API ของ ReceiptRoller (/api/v1/orders) รวบรวมการสร้าง・อัปเดต・เปลี่ยนสถานะ (ยืนยัน・กำลังดำเนินการ・ยกเลิก)・ลบคำสั่งซื้อ และโฟลว์สำหรับแอป Android／iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
วิธีใช้ Store Information API
คู่มือ REST API สำหรับดึงและอัปเดตข้อมูลพื้นฐานของร้านค้า (ชื่อร้าน・ประเภทร้าน・ข้อมูลติดต่อ・ที่อยู่) สามารถสร้างหน้าจอแก้ไขข้อมูลร้านค้าจากไคลเอนต์ที่ยืนยันตัวตนด้วยโทเคน เช่น แอปพนักงาน ได้
การเชื่อมต่อข้อมูลการซื้อและใบเสร็จ
อธิบายโครงสร้างข้อมูลการซื้อและใบเสร็จที่ ReceiptRoller จัดการ วิธีการดึงข้อมูล สโคปที่เกี่ยวข้อง Webhook และกรณีการใช้งานที่พบบ่อย
สารบัญความช่วยเหลือสำหรับนักพัฒนา
สารบัญความช่วยเหลือสำหรับนักพัฒนา ReceiptRoller รวบรวมตั้งแต่การสมัครเป็นนักพัฒนา การลงทะเบียนแอปพลิเคชัน การยืนยันตัวตน OAuth และสโคป คู่มือการพัฒนา (แอปวอลเล็ต, Webhook สำหรับร้านค้า, Survey API) คู่มือแยกตามโดเมนข้อมูล การใช้งานและความปลอดภัย คอมมูนิตี ไปจนถึงการแก้ปัญหา
วิธีใช้ Staff API
คู่มือการทำ CRUD กับพนักงาน (สตาฟฟ์) ภายใต้บัญชีธุรกิจ ผ่าน Staff API ของ ReceiptRoller (/api/v1/staff) รองรับฟิลด์ที่เข้ากันได้กับ Square Team Member (ชื่อคานะ, การมอบหมายหลายงาน, โครงสร้างค่าจ้าง)
ข้อมูลด้านต่าง ๆ ที่ใช้ได้
อธิบายข้อมูลด้านต่าง ๆ ที่ดึงได้จากพอร์ทัลนักพัฒนาของ ReceiptRoller เป็นรายการ รวบรวมเนื้อหาที่อยู่ในแต่ละด้าน วิธีดึง และ scope ที่จำเป็น ครอบคลุมการซื้อ・สินค้า・สินค้าคงคลัง・คำสั่งซื้อ・ลูกค้า・คูปอง・SNS・โฆษณา・ข้อมูลผู้ใช้ส่วนบุคคล ฯลฯ
วิธีใช้ API จัดการสินค้า (Products API)
คู่มือสำหรับการดำเนินการ CRUD กับสินค้าภายใต้บัญชีธุรกิจผ่าน API จัดการสินค้าของ ReceiptRoller (/api/v1/products) เป็นบทความเริ่มต้นสำหรับการอ่านและเขียน PIM (มาสเตอร์สินค้า) จากแอป Android/iOS หรือการเชื่อมต่อฝั่งเซิร์ฟเวอร์
สร้างแอปใหม่
อธิบายขั้นตอนที่เป็นรูปธรรมในการลงทะเบียนแอปใหม่ (OAuth client) ในพอร์ทัลนักพัฒนาของ ReceiptRoller ครอบคลุมตั้งแต่รายการที่ต้องกรอก การ validate การแสดง client secret หลังสร้าง ไปจนถึงข้อผิดพลาดที่พบบ่อย
สิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนา
ภาพรวมของสิ่งที่ทำได้ด้วยพอร์ทัลนักพัฒนาของ ReceiptRoller ผสมผสานการดึงและจัดการข้อมูลผ่าน REST API กับการรับอีเวนต์แบบเรียลไทม์ผ่าน Webhook เพื่อเชื่อมต่อข้อมูลร้านค้าและผู้ใช้จากระบบภายนอก
วิธีใช้ Store App Content API (ประกาศ / เพจ / ข้อมูลการเปิดทำการ)
คู่มือการใช้ /api/v1/apps/{shopId}/* สำหรับดึงคอนเทนต์ (ประกาศ / เพจ / มานิเฟสต์ / ข้อมูลการเปิดทำการ / การตั้งค่าบัตรสมาชิก) อธิบายว่า shopId เป็นค่าเดียวกับ ID ของบัญชีธุรกิจ ความแตกต่างระหว่างคอนเทนต์ระดับบัญชีธุรกิจกับระดับร้านค้า และการจัดการเรื่องการยืนยันตัวตน