【会员相关接口】场景四：优惠券同步

主帖>【会员相关接口】八大场景接口对接说明

场景描述：

商家为了提高销量或吸粉，需要创建一些优惠券发放给用户，如何在微商城中完成优惠券的创建并发放给用户？如何实现外部系统的优惠券和有赞的打通？

——微商城后台-营销-营销概况-营销玩法-优惠券，点击绿色的按钮“新建优惠券”，即可创建对应权益的优惠券；

——微商城后台-营销-营销概况-营销玩法-优惠券界面，可以查看已经创建好的优惠券的推广方式及领取情况；

——点击“推广”后，获取优惠券的推广链接、二维码或小程序码；用户点击链接，扫描二维码或小程序码均可以领取优惠券；

——通过哪个接口可以在微商城创建对应权益的优惠券？

（1）创建优惠券：youzan.ump.promocard.add

（2）链接地址：https://www.youzanyun.com/apilist/detail/group_ump/coupon/youzan.ump.promocard.add ；

（3）重要字段说明：

》》at_least：如果 is_at_least 为 1，该字段表示订单必须满这个价格，优惠券才可用，即满多少元可用；单位：元，精确到分，例如5.20元；

》》end_at：优惠券有效期结束时间，时间格式yyyy-MM-ddHH:mm:ss，避免因时间格式不对造成的调用失败问题；

》》is_at_least：是否设置满多少元可用，0表示不限制，1表示限制；

》》need_user_level：是否限制领用者的等级，0 表示不限制，大于 0 表示领用者必须是这个等级ID，才有资格领取该优惠券；比如该参数入参为4，某用户持有的会员卡等级为3，则该用户是没有资格领取该优惠券的；

》》quota：限领个数，为0则表示不限制，入参2、3、4…分别表示每人最多领取2、3、4个…，以此类推；

》》start_at：优惠券生效时间，时间格式yyyy-MM-ddHH:mm:ss，避免因时间格式不对造成的调用失败问题；

》》total：总库存，即优惠券的总发放个数；如果quota字段的入参不为0，则优惠券发放完毕后，实际领取人数会比优惠券的总数少；

》》is_random：是否是随机优惠券，0 表示不随机，1 表示随机，用户领取到的优惠券面额是商家设置的面额范围内的随机值，面额范围由下面提到的value和value_random_to字段确定；

》》value：如果 is_random 为 1，则该字段表示随机金额的下限；单位：元，精确到分；

》》value_random_to:如果 is_random 为 1，则该字段表示随机金额的上限，单位：元，精确到分;

（4）调用格式，通过（2）中链接访问后：

（5）HTTP调用示例：

（6）JAVA调用示例：

YZClient client = new DefaultYZClient(newToken("token")); //new Sign(appKey, appSecret)

YouzanUmpPromocardAddParams youzanUmpPromocardAddParams =new YouzanUmpPromocardAddParams();

youzanUmpPromocardAddParams.setValueRandomTo("0");

youzanUmpPromocardAddParams.setValue("55");

youzanUmpPromocardAddParams.setTotal(55L);

youzanUmpPromocardAddParams.setTitle("大朱ceshi优惠券");

youzanUmpPromocardAddParams.setStartAt("2018-12-25 12:00:00");

youzanUmpPromocardAddParams.setRangeType("ALL");

youzanUmpPromocardAddParams.setQuota(55L);

youzanUmpPromocardAddParams.setNeedUserLevel(0L);

youzanUmpPromocardAddParams.setIsAtLeast(0L);

youzanUmpPromocardAddParams.setEndAt("2018-12-30 00:00:00");

youzanUmpPromocardAddParams.setAtLeast("0");

youzanUmpPromocardAddParams.setDateType(2L);

youzanUmpPromocardAddParams.setFixedBeginTerm(1L);

youzanUmpPromocardAddParams.setFixedTerm(2L);

youzanUmpPromocardAddParams.setPreferentialType(2L);

youzanUmpPromocardAddParams.setDiscount(88L);

YouzanUmpPromocardAdd youzanUmpPromocardAdd = newYouzanUmpPromocardAdd();

youzanUmpPromocardAdd.setAPIParams(youzanUmpPromocardAddParams);

YouzanUmpPromocardAddResult result =client.invoke(youzanUmpPromocardAdd);

——通过哪个接口可以将创建好的优惠券发放给客户？

（1）发放优惠券/优惠码：youzan.ump.coupon.take

（2）链接地址：https://www.youzanyun.com/apilist/detail/group_ump/coupon/youzan.ump.coupon.take ；

（3）重要字段说明：

》》coupon_group_id：优惠券码组ID，通过优惠券或优惠码创建接口创建成功后返回，也可以通过接口https://www.youzanyun.com/apilist/detail/group_ump/coupon/youzan.ump.coupon.search ”分页查询优惠券/优惠码列表“来获取，也可以通过接口https://www.youzanyun.com/apilist/detail/group_ump/coupon/youzan.ump.coupons.unfinished.search ”获取所有未结束的优惠券/优惠码列表“；两者的主要区别有两点，一是前者是获取所有优惠券信息，包括过期的和失效的，后者只获取可用的；二是后者可以自定义字段来查询信息，比如只想查询coupon_group_id，则入参只传coupon_group_id字段名即可；

》》fans_id：粉丝ID，从各渠道进入微商城后，粉丝在微商城中的唯一ID，如果没有写0，mobile/fans_id/open_user_id 三选一传入；

》》mobile：手机号，如果用户主动绑定了手机号，或是直接通过手机号注册的方式进入微商城，后台会优先以手机号作为用户标识；如果没有写0，mobile/fans_id/open_user_id 三选一传入；

》》open_user_id：三方用户ID，此ID只出现在APPSDK开店业务场景中，在登录态打通过程中，三方将open_user_id传给有赞，作为三方APP用户在微商城中的用户标识；如果没有写0，mobile/fans_id/open_user_id 三选一传入；

》》weixin_openid：微信用户对应的openid，fans_id与weixin_openid存在一个即可；

注意：当入参fans_id/weixin_openid、mobile、open_user_id均有时，首先会通过mobile查找用户，其次是fans_id/weixin_openid，最后是open_user_id；

（4）调用格式，通过（2）中链接访问后：

（5）HTTP调用示例：

（6）JAVA调用示例：

YZClient client = new DefaultYZClient(newToken("token")); //new Sign(appKey, appSecret)

YouzanUmpCouponTakeParams youzanUmpCouponTakeParams = newYouzanUmpCouponTakeParams();

youzanUmpCouponTakeParams.setMobile(15088886668L);

youzanUmpCouponTakeParams.setCouponGroupId(1675420L);

YouzanUmpCouponTake youzanUmpCouponTake = newYouzanUmpCouponTake();

youzanUmpCouponTake.setAPIParams(youzanUmpCouponTakeParams);

YouzanUmpCouponTakeResult result =client.invoke(youzanUmpCouponTake);

主帖>【会员相关接口】八大场景接口对接说明