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

2022-05-11 15:09 更新

logistics.batchGetOrder

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

批量獲取運(yùn)單數(shù)據(jù)

調(diào)用方式:

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

HTTPS 調(diào)用

請(qǐng)求地址

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

請(qǐng)求參數(shù)

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
access_token string 接口調(diào)用憑證
order_list Array.<Object> 訂單列表, 最多不能超過(guò)100個(gè)

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

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
order_id string 訂單ID
delivery_id string 快遞公司ID,參見(jiàn)getAllDelivery
waybill_id string 運(yùn)單ID

返回值

Object

屬性 類(lèi)型 說(shuō)明
order_list Array.<Object> 運(yùn)單列表
order_status number 運(yùn)單狀態(tài), 0正常,1取消

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

屬性 類(lèi)型 說(shuō)明
errcode number 錯(cuò)誤碼
errmsg string 錯(cuò)誤信息
order_id string 訂單ID
delivery_id string 快遞公司ID,參見(jiàn)getAllDelivery
waybill_id string 運(yùn)單ID
print_html string 運(yùn)單 html 的 BASE64 結(jié)果
waybill_data Array.<Object> 運(yùn)單信息

order_list.waybill_data 的結(jié)構(gòu)

屬性 類(lèi)型 說(shuō)明
key string 運(yùn)單信息 key
value string 運(yùn)單信息 value

請(qǐng)求數(shù)據(jù)示例

{
   "order_list": [
       {
          "order_id": "01234567890123456789",
          "delivery_id": "SF",
          "waybill_id": "123456789"
       },
       {
          "order_id": "01234567890123456789",
          "delivery_id": "SF",
          "waybill_id": "123456789"
       }
   ]
}

返回?cái)?shù)據(jù)示例

{
   "order_list": [
       {
          "errcode": 0,
          "errmsg": "ok",
          "order_id": "01234567890123456789",
          "delivery_id": "SF",
          "waybill_id": "123456789",
          "print_html": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
          "waybill_data": [
               {
                   "key": "SF_bagAddr",
                   "value": "廣州"
               },
               {
                  "key": "SF_mark",
                  "value": "101- 07-03 509"
               }
           ],
           "order_status": 0
       },
       {
          "errcode": 0,
          "errmsg": "ok",
          "order_id": "01234567890123456789_2",
          "delivery_id": "SF",
          "waybill_id": "123456789_2",
          "print_html": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
          "waybill_data": [
               {
                   "key": "SF_bagAddr",
                   "value": "廣州"
               },
               {
                  "key": "SF_mark",
                  "value": "101- 07-03 509"
               }
           ],
           "order_status": 0
       }
   ]
}

云調(diào)用

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

接口方法

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

請(qǐng)求參數(shù)

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
orderList Array.<Object> 訂單列表, 最多不能超過(guò)100個(gè)

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

屬性 類(lèi)型 默認(rèn)值 必填 說(shuō)明
orderId string 訂單ID
deliveryId string 快遞公司ID,參見(jiàn)getAllDelivery
waybillId string 運(yùn)單ID

返回值

Object

屬性 類(lèi)型 說(shuō)明
orderList Array.<Object> 運(yùn)單列表
orderStatus number 運(yùn)單狀態(tài), 0正常,1取消

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

屬性 類(lèi)型 說(shuō)明
errcode number 錯(cuò)誤碼
errmsg string 錯(cuò)誤信息
orderId string 訂單ID
deliveryId string 快遞公司ID,參見(jiàn)getAllDelivery
waybillId string 運(yùn)單ID
printHtml string 運(yùn)單 html 的 BASE64 結(jié)果
waybillData Array.<Object> 運(yùn)單信息

orderList.waybillData 的結(jié)構(gòu)

屬性 類(lèi)型 說(shuō)明
key string 運(yùn)單信息 key
value string 運(yùn)單信息 value

請(qǐng)求數(shù)據(jù)示例

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

返回?cái)?shù)據(jù)示例

{
  "orderList": [
    {
      "errcode": 0,
      "errmsg": "ok",
      "orderId": "01234567890123456789",
      "deliveryId": "SF",
      "waybillId": "123456789",
      "printHtml": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
      "waybillData": [
        {
          "key": "SF_bagAddr",
          "value": "廣州"
        },
        {
          "key": "SF_mark",
          "value": "101- 07-03 509"
        }
      ],
      "orderStatus": 0
    },
    {
      "errcode": 0,
      "errmsg": "ok",
      "orderId": "01234567890123456789_2",
      "deliveryId": "SF",
      "waybillId": "123456789_2",
      "printHtml": "jh7DjipP4ul4CQYUh69cniskrQZuOPwa1inAbXIqKbU0t71c0s65Au54cdWBZW0QJY4LYeofdM",
      "waybillData": [
        {
          "key": "SF_bagAddr",
          "value": "廣州"
        },
        {
          "key": "SF_mark",
          "value": "101- 07-03 509"
        }
      ],
      "orderStatus": 0
    }
  ],
  "errMsg": "openapi.logistics.batchGetOrder:ok"
}


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

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)