小程序
取消
开发
中文
EN
取消
  • 指南

    • # 获取支持的快递公司列表

    调试诊断

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

    接口英文名：getAllDelivery

    该接口用于获取支持的快递公司列表。

    # 1. 调用方式

    # HTTPS 调用

    GET https://api.weixin.qq.com/cgi-bin/express/business/delivery/getall?access_token=ACCESS_TOKEN

    支持加密请求： 本接口支持服务通信二次加密和签名，可有效防止数据篡改与泄露。查看详情

    # 云调用

    • 调用方法：logistics.getAllDelivery

    • 出入参和 HTTPS 调用相同，调用方式可查看 云调用 说明文档

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：45、71

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填说明
    access_tokenstring是接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    无

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    countnumber快递公司数量
    dataobjarray快递公司信息列表

    # Res.data(Array) Object Payload

    快递公司信息列表

    参数名类型说明
    delivery_idstring快递公司 ID
    delivery_namestring快递公司名称
    can_use_cashnumber是否支持散单, 1表示支持
    can_get_quotanumber是否支持查询面单余额, 1表示支持
    service_typeobjarray支持的服务类型
    cash_biz_idstring散单对应的bizid，当can_use_cash=1时有效

    # Res.data(Array).service_typeObject Payload

    支持的服务类型

    参数名类型说明
    service_typenumberservice_type
    service_namestring服务类型名称

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    # 5.1 HTTPS调用

    请求示例

    GET https://api.weixin.qq.com/cgi-bin/express/business/delivery/getall?access_token=ACCESS_TOKEN

    返回示例

    {
  "count": 7,
  "data": [
    {
      "delivery_id": "BEST",
      "delivery_name": "百世快递"
    },
    {
      "delivery_id": "EMS",
      "delivery_name": "中国邮政速递物流"
    },
    {
      "delivery_id": "PJ",
      "delivery_name": "品骏物流"
    },
    {
      "delivery_id": "SF",
      "delivery_name": "顺丰速运"
    },
    {
      "delivery_id": "YTO",
      "delivery_name": "圆通速递"
    },
    {
      "delivery_id": "YUNDA",
      "delivery_name": "韵达快递"
    },
    {
      "delivery_id": "ZTO",
      "delivery_name": "中通快递"
    }
  ]
}

    # 5.2 云函数调用

    请求示例

    const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.logistics.getAllDelivery({})
    return result
  } catch (err) {
    return err
  }
}

    返回示例

    {
  "count": 7,
  "data": [
    {
      "deliveryId": "BEST",
      "deliveryName": "百世快递"
    },
    {
      "deliveryId": "EMS",
      "deliveryName": "中国邮政速递物流"
    },
    {
      "deliveryId": "PJ",
      "deliveryName": "品骏物流"
    },
    {
      "deliveryId": "SF",
      "deliveryName": "顺丰速运"
    },
    {
      "deliveryId": "YTO",
      "deliveryName": "圆通速递"
    },
    {
      "deliveryId": "YUNDA",
      "deliveryName": "韵达快递"
    },
    {
      "deliveryId": "ZTO",
      "deliveryName": "中通快递"
    }
  ],
  "errMsg": "openapi.logistics.getAllDelivery:ok"
}

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述解决方案
    40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口

    # 7. 适用范围

    本接口支持「小程序（仅认证）」账号类型调用。其他账号类型如无特殊说明，均不可调用。