查詢用戶提貨券信息。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ExpiryTimeStart | string | 否 | 失效開始時間。格式:yyyy-MM-ddTHH:mm:ssZ。 | 2018-08-01T00:00:00Z |
ExpiryTimeEnd | string | 否 | 失效結(jié)束時間。格式:yyyy-MM-ddTHH:mm:ssZ。 | 2018-08-01T00:00:00Z |
EffectiveOrNot | boolean | 否 | 提貨券是否生效:
默認(rèn) false。 | true |
PageNum | integer | 否 | 頁碼。 | 1 |
PageSize | integer | 否 | 每頁顯示條數(shù)。每頁條數(shù)不允許超過 300 | 10 |
返回參數(shù)
示例
正常返回示例
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": "云服務(wù)器",
"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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-08-08 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |