调用QueryRedeem查询用户提货券信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryRedeem

系统规定参数。取值:QueryRedeem。

EffectiveOrNot Boolean true

提货券是否生效:

  • true。
  • false。

默认false。

ExpiryTimeEnd String 2018-08-01T00:00:00Z

失效结束时间。格式:yyyy-MM-ddTHH:mm:ssZ。

ExpiryTimeStart String 2018-08-01T00:00:00Z

失效开始时间。格式:yyyy-MM-ddTHH:mm:ssZ。

PageNum Integer 1

页码。

PageSize Integer 10

每页显示条数。

返回数据

名称 类型 示例值 描述
Code String Success

状态码。

Data Struct

返回数据。

PageNum Long 1

页码。

PageSize Long 10

每页显示条数。

Redeem Array

提货券详情。

Redeem
ApplicableProducts String 云服务器

适用产品。

Balance String 0

余额。

EffectiveTime String 2018-05-14 20:25:00

提货券生效时间。

ExpiryTime String 2018-06-13 20:25:00

提货券失效时间。

GrantedTime String 2018-05-14 20:25:00

提货券发行时间。

NominalValue String 0

面额。

RedeemId String 1342

提货券ID。

RedeemNo String 4889*****1610

提货券Number。

Specification String

提货券规格。

Status String Generated

提货券状态,取值:

  • Generated。
  • CallBack。
  • RefundPending。
  • Canceled。
  • Order_Canceled。
  • ActivePending。
  • ActiveSuccess。
  • ExchangePending。
  • ExchangeSuccess。
  • Expired。
TotalCount Long 1

总记录数。

Message String Successful

错误信息。

RequestId String E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B

请求ID。

Success Boolean true

是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=QueryRedeem
&ExpiryTimeEnd=2018-08-01T00:00:00Z
&ExpiryTimeStart=2018-08-01T00:00:00Z
&PageNum=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML 格式

<QueryRedeemResponse>
      <Message>Successful!</Message>
      <RequestId>E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B</RequestId>
      <Data>
            <TotalCount>0</TotalCount>
            <PageSize>10</PageSize>
            <PageNum>1</PageNum>
            <Redeem>
        </Redeem>
      </Data>
      <Code>Success</Code>
      <Success>true</Success>
</QueryRedeemResponse>

JSON 格式

{
	"Message": "Successful!",
	"RequestId": "E503DC7B-E4F0-4B3C-BC89-BCECF1338F0B",
	"Data": {
		"TotalCount": 0,
		"PageSize": 10,
		"PageNum": 1,
		"Redeem": {
			"Redeem": []
		}
	},
	"Code": "Success",
	"Success": true
}

错误码

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