วิธีใช้ Orders / OMS API
API
OAuth
การจัดการการขาย
OMS
คำสั่งซื้อ
CRUD
Android
iOS
วัตถุประสงค์ของคู่มือนี้
รวบรวมวิธีสร้าง・ดึง・อัปเดต・เปลี่ยนสถานะ (ยืนยัน/กำลังดำเนินการ/ยกเลิก/รับสินค้าที่ POS ร้าน)・ลบคำสั่งซื้อภายใต้บัญชีธุรกิจ โดยใช้ Orders / OMS API ของ ReceiptRoller คู่มือนี้เป็นจุดเริ่มต้นเมื่อต้องการรวมช่องทางการขายของร้าน เช่น รับออร์เดอร์ทางเว็บ・คำสั่งซื้อทางโทรศัพท์・การเชื่อมต่อมาร์เก็ตเพลส
เงื่อนไขเบื้องต้น
- ต้องได้แอกเซสโทเคนจาก OAuth 2.0 Authorization Code Flow แล้ว
- สโคปของแอปต้องรวม
store.orders.read(อ่าน)/store.orders.write(สร้าง・อัปเดต・ลบ・เปลี่ยนสถานะ) - ต้องทราบ ID ของบัญชีธุรกิจ (UUID) (การดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS)
- Base URL:
https://receiptroller.io
รายการเอนด์พอยต์
| เมธอด | พาธ | วัตถุประสงค์ | สโคปที่จำเป็น |
|---|---|---|---|
| GET | /api/v1/orders | รายการคำสั่งซื้อ (กรองด้วย status / channel / paymentStatus) | store.orders.read |
| GET | /api/v1/orders/{orderId} | รายละเอียด 1 คำสั่งซื้อ | store.orders.read |
| POST | /api/v1/orders | สร้างคำสั่งซื้อใหม่ | store.orders.write |
| PUT | /api/v1/orders/{orderId} | อัปเดตคำสั่งซื้อ (ลูกค้า・ที่อยู่・รายการ・จำนวนเงิน ฯลฯ) | store.orders.write |
| POST | /api/v1/orders/{orderId}/confirm | เปลี่ยนสถานะ: รอดำเนินการ → ยืนยันแล้ว | store.orders.write |
| POST | /api/v1/orders/{orderId}/process | เปลี่ยนสถานะ: ยืนยันแล้ว → กำลังดำเนินการ | store.orders.write |
| POST | /api/v1/orders/{orderId}/cancel | เปลี่ยนสถานะ: ยกเลิก | store.orders.write |
| POST | /api/v1/orders/{orderId}/fulfill-via-pos | เปลี่ยนสถานะ: รับสินค้าที่ POS ร้านเสร็จ (→ Delivered) | store.orders.write |
| DELETE | /api/v1/orders/{orderId} | ลบคำสั่งซื้อ | store.orders.write |
ประเภทสถานะคำสั่งซื้อ
| สถานะ | ภาษาไทย | คำอธิบาย |
|---|---|---|
Pending | รอดำเนินการ | รับคำสั่งซื้อแล้ว แต่ยังไม่ยืนยัน |
Confirmed | ยืนยันแล้ว | ฝั่งร้านค้ายืนยันคำสั่งซื้อแล้ว |
Processing | กำลังดำเนินการ | กำลังแพ็ก・เตรียมจัดส่ง |
Shipped | จัดส่งแล้ว | จัดส่งเสร็จ (อาจอัปเดตอัตโนมัติจากการเชื่อมต่อ WMS) |
Delivered | ส่งถึงแล้ว | จัดส่งถึงลูกค้าเสร็จ (การรับที่ POS ร้านก็เปลี่ยนมาที่นี่) |
Cancelled | ยกเลิก | ยกเลิกคำสั่งซื้อ |
Refunded | คืนเงินแล้ว | ดำเนินการคืนเงินเสร็จแล้ว |
1. ดึงรายการคำสั่งซื้อ
GET /api/v1/orders?organizationId={organizationId}&status=Pending
Authorization: Bearer {access_token}
พารามิเตอร์เควรี (ตัวเลือก)
status— กรองด้วยสถานะคำสั่งซื้อchannel— Web / POS / Phone / Manual / MarketplacepaymentStatus— Unpaid / Paid / Refunded / PartialRefund
เรสปอนส์คืออ็อบเจกต์คำสั่งซื้อในอาร์เรย์ orders ฟิลด์หลักของแต่ละอ็อบเจกต์กรุณาดูที่ "โครงสร้างของอ็อบเจกต์คำสั่งซื้อ" ด้านล่าง
2. ดึงรายละเอียด 1 คำสั่งซื้อ
GET /api/v1/orders/{orderId}?organizationId={organizationId}
Authorization: Bearer {access_token}
3. สร้างคำสั่งซื้อใหม่
…
วันที่เผยแพร่: 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