NAV Navbar
json
中文
English

Webhook(zh-tw)

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

說明

這是 Boxful WEBHOOK API 專用文件，僅提供 Boxful fulfillment 商家使用。

Region

Hook Post 統一格式

主要資料放置於 payload 參數內，請依據各事件回覆格式參考。


若對想驗證資料來源可靠性請透過 validator_code 解碼後可得到完整 payload

{
  "timestamp": 1608202713,
  "region": "tw",
  "event_type": "shipment_logistics",
  "event": "update",
  "payload": {},
  "validator_code": "..."
}

可靠性驗證

可靠性驗證採用 AES-256-CBC 加密

Handle 需統一向左側補 0 至 16 碼

function decryptValidatorCode($data = "", $token = "", $handle = "")
{
    $output = '';
    $handle = str_pad($handle, 16, '0', STR_PAD_LEFT);
    $string = openssl_decrypt(hex2bin($data), 'AES-256-CBC', $token, OPENSSL_RAW_DATA | OPENSSL_ZERO_PADDING,
        $handle);
    $string_ascii = ord(substr($string, -1));
    $stringing_chr = chr($string_ascii);
    if (preg_match("/$stringing_chr{" . $string_ascii . "}/", $string)) {
        $string = substr($string, 0, strlen($string) - $string_ascii);
        parse_str($string, $output);
    }
    return $output;
}

事件網址設定

請提供事件類別.事件項目.傳送網址給 Boxful ex. shipment_logistics.create http://api.boxful.com/webhook_url

事件列表

HEAD /Webhook-Description

入倉事件 pickup

EventType
pickup
Event Description Response Format Ref.
main_update 入倉 PL 更新 pickup_main_update
item_update 入倉品項狀態更新 pickup_item_update

pickup_main_update 回傳範例

{
  "timestamp": 1608726044,
  "region": "tw",
  "event_type": "pickup",
  "event": "main_update",
  "payload": {
    "packing_order_id": "1601283742",
    "name": "OwenShih",
    "phone": "0800050777",
    "address": "台北市松山區光復北路11巷44號11樓",
    "email": "owen@boxful.com.tw",
    "logistics_date": "2020-12-20",
    "logistics_time_slot": "1100-1200",
    "logistics_code": "own-self",
    "logistics_label": "自行出貨",
    "is_container": 0,
    "is_custom": 0,
    "status_code": 1,
    "status_label": "Packing已抵達倉庫"
  },
  "validator_code": "9455f62917ba803bdafa4ddd3112d90a0360729"
}

pickup_item_update 回傳範例

{
  "timestamp": 1612346367,
  "region": "tw",
  "event_type": "pickup",
  "event": "item_update",
  "payload": {
    "id": 48897,
    "label": "Demo product",
    "description": null,
    "sku": "A001(132777)",
    "barcode": "4711769132777",
    "expiry_date": null,
    "status": "machining",
    "status_description": "加工中",
    "logistics_date": "2021-02-03",
    "packing_list_order_id": "1616676633",
    "out_bound_total_count": 200,
    "receive": [
      {
        "expected_entering_type": "item_out",
        "expected_entering_type_label": "箱出",
        "expected_entering_count": 10,
        "actual_entering_type": "item_out",
        "actual_entering_type_label": "箱出",
        "actual_entering_count": 10,
        "receive_detail": [
          {
            "count": 10,
            "unit_count": 20,
            "total_count": 200,
            "is_defective": 0
          }
        ]
      }
    ]
  },
  "validator_code": "b3fe1376718eb05e1a0b21e2ec412712"
}

庫存事件 inventory

EventType
inventory
Event Description Response Format Ref.
low_warning 當商品抵達庫存水位預警時通知每日一次 inventory_low_warning

inventory_low_warning 回傳範例


{
  "timestamp": 1612410721,
  "region": "tw",
  "event_type": "inventory",
  "event": "low_warning",
  "payload": {
    "label": "demo001",
    "barcode": "15893383605698102",
    "sku": "demo001",
    "safety_stock": 99999999,
    "retrieving_type": "piece_out"
  },
  "validator_code": "546a8aa577c091eb53017b46f95d8a5be5cb310c8"
}

物流事件 logistics

EventType
logistics
Event Description Response Format Ref.
create 當有新的物流建立時則觸發此事件 shipment_and_logistics
update 當物流有狀態更新/物流追蹤碼更新時時則觸發此事件 shipment_and_logistics

shipment_and_logistics 回傳範例


{
  "timestamp": 1344544545,
  "region": "tw",
  "event_type": "shipment_logistics",
  "event": "update",
  "payload": {
    "logistics_date": "2019-07-29",
    "address": "Address",
    "name": "香港商便利存",
    "phone": "03-4569170",
    "instruction": "付單",
    "remark": null,
    "order_id": "1496",
    "collect_amount": 0,
    "vendor_order_id": "7142",
    "wms_order_id": "15641381475151991034",
    "status": "closed",
    "logistics": [
      {
        "logistics_vendor": "Boxful跨境配",
        "logistics": "boxful_corss",
        "logistics_status": "shipment",
        "service_at": "2019-07-28 12:00:00",
        "logistics_status_label": "shipment",
        "logistics_code": "xdJ5jc",
        "tracking_url": "https://t.boxful.tw/1TDPGE"
      }
    ]
  },
  "validator_code": "92a2124ba634da84fb343514cc78cebfc8"
}

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK successful operation Inline

Response Schema

Status Code 200

empty object

Name Type Required Restrictions Description
json