Orders API v1

ระบบรับออเดอร์ของร้านออนไลน์ สร้าง ดู อัปเดตสถานะ และแจ้งเตือนเข้า LINE ของร้านทันที

A small REST API for taking orders, tracking their status and notifying the shop on LINE.

Base URL
https://api.example.test
Auth
Bearer token (ไม่ต้องใช้ในเดโม)
Format
JSON, UTF-8
POST
⌘/Ctrl + Enter เพื่อส่ง
Response

กด Send เพื่อยิงคำขอ ผลลัพธ์จะแสดงที่นี่

curl
curl -X POST "https://api.example.test/orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"customer":"คุณนิด (ตัวอย่าง)","items":[{"sku":"NP-01","name":"น้ำพริกหนุ่ม","qty":2,"price":120}]}'

ข้อมูลตัวอย่างตอนนี้มี 8 ออเดอร์ เก็บไว้ในเบราว์เซอร์นี้เท่านั้น

อ้างอิง

Order

หน้าตาข้อมูลออเดอร์ที่ทุก endpoint ส่งกลับมา

idstring
รหัสออเดอร์ ระบบออกให้อัตโนมัติ เช่น ORD-1009
customerstring
ชื่อลูกค้า (บังคับ)
itemsOrderItem[]
รายการสินค้า แต่ละรายการมี sku, name, qty, price
totalnumber
ยอดรวมเป็นบาท คำนวณจาก qty × price ให้เอง
statusOrderStatus
pending, paid, shipped หรือ cancelled
createdAtstring
เวลาที่สร้าง รูปแบบ ISO 8601

ลำดับสถานะ

  1. pending
  2. paid
  3. shipped

เปลี่ยนเป็น cancelled ได้ทุกเมื่อ แต่เมื่อยกเลิกแล้วจะเปลี่ยนกลับไม่ได้ (409)

รหัสสถานะที่อาจได้รับ

ทุก error ส่งกลับเป็น JSON ที่มีช่อง error อธิบายเสมอ

200 OK
สำเร็จ ได้ข้อมูลกลับมาตามที่ขอ
201 Created
สร้างออเดอร์ใหม่เรียบร้อย
400 Bad Request
อ่าน JSON ที่ส่งมาไม่ได้
404 Not Found
ไม่พบออเดอร์หรือเส้นทางนี้
405 Method Not Allowed
เส้นทางนี้ไม่รองรับเมธอดที่ใช้
409 Conflict
ออเดอร์ที่ยกเลิกแล้วเปลี่ยนสถานะไม่ได้
422 Unprocessable Entity
ข้อมูลไม่ครบหรือไม่ถูกต้อง มี details บอกว่าช่องไหนผิด
ร้านดีเป็นร้านสมมติ ทุกคำขอในหน้านี้ทำงานในเบราว์เซอร์ของคุณ ไม่มีข้อมูลถูกส่งออกไปที่ใด

Web app · Basic · ฿5,900

Demo · fictional business

Order this package