产品动态
产品公告
Domain name for API request: billing.intl.tencentcloudapi.com.
Querying orders
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeDealsByCond. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-09. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| StartTime | Yes | Timestamp | Start time Example :2016-01-01 00:00:00 |
| EndTime | Yes | Timestamp | End time Example:2016-02-01 00:00:00. It is recommended that the span does not exceed 3 months. |
| Limit | Yes | Integer | The number of records per page. The default is 20, and the maximum is 1,000. |
| Offset | No | Integer | The page number the records start from, starting from 0. The default is 0. |
| Status | No | Integer | Order status, default is 4 (successful order) Status of the order 1: unpaid 2: paid 3: shipment in progress 4: shipped 5 : Shipment Failed<br/>6: Refunded7 : Ticket closed<br/>8: Order expired9`: Order invalid 10: product invalidated 11: third-party payment refused 12: payment in process |
| OrderId | No | String | Sub-order number Example: 202202021234567 |
| BigDealId | No | String | Large order number. Example: 202202021234566 |
| ResourceId | No | String | Resource ID Example:ins-a2bb34 |
| Parameter Name | Type | Description |
|---|---|---|
| Deals | Array of Deal | Order list |
| TotalCount | Integer | Total number of orders |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to get an order.
POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDealsByCond
<Common request parameters>
{
"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": "Refund: xxxxx USD, voucher not refundable (xxxxxxxx",
"Status": 4,
"SubProductCode": "sp_abc",
"ResourceId": [
"ins-abscde"
],
"Price": 0.0,
"ProductInfo": [
{
"Name": "Specification Name",
"Value": "Specification 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 Product",
"Currency": "USD",
"SubProductName": "xx Product",
"TimeUnit": "m",
"CreateTime": "2020-09-22 00:00:00"
}
],
"TotalCount": 1,
"RequestId": "c33d6ae6-c0de-4a55-8318-0950b5bdc79e"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameterValue | Invalid parameter value. |
文档反馈