Skip to content

08.03 Order Rejection Response Data Model


📌 At a Glance

รายการรายละเอียด
TopicOrder Rejection Response Data Model
EndpointGET /order-rejections
Difficulty⭐⭐ Intermediate
Reading Time8 นาที
TargetDeveloper

🎯 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

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

FieldTypeDescription
idIntegerรหัสรายการปฏิเสธในระบบ SISAHYGO
client_reference_noStringเลขอ้างอิงของเอกสารจาก Client System
reasonStringเหตุผลที่รายการถูกปฏิเสธ
rejected_atDateTimeวันที่และเวลาที่ปฏิเสธรายการ (ISO 8601)
order_header_idIntegerรหัส Order ที่เกี่ยวข้องในระบบ SISAHYGO

Meta Object

เมื่อเรียก API แบบรายการ (GET /order-rejections) ระบบจะส่งข้อมูล Pagination กลับมาด้วย

FieldTypeDescription
current_pageIntegerหน้าปัจจุบัน
per_pageIntegerจำนวนรายการต่อหน้า
totalIntegerจำนวนรายการทั้งหมด
last_pageIntegerจำนวนหน้าทั้งหมด

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

SISAHYGO API Integration Guide