Webhook

Webhook provides a way to configure Sokochan to make a request to your server or service.

    A Webhook consists of:
  • Order status - a request contains latest order status.

Order status


A webhook accours when order status was changed.

  • order.picked
  • order.packed
  • order.shipped
  • order.shipment.updated
  • order.cancelled
Name Description Type Length
url Merchant's URL to receive webhook string 255
event Event name string order.picked
object Object Type string order
data
Object data
external_id External ID from merchant string 50
order_code Sokochan order code string 50
order_number Order number string 20
tracking_number Order shipment tracking number string 20
shipping Shipping provider string 50
cod_amount Cod amount decimal
updated Updated date time datetime
status Order status string 30
order_history
Only shows in "order.shipment.updated" event
Array of order history array
    {
      "url": "http://example.com/partner-url",
      "event": "order.picked",
      "object": "order",
      "data": {
        "external_id": "ex-1234",
        "order_code": "2212-999-00000",
        "order_number": "630181022738473",
        "tracking_number": "LEXPU016961XXXX",
        "shipping": "LEX",
        "cod_amount": 0,
        "status": "picked",
        "updated": "2022-12-21 10:25:33"
      }
    }
    
    {
      "url": "http://example.com/partner-url",
      "event": "order.packed",
      "object": "order",
      "data": {
        "external_id": "ex-1234",
        "order_code": "2212-999-00000",
        "order_number": "630181022738473",
        "tracking_number": "LEXPU016961XXXX",
        "shipping": "LEX",
        "cod_amount": 0,
        "status": "packed",
        "updated": "2022-12-21 10:25:33"
      }
    }
		
    {
      "url": "http://example.com/partner-url",
      "event": "order.shipped",
      "object": "order",
      "data": {
        "external_id": "ex-1234",
        "order_code": "2212-999-00000",
        "order_number": "630181022738473",
        "tracking_number": "LEXPU016961XXXX",
        "shipping": "LEX",
        "cod_amount": 0,
        "status": "shipped",
        "updated": "2022-12-21 10:25:33"
      }
    }
		
    {
      "url": "http://example.com/partner-url",
      "event": "order.shipment.updated",
      "object": "order",
      "data": {
        "external_id": "16714571161016",
        "order_code": "2212-999-02999",
        "order_number": "OD00078974",
        "tracking_number": "CSKC20024XXXX",
        "shipping": "KND",
        "cod_amount": 0,
        "status": "shipped",
        "updated": "2022-12-20 14:07:18",
        "shipping_status": "shipping",
        "order_history": [
          {
            "date_time": "19/12/2565 20:38",
            "location": "Thairemote",
            "status_title": "สร้างออเดอร์ / Order Created ",
            "remark": "2212-111-02394",
            "status_code": ""
          },
          {
            "date_time": "20/12/2565 07:15",
            "location": "SKC WH1 (Warehouse)",
            "status_title": "เข้าสู่กระบวนการ / Order Processed ",
            "remark": "",
            "status_code": ""
          },
          {
            "date_time": "20/12/2565 08:11",
            "location": "SKC WH1 (Warehouse)",
            "status_title": "หยิบออเดอร์ / Order Picked ",
            "remark": "",
            "status_code": ""
          },
          {
            "date_time": "20/12/2565 08:20",
            "location": "SKC WH1 (Warehouse)",
            "status_title": "แพ็คออเดอร์ / Order Packed ",
            "remark": "",
            "status_code": ""
          },
          {
            "date_time": "20/12/2565 14:07",
            "location": "SKC WH1 (Warehouse)",
            "status_title": "จัดส่งโดย / Shipped KND",
            "remark": "CSKC20024XXXX",
            "status_code": ""
          },
          {
            "datetime": "20/12/2565 14:14",
            "location": "Samut Prakan",
            "status_title": "เคอรี่เข้ารับพัสดุแล้ว",
            "remark": "",
            "complete": 0,
            "lang": "th",
            "mo_id": "3086024",
            "status_code": "010"
          },
          {
            "datetime": "20/12/2565 16:20",
            "location": "Bangkok",
            "status_title": "พัสดุถึงศูนย์คัดแยกสินค้า",
            "remark": "",
            "complete": 0,
            "lang": "th",
            "mo_id": "3086024",
            "status_code": "102"
          },
          {
            "datetime": "21/12/2565 10:17",
            "location": "Pathum Thani",
            "status_title": "พัสดุถึงสาขาปลายทาง",
            "remark": "",
            "complete": 0,
            "lang": "th",
            "mo_id": "3086024",
            "status_code": "103"
          }
        ]
      }
    }