文档中心 > API类目 > 零售终端API

qimen.tmall.nrt.scene.activity.synchronize (新零售营销场景活动同步)

新零售营销场景活动同步

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
op_type	String	必须	new		操作类型
activity_id	Number	必须	11		活动id
activity_type	String	必须	0		活动类型，0:有价礼包
name	String	必须	测试		活动名称
start_time	String	可选	2020-02-01 00:00:00		开始时间
end_time	String	可选	2020-02-01 00:00:00		结束时间
item_id	Number	可选	111		商品id
status	String	必须	0		活动状态
channel_list	ChannelList []	可选		最大列表长度：999	渠道列表
└ channel_name String 可选渠道1 渠道名称 └ channel_code String 可选 11 渠道编码
modified_id	String	可选	11		修改者id
creator_id	String	可选	11		创建者id
extra	String	可选	{"11":"11"}		扩展
version	String	可选	11		版本号
idempotent_id	String	可选	11		幂等id
benefit_list	BenefitList []	可选		最大列表长度：999	权益列表
└ status String 可选 11 权益状态 └ out_relate_id String 必须 111 关联权益id（如券模板id） └ benefit_id Number 必须 11 权益id └ benefit_type String 必须 1 权益类型 └ gmt_modified String 可选 2020-02-01 00:00:00 修改时间 └ gmt_create String 可选 2020-02-01 00:00:00 创建时间 └ extra String 可选 {"ss":"ss"} 扩展 └ total_quantity String 可选 20 限领总数 └ person_limit_count String 可选 10 个人限领 └ use_channel String 可选 1 使用渠道 └ end_time String 可选 2020-02-01 00:00:00 权益结束时间 └ start_time String 可选 2020-02-01 00:00:00 权益开始时间 └ benefit_name String 可选 1 权益名称 └ probability String 可选 0.0323 中奖概率 └ description String 可选 11 权益描述 └ img_url String 可选 11 权益图片

响应参数

名称	类型	示例值	描述
resultDO	ResultDO		结果类
└ errCode String CE001 错误码 └ success Boolean true 处理结果 └ errMsg String 系统错误错误信息

请求示例

{"modified_id":"11","idempotent_id":"11","item_id":111,"end_time":"2020-02-01 00:00:00","benefit_list":[{"gmt_create":"2020-02-01 00:00:00","benefit_name":"1","probability":"0.0323","end_time":"2020-02-01 00:00:00","description":"11","gmt_modified":"2020-02-01 00:00:00","benefit_type":"1","person_limit_count":"10","start_time":"2020-02-01 00:00:00","use_channel":"1","img_url":"11","extra":"{\"ss\":\"ss\"}","total_quantity":"20","out_relate_id":"111","benefit_id":11,"status":"11"}],"version":"11","start_time":"2020-02-01 00:00:00","activity_type":"0","extra":"{\"11\":\"11\"}","activity_id":11,"name":"测试","creator_id":"11","op_type":"new","channel_list":[{"channel_name":"渠道1","channel_code":"11"}],"request_id":"","status":"0"}

响应示例

{
    "resultDO":{
        "errCode":"CE001",
        "success":true,
        "errMsg":"系统错误"
    }
}

验签示例

{"resultDO":{"success":"false","errCode":"sign-check-failure","errMsg":"Illegal request"}}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

零售终端API

qimen.tmall.nrt.scene.activity.synchronize (新零售营销场景活动同步)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