logistics.getAllDelivery

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

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

获取支持的快递公司列表

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证

返回值

Object

属性类型说明
countnumber快递公司数量
dataArray.<Object>快递公司信息列表

data 的结构

属性类型说明
delivery_idstring快递公司 ID
delivery_namestring快递公司名称
can_use_cashnumber是否支持散单, 1表示支持
can_get_quotanumber是否支持查询面单余额, 1表示支持
cash_biz_idstring散单对应的bizid,当can_use_cash=1时有效
service_typeArray.<Object>支持的服务类型

data.service_type 的结构

属性类型说明
service_typenumber服务类型ID
service_namestring服务类型名称

返回数据示例

  1. {
  2. "count": 8,
  3. "data": [
  4. {
  5. "delivery_id": "BEST",
  6. "delivery_name": "百世快递"
  7. },
  8. {
  9. "delivery_id": "EMS",
  10. "delivery_name": "中国邮政速递物流"
  11. },
  12. {
  13. "delivery_id": "OTP",
  14. "delivery_name": "承诺达特快"
  15. },
  16. {
  17. "delivery_id": "PJ",
  18. "delivery_name": "品骏物流"
  19. },
  20. {
  21. "delivery_id": "SF",
  22. "delivery_name": "顺丰速运"
  23. },
  24. {
  25. "delivery_id": "YTO",
  26. "delivery_name": "圆通速递"
  27. },
  28. {
  29. "delivery_id": "YUNDA",
  30. "delivery_name": "韵达快递"
  31. },
  32. {
  33. "delivery_id": "ZTO",
  34. "delivery_name": "中通快递"
  35. }
  36. ]
  37. }

云调用

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

接口方法

  1. openapi.logistics.getAllDelivery

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

返回值

Object

属性类型说明
countnumber快递公司数量
dataArray.<Object>快递公司信息列表

data 的结构

属性类型说明
deliveryIdstring快递公司 ID
deliveryNamestring快递公司名称
canUseCashnumber是否支持散单, 1表示支持
canGetQuotanumber是否支持查询面单余额, 1表示支持
cashBizIdstring散单对应的bizid,当can_use_cash=1时有效
serviceTypeArray.<Object>支持的服务类型

data.serviceType 的结构

属性类型说明
serviceTypenumber服务类型ID
serviceNamestring服务类型名称

请求示例

  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.getAllDelivery({})
  6. console.log(result)
  7. return result
  8. } catch (err) {
  9. console.log(err)
  10. return err
  11. }
  12. }

返回数据示例

  1. {
  2. "count": 8,
  3. "data": [
  4. {
  5. "deliveryId": "BEST",
  6. "deliveryName": "百世快递"
  7. },
  8. {
  9. "deliveryId": "EMS",
  10. "deliveryName": "中国邮政速递物流"
  11. },
  12. {
  13. "deliveryId": "OTP",
  14. "deliveryName": "承诺达特快"
  15. },
  16. {
  17. "deliveryId": "PJ",
  18. "deliveryName": "品骏物流"
  19. },
  20. {
  21. "deliveryId": "SF",
  22. "deliveryName": "顺丰速运"
  23. },
  24. {
  25. "deliveryId": "YTO",
  26. "deliveryName": "圆通速递"
  27. },
  28. {
  29. "deliveryId": "YUNDA",
  30. "deliveryName": "韵达快递"
  31. },
  32. {
  33. "deliveryId": "ZTO",
  34. "deliveryName": "中通快递"
  35. }
  36. ],
  37. "errMsg": "openapi.logistics.getAllDelivery:ok"
  38. }