# Webhook
*** ## การลงทะเบียน คุณสามารถลงทะเบียนเว็บฮุกได้ที่ **`การตั้งค่า`** **>** **`การเชื่อมต่อและ API`** ในทีม BoxHero ของคุณ ## พฤติกรรมการส่งและการลองใหม่ เมื่อเกิดเหตุการณ์ BoxHero จะส่งคำขอ HTTP `POST` ไปยังปลายทางเว็บฮุกที่คุณลงทะเบียนไว้ เนื้อหาของคำขอจะมีเพย์โหลด JSON ที่อธิบายเหตุการณ์นั้น * หากเซิร์ฟเวอร์ตอบกลับด้วย **HTTP 200 OK**เหตุการณ์นั้นจะถือว่าส่งสำเร็จ * หากเซิร์ฟเวอร์ตอบกลับด้วย **รหัสสถานะใดๆ ที่ไม่ใช่ 200**BoxHero จะถือว่าเป็นความล้มเหลวชั่วคราวและจะลองส่งซ้ำได้สูงสุด 3 ครั้ง ## โครงสร้างเพย์โหลดของเว็บฮุก เหตุการณ์เว็บฮุกทั้งหมดจะถูกส่งพร้อมโครงสร้าง JSON ต่อไปนี้ในเนื้อหาของคำขอ: ```json { "id": "1234", // รหัสเฉพาะของเหตุการณ์ "topic": "txs/new", // หัวข้อของเหตุการณ์ "version": 1, // เวอร์ชันสคีมาของเพย์โหลด "payload": { // ข้อมูลเฉพาะของเหตุการณ์ ... }, "created_time": "2025-08-06T09:20:48.623Z" // เวลาที่เกิดเหตุการณ์ (ISO 8601) } ``` *** ## ลำดับของเหตุการณ์ BoxHero **ไม่** รับประกันลำดับการส่งเหตุการณ์ ตัวอย่างเช่น เหตุการณ์ `item/new` อาจมาถึงหลังจากเหตุการณ์ `item/delete` สำหรับรายการเดียวกัน แผน `created_time` ฟิลด์ในเพย์โหลดของเหตุการณ์แสดงเวลาจริงของเหตุการณ์นั้น ควรใช้ตรรกะแบบ idempotent และทนต่อการสลับลำดับในตัวจัดการเว็บฮุกของคุณเพื่อรองรับเหตุการณ์อย่างน่าเชื่อถือ ## หัวข้อของเหตุการณ์ {% hint style="info" %} หากคุณต้องการการรองรับหัวข้อเหตุการณ์เพิ่มเติม โปรดติดต่อ [ฝ่ายสนับสนุน](https://www.boxhero.io/docs/documentation/th/resources/contact). {% endhint %} ### `txs/new` ถูกเรียกเมื่อมีธุรกรรมสินค้าคงคลังเกิดขึ้น (รับเข้า / จ่ายออก / ปรับสต็อก / ย้ายสต็อก) {% hint style="warning" %} **หมายเหตุ:** เหตุการณ์นี้ *ไม่* ถูกเรียกสำหรับการปรับที่สร้างผ่านการแก้ไขจำนวนมากหรือการนำเข้า (เช่น เมื่อเพิ่มหรืออัปเดตรายการผ่าน Excel) {% endhint %}
ฟิลด์จำเป็นคำอธิบายจำเป็นหรือไม่คำอธิบายโหมดทีม
idtrueรหัสเฉพาะของธุรกรรมtrueรหัสเฉพาะของประวัติทั้งหมด
typetrueประเภทของธุรกรรม
(in, out, adjust, move)		true

ประเภทของประวัติ

  • รับเข้า : in
  • จ่ายออก : out
  • ปรับ : adjust
  • ย้าย : move
