查询订单数据

最近更新时间:2024-04-22 01:08:23

我的收藏

1. 接口描述

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

查询订单

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
Deals Array of Deal 订单列表
TotalCount Integer 订单总数
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取订单示例

获取订单示例

输入示例

POST / HTTP/1.1
Host: billing.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDealsByCond
<公共请求参数>

{
    "EndTime": "2016-02-01 00:00:00",
    "Limit": "20",
    "StartTime": "2016-01-01 00:00:00",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "Deals": [
            {
                "GoodsCategoryId": 100019,
                "TimeSpan": 1,
                "Policy": 100,
                "Formula": "退款:xxxxx元,代金券不退(xxxxxxxx",
                "Status": 4,
                "SubProductCode": "sp_abc",
                "ResourceId": [
                    "ins-abscde"
                ],
                "Price": 0.0,
                "ProductInfo": [
                    {
                        "Name": "规格名称",
                        "Value": "规格值"
                    }
                ],
                "TotalCost": 0.0,
                "ProductCode": "p_abc",
                "Payer": "1007416710",
                "RealTotalCost": 17000,
                "ProjectId": 0,
                "BigDealId": "20220214710000851640801",
                "PayMode": "1",
                "RefReturnDeals": "",
                "Action": "purchase",
                "OrderId": "20220214710000851640811",
                "VoucherDecline": 0,
                "Creator": "1007416710",
                "ProductName": "xx商品",
                "Currency": "CNY",
                "SubProductName": "xx商品",
                "TimeUnit": "m",
                "CreateTime": "2020-09-22 00:00:00"
            }
        ],
        "TotalCount": 1,
        "RequestId": "c33d6ae6-c0de-4a55-8318-0950b5bdc79e"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

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