API文档 >>   获取应用导入的在线预订订单的历史记录

  • API名称:  获取应用导入的在线预订订单的历史记录 stats/get_reservation_transaction_history
  • 描述:获取指定时间段内开发者应用导入的在线预订订单的历史记录
  • 数据格式:JSON/XML
  • 方法:HTTP GET
  • 等级:普通
  • 是否需要用户授权:
  • 请求URL:http://api.dianping.com/v1/stats/get_reservation_transaction_history

请求参数

  • 必选参数

    名称 类型 说明
    appkey string App Key,应用的唯一标识
    sign string 请求签名,生成方式见《API请求签名生成文档》
    begin_time string 查询起始日期,格式为“YYYY-MM-DD HH:MM:SS”,其中HH代表24小时制
    end_time string 查询结束日期,格式为“YYYY-MM-DD HH:MM:SS”,其中HH代表24小时制
    transaction_status int 订单状态,1:用户下单,5:用户到店,7:订单取消
  • 可选参数

    名称 类型 说明
    city string 支持在线预订的城市名称,可以按城市为单位过滤结果,可选范围见相关API返回结果
    business_id int 商户ID,可以按单个商户为单位过滤结果
    uid string 合作方在链接后加上的明文传输的自定义参数,使用方法如:注意事项
    limit int 每页返回的记录条目数上限,最小值1,最大值40,如不传入默认为40
    page int 页码,如不传入默认为1,即第一页
    format string 返回数据格式,可选值为json或xml,如不传入,默认值为json

返回结果

  • 状态字段

    名称 类型 说明
    status string 本次API访问状态,如果成功返回"OK",并返回结果字段,如果失败返回"ERROR",并返回错误说明
    count int 本次API访问所获取的单页记录数量
    total_count int 所有页面记录总数
  • 结果字段

    名称 类型 说明
    uid string 第三方应用用户的标识,使用方法如:注意事项
    update_time string 订单状态更新时间
    business_id int 商户ID
    order_id string 订单号
    consumption float 到店消费金额,当且仅当transaction_status=5时返回,其余状态返回0
    transaction_status int 订单状态,1:用户下单,5:用户到店,7:订单取消

注意事项

  • 如果要获取uid信息,需要在链接后自行拼接uid,例如:http://dpurl.cn/p/A9+wfuFK1u?uid=123

API测试工具

示例请求

http://api.dianping.com/v1/stats/get_reservation_transaction_history?begin_time=2013-04-23&end_time=3013-04-25&transaction_status=1&appkey=[appkey]&sign=[signature]

示例结果

{
  "status": "OK",
  "total_count": 2,
  "count": 2,
  "transactions": [
    {
      "update_time": "2013-12-06 15:52:19",
      "business_id": 2880997,
      "order_id": "710340",
      "consumption": 0.0,
      "transaction_status": 1,
      "uid": ""
    },
    {
      "update_time": "2013-12-06 15:41:42",
      "business_id": 2880997,
      "order_id": "710338",
      "consumption": 0.0,
      "transaction_status": 1,
      "uid": ""
    }
  ]
}