微信小程序 小程序使用·getPath

2022-05-11 15:12 更新

logistics.getPath

本接口應(yīng)在服務(wù)器端調(diào)用,詳細說明參見服務(wù)端API。
本接口支持云調(diào)用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載
wx-server-sdk >= 0.4.0

查詢運單軌跡

調(diào)用方式:

  • HTTPS 調(diào)用
  • 云調(diào)用

HTTPS 調(diào)用

請求地址

POST https://api.weixin.qq.com/cgi-bin/express/business/path/get?access_token=ACCESS_TOKEN

請求參數(shù)

屬性 類型 默認值 必填 說明
access_token string 接口調(diào)用憑證
order_id string 訂單 ID,需保證全局唯一
openid string 用戶openid,當add_source=2時無需填寫(不發(fā)送物流服務(wù)通知)
delivery_id string 快遞公司ID,參見getAllDelivery
waybill_id string 運單ID

返回值

Object

屬性 類型 說明
openid string 用戶openid
delivery_id string 快遞公司 ID
waybill_id string 運單 ID
path_item_num number 軌跡節(jié)點數(shù)量
path_item_list Array.<Object> 軌跡節(jié)點列表

path_item_list 的結(jié)構(gòu)

屬性 類型 說明
action_time number 軌跡節(jié)點 Unix 時間戳
action_type number 軌跡節(jié)點類型
action_msg string 軌跡節(jié)點詳情

action_type 的合法值

說明 最低版本
100001 攬件階段-攬件成功
100002 攬件階段-攬件失敗
100003 攬件階段-分配業(yè)務(wù)員
200001 運輸階段-更新運輸軌跡
300002 派送階段-開始派送
300003 派送階段-簽收成功
300004 派送階段-簽收失敗
400001 異常階段-訂單取消
400002 異常階段-訂單滯留

請求數(shù)據(jù)示例

{
  "order_id": "01234567890123456789",
  "openid": "oABC123456",
  "delivery_id": "SF",
  "waybill_id": "123456789"
}

返回數(shù)據(jù)示例

{
  "openid": "OPENID",
  "delivery_id": "SF",
  "waybill_id": "12345678901234567890",
  "path_item_num": 3,
  "path_item_list": [
    {
      "action_time": 1533052800,
      "action_type": 100001,
      "action_msg": "快遞員已成功取件"
    },
    {
      "action_time": 1533062800,
      "action_type": 200001,
      "action_msg": "快件已到達xxx集散中心,準備發(fā)往xxx"
    },
    {
      "action_time": 1533072800,
      "action_type": 300001,
      "action_msg": "快遞員已出發(fā),聯(lián)系電話xxxxxx"
    }
  ]
}

云調(diào)用

云調(diào)用是小程序·云開發(fā)提供的在云函數(shù)中調(diào)用微信開放接口的能力,需要在云函數(shù)中通過 wx-server-sdk 使用。

接口方法

openapi.logistics.getPath
需在 config.json 中配置 logistics.getPath API 的權(quán)限,詳情

請求參數(shù)

屬性 類型 默認值 必填 說明
orderId string 訂單 ID,需保證全局唯一
openid string 用戶openid,當add_source=2時無需填寫(不發(fā)送物流服務(wù)通知)
deliveryId string 快遞公司ID,參見getAllDelivery
waybillId string 運單ID

返回值

Object

屬性 類型 說明
openid string 用戶openid
deliveryId string 快遞公司 ID
waybillId string 運單 ID
pathItemNum number 軌跡節(jié)點數(shù)量
pathItemList Array.<Object> 軌跡節(jié)點列表

pathItemList 的結(jié)構(gòu)

屬性 類型 說明
actionTime number 軌跡節(jié)點 Unix 時間戳
actionType number 軌跡節(jié)點類型
actionMsg string 軌跡節(jié)點詳情

actionType 的合法值

說明 最低版本
100001 攬件階段-攬件成功
100002 攬件階段-攬件失敗
100003 攬件階段-分配業(yè)務(wù)員
200001 運輸階段-更新運輸軌跡
300002 派送階段-開始派送
300003 派送階段-簽收成功
300004 派送階段-簽收失敗
400001 異常階段-訂單取消
400002 異常階段-訂單滯留

請求數(shù)據(jù)示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.logistics.getPath({
        openid: 'oABC123456',
        orderId: '01234567890123456789',
        deliveryId: 'SF',
        waybillId: '123456789'
      })
    return result
  } catch (err) {
    return err
  }
}

返回數(shù)據(jù)示例

{
  "openid": "OPENID",
  "deliveryId": "SF",
  "waybillId": "12345678901234567890",
  "pathItemNum": 3,
  "pathItemList": [
    {
      "actionTime": 1533052800,
      "actionType": 100001,
      "actionMsg": "快遞員已成功取件"
    },
    {
      "actionTime": 1533062800,
      "actionType": 200001,
      "actionMsg": "快件已到達xxx集散中心,準備發(fā)往xxx"
    },
    {
      "actionTime": 1533072800,
      "actionType": 300001,
      "actionMsg": "快遞員已出發(fā),聯(lián)系電話xxxxxx"
    }
  ],
  "errMsg": "openapi.logistics.getPath:ok"
}


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號