# 一般查詢

# PA-API-2.1 獲取可使用 VAS

POST /vas

接口類型 請求接口
說明 獲取可使用 VAS,在PA-API-3.1 訂單創建時,可以傳入 VAS 選項。

# 請求參數

名稱 類型 必填 默認值 說明 備註
merchant_id string Y - 商家 ID
product_code string Y - 產品代號 - 可以傳入"DASH2HR""DASH4HR""MPOINTS"
- 請與 Zeek 團隊查詢可以傳入的值。

例子:

{
    "merchant_id": "1111111",
    "product_code": "DASH2HR"
}

# 返回結果

名稱 類型 說明 備註
vas[] array VAS 服務列表
vas[].code string 服務代號
vas[].name string 服務名稱
vas[].description string 服務描述
vas[].help string 服務描述 URL
vas[].options array 服務選項
vas[].options[].count string 選項數量 開發者在創建訂單時,跟據本接口提供的 count 值傳入到PA-API-3.1 訂單創建 接口。
vas[].options[].fee string 選項價格
vas[].options[].label string 選項名稱

例子:

{
    "error": 0,
    "data": {
        "vas": [
            {
                "code": "HKDASH_HOURS",
                "name": "包鐘",
                "description": "請在司機備註欄內簡單描述要求,並與接單司機落實報價(該費用需以現金支付)",
                "help": "https://staging-ap1-img.ks-it.co/Markdown/manual_93_zh_hk.html?1593428037",
                "options": [
                    {
                        "count": "1",
                        "fee": "$10",
                        "label": "1部"
                    },
                    {
                        "count": "2",
                        "fee": "$20",
                        "label": "2部"
                    },
                    {
                        "count": "3",
                        "fee": "$30",
                        "label": "3部"
                    }
                ]
            },
            {
                "code": "HKDASH_TMBAG",
                "name": "食物保溫袋",
                "description": "",
                "help": "",
                "options": [
                    {
                        "count": "0",
                        "label": "不需要",
                        "fee": "$0"
                    },
                    {
                        "count": "1",
                        "label": "需要",
                        "fee": "$0"
                    }
                ]
            }
        ]
    }
}

# PA-API-2.2 獲取可使用商家工種

POST /business_positions

接口類型 請求接口
說明 獲取可使用商家工種,在PA-API-3.1 訂單創建時,可以傳入下單偏好 preferences 選項。

# 請求參數

名稱 類型 必填 默認值 說明 備註
merchant_id string Y - 商家 ID
product_code string Y - 產品代號 - 可以傳入"DASH2HR""DASH4HR""MPOINTS"
- 請與 Zeek 團隊查詢可以傳入的值。
schedule_time string N '' 預約取件時間 - 即時訂單時不用傳入
- 最早可預約時間 = 當前時間 + 30分鐘
- 最遲可預約時間 = 當前時間 + 31日
- 例子:"2020-09-08 16:00"
items object N - 貨物信息
items.box string Y - 貨物容量 Code - 可填:"XS""S""M""L""XL"
path array N - 配送路線地點 請按順序傳入寄件地、中途點(如有)及收件地數據。
path[].coordinate string Y - 座標

例子:

{
    "merchant_id": "1111111",
    "product_code": "DASH2HR",
    "schedule_time": "2020-08-19 19:30",
    "items": {
        "box": "M"
    },
    "path": [
        {
            "coordinate": "22.277495,114.166271"
        },
        {
            "coordinate": "22.300813,114.179696"
        }
    ]
}

# 返回結果

名稱 類型 說明 備註
business_positions[] array 商家工種列表
business_positions[].code string 商家工種代號
business_positions[].name string 商家工種名稱

例子:

{
    "error": 0,
    "data": {
        "business_positions": [
            {
                "code": "mR",
                "name": "Motorbike",
            },
            {
                "code": "mC",
                "name": "Car",
            },
            {
                "code": "mV",
                "name": "Van",
            }
        ]
    }
}