# 启动销售明细导出任务

# 接口地址

/mqb/export/sale/start

# 说明

导出任务启动接口,调用后立即返回。服务端在后台发起了一个导出的任务,在导出任务队列中排队,导出任务被串行执行。

注意:此接口返回,不代表导出任务执行完成,只表明发起一个导出任务。导出任务一般执行时间较长,需要后续通过导出进度查询接口,每隔一段时间查询某个导出任务的执行进度。任务完成后导出进度查询接口会返回任务状态为已完成,并包含导出文件下载路径。

# 导出文件字段说明

导出文件与 新报表-> 销售报表-> 销售明细(销售内容)的导出文件的字段一致。

# 接口调用限制

  1. 单个用户只允许发起最多5个进行中的导出任务。如果该用户有5个还未完成的导出任务,启动新的导出任务会报错。
  2. 单个导出任务执行时间默认最大为10分钟,超过此时间的导出任务,状态会被置为超时失败。
  3. 每次导出请求,结清日期跨度最大范围为31天。
  4. 接口允许的调用时间,为下午16点以后, 至早上7点之间。其他时间端调本接口报错。

# 入参

# 字段说明

名称 类型 必填 示例 描述
beginFinishDate String "2020-01-01" 结清日期,开始。格式 yyyy-MM-dd
endFinishDate String "2020-01-31" 结清日期,结束。格式 yyyy-MM-dd
ycdc Boolean true 是否隐藏抵充数据,true 是,false 否。不填默认false

# JSON 示例

{
    "paramValues": [
        {
            "beginFinishDate": "2020-04-01",
            "endFinishDate": "2020-04-10",
            "ycdc":true
        }
    ]
}

# 出参

# 字段说明

名称 类型 示例 描述
taskId Number 121212 导出任务id, 标识一次导出任务。指定任务id, 可调用导出任务进度查询接口,查看任务进度和结果。
因数值较大,为避免精度丢失,请使用大整数类型,比如Java的BigInteger。

# JSON 示例

{
  "code": 200,//200为正常,其他代码为错误
  "message": "SUCCESS",
  "data": {
    "taskId": 10102
  }
}

当code为非200值时,message表示具体的错误信息:

message 对应场景
单用户最多同时发起5个进行中的导出任务! 接口调用限制1
结清日期跨度超过限制,最多31天! 接口调用限制3
系统繁忙,请在下午16点以后, 至早上7点之间调用本接口! 接口调用限制4

#