Skip to content

06.01 Order Checking API Overview ​


📌 At a Glance ​

รายการรายละเอียด
TopicOrder Checking API Overview
Difficulty⭐ Beginner
Reading Time8 นาที
TargetDeveloper, System Integrator
API Versionv1.1
EndpointPOST /order-checkings

🎯 Learning Objectives ​

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

  • เข้าใจวัตถุประสงค์ของ Order Checking API
  • เข้าใจรูปแบบการส่งข้อมูลทั้งแบบ Single และ Bulk
  • เลือกแนวทางการใช้งาน API ให้เหมาะสมกับระบบของตน
  • เข้าใจลำดับการทำงานของกระบวนการตรวจรับสินค้าใน SISAHYGO

Overview ​

Order Checking API เป็น API หลักสำหรับรับข้อมูลรายการตรวจรับสินค้าจากระบบภายนอกเข้าสู่ SISAHYGO โดยรองรับการส่งข้อมูลได้ทั้ง แบบรายการเดียว (Single Order) และ แบบหลายรายการพร้อมกัน (Bulk Orders) ผ่าน Endpoint เดียวกัน

เมื่อระบบได้รับข้อมูล จะดำเนินการตรวจสอบความถูกต้องของข้อมูล (Validation) และสร้างรายการตรวจรับสินค้าเข้าสู่ระบบ โดยกำหนดสถานะเริ่มต้นเป็น checking เพื่อรอการตรวจสอบและยืนยันโดยเจ้าหน้าที่ SISAHYGO

การออกแบบให้รองรับทั้ง Single และ Bulk ช่วยให้ระบบสามารถเชื่อมต่อกับ ERP, POS, WMS และระบบงานอื่น ๆ ได้อย่างยืดหยุ่น รองรับทั้งการทำงานแบบ Real-time และการส่งข้อมูลเป็นชุด (Batch Processing)


Figure 6-1 Order Checking API Overview ​

Figure 6-1

Figure 6-1 แสดงภาพรวมของกระบวนการส่งข้อมูลรายการตรวจรับสินค้าเข้าสู่ SISAHYGO API ทั้งแบบ Single Order และ Bulk Orders ผ่าน Endpoint เดียวกัน


Supported Operations ​

Order Checking API รองรับการทำงานดังต่อไปนี้

OperationDescription
Single Orderส่งรายการตรวจรับสินค้าครั้งละ 1 รายการ
Bulk Ordersส่งหลายรายการใน Request เดียว
Validationตรวจสอบความถูกต้องของข้อมูลทุก Order
Responseส่งผลลัพธ์กลับสำหรับแต่ละรายการ

Typical Integration Flow ​

text
Business Application

        │

        ├──────────────┐

        │              │

        ▼              ▼

 Single Order     Bulk Orders

        │              │

        └──────┬───────┘

               ▼

POST /order-checkings

               ▼

Validate Request

               ▼

Create Order Checking

               ▼

Return Response

When to Use Single Order ​

เหมาะสำหรับ

  • การสร้างรายการจากหน้าจอของผู้ใช้งาน
  • การเชื่อมต่อแบบ Real-time
  • ระบบ POS
  • การส่งข้อมูลทันทีเมื่อมีรายการใหม่

When to Use Bulk Orders ​

เหมาะสำหรับ

  • การนำเข้าข้อมูลจาก ERP
  • Batch Processing
  • การย้ายข้อมูลจากระบบเดิม
  • การส่งข้อมูลจำนวนมากในช่วงเวลาที่กำหนด
  • การลดจำนวน API Calls

Benefits of Bulk Processing ​

การส่งข้อมูลแบบ Bulk มีข้อดีดังนี้

  • ลดจำนวนการเรียก API
  • ลด Network Overhead
  • เพิ่มความเร็วในการประมวลผล
  • รองรับข้อมูลจำนวนมากได้อย่างมีประสิทธิภาพ
  • ลดภาระของ Client และ API Server

Processing Workflow ​

สำหรับทุก Request ไม่ว่าจะเป็น Single หรือ Bulk ระบบจะดำเนินการตามลำดับดังนี้

  1. รับ Request จาก Client
  2. ตรวจสอบ API Key และสิทธิ์การใช้งาน
  3. ตรวจสอบโครงสร้างข้อมูล (Validation)
  4. ตรวจสอบข้อมูลอ้างอิง เช่น ผู้รับสินค้า สินค้า และหน่วยนับ
  5. สร้างรายการตรวจรับสินค้า
  6. กำหนดสถานะเริ่มต้นเป็น checking
  7. ส่งผลลัพธ์กลับไปยัง Client

Key Features ​

FeatureSupported
Single Order✅
Bulk Orders✅
JSON Request✅
JSON Response✅
Validation✅
API Key Authentication✅
Error Handling✅

Best Practices ​

เพื่อให้ระบบทำงานได้อย่างมีประสิทธิภาพ แนะนำให้

  • ใช้ Single Order สำหรับงานที่ต้องการตอบสนองแบบ Real-time
  • ใช้ Bulk Orders สำหรับการส่งข้อมูลจำนวนมาก
  • ตรวจสอบข้อมูลจาก Master Data ก่อนส่ง Request
  • ใช้ client_reference_no ที่ไม่ซ้ำกันในแต่ละ Order
  • ตรวจสอบ Response ของทุก Order ก่อนดำเนินการขั้นตอนถัดไป

Related Sections ​

  • 06.02 API Endpoint
  • 06.03 Request Structure
  • 06.04 Request Examples
  • 06.05 Response Structure

Summary ​

Order Checking API เป็นจุดเริ่มต้นของกระบวนการรับข้อมูลเข้าสู่ SISAHYGO โดยรองรับการส่งข้อมูลทั้งแบบ Single Order และ Bulk Orders ผ่าน Endpoint เดียวกัน ช่วยให้ระบบสามารถรองรับการทำงานได้ทั้งแบบ Real-time และ Batch Processing พร้อมตรวจสอบความถูกต้องของข้อมูลก่อนสร้างรายการตรวจรับสินค้าและส่งผลลัพธ์กลับไปยังระบบต้นทางอย่างเป็นมาตรฐาน


Next Step ​

➡️ 06.02 API Endpoint

SISAHYGO API Integration Guide