接口描述:

  • 获取配送记录列表。

请求 URL:

  • http|https://host/api/v1/delivery_dist/method/get.delivery.dist.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
order_code string max:50 PO_I1049550470 流水号(订单号、售后单号等)
logistic_code string max:50 484106215266 快递单号
is_trace integer in:0,1 0 是否获取配送轨迹 0=否 1=是
state integer in:0,1,2,3,4,201 0 配送状态 0=无轨迹 1=已揽收 2=在途中 201=到达派件城市 3=签收 4=问题件
is_sub integer in:0,1 0 是否订阅 0=否 1=是
account string max:80 carey 账号或昵称
timeout integer egt:0 3 超时配送 单位:天
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量
order_type string in:asc,desc desc asc 排序方式
order_field string 见附属 A delivery_dist_id state 排序字段

附属 A:
in:delivery_dist_id,order_code,delivery_item_id,logistic_code,state,is_sub

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 5 合计计数
items 类型 是否返回 示例值 描述
delivery_dist_id integer 3 配送记录编号
user_id integer 1 账号编号
order_code string PO_I1049550470 流水号(订单号、售后单号等)
logistic_code string 484106215266 快递单号
trace array [] 配送轨迹
accept_station string 糯米已揽收 描述
accept_time string 2018-03-20 20:51:17 时间
remark string 备注
state integer 3 配送状态 0=无轨迹 1=已揽收 2=在途中 201=到达派件城市 3=签收 4=问题件
is_sub integer 0 是否订阅 0=否 1=是
create_time datetime 2018-03-09 23:32:11 创建时间
update_time datetime 2018-05-13 00:12:11 更新时间
get_delivery_item object [] 快递公司对象
get_user object [] 账号对象
get_delivery_item 类型 是否返回 示例值 描述
name string 中通快递 快递公司名称
code string ZTO 快递公司编码
get_user 类型 是否返回 示例值 描述
username string careya 账号
nickname string careya 昵称
head_pic string //host/head_pic.jpg 头像

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "delivery_dist_id": 6,
  8. "user_id": 1,
  9. "order_code": "PO_I1049550470",
  10. "logistic_code": "889138951963212863",
  11. "trace": [
  12. {
  13. "accept_station": "【江苏省盐城市公司】 已收件",
  14. "accept_time": "2018-04-17 19:38:14"
  15. }
  16. ],
  17. "state": 3,
  18. "is_sub": 0,
  19. "create_time": "2018-05-13 00:04:19",
  20. "update_time": "2018-05-13 00:28:57",
  21. "get_delivery_item": {
  22. "name": "圆通速递",
  23. "code": "YTO"
  24. },
  25. "get_user": {
  26. "username": "careya",
  27. "nickname": "careya",
  28. "head_pic": "//host/head_pic.jpg"
  29. }
  30. },
  31. {
  32. "delivery_dist_id": 3,
  33. "user_id": 1,
  34. "order_code": "PO_I1049550470",
  35. "logistic_code": "484106215266",
  36. "trace": [
  37. {
  38. "accept_station": "糯米已揽收",
  39. "accept_time": "2018-03-20 20:51:17"
  40. }
  41. ],
  42. "state": 3,
  43. "is_sub": 0,
  44. "create_time": "2018-03-09 23:32:11",
  45. "update_time": "2018-05-13 00:28:57",
  46. "get_delivery_item": {
  47. "name": "中通快递",
  48. "code": "ZTO"
  49. },
  50. "get_user": {
  51. "username": "careya",
  52. "nickname": "careya",
  53. "head_pic": "//host/head_pic.jpg"
  54. }
  55. }
  56. ],
  57. "total_result": 2
  58. }
  59. }

备注:

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