各位第三方开发者:
开放合作是未来的趋势,有赞认为商业合作伙伴将在未来的开放环境中扮演越来越重要的角色。我们提供一个开放的平台,让合作伙伴可以与消费者、商家建立起紧密合作,让消费者购物更加便捷有趣,让有赞商家更专业、更高效进行经营。无论您是第三方开发者(ISV)、传统软件厂商、互联网O2O硬件,应用营销开发商或者大商家,都能基于有赞开放平台找到适合自己的业务方向。
有赞开放平台是我们共同的家园。在此帖可以展开各种技术讨论、经验交流、需求收集、期望彼此能摩擦出更多的商机。为了开放平台的健康和谐发展,请大家踊跃参与跟帖。
请勿发广告,文明交流,如有接口需求请具体描述使用场景价值,有赞官方会及时收集大家的需求和问题!
接口更新公告
11月28日更新: 更新接口:给用户增减积分接口:kdt.crm.customer.points.decrease/kdt.crm.customer.points.increase 说明:入参规则新增手机号码字段“mobile”支持用户手机号和粉丝id调用(mobile或fans_id至少传一个),以此来给用户增减积分 新增接口:查询用户积分以及积分变更记录(支持根据手机号或粉丝id) kdt.crm.customer.points.changelog.get 说明:第三方通过该接口查询用户积分和积分变更记录,通过入参查询时间(必须七天之内),用户信息(粉丝id和手机号其一)来查询用户在有赞增减多少积分,最终剩下多少积分数值等信息。 场景: 1.之前积分必须以粉丝id为唯一标识,导致现在很多以手机号为准的第三方会员系统无法对应有赞的积分,有了手机号入参后外部可以自由选择手机号和粉丝信息来对应用户账号,实现积分同步 2.通过积分变更记录同步接口,可以获取到最新的有赞内部的积分变化记录,例如某用户通过规则获取到了商家的30个积分,商家需求系统马上同步到积分信息,然后推送一条微信消息给到用户告知。另外,现在积分信息现在只能调取不能主动推送,敬请期待推送积分功能上线。
11月17日更新: 注意:原根据 fans_id 加减积分的kdt.crm.fans.points.payin.get / kdt.crm.fans.points.payout.get 两个接口已下线(不影响已调用商家),建议切换调用上述新接口。
11月15日更新: 新增字段:TradeFetch中新增shop id字段判断自提订单的门店id信息,与多门店id无关 交易接口中新增酒店版解决方案接口:kdt.trade.get、kdt.trades.sold.get
新增返回字段:hotel_info,酒店入住信息包括入驻时间,入驻人信息,退房信息
场景:酒店客栈商家在有赞销售房间,订单产生后,商家自有系统上同步常规订单信息之外,可同时查看客户入驻时间,退房时间,入住人信息,以便核对显示,对账等 10月13日更新: 1.消息推送服务新增支持商品数据变更推送通知。
说明:有赞商家可通过上述接口根据客户手机号给客户加减积分。 场景:商家已有一批具有手机号信息的会员,且有会员积分。如商家想将这批会员导入有赞微商城同时将相应的积分记录导入,只需使用有赞微商城的【客户-会员管理-导入会员】功能将会员账号信息导入有赞,再调用上述接口以手机号为标识给相应会员加上积分,即可实现会员积分打通。
10月9日更新: 说明:增加tuan_no 字段,表示拼团订单对应的团编号 场景:用户是销售的班级是健身小班课程,举行呼朋唤友的活动。组团购买的用户需要进入一个班级,不同团的用户需要进行隔离。因此需要团编号。
9月29日更新:
交易接口:获取单笔交易信息和获取交易列表数据
更新:shipping_type字段新增同城配送订单类型,当显示为local时代表同城配送订单。方便第三方硬件和软件能根据同城订单类型来做归类和后续打印操作。
9月29日更新:
微信粉丝领取优惠券优惠码:kdt.ump.coupon.take
更新:新增card_id入参。“微信卡券card_id。coupon_group_id和card_id两个必须有一个
场景:有赞商家在有赞后台创建优惠券后,同步至微信卡券,可通过微信卡券功能对用户投放卡券(群发、嵌入图文等)。粉丝领取到卡券后,通过该接口字段,商家可传入微信的卡券id将相应的有赞优惠券/码派发给指定粉丝,实现双方领券同步。
9月28日更新:
交易接口新增秒杀和降价拍优惠信息
获取单笔交易的信息和查询卖家已卖出的交易列表返回信息中TradePromotion(订单中使用到的优惠活动的数据结构)新增SECKILL(秒杀)和 AUCTION(降价拍)优惠信息,包括标题,金额等内容。方便外部开发者核对对账。
9月26日 根据最新收银台功能完善接口: 创建收款二维码接口中收款理由变更为二维码名称,新增标签字段; 获取收款二维码生成记录列表接口新增二维码类型、是否使用优惠及具体优惠信息; 新增二维码详情查询接口,可查询二维码图片、名称、金额、关联 URL、优惠信息等; 新增二维码标签列表信息接口。
9月22日开放接口: 说明:通过店铺id,商品id,skuid,订单id,买家id等条件去获取商品评价内容,支持查询单条评价数据或复合条件组合查询多条评价数据,支持查询某个商品的好评/中评/差评统计数。 备注:新增评价接口组,以往开发者须自行重新生成token才能调用评价接口组内的接口。
9月14日更新:
获取商品优惠详情:kdt.ump.promotion.get
说明:一个牛逼的全站优惠信息的商品接口
通过商品id(必填)或粉丝id,有赞id查找有赞店铺该商品关联的所有优惠活动信息,包括订单维度的满减送和订单返现;包括优惠套餐和积分兑换;包括商品维度的团购,秒杀,拼团,降价拍,会员折扣,限时折扣。
场景:某商家需求自定义商品展示详情页面,需求在每个商品页面上展示该商品关联的优惠信息有哪些,通过该接口可以知道商品有哪些优惠活动。也可以通过该接口核对出所有某优惠活动的商品列表信息,在商品页面上设计秒杀专区,团购专区等活动策划。
有赞接口文档中的各种ID:weixin_user_id;buyer_id;outer_user_id;fans_id;user_id,weixin_open_id,是不是把你凌乱得傻傻分不清楚。
开放平台已对文档中的用户ID进行了梳理优化,帮助开发者们更好的理解各名称的意义,更方便的调用开放接口
说明:多门店第二期主要目的是实现商品维度的外部同步,包括商品库存,价格,规格等信息。同时外部可以更新网点基础配置信息,修改网点的配送范围,起送金额等字段。 场景: 1.某商家有线下门店5家,利用有赞多门店功能,分别发布不同的商品信息,通过接口获取每个门店的商品信息。 2.如门店地址不准确,可以根据门店的经纬度来更新门店配置。 3.订单产生后,流转到指定的门店处理发货。该门店通过获取商品sku接口读取最新库存信息,实现门店和网店的库存同步管理 4.获取线下门店的单个商品或所有商品的配送方式,也可以通过接口更新商品的配送方式。 ps:多门店二期接口应与第一期的接口共同配置使用,获取网点列表信息的接口请到店铺接口中使用。
用户接口(获取用户粉丝信息):http://open.youzan.com/api#9 包括三个接口: 查询微信粉丝用户信息 根据多个微信粉丝用户的 openid 或 user_id 获取用户信息 根据微信粉丝用户的 openid 或 user_id 获取用户信息 入参规则:限制拉取用户信息的单页条数,例如代表拉取微信粉丝用户信息的每页条数,原来限定为最大值5000条,现都改为每页50条拉取。请各位开发者及时知晓。
9月8日
交易接口中增加单个商品退款金额字段:https://open.youzan.com/structparam?struct=TradeOrder
说明:交易接口 tradeorder 字段内增加 refunded_fee字段,代表单笔订单中单个商品的退款金额信息
目的:更好的协助商家对账
1. 修改kdt.item/1.0.0/add 添加商品接口 新增电子卡券相关字段item_validity_start,item_validity_end,effective_type,effective_delay_hours,holidays_available,virtual_type; 2. 修改kdt.item/1.0.0/update 修改商品接口 添加电子卡券相关字段effective_type,effective_delay_hours,holidays_available 8月20日
线下收银台创建二维码:点击进入
线下收银台外部订单号查看使用详情:点击进入 说明:外部入参二维码名称,外部来源(由有赞分配)外部订单号,创建临时收银台二维码收款。再可通过传入外部订单号查询该笔支付订单的收款详情。
场景:某门店进销存系统,已经与有赞打通基础接口。通过该接口增加商家的支付方式。用户到线下消费100元,营业员输入100元,通过该接口向有赞申请一个收款二维码,显示在POS屏显上,用户用手机扫码支付。支付成功后返回支付结果。
备注:此接口仅支持免签名协议;该接口需要提前申请,得到有赞分配的外部来源标识,以便有赞判断该收银台二维码是哪个第三方产生。
1.仅针对微信支付-自有订单,标记退款只是标记作用,且无法真正退款,当订单中的所有商品都标记退款之后,会把订单状态变成已关闭。 2.由于是对商品进行标记退款,接口必须传交易商品标号以及对应的退款金额。 3.微信支付-自有订单退款,您需自行前往微信商户平台操作退款。
说明:交易数据接口里增加“points_price”字段,代表此订单用了积分兑换,具体数值代表消耗了多少积分,非积分兑换订单默认为0,此接口开放便于商家通过接口来核对积分消耗和订单金额的核对,从而财务对账会更加清晰。 说明:多门店上线后,交易订单需要快速流转到指定的门店,交易接口中增加“shop_id”字段,非多门店订单则默认为0。根据该字段识别该笔订单属于哪个具体门店,订单分配到该门店,快速处理订单发货等后续流程,实现多门店订单打通。
8月2日 开放接口:
获取网点列表:点击前往
说明:通过网点类型(自提点或网点),网点名称,当前页码搜索单个店铺下面所有的门店列表,如果网点数很多,以分页显示网点信息。返回字段包括网点id,门店地址,电话,创建时间等等信息。
原有交易接口: 请找到入参列表里“store_id”字段,意是通过网点id去调取该网点下的所有订单信息
场景:某有赞商家有200家线下门店,利用有赞合作的小票打印机打印小票。打印机系统通过获取所有网点id和网点id下的所有网点信息,绑定每个网点的小票打印机唯一编号。再通过交易列表接口,获取网点所产生的交易信息,自动关联某笔交易属于哪个网点,从而知道该笔订单属于哪个小票打印机,小票打印机自动打印出这笔订单的小票。
7月28日 返回结果中增加“用户领取优惠码和优惠券详情”的页面,详情包括已经核销的优惠券/码id,标题,链接等所有优惠券/码信息 背景:很多商家或第三方专业做优惠券的平台,会集合各种平台的优惠券派发,当用户领取后,显示核销状态 流程:在有赞后台新建一组优惠券->优惠券信息通过API同步到外部的会员后台->会员通过外部后台根据积分等活动领取优惠券->我们通过API后台帮会员在有赞领取优惠券->会员到有赞使用优惠券->外部后台到有赞读取优惠券核销信息,更改优惠券状态 下单接口介绍:外部开发者通过上传下单商品的信息,加上订单类型,店铺id等信息,有赞给予回传下一步的结算页url,走完下单流程 添加购物车接口介绍:外部开发者通过上传商品的id,营销活动信息,店铺id等信息,申请添加至有赞购物车页面 背景:很多有开发能力的商家和外部app开发者,利用有赞开店后,需求设计自己的前端店铺首页和商品详情页,根据自己的企业属性配置不同的ui和交互呈现,实现更加自定义和丰富的展示效果。利用这两个接口,开发者们可以完全自定义开发页面。
标记退款:kdt.trade.sign.close
介绍:该接口只支持微信自有的商家,利用该接口实现上传交易单号,该笔订单自动在有赞后台自动标记退款,订单状态会变成已关闭,所以请商家和开发者谨慎处理每一笔订单。 有可能出现一笔订单中,某个商品退款,容易误操作变成已关闭订单 场景:某微信自有支付商家,订单量很大,每天需要退款的订单也很大,当微信后台退款完成后,需要到有赞后台一个一个标记退款,操作成本很大。有了该接口,可以快速上传订单号,自动标记退款。利用接口快速上传,可以实现批量标记的退款,减轻了操作人员的操作成本。
获取单比交易信息和列表信息中增加字段:is_virtual,识别该笔订单是否属于虚拟商品订单 场景:很多商家店铺中不仅卖实物商品,也同时卖虚拟商品。虚拟商品线下核销后,无法根据订单来对账,有了这个字段,可以区分常规订单和虚拟订单。
7月2日 1.获取推广订单列表 2.获取商品推广链接 3.批量获取商品提成比例信息 4.获取销售员账户信息 5.三方用户成为销售员
适用对象: 1.目前只支持三方APP环境下的使用,后续陆续开放微信和外部PC网站的使用场景。 2.适合拥有大量网红,主播,淘客,意见领袖等用户沉淀的平台商家
1、获取店铺积分商城基本配置信息
2、给用户加积分
3、消耗用户积分
4、第三方应用查询积分变更纪录
5、获取粉丝积分
如何申请:
3. 增加一种新的授权方式 silent (三方不需要用户主动来授权 就可以换取凭证 。前提是三方在用户授权白名单里 )
1. 兼容性问题 有部分安卓机上 以及部分浏览器 访问授权页面 会白屏 (前端工程师正在修复) 2. POST 提交参数的问题 编码仅支持 form-data 、x-www-from-urlencoded (之前是没有说明清楚) 3. 之前走授权码 TOKEN 换取的时候 后台是没有做redirect_url检查的 (文档里虽然说明要求 但实际上并没有)
2016年6月12日(重要,非常重要) 接口信息变更通知:
kdt.trade.get 获取单笔交易的信息
kdt.trades.sold.get 查询卖家已卖出的交易列表
返回字段中:原discount_fee字段——交易优惠金额(不包含交易明细中的优惠金额)
—现在不再将对订单的改价金额计算到该字段中 adjust_fee字段:卖家手工调整订单金额。精确到2位小数;单位:元。若卖家减少订单金额10元2分,则这里为10.02;若卖家增加订单金额10元2分,则这里为-10.02 —现多返回一组数据(1.总改价金额;2.订单改价;2.邮费改价)
现promotion_details字段:在交易中使用到优惠活动详情,包括:满减满送 —订单中使用到的优惠活动的数据结构中增加拼团订单的优惠详情
2016年6月12日
kdt.trade.get 获取单笔交易的信息
kdt.trades.sold.get 查询卖家已卖出的交易列表
pay_type字段中新增WEIXIN (微信自有支付)和WEIXIN_DAIXIAO (微信代销支付)的支付类型 场景:商户通过交易接口中的微信自有支付的交易类型字段信息,了解到该笔订单属于微信支付自有,通过订单号去核对微信官方后台的财物对账信息。
2016年5月31日
获取限时折扣的商品和折扣信息:https://open.youzan.com/apidetail?method=kdt.ump.timelimiteddiscount.find&apiId=7155
通过接口得到限时折扣商品信息和折扣信息列表,还有商品的总数量。
场景:某商家自己做了一个活动详情页,通过搞限时折扣活动吸引客户来购买。通过该接口商家拿到了有赞店铺中所有的限时折扣的商品信息列表,然后根据设计排列出来展示,大大冲击了用户的点击冲动。
方式:先通过“查询卖家已卖出的交易列表”接口中返回的三方APP用户ID:outer_user_id字段调用得到三方交易中的所有订单列表信息。场景: 小明是喜马拉雅app的忠实用户,在喜马拉雅app的有赞店铺中买了很多周边产品,但是喜马拉雅并不能很方便的查询该用户在店铺中的所有交易信息,就无法根据用户购买订单来进一步分析。喜马拉雅方通过调取有赞开放平台交易列表接口,得到用户的user ID信息,再通过该接口查询到该用户的所有订单信息
通过接口实现外部更新,删除,新增一个自定义的商品标签 场景:小明是一家超市的负责人,在有赞开了一家新店铺,线下有一个超市进销存系统,他通过超市收银系统跟有赞商品打通,省去了在有赞传上千个商品的苦恼,可新的苦恼是超市的商品品类众多,他需要去有赞给所有商品自定义各种商品的标签,有了有赞的更新,删除,新增自定义商品标签接口,可以在收银系统上快速更新,新增自定义商品标签同步到有赞,大大提高了效率!
根据交易订单获取找人代付类型的订单,如是微信支付自有支付,可通过outer_tid外部订单列表,就是财付通的交易单号 场景:小红是个一个直播平台的知名主播,有众多粉丝追随。该直播平台里有有赞的微商城销售各种礼品,小红进入商城看到一个中意的商品,点击进入购买页面,选择找人代付。小红把该代付订单链接上传到自己的个人主页,小红的粉丝看到后,争先恐后的帮忙下单,完成付款。
根据微信粉丝openid主动派发优惠券和优惠码,同时获取用户得到优惠详情和使用状态。 场景:商家通过各种营销工具,如签到积分,扫码关注,朋友圈分享,投票等活动给这类特定参与用户主动派发优惠券。比如商家在实物商品上带上二维码,用户关注后系统自动给用户派发一个有赞优惠券。为了让用户有感知得到优惠,再可以通过微信客服接口,给予消息提醒。 获取后台设置的未结束的(包含未开始的、进行中的)所有优惠券和优惠码列表,内含该优惠券的所有参数信息场景:某商家搞大型活动,全场促销领取优惠券。商家页面展示所有优惠券列表,用户到页面自由选择领取优惠券。
到店自提核销接口:https://open.youzan.com/apidetail?method=kdt.trade.selffetchcode.apply&apiId=7054 返回到店自提的码核销结果信息,同时根据到店自提获得的码,获取该订单的相关信息 场景:小明购买了一箱苹果,支付时选择到店自提,购买成功后,获得一个该订单的二维码页面。小明第二天路过该门店,进店告知营业员需要拿已经线上买的一箱苹果,小明拿出该到店自提的二维码凭证,主动靠近柜台的硬件核销设备(也可以核销设备主动扫小明的二维码),确认核销完成,小票打印机出该订单小票,营业员留底小票,给小明一张小票,同时小明拿走苹果。
2016年4月8日
拼团订单等待成团状况接口:https://open.youzan.com/structparam?struct=TradeDetail(字段名:WAIT_GROUP 等待成团,即:买家已付款,等待成团),)
场景:商家可通过ERP读取到该订单为拼团订单,3人成团订单为例,一人购买,成为团长,他的订单(state=50)为待成团状态,如果其他两人购买成功,整组订单会变为已成团订单,状态返回都是5!!如果拼团失败,只有一人支付,这个组的订单会被关闭(状态99),团解散,已付款的会系统自动退款,状态都会变为99关闭。
order_type=10 为拼团订单 (前置条件)
state=50 为待成团
state=5 为已成团
2016年3月28日
店铺首页url接口:https://open.youzan.com/apidetai ... asic.get&apiId=6669
开放店铺接口中店铺首页链接信息返回
场景:第三方平台现只能通过店铺接口得到店铺的id和店铺名称等信息。之后,第三方可以通过店铺首页url信息,自动展示在前端平台上,用户点击后进入浏览。
2016年3月24日
团购、订单返现信息:http://open.koudaitong.com/doc/api/struct?name=TradePromotion
限时折扣信息:http://open.koudaitong.com/doc/api/struct?name=TradeOrderPromotion
开放接口订单详情promotion_details中添加团购,订单返现,限时折扣的信息返回。
场景:外部平台可以通过获取单笔订单接口获取到该笔订单是否参加限时折扣,团购,订单返现。同时获取到优惠完后的实际支付价格,优惠金额。
2016年3月18日
分销订单接口:http://open.koudaitong.com/doc/api/struct?name=TradeDetail (字段名:relation_type)
加入分销订单、采购单、普通订单的标识输出,同时根据订单类型,返回订单号列表。
场景:门店导购成为分销商销售商品,买家到店自提、核销,买家手头掌握的是:买家手机号、买家付款的订单号。门店核销时,让买家报手机号,可能订单不唯一。通过买家付款的订单号,可以直接反查到供货商端的采购单号,现场点击发货、交付。
|