koubei.marketing.campaign.retail.dm.modify (快消店铺展位内容修改接口)

修改DM店铺展位内容

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.marketing.campaign.retail.dm.modify
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
content_id String 必须 20 内容ID,调用koubei.marketing.campaign.retail.dm.create创建内容时返回的内容ID 1
campaign_type String 必须 20 活动类型:该活动是属于单品优惠,还是全场活动,单品优惠 SINGLE,全场优惠UNIVERSAL SINGLE
thumbnail_image_id String 可选 1024 4:3缩略图url,用于产品在店铺页简单规范的展示。 (通过alipay.offline.material.image.upload 接口上传视频/图片获取的资源id)
注意:本图片会进行图片尺寸校验,不符合4:3尺寸则无法上传。
ToxzrXYgQpCExkMDpYbd4AAAACMAAQED
image_id String 必须 1024 图片url,该图片id只有一个,由Isv传入,(通过alipay.offline.material.image.upload 接口上传视频/图片获取的资源id)(图片的宽高比为4:3) dCq1oPoXQ521PLw7rSoa0AAAACMAAQED
item_code String 可选 1024 商品编码,SKU或店内码,该编码由Isv系统传入 6901294175846
item_name String 必须 1024 商品名称,单品优惠时传入商品名称;全场活动时传入活动名称,注意:该字段需要过风控校验,不得传入敏感词 立白洗衣液买一送一
campaign_end_time Date 可选 18 下架时间,基本格式:yyyy-MM-dd HH:mm:ss,下架时间必须晚于上架时间,下架时间不得早于当前时间,下架状态的内容不能上架,上架状态下架时间不能为空,只有上架状态可以修改下架时间。 2017-09-20 23:59:59
brief String 可选 100 简要的促销说明,用于对促销的内容进行直接明了的说明(如会员价:10元)。注意:该字段需要过风控校验,不得传入敏感词。 低至5.2元/斤
activity_start_time String 可选 10 促销开始时间,在产品详情中展示,格式为:2017-02-01 11:11:11。
注意:开始时间要求早于结束时间
2017-02-01 11:11:11
activity_end_time String 可选 10 促销结束时间,用于产品详情展示,格式为:2017-02-07 11:11:11。
注意开始时间要求早于结束时间
2017-02-07 11:11:11
shop_ids String [] 必须 30 适用外部门店id,传入该优惠适用口碑门店id,可以传入多个值,列表类型 2016122800077000000003487108
description String 必须 1024 该活动的活动文案,主要涉及(活动时间、参与方式、活动力度),最多不得超过1024个字,注意:该字段需要过风控校验,不得传入敏感词 立白洗衣液买一送一,多买多送
action_url String 必须 1024 第三方详情页链接:该商品/活动的详细介绍,注意:该字段需要过风控校验,不得传入敏感链接 http://www.alipay.com
member_only String 必须 10 该商品/活动,是否是会员专享的,TRUE表示会员专享,FALSE表示非会员专享 TRUE
coupon_type String 必须 20 优惠类型,全场优惠传入枚举值
比如:DISCOUNT(折扣),OFF(立减),CARD(集点),VOUCHER(代金),REDEMPTION(换购),EXCHANGE(兑换),GIFT(买赠),OTHERS(其他)
DISCOUNT
ext_info String 可选 1024 扩展备用信息,一些其他信息存入该字段 该活动的最终解释权归立白所有
item_brand String 可选 128 品牌:该商品属于哪个牌子/该活动属于哪个商家(比如 海飞丝,统一,徐福记,立白......) 立白
item_category String 可选 128 该商品/活动所属类别(吃的:食品 面膜:个人洗护 拖把:家庭清洁) 家庭清洁

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
content_id String 必填 20 内容id:该活动/商品入库成功之后,会将该活动/商品的id返回,作为商品/活动的内容id 18

请求示例

  • 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");
