接口描述:

  • 获取订单促销列表。

请求 URL:

  • http|https://host/api/v1/promotion/method/get.promotion.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
name string max:100 店庆 促销名称
status integer in:0,1 1 促销状态 0=禁用 1=启用
begin_time datetime beforeTime:end_time 2018-06-01 00:00:00 促销开始时间
end_time datetime afterTime:begin_time 2018-06-30 00:00:00 促销结束时间
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 promotion_id status 排序字段

附属 A:
in:discount_id,name,default_dct,begin_time,end_time,status

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 28 合计计数
items 类型 是否返回 示例值 描述
promotion_id integer 106 促销编号
name string 端午订单促销 促销名称
begin_time datetime 2018-05-26 15:20:23 促销开始时间
end_time datetime 2018-06-26 15:20:23 促销结束时间
status integer 1 促销状态 0=禁用 1=启用
promotion_item array [] 促销方式
promotion_item 类型 是否返回 示例值 描述
quota number 500 促销限额
settings array [] 促销方式项数组
settings 类型 是否返回 示例值 描述
type integer 1 促销方式类型,详见备注
value number 80 促销方式数值

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "promotion_id": 107,
  8. "name": "店庆",
  9. "begin_time": "2018-06-26 15:20:24",
  10. "end_time": "2018-06-28 15:20:24",
  11. "status": 1,
  12. "promotion_item": [
  13. {
  14. "quota": 500,
  15. "settings": [
  16. {
  17. "type": "2",
  18. "value": "0"
  19. }
  20. ]
  21. }
  22. ]
  23. },
  24. {
  25. "promotion_id": 106,
  26. "name": "端午订单促销",
  27. "begin_time": "2018-05-26 15:20:23",
  28. "end_time": "2018-06-26 15:20:23",
  29. "status": 1,
  30. "promotion_item": [
  31. {
  32. "quota": 500,
  33. "settings": [
  34. {
  35. "type": "1",
  36. "value": "80"
  37. }
  38. ]
  39. },
  40. {
  41. "quota": 1000,
  42. "settings": [
  43. {
  44. "type": "1",
  45. "value": "70"
  46. },
  47. {
  48. "type": "3",
  49. "value": "1000"
  50. }
  51. ]
  52. }
  53. ]
  54. }
  55. ],
  56. "total_result": 28
  57. }
  58. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。

  2. 请参考「添加一个订单促销」中的备注说明。

文档更新时间: 2018-05-26 18:34