查询数据采集订单接口

接口描述

用户可通过此接口查询已发起的数据采集订单状态，包括订单采集进度、授权时间等信息，方便用户跟踪数据采集进程。

业务规则

数据排列规则：返回的数据将按照“订单生效时间”正序排列，当查询数据时，可能会出现“在查询请求期间发生数据更新”的情况，更新的数据可能会被一同返回，为保证数据完整，可根据totalpage参数判断是否增加查询次数。

请求参数

Header 参数

X-App-Key

string

必需

示例值:

appKey

X-App-Secret-Key

string

必需

示例值:

ssss

X-Tenant-Id

string

可选

Body 参数application/json

channelCode

string

渠道编码

必需

orgTaxNum

string

税号

必需

startTime

string

采集开始时间

必需

endTime

string

采集结束时间

必需

pageNum

integer

页码

可选

默认1

pageSize

integer

页面大小

可选

默认100

示例

{
    "channelCode": "35", //渠道编码；
    "orgTaxNum": "75", //税号；
    "startTime": "2021-01-01", //采集开始时间；
    "endTime": "2021-03-31", //采集结束时间；
    "pageNum": 1, //页码；默认1
    "pageSize": 100 //页面大小；默认100
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

success

boolean

必需

code

integer

必需

data

object (OrderPageOpenResp)

必需

data

array[object (AuthCollectOrderPageOpenResp) {10}]

结果

可选

pageNum

integer

页码

可选

页码，默认1

默认值:

pageSize

integer

页面大小

可选

页面大小，默认500

默认值:

100

total

integer <int64>

页面大小

可选

总数

pages

integer

总页数

可选

总页数

errorMessage

string

可选

示例

成功示例服务内部失败或异常示例


{
  "success": true,
  "code": 200,
  "data": {
      "data": [
          {
              "orderNo": "proident ipsum laboris", //  订单编号；
              "orgName": "窦建军", //  公司名称；
              "orgTaxNum": "59", //  公司税号；
              "authVerifyCode": "30", //  核销码；
              "isTest": 1, //  测试订单；
              "orderStatus": "SUCCESS", //  订单状态；
              "errMsg": "veniam ex quis", //  异常信息；
              "orderAuthFirstTime": 1761617246251, //  最早授权时间；
              "orderAuthLastTime": 1754444727471, //  末次授权时间；
              "collectionPercentage": "aute officia ut aliquip" //  采集进度；
          }
      ],
      "pageNum": 1, // 页码；默认1
      "pageSize": 100, // 页面大小；默认100
      "total": 37, // 总数；
      "pages": 1 // 总页数；
  },
  "errorMessage": "sit irure ipsum sed proident"
}

查询数据采集订单接口

接口描述#

业务规则#

请求参数

示例代码

返回响应

接口描述

业务规则