API การสมัครรับข้อมูลหมายเลขการติดตามของการติดตามสถานะแบบรวมระบบขั้นสูง (AIV) ช่วยให้ผู้สมัครการติดตามสถานะแบบรวมระบบขั้นสูงสามารถเชื่อมโยงหมายเลขการติดตามกับโครงการเว็บฮุค AIV ได้โดยใช้ปลายทาง API ความสามารถในการเชื่อมโยงหมายเลขการติดตามรองรับวิธีประมวลผลสองวิธี:

• การเชื่อมโยงหมายเลขการติดตาม – แบบซิงโครนัส จะส่งคืนผลลัพธ์การประมวลผลภายในการตอบสนอง HTTP เดียวกัน โดยตัวเลือกนี้เหมาะที่สุดสำหรับแอปพลิเคชันที่ต้องการการยืนยันทันทีเมื่อเชื่อมโยงหมายเลขการติดตามจำนวนน้อย 
• การเชื่อมโยงหมายเลขการติดตาม – แบบอะซิงโครนัส จะส่งคำขอสำหรับการดำเนินการในพื้นหลังและส่งคืน ID งานที่สามารถใช้เพื่อเรียกดูสถานะและผลลัพธ์การประมวลผลในภายหลังได้ โดยตัวเลือกนี้เหมาะที่สุดสำหรับการประมวลผลหมายเลขการติดตามจำนวนมาก 

เลือกวิธีการประมวลผลที่ตรงกับข้อกำหนดด้านประสิทธิภาพและปริมาณงานของแอปพลิเคชันของคุณมากที่สุด

หมายเหตุ:

• คุณต้องมีสิทธิ์การเข้าถึงระดับผู้ดูแลระบบหรือผู้มีส่วนร่วมสำหรับโครงการการติดตามสถานะแบบรวมระบบขั้นสูงของคุณ
• สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการติดตามสถานะแบบรวมระบบขั้นสูงและคุณสมบัติต่างๆ โปรดไปที่หน้าเอกสารประกอบการติดตามสถานะแบบรวมระบบขั้นสูง

API การสมัครรับข้อมูลหมายเลขการติดตามสถานะแบบรวมระบบขั้นสูงมีประโยชน์ดังต่อไปนี้:

• คุณสามารถเชื่อมโยง อัปเดต และจัดการหมายเลขการติดตามของโครงการเว็บฮุคการติดตามสถานะแบบรวมระบบขั้นสูงของคุณได้อย่างง่ายดายโดยใช้ปลายทาง API
• เชื่อมโยงหมายเลขการติดตามหลายหมายเลขในคำขอ API เดียว แทนที่จะประมวลผลหมายเลขการติดตามแต่ละหมายเลขแยกกัน
• เลือกได้ระหว่างการประมวลผลแบบซิงโครนัสเพื่อให้ได้ผลลัพธ์ทันที หรือการประมวลผลแบบอะซิงโครนัสสำหรับการดำเนินการแบบกลุ่มขนาดใหญ่

ใช้ปลายทางต่อไปนี้เพื่อจัดการโครงการการติดตามสถานะแบบรวมระบบขั้นสูงของคุณ:

• การเชื่อมโยงหมายเลขการติดตาม – แบบซิงโครนัส: ช่วยให้คุณเชื่อมโยงหมายเลขการติดตามกับเว็บฮุคและรับสถานะการประมวลผลขั้นสุดท้ายภายในการตอบสนอง HTTP เดียวกัน
• การเชื่อมโยงหมายเลขการติดตาม – แบบอะซิงโครนัส: ช่วยให้คุณเชื่อมโยงหมายเลขการติดตามกับเว็บฮุคและใช้ jobId ที่ส่งคืนในภายหลังเพื่อตรวจสอบสถานะของงานแบบอะซิงโครนัสหรือดาวน์โหลดรายละเอียดโดยใช้ปลายทางที่เกี่ยวข้อง:    
  • สถานะงานหมายเลขการติดตาม
  • รายละเอียดงานหมายเลขการติดตาม