ทั้งหมด
คู่ค้าfalseคู่ค้าfalse
partner.idfalseรหัสเฉพาะของคู่ค้าfalse
partner.namefalseชื่อของคู่ค้าfalse
partner.deletedfalseระบุว่าคู่ค้าถูกลบหรือไม่false
from_locationfalseตำแหน่งต้นทางfalse
from_location.idfalseรหัสเฉพาะของตำแหน่งต้นทางfalse
from_location.namefalseชื่อตำแหน่งต้นทางfalse
from_location.deletedfalseระบุว่าตำแหน่งต้นทางถูกลบหรือไม่false
to_locationtrueตำแหน่งปลายทางfalse
to_location.idtrueรหัสเฉพาะของตำแหน่งปลายทางfalse
to_location.nametrueชื่อตำแหน่งปลายทางfalse
to_location.deletedtrueระบุว่าตำแหน่งปลายทางถูกลบหรือไม่false
itemstrueรายการสินค้าในธุรกรรมtrueรายการตามสินค้าในประวัติทุกโหมด
items.idtrueรหัสเฉพาะของรายการสินค้าtrueรหัสเฉพาะของสินค้าทุกโหมด
items.nametrueชื่อสินค้าtrueชื่อของสินค้าทุกโหมด
items.quantitytrueการเปลี่ยนแปลงสต็อกจากการรับเข้า/จ่ายออก/ปรับ/ย้ายtrueจำนวนรับเข้า/จ่ายออก/ปรับ/ย้ายของสินค้านั้นทุกโหมด
items.deletedtrueระบุว่าสินค้าถูกลบหรือไม่trueระบุว่าสินค้าถูกลบหรือไม่
items.from_location_new_stock_levelfalseระดับสต็อกที่ตำแหน่งต้นทางหลังจากทำธุรกรรมfalse
items.to_location_new_stock_leveltrueระดับสต็อกที่ตำแหน่งปลายทางหลังจากทำธุรกรรมfalse
transaction_timetrueเวลาของธุรกรรม (เช่น เวลาในการรับเข้า/จ่ายออก)false
created_attrueเวลาที่สร้างธุรกรรมfalse
created_bytrueสมาชิกที่สร้างธุรกรรมfalse
created_by.idtrueรหัสเฉพาะของสมาชิกfalse
created_by.nametrueชื่อสมาชิกfalse
created_by.deletedtrueระบุว่าสมาชิกถูกลบหรือไม่false
count_of_itemstrueจำนวนรายการสินค้าfalse
total_quantitytrueปริมาณรวมของการเปลี่ยนแปลงสต็อกfalse
urltrueที่อยู่ URL สำหรับดูหน้ารายละเอียดธุรกรรมfalse
memofalseหมายเหตุที่เกี่ยวข้องกับธุรกรรมfalse
#### ตัวอย่างเพย์โหลดเว็บฮุก – `รับเข้า` เหตุการณ์ ```json { "id": 16160911, "type": "in", "to_location": { "id": 52766, "name": "Warehouse 3", "deleted": false }, "items": [ { "id": 14277699, "name": "belif Cleansing Gel Oil Enriched", "quantity": 2, "deleted": false, "to_location_new_stock_level": 3 }, { "id": 14277698, "name": "belif Aqua Bomb Jelly Cleanser", "quantity": 2, "deleted": false, "to_location_new_stock_level": 5 } ], "transaction_time": "2023-04-25T05:42:27.545Z", "created_at": "2023-08-14T05:14:29.499Z", "created_by": { "id": 201345, "name": "corp", "deleted": false }, "count_of_items": 2, "total_quantity": 4, "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911" } ``` #### ตัวอย่างเพย์โหลดเว็บฮุก – `ย้ายสต็อก` เหตุการณ์ 
{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Warehouse 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Warehouse 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14873303,
      "name": "Auto liner 3.5mm",
      "quantity": 1,
      "deleted": false,
      "from_location_new_stock_level": -1,
      "to_location_new_stock_level": 1
    }
  ],
  "transaction_time": "2025-04-25T05:42:27.545Z",
  "created_at": "2025-04-25T05:42:27.545Z",
  "created_by": {
    "id": 176829,
    "name": "Tony Lee",
    "deleted": false
  },
  "count_of_items": 1,
  "total_quantity": 1,
  "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714"
}
### `txs/edit` ส่งเมื่อมีการ **แก้ไข**.
ฟิลด์จำเป็นคำอธิบายจำเป็นหรือไม่คำอธิบายโหมดทีม
idtrueรหัสเฉพาะของธุรกรรมtrueรหัสเฉพาะของประวัติทั้งหมด
typetrueประเภทของธุรกรรม
(in, out, adjust, move)		true

ประเภทของประวัติ

  • รับเข้า : in
  • จ่ายออก : out
  • ปรับ : adjust
  • ย้าย : move
