logistics.getQuota

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

获取电子面单余额。仅在使用加盟类快递公司时,才可以调用。

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
delivery_idstring快递公司ID,参见getAllDelivery
biz_idstring快递公司客户编码

返回值

Object

属性类型说明
quota_numnumber电子面单余额

请求数据示例

  1. {
  2. "delivery_id": "YTO",
  3. "biz_id": "xyz"
  4. }

返回数据示例

  1. {
  2. "quota_num": 210
  3. }

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.logistics.getQuota

需在 config.json 中配置 logistics.getQuota API 的权限,详情

请求参数

属性类型默认值必填说明
deliveryIdstring快递公司ID,参见getAllDelivery
bizIdstring快递公司客户编码

返回值

Object

属性类型说明
quotaNumnumber电子面单余额

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4. try {
  5. const result = await cloud.openapi.logistics.getQuota({
  6. deliveryId: 'YTO',
  7. bizId: 'xyz'
  8. })
  9. console.log(result)
  10. return result
  11. } catch (err) {
  12. console.log(err)
  13. return err
  14. }
  15. }

返回数据示例

  1. {
  2. "quotaNum": 210,
  3. "errMsg": "openapi.logistics.getQuota:ok"
  4. }