สามารถใช้งาน API เหล่านี้ได้จากภาพรวมโครงการการติดตามสถานะแบบรวมระบบขั้นสูงของคุณ

สามารถเข้าถึง API เหล่านี้ได้ผ่านภาพรวมโครงการของคุณตามที่แสดงในภาพถ่ายหน้าจอด้านบนเท่านั้น

ตารางต่อไปนี้สรุปความแตกต่างระหว่างปลายทางการเชื่อมโยงหมายเลขการติดตามแบบซิงโครนัสและแบบอะซิงโครนัส
 

ใช้ปลายทางแบบซิงโครนัสเมื่อคุณต้องการการยืนยันทันทีสำหรับหมายเลขการติดตามจำนวนน้อย ใช้ปลายทางแบบอะซิงโครนัสเมื่อประมวลผลหมายเลขการติดตามจำนวนมากที่ไม่ต้องการการตอบสนองทันที

ใช้ปลายทางนี้เพื่อเชื่อมโยงอย่างน้อยหนึ่งหมายเลขการติดตามกับโครงการเว็บฮุคการติดตามสถานะแบบรวมระบบขั้นสูงและรับผลลัพธ์การประมวลผลภายในการตอบสนอง HTTP เดียวกัน

ปลายทางนี้มีไว้สำหรับแอปพลิเคชันที่ต้องการการยืนยันทันทีและรองรับคำขอที่มีหมายเลขการติดตามได้สูงสุด 150 หมายเลข

ข้อมูลที่จำเป็น: 

• subscriptionID
• trackingNumber

ประโยชน์

ปลายทางแบบซิงโครนัสมีประโยชน์ดังต่อไปนี้:

• ได้ผลลัพธ์การประมวลผลทันที
• ได้รับข้อมูลความสำเร็จและความล้มเหลวโดยละเอียดในการตอบสนองเดียว
• รองรับหมายเลขการติดตามสูงสุด 150 หมายเลขต่อคำขอ
• ตรวจสอบคำขอและบังคับใช้กฎการดำเนินธุรกิจก่อนการประมวลผล
• รหัสข้อผิดพลาดที่เครื่องอ่านได้และข้อความแสดงข้อผิดพลาดโดยละเอียด
• ID การทำรายการสำหรับการตรวจสอบคำขอและการแก้ไขปัญหา

การเชื่อมโยงหมายเลขการติดตาม – ปลายทางแบบซิงโครนัสบังคับใช้กฎการตรวจสอบหลายข้อ รวมถึง:

• จำเป็นต้องมี subscriptionId ที่ถูกต้องและใช้งานได้
• อนุญาตให้มี subscriptionId เพียงหนึ่งรายการต่อคำขอ
• จำเป็นต้องมี trackingNumber
• ตรวจสอบให้แน่ใจว่าหมายเลขการติดตามเป็นไปตามข้อกำหนดรูปแบบของ FedEx รวมถึงขีดจำกัดหมายเลขการติดตามสูงสุดที่ 6 ถึง 22 หลัก

การตอบสนองข้อผิดพลาดมีโครงสร้างที่สม่ำเสมอ โดยมี errors[] ที่ประกอบด้วยรหัสและข้อความเพื่อให้ง่ายต่อการวิเคราะห์

