文档中心 > API类目 > 天猫校园零售

qimen.tmall.campus.retail.marketing.verify.shoppromotion.activity.get (获取活动列表)

获取活动列表

公共参数

请求地址：

环境	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输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	描述
startTime	String	必须	2015-01-01 12:00:00	查询开始时间
endTime	String	必须	2015-01-01 12:00:00	查询结束时间
pageNum	Number	必须	1	页码
pageSize	Number	必须	10	每页大小
_platform_num	String	必须	8800001	租户号

响应参数

名称	类型	示例值	描述
activities	ShopPromotionMarketingActivityResponse []		活动
└ description String 活动描述描述 └ name String 活动名称名称 └ activityId Number 434555 天猫校园活动id └ tpId Number 788888 tpId └ endTime String 2022-03-10 12:00:00 活动结束时间 └ startTime String 2022-03-10 12:00:00 活动开始时间 └ updateTime String 2022-03-10 12:00:00 更新时间 └ status Number 1 状态 1:正常 -1失效 └ idempotentCode String HJ2394538348 幂等ID └ useLimit Number 1 是否使用限购 └ limit Number 10 总限购 └ dailyLimit Number 5 日限制 └ publishStatus Number 1 1 = 发布成功 0 = 发布失败 └ extMap String {} 扩展字段，必须是json序列化方式
success	Boolean	true	成功
errCode	String	999	错误码
errMsg	String	这是错误消息	错误信息

请求示例

{"_platform_num":"8800001","pageSize":10,"startTime":"2015-01-01 12:00:00","endTime":"2015-01-01 12:00:00","pageNum":1}

响应示例

{
    "activities":[
        {
                "description":"活动描述",
                "name":"活动名称",
                "activityId":434555,
                "tpId":788888,
                "endTime":"2022-03-10 12:00:00",
                "startTime":"2022-03-10 12:00:00",
                "updateTime":"2022-03-10 12:00:00",
                "status":1,
                "idempotentCode":"HJ2394538348",
                "useLimit":1,
                "limit":10,
                "dailyLimit":5,
                "publishStatus":1,
                "extMap":"{}"
        }
    ],
    "success":true,
    "errCode":"999",
    "errMsg":"这是错误消息"
}

验签示例

{"success":"不等于true","errCode":"sign-check-failure","errMsg":"Illegal request"}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

天猫校园零售

qimen.tmall.campus.retail.marketing.verify.shoppromotion.activity.get (获取活动列表)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