API文档中心

热门接口:产品ID找同款全量维权查询万能转链字符串ID转换 (有API需求可联系本站)

唯礼金创建接口

调用权限:核心接口会员卡调用
接口使用场景等说明:

礼金创建接口可针对指定商品生成礼金code,之后还需调用转链接口,传入商品链接/ID + 礼金code,即可生成礼金推广链接,进行投放推广。


 注:您需要预先转入佣金才可创建礼金,请在联盟PC官网-我要推广-营销工具-唯礼金,或唯享客app-收益-唯礼金,进行佣金转入,佣金转入和转出均实时到账。 (您需开通礼金权限方可转入金额,如您没有找到礼金入口,请先联系商务开通礼金权限,部分商品不可创建礼金)

调用说明

本接口需要您在会员中心授权(如果多用户可传入sessionkey参数)

接口请求地址

环境 http 地址 https 地址
正式环境 http://api.veapi.cn/vip/vip_createGift 暂无

请求方式:GETPOST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String V123M56 公共参数,接口秘钥,请在会员中心获取
requestId String   请求唯一id(唯一标识,用于幂等性控制,建议使用UUID
giftName String   礼金名称(不支持表情符号,最长32个字符)
goodsId String   商品ID(需要创建礼金的商品goodsId、链接、口令,也可以通过vipLinkCheck接口获取对应链接的商品ID;当创建多商品礼金传入giftCouponType=1时,用英文逗号","隔开多个商品id,数量为2~1000个商品ID)
amount String 1 礼金面额(单位:元)最小不可低于1元,最大不可超过商品最低价格的30%,需为整数
totalCount Integer   创建礼金券的总数量
activityStartTime String 2025-06-25 00:00:00 领取开始时间(yyyy-MM-dd HH:mm:ss),区间为(创建当前时间直至未来3个月内)
activityEndTime String 2025-06-26 23:59:59 领取结束时间(yyyy-MM-dd HH:mm:ss),区间为(创建当前时间直至未来3个月内)
useTimeType Integer   使用时间类型:0:绝对时间,1:领取后1天有效,2:领取后3天有效,3:领取后n天有效(领取后时间为相对时间,需配合使用时间段一同传入)
useStartTime String   使用开始时间(useTimeType=0 时生效)
useEndTime String   使用结束时间(useTimeType=0 时生效)
targetUserTypes String   礼金可领取人群(可多选):1 唯品会新客,2 唯品会沉睡用户 3 新客/沉睡复购,多个用英文逗号分隔
singleClaimPerLink Integer   每个礼金推广链接是否限制仅可领取1张礼金:0不限,1限制,如果需要提供礼金链接推手自行转链,请传入0,否则推手转链的链接仅可被领取1张礼金,仅相同唯品会联盟账号可转礼金的链接,其他账号无法转礼金链接
allSkusUnderProduct Integer 0 是否绑定同spu商品(1-是;0-否),扩展到这款商品的全部颜色,如,口红的全部色号、衣服的全部颜色。
relativeNumber Integer   礼金被领取后的有效天数(useTimeType =3时需要传入,单位:天,比如传入值为3代表创建的礼金在领取后3天内有效)
targetedType Integer 1 定向派发类型:1:不限制派发,本账号所有用户可派发 2:本账号推广-定向PID,3:本账号推广-定向OPENID(传入值为2或者3时,转链时如果传入非指定pid或者openId,无法生成对应giftCode的礼金页面链接,只会生成普通转链链接)
targetedValues String   定向派发类型具体值(当定向派发类型为2,3时,必须传入):定向派发类型为2时,传入PID,可传入多个; 定向派发类型为3时,传入OPENID,可传入多个
createMode Integer   创建礼金模式:1 -不可使用官方充值资金时自动使用自有资金创建,2 - 不可使用官方充值资金时直接创建失败
giftCouponType Integer 0 创建礼金类型:0-单商品礼金,1-多商品礼金(不传默认为单商品礼金,单商品礼金:仅可针对一个商品创建礼金,创建后,礼金的使用范围为该商品;多商品礼金:可针对最多1000个商品ID创建礼金,创建后,礼金使用范围为传入的商品ID)

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/vip/vip_createGift?vekey=xxx&giftName=aaabbbb&goodsId=6921408663914989575&amount=50&totalCount=2&activityStartTime=2026-07-20%2018:00:00&activityEndTime=2026-07-22%2018:00:00 

使用curl函数,curl不是php原生库,需要安装才能使用

$api="http://api.veapi.cn/vip/vip_createGift?vekey=xxx&giftName=aaabbbb&goodsId=6921408663914989575&amount=50&totalCount=2&activityStartTime=2026-07-20%2018:00:00&activityEndTime=2026-07-22%2018:00:00";

$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; //返回值
使用okhttp3/httpclient/jsoup/hutool,以hutool为例:

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_createGift?vekey=xxx&giftName=aaabbbb&goodsId=6921408663914989575&amount=50&totalCount=2&activityStartTime=2026-07-20%2018:00:00&activityEndTime=2026-07-22%2018:00:00";
        // JDK 8u111版本后,若目标页面为HTTPS协议,请启用proxy用户密码鉴权
        //System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");

        // 发送请求
        String result = HttpRequest.get(url)
                .timeout(10000)//设置超时,毫秒
                .execute().body();
        System.out.println(result);
    }
}
推荐使用 requests,支持访问http,https网页:

import requests
		
# 要访问的API网页
target_url = "http://api.veapi.cn/vip/vip_createGift?vekey=xxx&giftName=aaabbbb&goodsId=6921408663914989575&amount=50&totalCount=2&activityStartTime=2026-07-20%2018:00:00&activityEndTime=2026-07-22%2018:00:00"

# 发送请求
response = requests.get(target_url)

# 获取页面内容
if response.status_code == 200:
	print response.text

返回值(JSON)

参数名称 参数类型 是否必选 示例值 描述
giftCode String   礼金code(转链时作为参数传入可生成商品对应的礼金领取链接)
createSuccessNum Integer   多商品礼金创建成功数量

返回示例

【提示】推广链接或口令有时效性,示例中链接与口令为创建文档时生成,仅用于展示返回结果,有可能已失效。

错误码

如果error不为0时,请点此查看错误码表格

在线
客服

会员请加QQ群交流:

微信
咨询

加微信咨询
顶部