接口使用场景等说明:您可以通过本接口唯礼金code或礼金商品goodsId实时查询查询 唯品会联盟(唯享客)的礼金面额、剩余数量、有效期等基础信息,以及礼金的实时推广数据。
| 环境 | http 地址 | https 地址 |
|---|---|---|
| 正式环境 | http://api.veapi.cn/vip/vip_queryGiftDetail | 暂无 |
| 参数名称 | 参数类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| vekey | String | 是 | V123M56 | 公共参数,接口秘钥,请在会员中心获取 |
| requestId | String | 否 | 请求唯一id(唯一标识,用于幂等性控制,建议使用UUID | |
| giftCreateStartDate | String | 否 | 可查询此日期及以后创建的礼金,如不传则不限日期。 格式:yyyy-MM-dd(传入giftCode时该条件无效) | |
| giftOrderStartDate | String | 否 | 可查询此日期及以后下单的礼金效果数据,如不传则不限日期。 格式:yyyy-MM-dd(传入giftCode时该条件无效) | |
| goodsId | String | 否 | 商品id(用于查询您创建的推客礼金,以及该goodsId下您可推广的联盟礼金。商品ID和礼金活动code二选一,不可同时入参) | |
| giftCode | String | 否 | 礼金活动code(创建礼金接口中返回,查询时与goodsId二选一传入) | |
| openId | String | 否 | 根据openid查询该openid下创建的礼金,仅支持礼金的定向类型为“openid”时查询(传入giftCode时该条件无效) |
GET/POST http://api.veapi.cn/vip/vip_queryGiftDetail?vekey=xxx&goodsId=6921408663914989575&giftCreateStartDate=2026-07-20
$api="http://api.veapi.cn/vip/vip_queryGiftDetail?vekey=xxx&goodsId=6921408663914989575&giftCreateStartDate=2026-07-20"; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $api); //curl_setopt($ch, CURLOPT_POST, true); //POST方式时启用 //curl_setopt($ch, CURLOPT_POSTFIELDS, $postData ); //POST方式时传参 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); //如果使用https请启用 curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); //如果使用https请启用 curl_setopt($ch, CURLOPT_RETURNTRANSFER, true ); //返回数据流,不直接输出 curl_setopt($ch, CURLOPT_ENCODING, 'gzip'); //使用gzip压缩传输让访问更快 curl_setopt($ch, CURLOPT_TIMEOUT, 6); //允许执行的最长秒数。这里设定6S curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5); $result = curl_exec($ch); $info = curl_getinfo($ch); curl_close($ch); echo $result; //返回值
import cn.hutool.http.HttpResponse;
import cn.hutool.http.HttpRequest;
public class testGetParam {
public static void main(String[] args) {
// API网址
String url = "http://api.veapi.cn/vip/vip_queryGiftDetail?vekey=xxx&goodsId=6921408663914989575&giftCreateStartDate=2026-07-20";
// JDK 8u111版本后,若目标页面为HTTPS协议,请启用proxy用户密码鉴权
//System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");
// 发送请求
String result = HttpRequest.get(url)
.timeout(10000)//设置超时,毫秒
.execute().body();
System.out.println(result);
}
}
import requests # 要访问的API网页 target_url = "http://api.veapi.cn/vip/vip_queryGiftDetail?vekey=xxx&goodsId=6921408663914989575&giftCreateStartDate=2026-07-20" # 发送请求 response = requests.get(target_url) # 获取页面内容 if response.status_code == 200: print response.text
| 参数名称 | 参数类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| giftName | String | 否 | 礼金名称 | |
| giftCode | String | 否 | 礼金 code | |
| amount | String | 否 | 面额(元) | |
| totalCount | Integer | 否 | 礼金张数 | |
| remainAmount | String | 否 | 礼金剩余张数 | |
| usedCount | Integer | 否 | 礼金已使用数 | |
| enableStatus | Integer | 否 | 启用状态:1=启用,2=停用 | |
| giftStatus | Integer | 否 | 礼金状态:1=未开始,2=生效中,3=已结束 | |
| useTimeType | Integer | 否 | 使用时间类型:0=绝对时间,1=领取后1天,2=领取后3天 | |
| activityStartTime | String | 否 | 活动开始时间(格式:yyyy-MM-dd HH:mm:ss) | |
| activityEndTime | String | 否 | 活动结束时间(格式:yyyy-MM-dd HH:mm:ss) | |
| useStartTime | String | 否 | 券使用开始时间(格式:yyyy-MM-dd HH:mm:ss) | |
| useEndTime | String | 否 | 券使用结束时间(格式:yyyy-MM-dd HH:mm:ss) | |
| relativeNumber | Integer | 否 | 礼金被领取后的有效天数(useTimeType = 3时需要传入,单位:天,比如传入值为3代表创建的礼金在领取后3天内有效) | |
| targetedType | Integer | 否 | 定向派发类型 1:不限制派发,本账号所有用户可派发 2:本账号推广-定向PID,3:本账号推广-定向OPENID(传入值为2或者3时,转链时如果传入非指定pid或者openId,无法生成对应giftCode的礼金页面链接,只会生成普通转链链接) | |
| targetedValues | Set | 否 | 定向派发类型具体值(当定向派发类型为2,3时,必须传入):定向派发类型为2时,传入PID,可传入多个; 定向派发类型为3时,传入OPENID,可传入多个 | |
| singleClaimPerLink | Integer | 否 | 每个链接仅限领取一张 | |
| allSkusUnderProduct | Integer | 否 | 是否针对全部尺码颜色 | |
| giftCouponType | Integer | 否 | 礼金类型:0-单商品礼金,1-多商品礼金 | |
| giftCode | String | 否 | 礼金code | |
| giftName | String | 否 | 礼金名称 | |
| amount | String | 否 | 礼金面额(单位:元) | |
| goodsId | String | 否 | 礼金对应商品id | |
| totalCount | String | 否 | 礼金张数 | |
| receiveCount | Integer | 否 | 领取数(张) | |
| useCount | Integer | 否 | 使用数(张) | |
| estimatedCommission | String | 否 | 预估佣金(元) | |
| expiredCount | Integer | 否 | 已失效数 | |
| useAmount | String | 否 | 使用资金 | |
| targetedType | Integer | 否 | 定向派发类型 1:不限制派发,本账号所有用户可派发 2:本账号推广-定向PID 3:本账号推广-定向OPENID | |
| targetedValues | Set | 否 | 定向派发类型具体值(当定向派发类型为2,3时有值):定向派发类型为2时,返回PID列表; 定向派发类型为3时,返回OPENID列表 | |
| returnedCount | Integer | 否 | 0 | 已返还礼金数量 |
| goodsIdList | List | 否 | 多商品礼金对应的商品id列表 |