KoubeiMarketingCampaignRetailDmModifyRequest request = new KoubeiMarketingCampaignRetailDmModifyRequest();
request.setBizContent("{" +
"\"content_id\":\"1\"," +
"\"campaign_type\":\"SINGLE\"," +
"\"thumbnail_image_id\":\"ToxzrXYgQpCExkMDpYbd4AAAACMAAQED\"," +
"\"image_id\":\"dCq1oPoXQ521PLw7rSoa0AAAACMAAQED\"," +
"\"item_code\":\"6901294175846\"," +
"\"item_name\":\"立白洗衣液买一送一\"," +
"\"campaign_end_time\":\"2017-09-20 23:59:59\"," +
"\"brief\":\"低至5.2元/斤\"," +
"\"activity_start_time\":\"2017-02-01 11:11:11\"," +
"\"activity_end_time\":\"2017-02-07 11:11:11\"," +
"      \"shop_ids\":[" +
"        \"2016122800077000000003487108\"" +
"      ]," +
"\"description\":\"立白洗衣液买一送一,多买多送\"," +
"\"action_url\":\"http://www.alipay.com\"," +
"\"member_only\":\"TRUE\"," +
"\"coupon_type\":\"DISCOUNT\"," +
"\"ext_info\":\"该活动的最终解释权归立白所有\"," +
"\"item_brand\":\"立白\"," +
"\"item_category\":\"家庭清洁\"" +
"  }");
KoubeiMarketingCampaignRetailDmModifyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"koubei_marketing_campaign_retail_dm_modify_response":{
		"msg":"Success",
		"code":"10000",
		"content_id":"18"
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
IMG_PROPORTION_ERROR 传入的图片宽高比不符合要求(保证在图片的宽高比为4:3) 请检查传入图片的宽高比,保证在图片的宽高比为4:3,重新提交,具体问题,请联系技术支持,参考链接https://support.open.alipay.com/alipay/support/index.htm
INFOSEC_ERROR 入参含有敏感词 请修改店铺dm展位创建的商品名称/活动文案/第三方链接,重新提交
SHOP_ID_NOT_EXIST 门店ID不存在 请准备shopIds等信息给技术支持排查,参考链接https://support.open.alipay.com/alipay/support/index.htm
SYSTEM_ERROR 系统繁忙 请重试或准备好插入信息给技术支持排查,参考链接https://support.open.alipay.com/alipay/support/index.htm
IMAGE_ID_NOT_EXIST 图片id不能为空 请检查入参,图片id字段是否为空,若图片id为空,则不能成功创建活动
SHOP_IDS_NOT_EXIST 门店ID不能为空 请检查入参,门店id是否为空,若门店id为空,则不能成功创建活动
MEMBER_ONLY_NOT_EXIST 会员专享不能为空 请检查入参,会员专享字段是否为空,若会员专享为空,则不能成功创建活动
ACTION_URL_NOT_EXIST 第三方详情链接不能为空 请检查入参,第三方链接详情字段是否为空,若第三方链接字段为空,则不能成功创建活动
ACTIVITY_TYPE_NOT_EXIST 活动类型不能为空 请检查入参,活动类型是否为空,若活动类型为空,则不能成功创建活动
COUPON_TYPE_NOT_EXIST 优惠类型不能为空 请检查入参,优惠类型是否为空,若优惠类型为空,则不能成功创建活动
DESCRIPTION_NOT_EXIST 活动文案不能为空 请检查入参,活动文案是否为空,若活动文案为空,则不能成功创建活动
IMAGE_URL_NOT_EXIST 图片链接不存在 请确保图片成功上传服务器
ITEM_NAME_NOT_EXIST 商品名称不能为空 请检查入参,商品名称是否为空,若商品名称为空,则不能成功创建活动
PARTNER_SHOP_NOT_MATCH 商户与门店不匹配 商户与门店不匹配,请检查门店的pid,是否与当前的商户id一致
SHOP_STATUS_NOT_OPEN 门店状态不是营业中 请确保选择的门店状态status为开放(OPEN)
CONTENT_NOT_EXIST 查询内容不存在 查询内容不存在,请确保内容id正确无误
PERMISSION_DENIED 用户没有权限操作该内容 传入partnerId是否和数据库相同,不相同调整后,请重试
MODIFY_FAILED 下架状态禁止修改 禁止下架状态修改
END_TIME_NOT_EXIST 下架时间不能为空 上架状态下架时间不能为空,请检查入参重新提交
END_TIME_BEFORE_NOW 下架时间不得早于当前时间 请检查参数,下架时间不得早于当前时间
THIRD_PART_ERROR 内部系统调用异常 请重试或准备好插入信息给技术支持排查,参考链接https://support.open.alipay.com/alipay/support/index.htm
CONTENT_ID_NOT_EXIST 内容ID不能为空 内容ID不能为空,请填写正确的内容ID
OPEN_API_NOT_OPEN 该接口暂未开放 请联系对应的接口人,开放对应的开关
INVALID_PARAMETER 参数有误 传入正确的参数,调整之后重试
BIZ_ERROR 业务异常 请结合提示解决业务问题

公共错误码

返回
顶部