查询订单数据

最近更新时间:2020-09-02 08:02:46

1. 接口描述

接口请求域名: billing.tencentcloudapi.com 。

查询订单

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDealsByCond。
Version String 公共参数,本接口取值:2018-07-09。
Region String 公共参数,本接口不需要传递此参数。
StartTime Timestamp 开始时间
EndTime Timestamp 结束时间
Limit Integer 一页多少条数据,默认是20条,最大不超过1000
Offset Integer 第多少页,从0开始,默认是0
Status Integer 订单状态,默认为4(成功的订单)
订单的状态
1:未支付
2:已支付3:发货中
4:已发货
5:发货失败
6:已退款
7:已关单
8:订单过期
9:订单已失效
10:产品已失效
11:代付拒绝
12:支付中
OrderId String 订单号
BigDealId String 大订单号

3. 输出参数

参数名称 类型 描述
Deals Array of Deal 订单列表
TotalCount Integer 订单总数
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取订单示例

输入示例

https://billing.tencentcloudapi.com/?Action=DescribeDealsByCond
&StartTime=2016-01-01 00:00:00
&EndTime=2016-02-01 00:00:00
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 1,
    "Deals": [
      {
        "OrderId": "20180806110065",
        "Status": 4,
        "Payer": "505515676",
        "CreateTime": "2018-08-06 15:21:23",
        "VoucherDecline": 0,
        "ProjectId": 0,
        "GoodsCategoryId": 100019,
        "RealTotalCost": 17000,
        "Creator": "505515676"
      }
    ],
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameterValue 参数取值错误。
目录