全部产品
云市场

订单列表查询服务

更新时间:2019-06-03 10:29:04

接口名

QueryOrders

描述

查询用户或者分销客户订单列表情况。
缺省查询当前时间最近1小时范围内订单,如需查询更长时间范围的订单数据,请参照设置CreateTimeStart & CreateTimeEnd 参数。

请求参数

名称 类型 是否必填 说明
Action String 要执行的操作,取值:QueryOrders
ProductCode String 产品代码
ProductType String 产品类型
SubscriptionType String 订阅类型。取值类型:Subscription:预付费,PayAsYouGo:后付费
OrderType String 订单类型。取值范围:New:新购,Renew:续费,Upgrade:升级,Refund:退款
PaymentStatus String 支付状态。取值范围:Unpaid:未支付,Paid:已支付,Cancelled:已作废
CreateTimeStart String 创建时间段起(缺省查询当前时间最近1小时内订单),格式:YYYY-MM-ddTHH:mm:ssZ(例:2016-05-23T12:00:00Z)
CreateTimeEnd String 创建时间段止(缺省查询当前时间最近1小时内订单),格式同上
PageNum Integer 分页数
PageSize Integer 每页条数
OwnerId Long OwnerId 分销商查询分销客户的时候需要填写

返回参数

名称 类型 说明
OrderID String 订单号
ProductCode String 主产品代码
ProductType String 主产品类型
SubscriptionType String 订阅类型 Subscription/PayAsYouGo
OrderType String 订单类型。取值范围:New:新购,Renew:续费,Upgrade:升级,Refund:退款
RelatedOrderId String 关联订单ID(适用于伙伴补单场景,对应上级订单ID)
CreateTime String 创建时间
PaymentTime String 支付时间
PaymentStatus String 支付状态。取值范围:Unpaid:未支付,Paid:已支付,Cancelled:已作废
PretaxGrossAmount String 原始金额
PretaxAmount String 订单应付金额
Currency String 币种

错误码

错误码 错误信息 HTTP状态码语义
NotApplicable This API is not applicable for caller. 400 该用户没有访问API的权限。
MissingParameter The specified parameter xx is mandatory for this request. 400 指定的参数未设置。
InvalidParameter The specified moduleCode is not valid. 400 指定的参数不合法。
InvalidModuleCode The specified moduleCode is not valid. 400 模块标识不合法。
InvalidConfigCode The specified configCode is not valid. 400 模块属性标识不合法。
InvalidOwner The specified owner doesn’t belong to caller. 400 指定的拥有者从属关系不属于调用者。
InvalidCaller The specified caller doesn’t exists. 400 调用者不合法。
InternalError The request processing has failed due to some unknown error, exception or failure. 400 内部未知错误。

请求示例

  1. https://business.aliyuncs.com/?Action=&Action=QueryOrders
  2. &OrderType=New
  3. &PaymentStatus=Paid
  4. &ProductCode=rds
  5. &ProductType=bards
  6. &SubscriptionType=PayAsYouGo
  7. &公共参数

返回示例

  1. "Data": {
  2. "TotalCount": 1,
  3. "OrderList": {
  4. "Order": [
  5. {
  6. "SubscriptionType": "PayAsYouGo",
  7. "PaymentTime": "2017-06-08T09:41:30Z",
  8. "ProductCode": "rds",
  9. "ProductType": "bards",
  10. "CreateTime": "2017-06-08T09:41:30Z",
  11. "OrderType": "New",
  12. "OrderId": "200849042540611",
  13. "PretaxAmount": 0,
  14. "Currency": "CNY",
  15. "PretaxGrossAmount": 0,
  16. "PaymentStatus": "Paid"
  17. }
  18. ]
  19. },
  20. "PageSize": 20,
  21. "PageNum": 1