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

2022-05-11 15:10 更新

logistics.cancelOrder

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

取消運(yùn)單

調(diào)用方式:

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

HTTPS 調(diào)用

請求地址

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

請求參數(shù)

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

返回值

Object

屬性 類型 說明
errcode number 錯(cuò)誤碼
errmsg string 錯(cuò)誤信息
delivery_resultcode number 運(yùn)力返回的錯(cuò)誤碼
delivery_resultmsg string 運(yùn)力返回的錯(cuò)誤信息

errcode 的合法值

說明 最低版本
0 成功
-1 系統(tǒng)失敗
40199 運(yùn)單 ID 不存在
9300503 delivery_id不存在
930563 訂單不存在
930561 參數(shù)錯(cuò)誤
9300506 運(yùn)單 ID 已經(jīng)存在軌跡,不可取消
9300524 取消訂單失敗(一般為重復(fù)取消訂單)
9300501 快遞公司邏輯錯(cuò)誤,具體錯(cuò)誤碼見delivery_resultcode

請求示例

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

返回示例

{
  "errcode": 0,
  "errmsg": "ok",
  "delivery_resultcode": 0,
  "delivery_resultmsg": ""
}

云調(diào)用

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

接口方法

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

請求參數(shù)

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

返回值

Object

屬性 類型 說明
errCode number 錯(cuò)誤碼
errMsg string 錯(cuò)誤信息
deliveryResultcode number 運(yùn)力返回的錯(cuò)誤碼
deliveryResultmsg string 運(yùn)力返回的錯(cuò)誤信息

errCode 的合法值

說明 最低版本
0 成功

異常

Object

拋出的異常

屬性 類型 說明
errCode number 錯(cuò)誤碼
errMsg string 錯(cuò)誤信息

errCode 的合法值

說明 最低版本
-1 系統(tǒng)失敗
40199 運(yùn)單 ID 不存在
9300503 delivery_id不存在
930563 訂單不存在
930561 參數(shù)錯(cuò)誤
9300506 運(yùn)單 ID 已經(jīng)存在軌跡,不可取消
9300524 取消訂單失敗(一般為重復(fù)取消訂單)
9300501 快遞公司邏輯錯(cuò)誤,具體錯(cuò)誤碼見delivery_resultcode

請求示例

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

返回示例

{
  "errCode": 0,
  "errMsg": "openapi.logistics.cancelOrder:ok",
  "deliveryResultcode": 0,
  "deliveryResultmsg": ""
}


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

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號