接口描述:

  • 获取快递公司列表。

请求 URL:

  • http|https://host/api/v1/delivery_item/method/get.delivery.company.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
name string max:50 顺丰 快递公司名称
code string max:30 sfsy 快递公司编码
type integer between:0,3 0 快递公司类型 0=热门 1=国内 2=国外 3=转运
company_all integer in:0,1 0 0 是否获取已删除 0=否 1=是
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量
order_type string in:asc,desc asc desc 排序方式
order_field string 见附属 A delivery_item_id phonetic 排序字段

附属 A:
in:delivery_item_id,name,phonetic,code,type

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 509 合计计数
items 类型 是否返回 示例值 描述
delivery_item_id integer 513 快递公司编号
name string 顺丰速运 快递公司名称
phonetic string s 快递公司拼音
code string sfsy 快递公司编码
type integer 1 快递公司类型 0=热门 1=国内 2=国外 3=转运

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "delivery_item_id": 1,
  8. "name": "顺丰速运",
  9. "phonetic": "s",
  10. "code": "SF",
  11. "type": 0
  12. },
  13. {
  14. "delivery_item_id": 2,
  15. "name": "百世快递",
  16. "phonetic": "b",
  17. "code": "HTKY",
  18. "type": 0
  19. },
  20. {
  21. "delivery_item_id": 3,
  22. "name": "中通快递",
  23. "phonetic": "z",
  24. "code": "ZTO",
  25. "type": 0
  26. }
  27. ],
  28. "total_result": 509
  29. }
  30. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。
文档更新时间: 2018-05-21 20:54