edit-icon download-icon

QueryOrders

Last Updated: Oct 18, 2018

API Name

QueryOrders

Overview

You can call this operation to retrieve the list of orders.

Request parameters

Name Type Required Description
ProductCode String Yes The code of the specified product.
ProductType String No The type of the specified product.
SubscriptionType String Yes The type of billing method. Valid values: Subscription, PayAsYouGo
OrderType String No The type of order. Valid values: New, Renew, Upgrade, Refund
PaymentStatus String No The status of payment. Valid values: Unpaid, Paid, Cancelled
CreateTimeStart String No The start time of the period when the specified orders were created. Will query latest 1 hour orders if blank.
CreateTimeEnd String No The end time of the period when the specified orders were created. Will query latest 1 hour orders if blank.
PageNum Integer No The current page number.
PageSize Integer No The number of items that are displayed on each page.
OwnerId Long No The ID of the owner. This parameter is required when a distributer calls this operation.

Response parameters

Name Type Required
OrderID String The ID of the specified order.
ProductCode String The code of the specified main product.
ProductType String The type of the specified main product.
SubscriptionType String The type of billing method. Valid values: Subscription and PayAsYouGo.
OrderType String The type of order. Valid values: New, Renew, Upgrade, Refund
CreateTime String The time when the specified order was created.
PaymentTime String The time of payment.
PaymentStatus String The status of payment. Valid values: Unpaid, Paid, Cancelled
PretaxGrossAmount String The pretax gross amount.
PretaxAmount String The pretax amount.
Currency String The type of currency.

Error codes

Error code Description HTTP status code Description
NotApplicable This API is not applicable for caller. 400 The error message returned when you are not authorized to use the API.
MissingParameter The specified parameter xx is mandatory for this request. 400 The error message returned when the xx parameter is not specified.
InvalidParameter The specified parameter xx is not valid. 400 The error message returned when the xx parameter is invalid.
InvalidModuleCode The specified moduleCode is not valid. 400 The error message returned when the specified moduleCode parameter is invalid.
InvalidConfigCode The specified configCode is not valid. 400 The error message returned when the specified configCode parameter is invalid.
InvalidOwner The specified owner doesn’t belong to caller. 400 The error message returned when the specified owner does not belong to the caller.
InvalidCaller The specified caller doesn’t exists. 400 The error message returned when the caller is invalid.
InternalError The request processing has failed due to some unknown error, exception or failure. 400 The error message returned when an unknown internal error occurs.
ProductNotFind Can not find inquired product, it may not exist. 400 The error message returned when the specified product is invalid.

Sample requests

  1. https://business.ap-southeast-1.aliyuncs.com/?Action=QueryOrders
  2. &CreateTimeStart=2018-09-01T00:00:00Z

Sample responses

  1. "Data": {
  2. "OrderList": {
  3. "Order": [
  4. {
  5. "SubscriptionType": "Subscription",
  6. "PretaxAmountLocal": 0.11,
  7. "OrderId": "500491030250924",
  8. "PretaxAmount": 0.11,
  9. "Tax": 0.01,
  10. "AfterTaxAmount": 0.12,
  11. "PaymentStatus": "Cancelled",
  12. "PaymentTime": "2018-09-17T06:13:43Z",
  13. "PaymentCurrency": "USD",
  14. "ProductType": "",
  15. "OrderType": "New",
  16. "CreateTime": "2018-09-17T06:13:43Z",
  17. "PretaxGrossAmount": 0.1,
  18. "Currency": "USD"
  19. },
  20. {
  21. "SubscriptionType": "Subscription",
  22. "ProductCode": "yunqimeeting_intl",
  23. "PretaxAmountLocal": 27.27,
  24. "OrderId": "500482925350924",
  25. "AfterTaxAmount": 27.54,
  26. "PretaxAmount": 27.27,
  27. "Tax": 0.27,
  28. "PaymentStatus": "Cancelled",
  29. "PaymentTime": "2018-09-07T02:14:05Z",
  30. "PaymentCurrency": "USD",
  31. "ProductType": "2018_hzyq_piao_single_intl",
  32. "OrderType": "New",
  33. "CreateTime": "2018-09-07T02:14:05Z",
  34. "PretaxGrossAmount": 27,
  35. "Currency": "USD"
  36. }
  37. ]
  38. },
  39. "TotalCount": 2,
  40. "PageSize": 20,
  41. "PageNum": 1
Thank you! We've received your feedback.