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

logistics.addOrder

本接口應(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/order/add?access_token=ACCESS_TOKEN

請求參數(shù)

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

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

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

cargo.detail_list 的結(jié)構(gòu)

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

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

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

返回值

Object

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

errcode 的合法值

請求示例

{
  "add_source": 0,
  "order_id": "01234567890123456789",
  "openid": "oABC123456",
  "delivery_id": "SF",
  "biz_id": "xyz",
  "custom_remark": "易碎物品",
  "sender": {
    "name": "張三",
    "tel": "020-88888888",
    "mobile": "18666666666",
    "company": "公司名",
    "post_code": "123456",
    "country": "中國",
    "province": "廣東省",
    "city": "廣州市",
    "area": "海珠區(qū)",
    "address": "XX路XX號XX大廈XX棟XX"
  },
  "receiver": {
    "name": "王小蒙",
    "tel": "020-77777777",
    "mobile": "18610000000",
    "company": "公司名",
    "post_code": "654321",
    "country": "中國",
    "province": "廣東省",
    "city": "廣州市",
    "area": "天河區(qū)",
    "address": "XX路XX號XX大廈XX棟XX"
  },
  "shop": {
    "wxa_path": "/index/index?from=waybill&id=01234567890123456789",
    "img_url": "https://mmbiz.qpic.cn/mmbiz_png/OiaFLUqewuIDNQnTiaCInIG8ibdosYHhQHPbXJUrqYSNIcBL60vo4LIjlcoNG1QPkeH5GWWEB41Ny895CokeAah8A/640",
    "goods_name": "微信氣泡狗抱枕&微信氣泡狗鑰匙扣",
    "goods_count": 2
  },
  "cargo": {
    "count": 2,
    "weight": 5.5,
    "space_x": 30.5,
    "space_y": 20,
    "space_z": 20,
    "detail_list": [
      {
        "name": "微信氣泡狗抱枕",
        "count": 1
      },
      {
        "name": "微信氣泡狗鑰匙扣",
        "count": 1
      }
    ]
  },
  "insured": {
    "use_insured": 1,
    "insured_value": 10000
  },
  "service": {
    "service_type": 0,
    "service_name": "標準快遞"
  }
}

返回示例

下單成功

{
  "order_id": "01234567890123456789",
  "waybill_id": "123456789",
  "waybill_data": [
    {
      "key": "SF_bagAddr",
      "value": "廣州"
    },
    {
      "key": "SF_mark",
      "value": "101- 07-03 509"
    }
  ]
}

下單失敗

{
  "errcode": 9300501,
  "errmsg": "delivery logic fail",
  "delivery_resultcode": 10002,
  "delivery_resultmsg": "客戶密碼不正確"
}

云調(diào)用

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

接口方法

openapi.logistics.addOrder

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

請求參數(shù)

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

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

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

cargo.detailList 的結(jié)構(gòu)

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

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

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

返回值

Object

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

errCode 的合法值

異常

Object

拋出的異常

errCode 的合法值

請求示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.logistics.addOrder({
        openid: 'oABC123456',
        sender: {
          name: '張三',
          tel: '020-88888888',
          mobile: '18666666666',
          company: '公司名',
          country: '中國',
          province: '廣東省',
          city: '廣州市',
          area: '海珠區(qū)',
          address: 'XX路XX號XX大廈XX棟XX',
          postCode: '123456'
        },
        receiver: {
          name: '王小蒙',
          tel: '020-77777777',
          mobile: '18610000000',
          company: '公司名',
          country: '中國',
          province: '廣東省',
          city: '廣州市',
          area: '天河區(qū)',
          address: 'XX路XX號XX大廈XX棟XX',
          postCode: '654321'
        },
        shop: {
          wxaPath: '/index/index?from=waybill&id=01234567890123456789',
          imgUrl: 'https://mmbiz.qpic.cn/mmbiz_png/OiaFLUqewuIDNQnTiaCInIG8ibdosYHhQHPbXJUrqYSNIcBL60vo4LIjlcoNG1QPkeH5GWWEB41Ny895CokeAah8A/640',
          goodsName: '微信氣泡狗抱枕&微信氣泡狗鑰匙扣',
          goodsCount: 2
        },
        cargo: {
          count: 2,
          weight: 5.5,
          spaceX: 30.5,
          spaceY: 20,
          spaceZ: 20,
          detailList: [
            {
              name: '微信氣泡狗抱枕',
              count: 1
            },
            {
              name: '微信氣泡狗鑰匙扣',
              count: 1
            }
          ]
        },
        insured: {
          useInsured: 1,
          insuredValue: 10000
        },
        service: {
          serviceType: 0,
          serviceName: '標準快遞'
        },
        addSource: 0,
        orderId: '01234567890123456789',
        deliveryId: 'SF',
        bizId: 'xyz',
        customRemark: '易碎物品'
      })
    return result
  } catch (err) {
    return err
  }
}

返回示例

下單成功

{
  "orderId": "01234567890123456789",
  "waybillId": "123456789",
  "waybillData": [
    {
      "key": "SF_bagAddr",
      "value": "廣州"
    },
    {
      "key": "SF_mark",
      "value": "101- 07-03 509"
    }
  ],
  "errMsg": "openapi.logistics.addOrder:ok"
}

下單失敗

{
  "errCode": 9300501,
  "errMsg": "openapi.logistics.addOrder:fail delivery logic fail",
  "deliveryResultcode": 10002,
  "deliveryResultmsg": "客戶密碼不正確"
}