All Products
Search
Document Center

QueryRedeem

Last Updated: Jun 18, 2020

API Name

QueryRedeem

Overview

You can call this operation to query redeem cards.

Request parameters

Name Type Required Description
EffectiveOrNot Boolean No Indicates whether the specified redeem card is valid. Valid values: True, False. By default is False.
ExpiryTimeStart String No The start time of expiration. Format: yyyy-MM-dd’T’HH:mm:ss’Z’, Example: 2018-08-01T00:00:00Z
ExpiryTimeEnd String No The end time of expiration. Format: yyyy-MM-dd’T’HH:mm:ss’Z’, Example: 2018-08-01T00:00:00Z
PageNum Integer No The current page number.
PageSize Integer No The number of items that are displayed on each page.

Response parameters

Name Type Required
RedeemId String The ID of the specified redeem card.
RedeemNo String The Number of the specified redeem card.
Status String Generated, CallBack, RefundPending, Canceled, Order_Canceled, ActivePending, ActiveSuccess, ExchangePending, ExchangeSuccess, Expired
GrantedTime String Time when issued.
EffectiveTime String Time when valid.
ExpiryTime String Time when expired.
NominalValue String The nominal value of the specified redeem card.
Balance String The balance of the specified redeem card.
ApplicableProducts String The products that the specified redeem card is applicable to.
Specification String The specification of this specified redeem card.

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=QueryRedeem
  2. &ExpiryTimeStart=
  3. &ExpiryTimeEnd=
  4. &EffectiveOrNot=
  5. &PageNum=
  6. &PageSize=

Sample responses

  1. "Data": {
  2. "Redeem": {
  3. "Redeem": [
  4. {
  5. "Status": "expired",
  6. "ApplicableProducts": "ECS (subscription international site 1)",
  7. "NominalValue": "0",
  8. "Specification": "",
  9. "Balance": "0",
  10. "RedeemId": "15",
  11. "ExpiryTime": "2018-06-13 20:25:00",
  12. "EffectiveTime": "2018-05-14 20:25:00",
  13. "RedeemNo": "48890819881872821610",
  14. "GrantedTime": "2018-05-14 20:25:00"
  15. }
  16. ]
  17. },
  18. "TotalCount": 1,
  19. "PageSize": 20,
  20. "PageNum": 1
  21. },
  22. "Message": "Successful!",
  23. "RequestId": "555C62F8-88C5-4FC5-A929-B8C544FC6AEC",
  24. "Success": true,
  25. "Code": "Success"