Skip to content

06.06 Response Fields ​


📌 At a Glance ​

รายการรายละเอียด
TopicResponse Fields
Difficulty⭐⭐ Intermediate
Reading Time10 นาที
TargetDeveloper, System Integrator

🎯 Learning Objectives ​

หลังจากศึกษาหัวข้อนี้แล้ว ผู้อ่านจะสามารถ

  • เข้าใจความหมายของทุก Field ใน Response
  • นำข้อมูลที่ได้รับไปใช้งานในระบบต้นทางได้อย่างถูกต้อง
  • เข้าใจความแตกต่างระหว่าง Single Response และ Bulk Response
  • ใช้ Order ID สำหรับติดตามสถานะสินค้าใน Shipment Tracking API

Overview ​

หลังจากระบบประมวลผลคำขอเรียบร้อย SISAHYGO จะส่งผลลัพธ์กลับในรูปแบบ JSON โดยแต่ละ Order จะมีข้อมูลสำคัญที่ใช้สำหรับอ้างอิงและติดตามรายการในระบบ

ไม่ว่าจะเป็น Single Order หรือ Bulk Orders ข้อมูลของแต่ละ Order จะใช้โครงสร้างเดียวกัน แตกต่างกันเพียงระดับบนสุดของ Response


Figure 6-6 Response Fields ​

Figure 6-6

Figure 6-6 แสดงรายละเอียดของข้อมูลที่ส่งกลับจาก Order Checking API พร้อมอธิบายความหมายและการนำไปใช้งานของแต่ละ Field


📌 Key Point

ค่า id ที่ SISAHYGO ส่งกลับ คือรหัสหลักของ Order ซึ่งจะใช้สำหรับเรียก Shipment Tracking API ใน Chapter 7


Response Fields ​

FieldTypeDescription
idIntegerรหัส Order ของ SISAHYGO
client_reference_noStringเลขอ้างอิงจากระบบต้นทาง
order_header_noStringเลขที่ใบรับส่งที่สร้างโดย SISAHYGO
order_statusStringสถานะเริ่มต้นของรายการ
successBooleanผลการสร้างรายการ
messageStringข้อความอธิบายผลการประมวลผล

Field Details ​

id ​

รหัสประจำรายการของ SISAHYGO

ตัวอย่าง

text
681126

ใช้สำหรับ

  • Shipment Tracking API
  • อ้างอิงกับฝ่ายปฏิบัติการ
  • อ้างอิงกับฝ่ายบริการลูกค้า
  • การค้นหารายการในระบบ SISAHYGO

client_reference_no ​

เลขอ้างอิงจากระบบต้นทาง

ตัวอย่าง

text
ERP-20260704-0001

ใช้จับคู่ข้อมูลระหว่าง

  • ERP
  • POS
  • WMS
  • SISAHYGO

order_header_no ​

เลขที่ใบรับส่งที่ระบบ SISAHYGO สร้าง

ตัวอย่าง

text
W202607040001

ใช้ในการอ้างอิงเอกสารภายในระบบ


order_status ​

สถานะเริ่มต้นของรายการ

ตัวอย่าง

text
checking

สถานะนี้จะแสดงว่ารายการกำลังรอการตรวจสอบก่อนเข้าสู่ขั้นตอนถัดไป


success ​

ผลการสร้างรายการ

ตัวอย่าง

text
true

หากเป็น

text
false

ระบบจะส่งรายละเอียดข้อผิดพลาดเพิ่มเติมใน Response


message ​

ข้อความสรุปผลการประมวลผล

ตัวอย่าง

text
Order created successfully.

หรือ

text
Validation failed.

Response Example ​

json
{
  "data": {
    "id": 681126,
    "client_reference_no": "ERP-20260704-0001",
    "order_header_no": "W202607040001",
    "order_status": "checking",
    "success": true,
    "message": "Order created successfully."
  }
}

Bulk Response ​

สำหรับ Bulk Orders

Field ของแต่ละ Order จะเหมือนกับ Single Response ทุกประการ

text
data[]

    ├── Order 1

    ├── Order 2

    ├── Order 3

    └── ...

Client ควรประมวลผลผลลัพธ์ของแต่ละ Order แยกจากกัน


Recommended Usage ​

FieldRecommendation
idเก็บไว้สำหรับ Shipment Tracking
client_reference_noใช้จับคู่กับ ERP
order_header_noใช้อ้างอิงเอกสาร
order_statusแสดงสถานะล่าสุด
successตรวจสอบผลการสร้างรายการ
messageแสดงข้อความให้ผู้ใช้งาน

Best Practices ​

  • เก็บ id และ client_reference_no ไว้คู่กัน
  • ใช้ id สำหรับเรียก Shipment Tracking API
  • ใช้ client_reference_no สำหรับค้นหาข้อมูลจากระบบต้นทาง
  • สำหรับ Bulk Orders ให้ประมวลผลแต่ละรายการแยกกัน
  • ตรวจสอบค่า success ก่อนดำเนินการขั้นตอนถัดไป

Related Sections ​

  • 06.05 Response Structure
  • 06.07 Error Handling
  • Chapter 7 Shipment Tracking API

Summary ​

Response ของ Order Checking API ถูกออกแบบให้มีโครงสร้างที่เรียบง่ายและสม่ำเสมอ โดยทุก Order จะมีข้อมูลสำคัญ ได้แก่ id, client_reference_no, order_header_no, order_status, success และ message ซึ่งสามารถนำไปใช้สำหรับติดตามสถานะสินค้า ตรวจสอบผลการสร้างรายการ และเชื่อมโยงข้อมูลกับระบบต้นทางได้อย่างมีประสิทธิภาพ


Next Step ​

➡️ 06.07 Error Handling

SISAHYGO API Integration Guide