"errors": [

{

"code": "ERROR.CODE",

"message": "ข้อความแสดงข้อผิดพลาดโดยละเอียด"

}

การเชื่อมโยงหมายเลขธุรกรรม – ปลายทางแบบซิงโครนัสอนุญาตให้มีการดำเนินการสำเร็จบางส่วนได้ เมื่อหมายเลขการติดตามบางหมายเลขล้มเหลว API แบบซิงโครนัสจะยังคงส่งคืน 200 OK และแสดงข้อความต่อไปนี้:

• failedTrackingNumbers
• ข้อความอธิบาย

{

"transactionId":

   "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",

   "output": {

      "failedTrackingNumbers":

         [ "XXXXX",

         " YYYYY"

         ],

      "message": "ไม่สามารถอัปโหลดหมายเลขการติดตามด้านล่างได้เนื่องจากข้อผิดพลาดในการตรวจสอบหรือระบบ"

      }

    }

โปรดดูส่วนกฎการดำเนินธุรกิจสำหรับรายละเอียดและกฎเพิ่มเติม

ใช้ปลายทางนี้เพื่อส่งหมายเลขการติดตามที่สมัครรับข้อมูลอย่างน้อยหนึ่งหมายเลขสำหรับการประมวลผลเบื้องหลัง

คำขอจะส่งคืน ID งานที่คุณสามารถใช้กับปลายทางสถานะงานหมายเลขการติดตามเพื่อตรวจสอบการประมวลผล และกับปลายทางรายละเอียดงานหมายเลขการติดตามเพื่อดาวน์โหลดผลลัพธ์การประมวลผลหลังจากงานเสร็จสมบูรณ์

ข้อมูลที่จำเป็น:

• การดำเนินการ
• รายละเอียดหมายเลขการติดตาม

คุณสามารถเชื่อมโยงหมายเลขการติดตามได้สูงสุด 1,000 หมายเลขในคำขอเดียว

ประโยชน์

ปลายทางแบบอะซิงโครนัสมีประโยชน์ดังต่อไปนี้:

• รองรับการส่งคำขอจำนวนมากได้สูงสุดถึง 1,000 หมายเลขการติดตาม
• อนุญาตให้ประมวลผลคำขอที่ใช้เวลานานในการทำงานเบื้องหลัง
• เปิดใช้งานการตรวจสอบสถานะงานและรายงานการประมวลผลที่ดาวน์โหลดได้
• ขจัดข้อกังวลเกี่ยวกับการหมดเวลาของคำขอสำหรับปริมาณงานขนาดใหญ่

ใช้ปลายทางนี้เพื่อรับสถานะของงานอะซิงโครนัส (คำขอหนึ่งรายการขึ้นไปที่ต่อเนื่องกันในคิว) หรือสถานะของงานทั้งหมดที่ส่ง

ข้อมูลที่จำเป็นสำหรับคำขอนี้ ได้แก่:

• jobID– ระบุ ID งานที่คุณต้องการเรียกดูสถานะ

หมายเหตุ: ID งานเป็นข้อมูลป้อนที่ไม่บังคับสำหรับปลายทางนี้ หากคุณไม่ระบุ ID งาน คุณจะได้รับสถานะของงานที่ส่งทั้งหมด

การตอบกลับที่เสร็จสมบูรณ์สำหรับคำขอนี้จะคืนค่า jobID สถานะงานปัจจุบัน และประทับเวลาการสร้างงานและการเสร็จสิ้นงาน การตอบกลับจะแสดงสถานะปัจจุบันของงาน นอกจากนี้ การตอบกลับยังจะมีข้อความประสบความสำเร็จ ข้อผิดพลาด หรือคำเตือนให้ผู้ใช้ดูและแก้ไขปัญหาตามความเหมาะสมอีกด้วย

• หากสถานะงานแสดงเป็นเสร็จสมบูรณ์ แสดงว่าหมายเลขการติดตามทั้งหมดได้รับการตรวจสอบและดำเนินการเสร็จเรียบร้อยแล้ว
  • สถานะเสร็จสมบูรณ์แสดงว่าหมายเลขการติดตามได้รับการตรวจสอบและดำเนินการเสร็จเรียบร้อยแล้ว ไม่ได้หมายความว่าหมายเลขการติดตามทั้งหมดได้ถูกเพิ่มไปยังโครงการการติดตามสถานะแบบรวมระบบขั้นสูงเรียบร้อยแล้ว
  • สำหรับงานที่มีหมายเลขการติดตามหลายหมายเลข สามารถถือว่าสถานะเสร็จสมบูรณ์ได้ แม้ว่าบางหมายเลขจะไม่สามารถเชื่อมโยงกับโครงการได้และบางหมายเลขเชื่อมโยงสำเร็จก็ตาม หากต้องการยืนยันสถานะของหมายเลขการติดตามแต่ละหมายเลขในคำขอเชื่อมโยงเดิม ให้ดาวน์โหลดรายงานแบบชุด

หมายเหตุ: หากสถานะงานแสดงเป็นล้มเหลว แสดงว่าเนื่องจากสาเหตุหลายประการหรือความล้มเหลวร้ายแรง ทำให้ไม่สามารถประมวลผลคำขอได้ และผู้ใช้จะต้องลองอีกครั้ง

ตารางต่อไปนี้แสดงสถานะงานและคำอธิบายที่เกี่ยวข้อง:

ใช้ปลายทางนี้เพื่อดาวน์โหลดรายงาน JSON สำหรับงานอะซิงโครนัสที่มีสถานะเสร็จสมบูรณ์

ข้อมูลที่เกี่ยวข้องกับคำขอนี้ได้แก่:

• jobID– ระบุ ID งานที่คุณต้องการเรียกดูสถานะ ต้องระบุ ID งานสำหรับปลายทางนี้

หมายเหตุ:

• คุณสามารถดาวน์โหลดรายงานของงานอะซิงโครนัสได้ครั้งละหนึ่งรายการเท่านั้น
• หากงานยังไม่เสร็จสมบูรณ์ และคุณพยายามดาวน์โหลดรายงาน ข้อความแสดงข้อผิดพลาดจะปรากฏขึ้น

การตอบกลับที่เสร็จสมบูรณ์สำหรับคำขอนี้จะมอบรายงานของงานให้คุณในรูปแบบ JSON

กฎการดำเนินธุรกิจทั่วไป

• ไม่มีข้อจำกัดเกี่ยวกับจำนวนหมายเลขการติดตามทั้งหมดที่สามารถเชื่อมโยงกับโครงการการติดตามสถานะแบบรวมระบบขั้นสูงได้
• หมายเลขการติดตามที่เชื่อมโยงกับโครงการการติดตามสถานะแบบรวมระบบขั้นสูงจะถูกตัดการเชื่อมโยง 40 วันหลังจากที่เชื่อมโยงกับเว็บฮุคสำเร็จ
• ข้อมูลการติดตามที่ปลอดภัย เช่น ที่อยู่ผู้รับ ลายเซ็นผู้รับ และข้อมูลการจัดส่งที่ละเอียดอ่อน จะไม่สามารถเข้าถึงได้ผ่าน API การสมัครรับข้อมูลหมายเลขการติดตาม

กฎการดำเนินธุรกิจสำหรับปลายทางแบบซิงโครนัส

• หมายเลขการติดตามสูงสุด 150 หมายเลขต่อคำขอ
• หมายเลขการติดตามทั้งหมดต้องใช้ subscriptionId เดียวกัน
• การสมัครรับข้อมูลเว็บฮุคการติดตามสถานะแบบรวมระบบขั้นสูงที่ระบุต้องถูกต้องและใช้งานได้
• คำขอจะถูกกำหนดให้หมดเวลาที่ 30 วินาที

กฎการดำเนินธุรกิจสำหรับปลายทางแบบอะซิงโครนัส

• หมายเลขการติดตามสูงสุด 1,000 หมายเลขต่อคำขอ
• สถานะงานและรายละเอียดงานสำหรับคำขอแบบอะซิงโครนัสจะถูกเก็บไว้เป็นเวลา 90 วันหลังจากที่หมายเลขการติดตามเชื่อมโยงกับเว็บฮุคการติดตามสถานะแบบรวมระบบขั้นสูงสำเร็จแล้ว