备案 控制台 登录 注册
文档中心 > 查询订单列表
查询订单列表

最近更新时间：2021-09-17

接口路径

https://api.unicloud.com/transaction

接口名

QueryOrders

描述

根据查询条件分页获取订单列表信息

请求参数

名称类型是否必填说明
ActionString是填写QueryOrders
PayTypeString否计费方式
ProductCategoryString否产品类型
OrderCategoryInteger否订单类型
OrderStatusInteger否订单状态
StartTimeString否开始时间 (yyyy-MM-dd HH:mm:ss。样例：2019-06-03 00:00:00)
EndTimeString否结束时间(yyyy-MM-dd HH:mm:ss。样例：2019-06-03 00:00:00)
PageInteger是页数
SizeInteger是每页个数

返回参数

名称类型说明
TotalCountInteger总订单条数
PageNumInteger页码
PageSizeInteger每页数量
OrderListMap<"Order",List>订单列表

order:

名称类型说明
IdString订单Id
OrderNoString订单号
UserIdString用户Id
UserNameString用户名
AccountIdString账户Id
AccountNameString账户名
OrderStatusString订单状态
OrderCategoryString订单类型
PayTypeString计费方式
ChargeTypeString扣费方式
IsOffineBoolean是否离线订单
ProductCategoryString产品类型
IsInvoiceBoolean是否开发票
PayTimeDate支付时间
TotalPriceBigDecimal订单金额
CouponAmountBigDecimal优惠券减免金额
PromotionAmountBigDecimal促销金额
PromotionRuleString营销规则
FinalPriceBigDecimal最终支付价格
PaidAmountBigDecimal实际支付价格
ProductRegionIdString产品区域Id
ProductRegionNameString产品区域名称
CreateTimeDate订单创建时间
UpdateTimeDate订单修改时间
InstanceIdString续费时对应的资源Id
NoteString备注

请求示例

?Action=QueryOrders&PayType=DAY_MONTH&Size=10&Page=1
&其他公共参数

正常返回示例

{    "OrderList": {        "Order": [
            {                "PromotionAmount": 0,                "Note": null,                "InstanceId": "35d272a7-4c2b-4079-aa50-45e6f7fa31b6",                "Id": "1144155076852449280",                "PromotionRule": null,                "PaidAmount": null,                "FinalPrice": 17.5,                "OrderCategory": "NEW",                "OrderNo": "P21785800229503",                "PayTime": null,                "CreateTime": 1561622802000,                "UpdateTime": 1561622802000,                "ChargeType": "postpaid",                "CouponAmount": 0,                "IsOffine": false,                "IsInvoice": false,                "PayType": "YEAR_MONTH",                "UserId": "35d272a7-4c2b-4079-aa50-45e6f7fa31b6",                "ProductCategory": "DATA_HARD_DISK",                "AccountId": null,                "AccountName": null,                "TotalPrice": 17.5,                "UserName": "haha",                "ProductRegionId": "8b128f0c-e9ad-472c-9c20-451b9f310e94",                "ProductRegionName": "cloudos-tj",                "OrderStatus": "UNPAID"
            },
            {                "PromotionAmount": 0,                "Note": null,                "InstanceId": "35d272a7-4c2b-4079-aa50-45e6f7fa31b6",                "Id": "1144119593783001088",                "PromotionRule": null,                "PaidAmount": null,                "FinalPrice": 0,                "OrderCategory": "NEW",                "OrderNo": "P21784954245923",                "PayTime": 1561614343000,                "CreateTime": 1561614343000,                "UpdateTime": 1561614343000,                "ChargeType": "postpaid",                "CouponAmount": 0,                "IsOffine": false,                "IsInvoice": false,                "PayType": "CHARGING_HOURS",                "UserId": "35d272a7-4c2b-4079-aa50-45e6f7fa31b6",                "ProductCategory": "DATA_HARD_DISK",                "AccountId": null,                "AccountName": null,                "TotalPrice": 0,                "UserName": "haha",                "ProductRegionId": "8b128f0c-e9ad-472c-9c20-451b9f310e94",                "ProductRegionName": "cloudos-tj",                "OrderStatus": "PAID"
            }
        ]
    },    "TotalCount": 80,    "PageNum": 1,    "PageSize": 2}

错误码 { .section}

HttpCode错误码错误信息错误描述
400InvalidParameterThe specified moduleCode is not valid.指定的参数不合法。
400MissingParameterThe specified parameter Size is necessary for this request.Size参数是请求必要参数
400MissingParameterThe specified parameter Page is necessary for this request.Page参数是请求必要参数
400OverMaxPageSizeMax available page size is 200, please check your param.单页最大size为200，size超过最大限制
400OverMinPageSizeMin available page size is 1, please check your param.最小page为1，page超过最小限制
500SystemErrorSystem Error系统错误