ทั้งหมด
คู่ค้าfalseคู่ค้าfalse
partner.idfalseรหัสเฉพาะของคู่ค้าfalse
partner.namefalseชื่อของคู่ค้าfalse
partner.deletedfalseระบุว่าคู่ค้าถูกลบหรือไม่false
from_locationfalseตำแหน่งต้นทางfalse
from_location.idfalseรหัสเฉพาะของตำแหน่งต้นทางfalse
from_location.namefalseชื่อตำแหน่งต้นทางfalse
from_location.deletedfalseระบุว่าตำแหน่งต้นทางถูกลบหรือไม่false
to_locationtrueตำแหน่งปลายทางfalse
to_location.idtrueรหัสเฉพาะของตำแหน่งปลายทางfalse
to_location.nametrueชื่อตำแหน่งปลายทางfalse
to_location.deletedtrueระบุว่าตำแหน่งปลายทางถูกลบหรือไม่false
itemstrueรายการสินค้าในธุรกรรมtrueรายการตามสินค้าในประวัติทุกโหมด
items.idtrueรหัสเฉพาะของรายการสินค้าtrueรหัสเฉพาะของสินค้าทุกโหมด
items.nametrueชื่อสินค้าtrueชื่อของสินค้าทุกโหมด
items.quantitytrueการเปลี่ยนแปลงจำนวนจากธุรกรรม (in/out/adjust/move)trueจำนวนรับเข้า/จ่ายออก/ปรับ/ย้ายของสินค้านั้นทุกโหมด
items.deletedtrueระบุว่าสินค้าถูกลบหรือไม่trueระบุว่าสินค้าถูกลบหรือไม่
items.from_location_new_stock_levelfalseระดับสต็อกที่ตำแหน่งต้นทางหลังจากทำธุรกรรมfalse
items.to_location_new_stock_leveltrueระดับสต็อกที่ตำแหน่งปลายทางหลังจากทำธุรกรรมfalse
transaction_timetrueเวลาของธุรกรรม (เช่น เวลาในการรับเข้า/จ่ายออก)false
created_attrueเวลาที่สร้างธุรกรรมfalse
created_bytrueสมาชิกที่สร้างธุรกรรมfalse
created_by.idtrueรหัสเฉพาะของสมาชิกfalse
created_by.nametrueชื่อสมาชิกfalse
created_by.deletedtrueระบุว่าสมาชิกถูกลบหรือไม่false
count_of_itemstrueจำนวนรายการสินค้าfalse
total_quantitytrueปริมาณรวมของการเปลี่ยนแปลงสต็อกfalse
urltrueที่อยู่ URL สำหรับดูหน้ารายละเอียดธุรกรรมfalse
memofalseหมายเหตุที่เกี่ยวข้องกับธุรกรรมfalse
revisiontrueหมายเลขเวอร์ชันปัจจุบันของธุรกรรม เริ่มจาก 1false
#### ตัวอย่างเพย์โหลดเว็บฮุก – แก้ไขแล้ว `รับเข้า` ธุรกรรม ```json { "id": 16160911, "type": "in", "to_location": { "id": 52766, "name": "Warehouse 3", "deleted": false }, "items": [ { "id": 14277699, "name": "belif Cleansing Gel Oil Enriched", "quantity": 2, "deleted": false, "to_location_new_stock_level": 3 }, { "id": 14277698, "name": "belif Aqua Bomb Jelly Cleanser", "quantity": 2, "deleted": false, "to_location_new_stock_level": 5 } ], "transaction_time": "2023-04-25T05:42:27.545Z", "created_at": "2023-08-14T05:14:29.499Z", "created_by": { "id": 201345, "name": "corp", "deleted": false }, "count_of_items": 2, "total_quantity": 4, "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911" } ``` #### ตัวอย่างเพย์โหลดเว็บฮุก – แก้ไขแล้ว `ย้ายสต็อก` ธุรกรรม ```json { "id": 3692714, "type": "move", "from_location": { "id": 52765, "name": "Warehouse 2", "deleted": false }, "to_location": { "id": 52766, "name": "Warehouse 3", "deleted": false }, "items": [ { "id": 14873303, "name": "Auto liner 3.5mm", "quantity": 1, "deleted": false, "from_location_new_stock_level": -1, "to_location_new_stock_level": 1 } ], "transaction_time": "2023-04-25T05:42:27.545Z", "created_at": "2023-04-25T05:42:27.545Z", "created_by": { "id": 176829, "name": "Joy Kim", "deleted": false }, "count_of_items": 1, "total_quantity": 1, "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714" } ``` ### `txs/delete` ส่งเมื่อธุรกรรมสินค้าคงคลังถูก **ลบ**. | ฟิลด์ | คำอธิบาย | | -------- | -------------------------------------------- | | id | รหัสเฉพาะของธุรกรรม | | revision | หมายเลขเวอร์ชันปัจจุบันของธุรกรรม เริ่มจาก 1 | #### ตัวอย่างเพย์โหลดเว็บฮุก – ธุรกรรมที่ถูกลบ ```json /{ "id": 27036740, "revision": 2 } ``` ### `item/new` ส่งเมื่อมีการเพิ่มรายการสินค้าใหม่ลงในสินค้าคงคลังของทีม {% hint style="warning" %} **หมายเหตุ**: เหตุการณ์นี้ *ไม่* ถูกเรียกเมื่อใช้ฟีเจอร์ **`เพิ่มตัวแปรสินค้าที่`** หรือนำเข้าสินค้าผ่าน **`นำเข้า Excel`**. {% endhint %}
ฟิลด์คำอธิบายจำเป็นหรือไม่คำอธิบายโหมดทีม
idรหัสสินค้าtrueรหัสเฉพาะของประวัติทั้งหมด
ชื่อชื่อสินค้าtrue

