调用QueryRedeem查询提货券服务_阿里云交易和账单管理API(BOA)-阿里云帮助中心

查询用户提货券信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ExpiryTimeStart	string	否	失效开始时间。格式：yyyy-MM-ddTHH:mm:ssZ。	2018-08-01T00:00:00Z
ExpiryTimeEnd	string	否	失效结束时间。格式：yyyy-MM-ddTHH:mm:ssZ。	2018-08-01T00:00:00Z
EffectiveOrNot	boolean	否	提货券是否生效： true。 false。默认 false。	true
PageNum	integer	否	页码。	1
PageSize	integer	否	每页显示条数。每页条数不允许超过 300	10

返回参数

名称	类型	描述	示例值
	object
Code	string	状态码。	Success
Message	string	错误信息。	Successful
RequestId	string	请求 ID。	E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B
Success	boolean	是否成功。	true
Data	object	返回数据。
PageNum	long	页码。	1
PageSize	long	每页显示条数。	10
TotalCount	long	总记录数。	1
Redeem	array<object>	提货券详情。
	object
ExpiryTime	string	提货券失效时间。	2018-06-13 20:25:00
GrantedTime	string	提货券发行时间。	2018-05-14 20:25:00
Status	string	提货券状态，取值： Generated：已生成。 CallBack：已回调。 RefundPending：提货券退款中。 Canceled：提货券已作废。 Order_Canceled：订单已作废。 ActivePending：激活中，请稍后。 ActiveSuccess：激活成功。 ExchangePending：兑换中。 ExchangeSuccess：兑换成功。 Expired：已过期。 Invalid：已作废。	Generated
Specification	string	提货券规格。	无
NominalValue	string	面额。	0
EffectiveTime	string	提货券生效时间。	2018-05-14 20:25:00
RedeemId	string	提货券 ID。	1342
RedeemNo	string	提货券 Number。	4889*****1610
ApplicableProducts	string	适用产品。	云服务器
Balance	string	余额。	0

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "Redeem": {
      "Redeem": [
        {
          "ExpiryTime": "2018-06-13 20:25:00",
          "GrantedTime": "2018-05-14 20:25:00",
          "Status": "Generated",
          "Specification": "无",
          "NominalValue": "0",
          "EffectiveTime": "2018-05-14 20:25:00",
          "RedeemId": "1342",
          "RedeemNo": "4889*****1610",
          "ApplicableProducts": "云服务器",
          "Balance": "0"
        }
      ]
    }
  }
}

错误码

HTTP status code	错误码	错误信息
400	NotAuthorized	This API is not authorized for caller.
400	NotApplicable	This API is not applicable for caller.
400	InvalidOwner	The specified owner doesn't belong to caller.
500	InternalError	The request processing has failed due to some unknown error.

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-08-08	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情