调用QueryOrders查询用户或者分销客户订单列表情况。默认查询当前时间最近1小时范围内订单,如需查询更长时间范围的订单数据,请设CreateTimeStart 和CreateTimeEnd参数。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | QueryOrders |
系统规定参数。取值:QueryOrders。 |
| CreateTimeEnd | String | 否 | 2016-05-23T12:00:00Z |
创建时间段止(缺省查询当前时间最近1小时内订单),格式:YYYY-MM-ddTHH:mm:ssZ。 |
| CreateTimeStart | String | 否 | 2016-05-23T13:00:00Z |
创建时间段起(缺省查询当前时间最近1小时内订单),格式:YYYY-MM-ddTHH:mm:ssZ。 |
| PageSize | Integer | 否 | 20 |
每页条数。 |
| PageNum | Integer | 否 | 1 |
页码。 |
| ProductType | String | 否 | rds |
产品类型。 |
| ProductCode | String | 否 | rds |
产品代码。 |
| OrderType | String | 否 | New |
订单类型。取值范围:
|
| PaymentStatus | String | 否 | Paid |
支付状态。非退款订单,取值范围:
说明 对于退款订单可置NULL。
|
| SubscriptionType | String | 否 | Subscription |
订阅类型。取值类型:
|
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | Success |
状态码。 |
| Data | Struct |
返回信息。 |
|
| HostName | String | test |
主机名。 |
| OrderList | Array |
订单列表。 |
|
| Order | |||
| AfterTaxAmount | String | 66 |
税后金额。 |
| CreateTime | String | 2017-06-08T09:41:30Z |
创建时间。 |
| Currency | String | CNY |
币种。 |
| OrderId | String | 34532532 |
订单号。 |
| OrderType | String | New |
订单类型。取值范围:
|
| PaymentCurrency | String | CNY |
支付币种。 |
| PaymentStatus | String | Paid |
支付状态。非退款订单,取值范围:
说明 对于退款订单可置NULL。
|
| PaymentTime | String | 2017-06-08T09:41:30Z |
支付时间。 |
| PretaxAmount | String | 0 |
订单应付金额。 |
| PretaxAmountLocal | String | 0 |
本币金额。 |
| PretaxGrossAmount | String | 0 |
原始金额。 |
| ProductCode | String | rds |
主产品代码。 |
| ProductType | String | rds |
主产品类型。 |
| RelatedOrderId | String | 234535345345342 |
关联订单ID。 |
| SubscriptionType | String | PayAsYouGo |
订阅类型。取值:
|
| Tax | String | 1 |
税费。 |
| PageNum | Integer | 1 |
分页数。 |
| PageSize | Integer | 20 |
每页条数。 |
| TotalCount | Integer | 1 |
总记录数。 |
| Message | String | Successful! |
错误信息。 |
| RequestId | String | 61293E7A-3406-4447-8620-EC88B0AA66AD |
请求ID。 |
| Success | Boolean | true |
是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=QueryOrders
&<公共请求参数>
正常返回示例
XML 格式
<QueryOrdersResponse>
<Message>Successful!</Message>
<RequestId>61293E7A-3406-4447-8620-EC88B0AA66AD</RequestId>
<Data>
<TotalCount>0</TotalCount>
<PageSize>20</PageSize>
<PageNum>1</PageNum>
<OrderList>
</OrderList>
</Data>
<Code>Success</Code>
<Success>true</Success>
</QueryOrdersResponse>
JSON 格式
{
"Message": "Successful!",
"RequestId": "61293E7A-3406-4447-8620-EC88B0AA66AD",
"Data": {
"TotalCount": 0,
"PageSize": 20,
"PageNum": 1,
"OrderList": {
"Order": []
}
},
"Code": "Success",
"Success": true
}
错误码
访问错误中心查看更多错误码。