ประเภทของประวัติ

  • รับเข้า : in
  • จ่ายออก : out
  • ปรับ : adjust
  • ย้าย : move
ทั้งหมด
skuSKUfalse
บาร์โค้ดบาร์โค้ดfalse
photo_urlURL รูปภาพfalse
ต้นทุนต้นทุนfalse
ราคาราคาfalse
attrsแอตทริบิวต์false
#### **ตัวอย่างเพย์โหลด – สินค้าที่สร้างใหม่** ```json { "id": 26122826, "name": "belif Peat Miracle Revital Cream", "sku": "SKU-YH2361KI", "barcode": "2002074321218", "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601", "cost": "50000", "price": "65000", "attrs": [ { "id": 413101, "name": "หมวดหมู่", "type": "text", "value": "รองพื้น" }, { "id": 459264, "name": "วันหมดอายุ", "type": "date", "value": "2027-08-07" }, { "id": 668272, "name": "สต็อกความปลอดภัย", "type": "number", "value": 33 } ] } ``` ### `item/edit` ส่งเมื่อมีการแก้ไขรายการสินค้าที่มีอยู่แล้ว {% hint style="warning" %} **หมายเหตุ**: เหตุการณ์นี้ *ไม่* ถูกเรียก *f*หรือสำหรับการแก้ไขจำนวนมากที่ทำผ่าน **`ศูนย์ข้อมูล`**** > ****`สินค้า`** หรือผ่านฟังก์ชัน **`นำเข้า Excel`** นี้ {% endhint %}
ฟิลด์คำอธิบายจำเป็นหรือไม่คำอธิบายโหมดทีม
idรหัสสินค้าtrueรหัสเฉพาะของประวัติทั้งหมด
ชื่อชื่อสินค้าtrue

ประเภทของประวัติ

  • รับเข้า : in
  • จ่ายออก : out
  • ปรับ : adjust
  • ย้าย : move
ทั้งหมด
skuSKUfalse
บาร์โค้ดบาร์โค้ดfalse
photo_urlURL รูปภาพfalse
ต้นทุนต้นทุนfalse
ราคาราคาfalse
attrsแอตทริบิวต์false
#### **ตัวอย่างเพย์โหลด – สินค้าที่อัปเดตแล้ว** ```json { "id": 26122826, "name": "belif Peat Miracle Revital Cream", "sku": "SKU-YH2361KI", "barcode": "2002074321218", "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601", "cost": "50000", "price": "65000", "attrs": [ { "id": 413101, "name": "หมวดหมู่", "type": "text", "value": "รองพื้น" }, { "id": 459264, "name": "วันหมดอายุ", "type": "date", "value": "2027-08-07" }, { "id": 668272, "name": "สต็อกความปลอดภัย", "type": "number", "value": 33 } ] } ``` ### `item/delete` ส่งเมื่อมีการลบรายการสินค้าออกจากสินค้าคงคลังของทีม {% hint style="warning" %} **หมายเหตุ**: เหตุการณ์นี้ *ไม่* ถูกเรียกสำหรับการลบจำนวนมากที่ทำผ่าน **`ศูนย์ข้อมูล`**** > ****`สินค้า`**. {% endhint %}
ฟิลด์คำอธิบายจำเป็นหรือไม่คำอธิบายโหมดทีม
idรหัสสินค้าtrueรหัสเฉพาะของประวัติทั้งหมด
#### ตัวอย่างเพย์โหลด **– สินค้าที่ถูกลบ** ```json { "id": 26122826 } ```