淘宝开放平台 - 文档中心

请求地址：

环境	HTTPS请求地址
正式环境	https://openapi.alipay.com/gateway.do

公共请求参数：

参数	类型	是否必填	最大长度	描述	示例值
app_id	String	是	32	支付宝分配给开发者的应用ID	2014072300007148
method	String	是	128	接口名称	koubei.marketing.campaign.intelligent.promo.consult
format	String	否	40	仅支持JSON	JSON
charset	String	是	10	请求使用的编码格式，如utf-8,gbk,gb2312等	utf-8
sign_type	String	是	10	商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2	RSA2
sign	String	是	344	商户请求参数的签名串，详见签名	详见示例
timestamp	String	是	19	发送请求的时间，格式"yyyy-MM-dd HH:mm:ss"	2014-07-24 03:07:50
version	String	是	3	调用的接口版本，固定为：1.0	1.0
app_auth_token	String	否	40	详见应用授权概述
biz_content	String	是	-	请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

参数	类型	是否必填	最大长度	描述	示例值
shop_ids	String []	可选	1000	当全场普通和单品普通方案时必传，体验方案不用传	201543245645454
out_request_no	String	可选	100	外部业务id，尽量保持该字段足够复杂	65165813-a51a-44b9-984c-c75022ecbaf7
partner_id	String	必须	32	商户和支付宝交互时，用于代表支付宝分配给商户ID	2088134435657657
template_code	String	必须	100	营销模板的编号，GENERAL_EXPERIENCE：全场体验；GENERAL_NORMAL：全场普通；ITEM_EXPERIENCE：单品体验；ITEM_NORMAL：单品普通	GENERAL_EXPERIENCE
operator_context	PromoOperatorInfo	必须	-	操作人信息
└ operator_id String 必填 32 操作人id 2088342364645765 └ operator_type String 必填 100 操作人类型。SALES：口碑内部小二；MER：商户；MER_OPERATOR：商户员工；PROVIDER：服务商；PROVIDER_STAFF：服务商员工； MER
parent_promo_id	String	可选	32	原智能方案id	20171218000000000586526911004390
ext_info	String	可选	32	扩展信息，以key-value的形式传递	{\"PARTNER_CATEGORY\":\"2015050700000002\",\"PROMO_REC_LOG\":\"20170919000000000195431911009130\"}

参数	类型	是否必填	最大长度	描述	示例值
code	String	是	-	网关返回码,详见文档	40004
msg	String	是	-	网关返回码描述,详见文档	Business Failed
sub_code	String	否	-	业务返回码,详见文档	ACQ.TRADE_HAS_SUCCESS
sub_msg	String	否	-	业务返回码描述,详见文档	交易已被支付
sign	String	是	-	签名,详见文档	DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

参数	类型	是否必填	最大长度	描述	示例值
promo	IntelligentPromo	必填	2000	智能营销方案咨询的模型
└ promo_id String 必填 100 智能营销活动的id。创建接口中这个参数不用填，仅在查询接口中返回 20170905000000000092980911009880 └ plan_id String 必填 100 智能营销活动对应的方案编号 20170901000000000007027911001170 └ template_id String 必填 100 智能营销活动对应的方案中的模板编号 20170901000000000006914911002170 └ name String 必填 500 智能营销活动对应的名称全场智能营销活动 └ type String 必填 32 智能活动类型，值如下：RECOMMENDATION：系统推荐；REGISTRATION：报名。在创建时，这个字段需要ISV自己进行决策，在推荐接口会返回优惠力度，比如代金券面额等信息，ISV判断如果优惠力度比这个大或者相同，就用RECOMMENDATION，其他情况用REGISTRATION，如推荐力度大于实际创建传过来的优惠力度，则创建的时候系统会自动将RECOMMENDATION改为REGISTRATION RECOMMENDATION owner_info PromoOperatorInfo 必填 300 智能活动对应的归属人信息 └ operator_id String 必填 32 操作人id 2088342364645765 └ operator_type String 必填 100 操作人类型。SALES：口碑内部小二；MER：商户；MER_OPERATOR：商户员工；PROVIDER：服务商；PROVIDER_STAFF：服务商员工； MER creator_info PromoOperatorInfo 必填 400 创建人信息 └ operator_id String 必填 32 操作人id 2088342364645765 └ operator_type String 必填 100 操作人类型。SALES：口碑内部小二；MER：商户；MER_OPERATOR：商户员工；PROVIDER：服务商；PROVIDER_STAFF：服务商员工； MER └ status String 必填 32 智能营销活动状态。CREATED：已创建；ENABLED：已生效；CLOSED：已关闭；FINISHED：已完结；DISABLED:已失效（有两种情况会是失效状态，一种是服务商创建方案，商户驳回，一种是服务商创建方案，商户未确认，活动到期。）（注意：修改方案的动作不需要传递方案状态） CREATED └ audit_status String 必填 32 审批状态。APPROVING：审批中；REJECTED：已驳回；PASS：已通过；（注意：修改接口无需传递审批状态） APPROVING └ sub_status String 必填 32 活动展示状态。已创建：CREATED； REJECTED：创建被驳回；ENABLING：生效中；ONLINE_WAIT_CONFIRM：上架待确认；PUBLISHED：已发布（活动未到开始时间）；ENABLED：已发布已开始；OFFLINE_WAIT_CONFIRM：下架待确认；CLOSING：下架中；CLOSED：已下架（人为干预下架）；FINISHED：已结束（活动到期自然结束）；MODIFYING：修改中；MODIFY_WAIT_CONFIRM：修改待确认；DISABLED：已失效（注意：修改接口子状态参数不能传递） ENABLING └ gmt_start Date 必填 100 智能营销活动开始时间 2016-05-01 00:00:00 └ gmt_end Date 必填 100 智能营销活动的结束时间 2016-05-01 00:00:00 └ gmt_enabled Date 必填 100 智能营销活动的生效时间 2016-05-01 00:00:00 └ gmt_closed Date 必填 100 智能营销活动下架的时间 2016-05-01 00:00:00 └ desc String 必填 2000 智能活动描述这是一个全场智能营销活动，仅在上海地区使用 └ ext_info String 必填 2000 活动扩展信息。活动推荐会返回扩展信息，推荐完以后，这里的信息要在活动效果预测，创建接口中也需要原样带回来； {\"PARTNER_CATEGORY\":\"2015050700000002\",\"PROMO_REC_LOG\":\"20170919000000000195431911009130\"} └ allow_auto_delay Boolean 必填 10 是否允许自动续期 true promos IntelligentPromoDetail [] 必填 5000 营销活动详情列表 └ camp_id String 必填 100 营销活动的id，也就是消费送的活动id 20170901000000000006913911002170 └ template_id String 必填 100 子营销活动对应的模板id 20170901000000000006912911002170 └ name String 必填 500 子营销活动名称全场消费送活动 └ desc String 必填 1000 智能营销活动的子活动这是一个全场消费送的活动 └ ext_info String 必填 1000 活动扩展信息 {\"key\":\"value\"} forecast_effect IntelligentPromoEffect 必填 2000 营销活动预测效果 └ effect_id String 必填 100 营销活动的预期效果id 2017062300077000000022017686 └ type String 必填 32 营销活动效果类型。FORECAST：预估；STATISTICS：统计 FORECAST └ gmt_from Date 必填 10 时间范围左值 2017-09-09 11:00:00 └ gmt_to Date 必填 20 时间范围右值 2017-09-09 12:00:00 └ cost Price 必填 20 成本 100 └ current_total_amount Price 必填 10 当前效益 39600 └ take_count Number 必填 10 发券数量 100 └ use_count Number 必填 100 核销量 432453 └ remain_stock_num Number 必填 100 剩余库存数 100000 └ gmv Price 必填 100 成交额 842853 └ repay_rate_increase String 必填 10 复购率提升比例 0.023163898428219726 └ avg_prize_increase String 必填 10 平均客单价提升比例 0.01992462805690956 └ send_count_increase String 选填 10 发券量提升比例 10 └ merchant_promo_type String 必填 20 自运营活动类型。DIRECT_SEND：直发奖；CONSUME_SEND：消费送 DIRECT_SEND budget BudgetInfo 必填 2000 活动预算 └ budget_type String 必填 16 预算类型 QUANTITY └ budget_total String 必填 64 预算数量 10258 └ sub_budget_dimension String 选填 64 设置每天的预算，如每天的预算设置为100，即该活动一天最多发放100次 D:表示每天的预算; └ sub_value String 选填 64 用于控制子纬度的预算数量 100:表示sub_dimension定义的纬度预算为100，若sub_dimension为D的话，则表示每天最多发放100张 constraint ConstraintInfo 必填 2000 活动限制信息 └ user_win_count String 选填 20 活动期间用户能够参与的次数限制如果不设置则不限制参与次数 1 └ cash_pool_id String 选填 64 资金池ID （数据来源：需要ISV自己去口碑销售中台创建资金池，拿到对应的资金池ID，此参数仅适用ISV接入口福业务场景时使用，其他场景不需要传递此参数） 2017031100073001472700000GY7 └ subsidy_percent String 选填 10 补贴百分比,95表示 95%，支持两位小数（参数说明：补贴比例95%，表示ISV出资95%，商户出资5%，此参数仅适用ISV接入口福业务场景时使用，其他场景不需要传递此参数） 95 └ user_win_frequency String 选填 32 活动期间用户能够参与的频率限制如果不设置则不限制参与频率每日中奖1次: D\|\|1 每周中奖2次: W\|\|2 每月中奖3次: M\|\|3 D\|\|3 └ crowd_group_id String 选填 32 人群规则组ID 仅直发奖类型活动设置有效，通过调用营销活动人群组规则创建接口参数返回 12344556 └ crowd_restriction String 选填 128 针对指定人群的约束条件 NEW_MEMBER_PROM O:新会员 STUDENT：学生用户，仅对 DIRECT_SEND类型下的代金券，折扣券活动有效 └ suit_shops String [] 必填 20000 活动适用的门店列表仅品牌商发起的招商活动可为空最多支持10w家门店 2015110600077000000002125023,2015110600077000000002125022 └ min_cost String 选填 32 最低消费金额，单位元仅在创建消费送礼包活动时设置 100 └ item_ids String [] 选填 20000 单品码列表仅在创建消费单品送活动时设置，最多设置500个单品码,由商户根据自己的商品管理自定义，一般为国标码 212313,221322 promo_tools PromoTool [] 必填 5000 营销工具集合。主要是活动涉及到的奖品信息 voucher Voucher 选填 2048 券对象，当活动类型为POINT_SEND时为null，其他活动类型此字段必填 └ type String 必填 10 券类型，目前支持以下类型： EXCHANGE：兑换券； MONEY：代金券； REDUCETO：减至券； RATE：折扣券； PER_FULL_CUT：每满减券 MONEY └ verify_mode String 选填 32 该字段仅在兑换券条件下(即券类型为EXCHANGE)，用于设置兑换券的核销方式 USER_CLICK:用户自己点击券上的按钮核销 MERCHANT_SCAN：商户通过APP扫码核销其他情况下此字段为空 MERCHANT_SCAN └ voucher_note String 选填 100 券的备注用于收银系统识别指定券使用；如备注中传入“123”，券发出后核销时将在当面付接口将该值传回，供收银系统识别券的备注 desc_detail_list VoucherDescDetail [] 选填 20000 券使用说明描述列表 └ title String 必填 2000 券说明的标题温馨提示 └ details String [] 选填 2000 具体描述信息列表周一到周五可用 └ images String [] 选填 2000 图片描述信息 https://dl.django.t.taobao.com/rest/1.0/image?fileIds=RY7twkJVR26nz8OeXRIjvAAAACMAAQED&zoom=original └ url String 选填 2000 券外部详情描述 www.alipay.com └ multi_use_mode String 选填 16 券叠加的属性，仅全场券可设置该选项； NO_MULTI:不可与其他全场券和单品券叠加; MULTI_USE_WITH_SINGLE: 该全场优惠和单品优惠的叠加；MULTI_USE_WITH_OTHE RS:该全场优惠和其他所有优惠都可以叠加 NO_MULTI └ rounding_rule String 选填 100 券核销时，抹零方式，目前支持： NOT_AUTO_ROUNDING:不自动抹零 AUTO_ROUNDING_YUAN:自动抹零到元 AUTO_ROUNDING_JIAO:自动抹零到角 ROUNDING_UP_YUAN:四舍五入到元 ROUNDING_UP_JIAO:四舍五入到角 NOT_AUTO_ROUNDING └ name String 必填 32 名称券的名称 └ brand_name String 选填 32 券副标题券副标题 └ use_instructions String [] 必填 1024 券的使用说明使用须知最多6条，且每条最多100字券的使用说明 └ logo String 必填 32 券LOGO文件ID，调用图片上传接口alipay.offline.material.image.upload获得 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC item_info ItemInfo 选填 1024 单品信息兑换券不允许设置单品信息减至券必须设置单品信息其他类型券可按需设置 └ item_text String 必填 1024 单品券说明单品券说明 └ sku_min_consume String 选填 20 券适用SKU的最低消费金额门槛如券适用A,B两个SKU，该字段设置的值为100，则订单中购买A,B两个SKU的合计金额需大于100元才可用券 10 └ item_name String 必填 1024 单品名称单品名称 └ item_imgs String [] 选填 1024 单品图片列表单品图片不能超过3张 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC └ item_link String 选填 1024 单品券详细介绍跳转链接 www.taobao.com └ original_price String 选填 64 单品的原价，单位元必须为合法金额类型字符串，如9.99 28.88 └ max_discount_num String 选填 32 单品券适用的商品列表中，每一个商品最高可享受优惠的件数；如：券适用于A,B两种商品，该字段设置为1，则用券A,B两种商品每种最多只有一件可享受优惠； 1 └ min_consume_num String 选填 32 单品券适用商品列表中，每种商品享受优惠最低购买件数的门槛；如：券适用于A,B两种商品，该字段设置为3，则A,B两种商品每种最少需要购买3件才可享受优惠； 1 └ item_ids String [] 选填 1024 券适用的单品码列表最少配置1个单品码最多配置500个单品码 0000123,0000124 └ total_max_discount_num String 选填 20 如果一个单品券适用A，B，C三个单品，若设置了该字段为2，则在一笔交易中，A，B，C三个单品加起来最多只有俩件能够享受优惠 10 └ voucher_img String 选填 1024 券图片文件ID,调用上传图片接口alipay.offline.material.image.upload获得 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC └ rate String 选填 10 折扣率仅当券类型为折扣券时有效有效折扣率取值范围0.11-0.99 仅允许保留小数点后两位 0.8 └ max_amount String 选填 10 最高优惠金额，单位元指用券最高可以优惠的金额必须为合法金额类型字符串仅当券类型为折扣券（DISOUNT），每满减券（PER_FULL_CUT）有效 100 └ worth_value String 选填 10 券面额，单位元必须为合法金额类型字符串券类型为代金券（MONEY）、减至券（REDUCETO）、每满减券（PER_FULL_CUT）时必填如：代金券：10元代金券中的10为券面额；每满减券：毎满100减10元，其中的10为券面额；减至券：单品原价100，现价10元，其中10为券面额，单品减至券的券面额必须低于单品原价 10 └ donate_flag String 选填 10 券是否可转赠，默认为可转赠 true └ validate_type String 必填 10 券有效期类型，目前支持以下类型： RELATIVE：相对有效期 FIXED：绝对有效期 FIXED └ start_time Date 选填 32 券有效期的开始时间仅在券有效期类型为绝对有效期时生效 2016-05-01 00:00:00 └ end_time Date 选填 32 券有效期的结束时间仅在券有效期类型为绝对有效期时生效必须晚于活动结束时间 2016-11-01 00:00:00 └ relative_time String 选填 10 券相对有效期，单位天仅在券有效期类型为相对有效期时生效如，设5表示领券领取后5日内有效 1 use_rule UseRule 必填 4096 券的使用规则信息 use_time UseTime [] 选填 1024 券可用时间段 └ dimension String 选填 32 券可用时段时间维度，目前支持周(W) W └ values String 选填 64 券可用时间维度值周维度的取值范围1-7(周一至周日)，多个可用时段用逗号分隔如"1,3,5"，对应周一，周三，周五可用 1,3,5 └ times String 选填 1024 券可用时间段可用时间段起止时间用逗号分隔，多个时间段之间用^分隔如, "16:00:00,20:00:00^21:00:00,22:00:00"表示16点至20点，21点至22点可用时间段不可重叠 16:00:00,20:00:00^21:00:00,22:00:00 └ pay_redirect_url String 选填 1024 券买单跳转链接 https://mycar-parkingplatform.alipay-eco.com/pbizplatform/park/parking/stayPayCarList?entrance=1 forbidden_time ForbbidenTime 选填 1024 券的不可用时间 └ days String 选填 1024 不可用日期区间，仅支持到天不可用区间起止日期用逗号分隔，多个区间之间用^分隔如"2016-05-01,2016-05-03^2016-10-01,2016-10-07"表示2016年5月1日至5月3日，10月1日至10月7日券不可用 2016-03-03,2016-03-08^2016-10-01,2016-10-01 └ suit_shops String [] 必填 20000 券适用门店列表仅品牌商发起的招商活动可为空直发奖类型活动必须与活动适用门店一致最多支持10w家门店 2015110600077000000002125023,2015110600077000000002125022 └ min_consume String 选填 20 券核销的最低消费门槛，单位元 10 └ ext_info String 选填 1024 扩展属性，无需设置 \"key\":\"value\" └ limit_rule String 选填 32 优惠券的使用支付渠道限制规则，不受支付渠道限制 :USE_NO_LIMIT; 仅限口碑储值卡支付时可用 :USE_ON_CURRENT_PAY_C HANNEL; 口碑储值卡支付时不可用 :NOT_ALLOWED_USE; 【备注】支付渠道限制不允许修改 USE_NO_LIMIT └ desc String 选填 1024 券详细说明最多包含500个字符券的详细说明 display_config DisplayConfig 选填 1024 券的展示信息 └ slogan String 选填 1024 券的宣传语含圈人的直领活动，且投放渠道选择了支付成功页或店铺的情况下必填券的宣传语 └ slogan_img String 选填 1024 券的宣传图片文件ID 含圈人的直领活动，且投放渠道选择了店铺的情况下必填 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC clause_terms ClauseTerm [] 选填 1024 券的说明条款 └ title String 选填 1024 说明title 说明title └ descriptions String [] 选填 1024 说明描述内容说明描述内容 └ effect_type String 必填 10 券生效的方式，目前支持以下方式立即生效：IMMEDIATELY 延迟生效：DELAY 仅在券有效期类型为相对有效期时生效 IMMEDIATELY delay_info DelayInfo 选填 64 延迟生效信息 └ type String 必填 32 延迟类型，目前支持以下类型 ABSOLUTELY：按绝对值延迟 BYDAY：按天延迟 ABSOLUTELY └ value String 必填 32 延迟值，单位分钟按绝对值延迟延迟2460 (1天)表示，当日08:00:00领到的券要到隔日的08:00:00才能使用按天延迟延迟2460(1天)表示，当日08:00:00领到的券，隔日00:00:00点就可以用 1440 └ ext_info String 选填 1024 券的扩展信息 "key":"value" └ available_amount String 选填 10 券剩余面额，单位元券详情查询接口返回，可拆分券中的券详情展示用 100 └ allow_split Boolean 选填 4 是否允许拆分，券在核销的时候是否允许券的面额拆分使用。(仅限渠道类型为ISV企业福利：ISV_ENTERPRISE_BENIFIT的场景使用) false └ status String 选填 16 单个营销工具的生效状态，当在招商部分券失效后会使用这个字段 STARTED └ voucher_no String 选填 32 营销工具uid,创建营销活动时无需设置 2342343245234234 point_card PointCard 选填 2048 集点卡工具，仅在活动类型为POINT_SEND时才有效且必填，其他活动类型此字段必须为null └ type String 必填 32 工具类型，目前支持：集点卡：POINT_CARD POINT_CARD └ name String 必填 32 工具的名称集点卡 └ desc String 选填 1024 工具的描述集点卡的功能描述 └ start_time Date 必填 32 工具的有效期的起始时间 2016-05-01 00:00:00 └ end_time Date 必填 32 工具的有效期的结束时间（必须晚于活动的结束时间） 2016-10-01 00:00:00 └ logo String 选填 32 工具的LOGO文件ID 1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC send_rule SendRule 选填 1024 奖品发放的规则 └ min_cost String 选填 32 发券最低消费金额，单位元活动类型为消费送且不是消费送礼包时设置多营销工具之间不允许设置重复值 100 └ send_num String 选填 32 发券数目最少发1张券，最多发5张券 1 └ send_budget String 选填 32 券的预算数量（仅对口令送随机抽奖有效，即当活动类型为GUESS_SEND，且营销工具PromoTool的个数大于1时，此字段必填，其余情况此字段必为空） 1234 └ allow_repeat_send String 选填 8 是否允许重复发奖： true代表允许，false代表不允许默认不设置，表明用户领取券后如果没有核销则不允许再次领取券如果设置为true，表明如果用户领取券后没有核销，还可以继续领取该券 true publish_channels PublishChannel [] 必填 2000 投放渠道信息 └ type String 必填 32 渠道类型，目前支持以下类型： QR_CODE：二维码投放； SHORT_LINK：短连接投放； SHOP_DETAIL：店铺页投放； PAYMENT_RESULT：支付成功页； MERCHANT_CROWD：口令送； URL_WITH_TOKEN：外部发奖活动， ISV_ENTERPRISE_BENIFIT:ISV企业福利, 只有活动类型为DIRECT_SEND时才支持； SHOP_DETAIL └ name String 必填 32 渠道名称投放到店铺 └ config String 选填 1024 当type为MERCHANT_CROWD时，config需填入口令送的密码和图片，样例如下："config":"{\"PASSWORD\":\"口令送密码\",\"BACKGROUND_LOGO\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\"}" "PASSWORD":"口令送密码","BACKGROUND_LOGO":"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC" └ ext_info String 选填 1024 扩展信息，无需配置 "key":"value" crowd_constraint CrowdConstraintInfo 必填 2000 圈人限制条件 └ crowd_name String 必填 32 圈人名称限笔单价30到50的老顾客 └ crowd_restriction String 必填 32 圈人约束，取值（NEWCOMER：新客人群；OFFLINE：离线人群），OFFLINE离线人群，需要传递crowd_condition圈人条件，使用方案参考crowd_condition使用说明 NEWCOMER └ crowd_condition String 必填 65535 圈人的条件 op:表示操作符，目前支持EQ相等,GT大于,GTEQ大于等于,LT小于,LTEQ小于等于,NEQ不等,LIKE模糊匹配,IN在枚举范围内,NOTIN不在枚举范围内,BETWEEN范围比较,LEFTDAYS几天以内,RIGHTDAYS几天以外,LOCATE地理位置比较,LBS地图位置数据 tagCode:标签code，详细标签code参见附件。标签信息 value:标签值 [{\"op\":\"BETWEEN\",\"tag_code\":\"pam_last_pay_amt\",\"value\":[\"2200\",\"999999999\"]}] └ create_request_no String 必填 100 创建活动时填入的外部流水号，这个只在查询时使用，创建和修改无效 434546645 forecast_effect IntelligentPromoEffect 必填 2000 方案级别的效果预测 └ effect_id String 必填 100 营销活动的预期效果id 2017062300077000000022017686 └ type String 必填 32 营销活动效果类型。FORECAST：预估；STATISTICS：统计 FORECAST └ gmt_from Date 必填 10 时间范围左值 2017-09-09 11:00:00 └ gmt_to Date 必填 20 时间范围右值 2017-09-09 12:00:00 └ cost Price 必填 20 成本 100 └ current_total_amount Price 必填 10 当前效益 39600 └ take_count Number 必填 10 发券数量 100 └ use_count Number 必填 100 核销量 432453 └ remain_stock_num Number 必填 100 剩余库存数 100000 └ gmv Price 必填 100 成交额 842853 └ repay_rate_increase String 必填 10 复购率提升比例 0.023163898428219726 └ avg_prize_increase String 必填 10 平均客单价提升比例 0.01992462805690956 └ send_count_increase String 选填 10 发券量提升比例 10 └ parent_promo_id String 选填 32 智能营销方案父id，如果需要续签智能营销活动，则会对于原有智能营销方案的id 20171001000000000286566911004880 └ sub_promo_ids String [] 选填 2000 该智能营销方案如果续签多次，则会返回该方案对应的所有智能营销子方案的promo_id [2016110700077000000003446037, 2016111000077000000003446529]

JAVA
.NET
PHP
HTTP请求源码

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingCampaignIntelligentPromoConsultRequest request = new KoubeiMarketingCampaignIntelligentPromoConsultRequest();
request.setBizContent("{" +
"      \"shop_ids\":[" +
"        \"201543245645454\"" +
"      ]," +
"\"out_request_no\":\"65165813-a51a-44b9-984c-c75022ecbaf7\"," +
"\"partner_id\":\"2088134435657657\"," +
"\"template_code\":\"GENERAL_EXPERIENCE\"," +
"\"operator_context\":{" +
"\"operator_id\":\"2088342364645765\"," +
"\"operator_type\":\"MER\"" +
"    }," +
"\"parent_promo_id\":\"20171218000000000586526911004390\"," +
"\"ext_info\":\"{\\\\\\\"PARTNER_CATEGORY\\\\\\\":\\\\\\\"2015050700000002\\\\\\\",\\\\\\\"PROMO_REC_LOG\\\\\\\":\\\\\\\"20170919000000000195431911009130\\\\\\\"}\"" +
"  }");
KoubeiMarketingCampaignIntelligentPromoConsultResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "app_id", "merchant_private_key", "json", "1.0", "RSA2", "alipay_public_key", "GBK", false);
KoubeiMarketingCampaignIntelligentPromoConsultRequest  request= new KoubeiMarketingCampaignIntelligentPromoConsultRequest() ;
request.BizContent="{" +
"      \"shop_ids\":[" +
"        \"201543245645454\"" +
"      ]," +
"\"out_request_no\":\"65165813-a51a-44b9-984c-c75022ecbaf7\"," +
"\"partner_id\":\"2088134435657657\"," +
"\"template_code\":\"GENERAL_EXPERIENCE\"," +
"\"operator_context\":{" +
"\"operator_id\":\"2088342364645765\"," +
"\"operator_type\":\"MER\"" +
"    }," +
"\"parent_promo_id\":\"20171218000000000586526911004390\"," +
"\"ext_info\":\"{\\\\\\\"PARTNER_CATEGORY\\\\\\\":\\\\\\\"2015050700000002\\\\\\\",\\\\\\\"PROMO_REC_LOG\\\\\\\":\\\\\\\"20170919000000000195431911009130\\\\\\\"}\"" +
"  }";
KoubeiMarketingCampaignIntelligentPromoConsultResponse response=client.execute(request);
Console.WriteLine(response.Body);

$aop = new AopClient ();
$aop->gatewayUrl = 'https://openapi.alipay.com/gateway.do';
$aop->appId = 'your app_id';
$aop->rsaPrivateKey = '请填写开发者私钥去头去尾去回车，一行字符串';
$aop->alipayrsaPublicKey='请填写支付宝公钥，一行字符串';
$aop->apiVersion = '1.0';
$aop->signType = 'RSA2';
$aop->postCharset='GBK';
$aop->format='json';
$request = new KoubeiMarketingCampaignIntelligentPromoConsultRequest ();
$request->setBizContent("{" .
"      \"shop_ids\":[" .
"        \"201543245645454\"" .
"      ]," .
"\"out_request_no\":\"65165813-a51a-44b9-984c-c75022ecbaf7\"," .
"\"partner_id\":\"2088134435657657\"," .
"\"template_code\":\"GENERAL_EXPERIENCE\"," .
"\"operator_context\":{" .
"\"operator_id\":\"2088342364645765\"," .
"\"operator_type\":\"MER\"" .
"    }," .
"\"parent_promo_id\":\"20171218000000000586526911004390\"," .
"\"ext_info\":\"{\\\\\\\"PARTNER_CATEGORY\\\\\\\":\\\\\\\"2015050700000002\\\\\\\",\\\\\\\"PROMO_REC_LOG\\\\\\\":\\\\\\\"20170919000000000195431911009130\\\\\\\"}\"" .
"  }");
$result = $aop->execute ( $request); 

$responseNode = str_replace(".", "_", $request->getApiMethodName()) . "_response";
$resultCode = $result->$responseNode->code;
if(!empty($resultCode)&&$resultCode == 10000){
echo "成功";
} else {
echo "失败";
}

https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=koubei.marketing.campaign.intelligent.promo.consult&app_id=5205&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&biz_content=
  {
      "shop_ids":[
        "201543245645454"
      ],
"out_request_no":"65165813-a51a-44b9-984c-c75022ecbaf7",
"partner_id":"2088134435657657",
"template_code":"GENERAL_EXPERIENCE",
"operator_context":{
"operator_id":"2088342364645765",
"operator_type":"MER"
    },
"parent_promo_id":"20171218000000000586526911004390",
"ext_info":"{\\\"PARTNER_CATEGORY\\\":\\\"2015050700000002\\\",\\\"PROMO_REC_LOG\\\":\\\"20170919000000000195431911009130\\\"}"
  }

//为确保安全通信，需自行验证响应示例中的sign值是否为蚂蚁金服所提供。

JSON示例

{
	"koubei_marketing_campaign_intelligent_promo_consult_response":{
		"msg":"Success",
		"promo":{
			"gmt_closed":"2016-05-01 00:00:00",
			"creator_info":{
				"operator_id":"2088342364645765",
				"operator_type":"MER"
			},
			"sub_status":"ENABLING",
			"sub_promo_ids":[
				"[2016110700077000000003446037",
				" 2016111000077000000003446529]"
			],
			"allow_auto_delay":true,
			"owner_info":{
				"operator_id":"2088342364645765",
				"operator_type":"MER"
			},
			"audit_status":"APPROVING",
			"promo_id":"20170905000000000092980911009880",
			"type":"RECOMMENDATION",
			"ext_info":"{\\\"PARTNER_CATEGORY\\\":\\\"2015050700000002\\\",\\\"PROMO_REC_LOG\\\":\\\"20170919000000000195431911009130\\\"}",
			"parent_promo_id":"20171001000000000286566911004880",
			"forecast_effect":{
				"cost":100,
				"avg_prize_increase":"0.01992462805690956",
				"gmt_from":"2017-09-09 11:00:00",
				"send_count_increase":"10",
				"repay_rate_increase":"0.023163898428219726",
				"type":"FORECAST",
				"use_count":432453,
				"gmv":842853,
				"current_total_amount":39600,
				"gmt_to":"2017-09-09 12:00:00",
				"take_count":100,
				"remain_stock_num":100000,
				"effect_id":"2017062300077000000022017686"
			},
			"gmt_start":"2016-05-01 00:00:00",
			"name":"全场智能营销活动",
			"template_id":"20170901000000000006914911002170",
			"gmt_enabled":"2016-05-01 00:00:00",
			"gmt_end":"2016-05-01 00:00:00",
			"promos":[
				{
					"forecast_effect":{
						"cost":100,
						"avg_prize_increase":"0.01992462805690956",
						"gmt_from":"2017-09-09 11:00:00",
						"send_count_increase":"10",
						"repay_rate_increase":"0.023163898428219726",
						"type":"FORECAST",
						"use_count":432453,
						"gmv":842853,
						"current_total_amount":39600,
						"gmt_to":"2017-09-09 12:00:00",
						"take_count":100,
						"remain_stock_num":100000,
						"effect_id":"2017062300077000000022017686"
					},
					"crowd_constraint":{
						"crowd_name":"限笔单价30到50的老顾客",
						"crowd_condition":"[{\\\"op\\\":\\\"BETWEEN\\\",\\\"tag_code\\\":\\\"pam_last_pay_amt\\\",\\\"value\\\":[\\\"2200\\\",\\\"999999999\\\"]}]",
						"crowd_restriction":"NEWCOMER"
					},
					"name":"全场消费送活动",
					"camp_id":"20170901000000000006913911002170",
					"template_id":"20170901000000000006912911002170",
					"constraint":{
						"subsidy_percent":"95",
						"cash_pool_id":"2017031100073001472700000GY7",
						"min_cost":"100",
						"item_ids":[
							"212313",
							"221322"
						],
						"crowd_group_id":"12344556",
						"crowd_restriction":"NEW_MEMBER_PROM\r\nO:新会员\r\nSTUDENT：学生用户，仅对\r\nDIRECT_SEND类型下的代金券，折扣券活动有效",
						"user_win_count":"1",
						"user_win_frequency":"D||3",
						"suit_shops":[
							"2015110600077000000002125023",
							"2015110600077000000002125022"
						]
					},
					"ext_info":"{\\\"key\\\":\\\"value\\\"}",
					"merchant_promo_type":"DIRECT_SEND",
					"promo_tools":[
						{
							"send_rule":{
								"send_num":"1",
								"send_budget":"1234",
								"min_cost":"100",
								"allow_repeat_send":"true"
							},
							"voucher":{
								"voucher_img":"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC",
								"item_info":{
									"original_price":"28.88",
									"total_max_discount_num":"10",
									"item_imgs":[
										"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC"
									],
									"max_discount_num":"1",
									"item_ids":[
										"0000123",
										"0000124"
									],
									"item_text":"单品券说明",
									"item_name":"单品名称",
									"item_link":"www.taobao.com",
									"min_consume_num":"1",
									"sku_min_consume":"10"
								},
								"donate_flag":"true",
								"clause_terms":[
									{
										"title":"说明title",
										"descriptions":[
											"说明描述内容"
										]
									}
								],
								"available_amount":"100",
								"type":"MONEY",
								"desc_detail_list":[
									{
										"images":[
											"https://dl.django.t.taobao.com/rest/1.0/image?fileIds=RY7twkJVR26nz8OeXRIjvAAAACMAAQED&zoom=original"
										],
										"details":[
											"周一到周五可用"
										],
										"title":"温馨提示",
										"url":"www.alipay.com"
									}
								],
								"rate":"0.8",
								"logo":"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC",
								"display_config":{
									"slogan_img":"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC",
									"slogan":"券的宣传语"
								},
								"use_instructions":[
									"券的使用说明"
								],
								"multi_use_mode":"NO_MULTI",
								"relative_time":"1",
								"end_time":"2016-11-01 00:00:00",
								"brand_name":"券副标题",
								"use_rule":{
									"forbidden_time":{
										"days":"2016-03-03,2016-03-08^2016-10-01,2016-10-01"
									},
									"min_consume":"10",
									"use_time":[
										{
											"times":"16:00:00,20:00:00^21:00:00,22:00:00",
											"values":"1,3,5",
											"dimension":"W"
										}
									],
									"pay_redirect_url":"https://mycar-parkingplatform.alipay-eco.com/pbizplatform/park/parking/stayPayCarList?entrance=1",
									"ext_info":"\\\"key\\\":\\\"value\\\"",
									"limit_rule":"USE_NO_LIMIT",
									"suit_shops":[
										"2015110600077000000002125023",
										"2015110600077000000002125022"
									]
								},
								"allow_split":false,
								"rounding_rule":"NOT_AUTO_ROUNDING",
								"effect_type":"IMMEDIATELY",
								"ext_info":"\"key\":\"value\"",
								"start_time":"2016-05-01 00:00:00",
								"verify_mode":"MERCHANT_SCAN",
								"name":"券的名称",
								"max_amount":"100",
								"worth_value":"10",
								"validate_type":"FIXED",
								"voucher_note":"券的备注",
								"delay_info":{
									"type":"ABSOLUTELY",
									"value":"1440"
								},
								"desc":"券的详细说明"
							},
							"voucher_no":"2342343245234234",
							"point_card":{
								"start_time":"2016-05-01 00:00:00",
								"name":"集点卡",
								"end_time":"2016-10-01 00:00:00",
								"logo":"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC",
								"type":"POINT_CARD",
								"desc":"集点卡的功能描述"
							},
							"status":"STARTED"
						}
					],
					"publish_channels":[
						{
							"name":"投放到店铺",
							"type":"SHOP_DETAIL",
							"ext_info":"\"key\":\"value\"",
							"config":"\"PASSWORD\":\"口令送密码\",\"BACKGROUND_LOGO\":\"1T8Pp00AT7eo9NoAJkMR3AAAACMAAQEC\""
						}
					],
					"desc":"这是一个全场消费送的活动",
					"budget":{
						"sub_value":"100:表示sub_dimension定义的纬度预算为100，若sub_dimension为D的话，则表示每天最多发放100张",
						"budget_total":"10258",
						"sub_budget_dimension":"D:表示每天的预算;",
						"budget_type":"QUANTITY"
					}
				}
			],
			"create_request_no":"434546645",
			"plan_id":"20170901000000000007027911001170",
			"status":"CREATED",
			"desc":"这是一个全场智能营销活动，仅在上海地区使用"
		},
		"code":"10000"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

JSON示例

{
	"koubei_marketing_campaign_intelligent_promo_consult_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

错误码	错误描述	解决方案
BIZ_ERROR	业务异常商户未签约	商户未签约
BIZ_ERROR	业务异常非法访问	非法访问
INVALID_PARAMETER	参数有误	参数非法
SYSTEM_ERROR	系统繁忙	系统异常，稍后重试
BIZ_ERROR	业务异常	根据返回操作信息提示，修改后重试！

公共错误码

开放平台

营销API

koubei.marketing.campaign.intelligent.promo.consult (智能营销活动咨询推荐接口)

公共参数

请求参数

公共响应参数

响应参数

请求示例

响应示例

异常示例

业务错误码

公共错误码