Appearance
08.03 Order Rejection Response Data Model
📌 At a Glance
| รายการ | รายละเอียด |
|---|---|
| Topic | Order Rejection Response Data Model |
| Endpoint | GET /order-rejections |
| Difficulty | ⭐⭐ Intermediate |
| Reading Time | 8 นาที |
| Target | Developer |
🎯 Learning Objectives
หลังจากศึกษาหัวข้อนี้แล้ว ผู้อ่านจะสามารถ
- เข้าใจโครงสร้าง Response ของ Order Rejection API
- อธิบายความหมายของแต่ละ Field ได้
- เชื่อมโยงข้อมูลกับระบบต้นทางโดยใช้
client_reference_no - นำข้อมูลไปแสดงผลและติดตามรายการที่ถูกปฏิเสธได้
Overview
Order Rejection API ส่งข้อมูลกลับในรูปแบบ JSON ซึ่งประกอบด้วยข้อมูลของรายการที่ถูกปฏิเสธ พร้อมเหตุผลและเวลาที่เกิดการปฏิเสธ
ข้อมูลดังกล่าวช่วยให้ Client System สามารถเชื่อมโยงกลับไปยังเอกสารต้นทาง และแจ้งให้ผู้ใช้งานแก้ไขข้อมูลก่อนส่งรายการใหม่เข้าสู่ระบบ
Figure 8-3 Order Rejection Response Data Model

Figure 8-3 แสดงโครงสร้างข้อมูลที่ตอบกลับจาก Order Rejection API ซึ่งประกอบด้วยข้อมูลของรายการที่ถูกปฏิเสธและข้อมูลสำหรับการแบ่งหน้า (Pagination)
Response Structure
text
Order Rejection
│
├── id
├── client_reference_no
├── reason
├── rejected_at
├── order_header_id
└── meta (List API Only)Root Fields
| Field | Type | Description |
|---|---|---|
| id | Integer | รหัสรายการปฏิเสธในระบบ SISAHYGO |
| client_reference_no | String | เลขอ้างอิงของเอกสารจาก Client System |
| reason | String | เหตุผลที่รายการถูกปฏิเสธ |
| rejected_at | DateTime | วันที่และเวลาที่ปฏิเสธรายการ (ISO 8601) |
| order_header_id | Integer | รหัส Order ที่เกี่ยวข้องในระบบ SISAHYGO |
Meta Object
เมื่อเรียก API แบบรายการ (GET /order-rejections) ระบบจะส่งข้อมูล Pagination กลับมาด้วย
| Field | Type | Description |
|---|---|---|
| current_page | Integer | หน้าปัจจุบัน |
| per_page | Integer | จำนวนรายการต่อหน้า |
| total | Integer | จำนวนรายการทั้งหมด |
| last_page | Integer | จำนวนหน้าทั้งหมด |
Response Relationship
text
Order Rejection
│
├── Rejection Information
└── Pagination (List API Only)Business Notes
client_reference_noเป็นข้อมูลสำคัญที่ใช้เชื่อมโยงกลับไปยังเอกสารในระบบต้นทางreasonเป็นข้อความที่เจ้าหน้าที่ SISAHYGO บันทึกไว้เพื่ออธิบายสาเหตุของการปฏิเสธrejected_atแสดงวันที่และเวลาที่เกิดเหตุการณ์จริงorder_header_idใช้เป็นข้อมูลอ้างอิงภายในระบบ SISAHYGO
Implementation Notes
- ใช้
client_reference_noเป็น Primary Reference ในฝั่ง Client System - แสดง
reasonให้ผู้ใช้งานเข้าใจว่าต้องแก้ไขข้อมูลส่วนใด - จัดเก็บ
rejected_atเพื่อใช้เป็นประวัติการดำเนินงาน - ใช้
order_header_idเมื่อต้องประสานงานกับทีมงาน SISAHYGO
Best Practices
- บันทึก Response ทุกครั้งที่เรียก API
- ใช้
client_reference_noเชื่อมโยงกับ ERP หรือระบบต้นทาง - แสดงเหตุผลการปฏิเสธอย่างชัดเจนแก่ผู้ใช้งาน
- จัดเก็บประวัติการปฏิเสธเพื่อใช้ในการวิเคราะห์และปรับปรุงคุณภาพข้อมูล
Related APIs
- POST /order-checkings
- GET /order-rejections
- GET /order-rejections/
Summary
Order Rejection Response Data Model ได้รับการออกแบบให้เรียบง่ายและเหมาะสำหรับการเชื่อมโยงข้อมูลกับระบบต้นทาง โดยใช้ client_reference_no เป็นข้อมูลอ้างอิงหลัก และส่งข้อมูลเหตุผลการปฏิเสธ (reason) พร้อมเวลาที่เกิดเหตุการณ์ (rejected_at) เพื่อให้ Client System สามารถแจ้งผู้ใช้งาน แก้ไขข้อมูล และส่งรายการใหม่เข้าสู่ SISAHYGO ได้อย่างถูกต้อง
Next Step
➡️ 08.04 Order Rejection Workflow
