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
https://business.ap-southeast-1.aliyuncs.com/?Action=QueryRedeem&ExpiryTimeStart=&ExpiryTimeEnd=&EffectiveOrNot=&PageNum=&PageSize=
Sample responses
"Data": { "Redeem": { "Redeem": [ { "Status": "expired", "ApplicableProducts": "ECS (subscription international site 1)", "NominalValue": "0", "Specification": "", "Balance": "0", "RedeemId": "15", "ExpiryTime": "2018-06-13 20:25:00", "EffectiveTime": "2018-05-14 20:25:00", "RedeemNo": "48890819881872821610", "GrantedTime": "2018-05-14 20:25:00" } ] }, "TotalCount": 1, "PageSize": 20, "PageNum": 1 }, "Message": "Successful!", "RequestId": "555C62F8-88C5-4FC5-A929-B8C544FC6AEC", "Success": true, "Code": "Success"