Appearance
06.05 Response Structure
📌 At a Glance
| รายการ | รายละเอียด |
|---|---|
| Topic | Response Structure |
| Difficulty | ⭐⭐ Intermediate |
| Reading Time | 10 นาที |
| Target | Developer, System Integrator |
| HTTP Method | POST |
🎯 Learning Objectives
หลังจากศึกษาหัวข้อนี้แล้ว ผู้อ่านจะสามารถ
- เข้าใจโครงสร้าง Response ของ Order Checking API
- เข้าใจความแตกต่างระหว่าง Single Response และ Bulk Response
- นำผลลัพธ์จาก API ไปประมวลผลในระบบต้นทางได้อย่างถูกต้อง
- ตรวจสอบผลการสร้าง Order แต่ละรายการได้
Overview
หลังจาก SISAHYGO ประมวลผลคำขอเรียบร้อย ระบบจะส่งผลลัพธ์กลับในรูปแบบ JSON โดยโครงสร้างของ Response จะขึ้นอยู่กับรูปแบบของ Request
- หากส่ง Single Order ระบบจะตอบกลับผลลัพธ์ของ Order เพียงรายการเดียว
- หากส่ง Bulk Orders ระบบจะตอบกลับผลลัพธ์ของทุก Order ภายใน Request เดียว
Response ถูกออกแบบให้สามารถตรวจสอบผลลัพธ์ของแต่ละ Order ได้อย่างชัดเจน เพื่อให้ Client System สามารถอัปเดตสถานะหรือจัดการข้อผิดพลาดได้อย่างถูกต้อง
Figure 6-5 Response Structure

Figure 6-5 เปรียบเทียบโครงสร้าง Response สำหรับ Single Order และ Bulk Orders โดยแสดงให้เห็นว่าทั้งสองรูปแบบใช้ข้อมูลผลลัพธ์ของแต่ละ Order เหมือนกัน แตกต่างกันเพียงระดับบนสุดของ JSON
📌 Key Point
ทุก Order ที่สร้างสำเร็จจะได้รับ Order ID (
id) ของ SISAHYGO สำหรับใช้เป็นรหัสอ้างอิงในการติดตามสถานะสินค้าใน Shipment Tracking API
Response Types
| Response Type | Description |
|---|---|
| Single Response | ผลลัพธ์ของ Order เดียว |
| Bulk Response | ผลลัพธ์ของหลาย Order |
Single Response Structure
text
Response
└── data
├── id
├── client_reference_no
├── order_header_no
├── order_status
└── messageBulk Response Structure
text
Response
└── data[]
├── Order 1
│ ├── id
│ ├── client_reference_no
│ ├── order_header_no
│ ├── order_status
│ └── message
│
├── Order 2
│
└── Order nResponse Comparison
| Feature | Single | Bulk |
|---|---|---|
| HTTP Status | ✅ | ✅ |
| JSON Response | Object | Array |
| Number of Results | 1 | หลายรายการ |
| Order ID | ✅ | ✅ |
| Client Reference | ✅ | ✅ |
| Order Status | ✅ | ✅ |
Typical Response Flow
text
Client Request
│
▼
SISAHYGO API
│
▼
Validate
│
▼
Create Orders
│
▼
Generate Response
│
▼
Return JSONOrder Identifier
เมื่อสร้างรายการสำเร็จ ระบบจะส่งข้อมูลสำคัญกลับ เช่น
| Field | Description |
|---|---|
| id | รหัส Order ของ SISAHYGO |
| client_reference_no | เลขอ้างอิงจากระบบต้นทาง |
| order_header_no | เลขที่ใบรับส่ง |
| order_status | สถานะเริ่มต้น (checking) |
โดย id เป็นรหัสหลักที่ใช้สำหรับเรียก Shipment Tracking API ในบทที่ 7
Best Practices
- บันทึก
idที่ได้รับจาก SISAHYGO ทุกครั้ง - จับคู่
idกับclient_reference_noในฐานข้อมูลของระบบต้นทาง - ตรวจสอบ Response ของทุก Order ก่อนอัปเดตสถานะในระบบ
- สำหรับ Bulk Orders ควรประมวลผลผลลัพธ์ของแต่ละ Order แยกจากกัน
Related Sections
- 06.04 Request Examples
- 06.06 Response Fields
- Chapter 7 Shipment Tracking API
Summary
Order Checking API ส่งผลลัพธ์กลับในรูปแบบ JSON ที่รองรับทั้ง Single Response และ Bulk Response โดยทุก Order ที่สร้างสำเร็จจะได้รับ Order ID (id) ของ SISAHYGO ซึ่งใช้เป็นรหัสอ้างอิงหลักในการติดตามสถานะสินค้าในระบบ Shipment Tracking API การจัดเก็บและเชื่อมโยง id กับ client_reference_no อย่างถูกต้อง จะช่วยให้การติดตามสินค้าและการตรวจสอบข้อมูลในระบบต้นทางเป็นไปอย่างมีประสิทธิภาพ
Next Step
➡️ 06.06 Response Fields
