卡券信息添加/更新

开发之前请创建腾讯数据接入数据源 （dataSourceId），可将 dataSourceId 理解为数据的集合。创建一个数据仓库后，所有接口传输数据时都可重复使用。

请求地址

域名/data-api/v1/order/add_coupon

请求方法

POST

请求参数

参数名	样例	描述
app_id	abc	分配的app_id
nonce	61794670f155b	随机字符串
sign	sha256	签名算法
timestamp	1569232087	请求时间戳（秒级）
signature	aee30792812d7b09ba7d3aa67c24e16c6a7ea81282ac728ad5966dd1b3eef6d5	签名结果

请求体类型

application/json

请求体参数

名称	类型	必填	描述
dataSourceId	string	Y	数据源id（create方法返回的data.dataSource.id）
coupons	array	Y	卡券列表，数组最大长度 50
external_coupon_id	string	Y	卡券批次唯一 id，字段长度最小 1 字节，长度最大 100 字节
brand_name	string		品牌名称，字段长度最小 1 字节，长度最大 64 字节
brand_logo	string		logo图片地址；字段长度最小 1 字节，长度最大 2048 字节
coupon_name	string	Y	卡券名称，字段长度最小 1 字节，长度最大 100 字节
promotion_ids	string[]		活动 id 列表，数组，字段长度最小 1 字节，长度最大 100 字节
coupon_type	integer	Y	卡券类型；1：商家券；2：微信券
coupon_sub_type	integer	Y	卡券子类型；1：满减券；2：打折券；3：商品券；4：兑换券；5：线索券；6：自定义券；7：运费券
plan_count	integer		卡券发行量
store_count	integer		卡券库存量
available_status	integer		卡券上下架状态，1：上架；2：下架，为空默认为上架
stock_status	integer		卡券的库存状态 1：库存＞0；2：库存≤0
start_time	string	C	卡券有效的开始时间，时间戳，毫秒，若填写了'end_time'则必填
end_time	string	C	卡券有效的结束时间，毫秒，若填写了'start_time'则必填
fixed_valid_time	string		卡券有效的固定时间，领券当日起X日可用，如 43200，单位秒
fixed_valid_start_time	string		领券当日起X日后可用，如 216000，单位秒
reminder_overdue	integer		是否开启过期提醒，1：开启；2：关闭
short_description	string		卡券短描述，字段长度最小 1 字节，长度最大 64 字节
rule_description	string		卡券规则描述，字段长度最小 1 字节，长度最大 1000 字节
added_status	integer		是否可叠加其他优惠，1：是；2：否
amount_coupon	float		卡券金额，单位元，保留 2 位小数，卡券子类型=1时必填
amount_original	float		卡券原价
discount_coupon	float		卡券折扣，卡券子类型= 2 时必填，保留2位小数，不带百分号，如 99.99% 填 99.99
price_coupon	float		卡券售卖金额，单位元，保留 2 位小数
amount_minimum	float		使用卡券的最低消费金额，若卡券类型 = 1 或 2 时填写，卡券为满减券/满折券
max_discount_amount	float		使用卡券的折扣金额上限，若卡券类型 = 1 或 2 时填写，卡券为满减券/满折券
number_minimum	integer		使用卡券的最低件数，若卡券类型 = 1 或 2 时填写，卡券为满减券/满折券
release_status	integer		发放状态；1：有效；2；过期；3：冻结
max_coupon_number_per_user	integer		每位用户最大领取数量
max_coupon_number_per_user_daily	integer		每位用户每日最大领取数量
max_amount_by_day	float		单天发放上限金额
max_coupons_by_day	integer		单天发放上线个数
natural_person_limit	boolean		是否开启自然人限制，true:开启；false:关闭
media_info	object		卡券图片信息，最大长度 10
primary_img	string		卡券主图图片信息地址，图片320*320以上，图片可正常打开，正方形，数组最大长度 10
imgs	array		卡券轮播图信息列表 数组最大长度 10
img_url	string		卡券轮播图地址；10张，图片可正常打开 字段长度最小 1 字节，长度最大 2048 字节
product	object		可使用卡券的商品信息
is_all	boolean		卡券使用范围是否为该小程序的全部商品，true:是；false：否
sku_ids	string[]		卡券使用的商品sku列表，数组，长度最大 2048 字节
spu_ids	string[]		卡券使用的商品spu列表，数组，长度最大 2048 字节
gift_info	array		卡券赠品信息 数组最大长度 10
external_sku_id	string		赠品sku编号
sku_name_chinese	string		赠品商品名称
goods_num	string		赠品数量
user	object		可使用卡券的用户信息
all_users	boolean		卡券使用范围是否为该小程序的全部用户，true:是；false：否
store	object		可使用卡券的门店信息
all_stores	boolean		卡券使用范围是否为商家的全部门店，true:是；false：否
store_info	array		可使用卡券的门店信息
external_store_id	string	C	可使用卡券的门店id，填写`store_name`时必填，字段长度最小 1 字节，长度最大 100 字节
store_name	string	C	可使用卡券的门店名称，填写`external_store_id`时必填，字段长度最小 1 字节，长度最大 100 字节
seller_info	object		商品的卖家信息，供平台类商家填写自己的卖家信息
seller_id	string		商品卖家 id，由平台类商家自己生成
release_location	array		卡券投放位置信息
country_code	string		国家编码，CN 字段长度最小 1 字节，长度最大 64 字节
country_name	string		国家名称，中国 字段长度最小 1 字节，长度最大 64 字节
province_code	integer		省份编码，使用《民政部行政区划代码》，440000
province_name	string		省份名称，XX省 字段长度最小 1 字节，长度最大 64 字节
city_code	integer		城市编码，使用《民政部行政区划代码》
city_name	string		城市名称，XX市 字段长度最小 1 字节，长度最大 64 字节
district_code	integer		区/县编码，使用《民政部行政区划代码》
district_name	string		区/县名称，字段长度最小 1 字节，长度最大 64 字节
release_location_status	integer		1：该位置适用；2：该位置不适用；为空默认为“1”
target_url	object		卡券领取页信息
url_miniprogram	string	C	微信小程序落地页 url，当落地页为微信小程序时必填 字段长度最小 1 字节，长度最大 100 字节
miniprogram_appid	string	C	微信小程序 appid，当落地页为微信小程序时必填 字段长度最小 1 字节，长度最大 100 字节
miniprogram_username	string	C	小程序原始ID，登录小程序管理后台-设置-基本设置-帐号信息中，gh_xx，当落地页为微信小程序时必填字段长度最小 1 字节，长度最大 100 字节
url_miniprogram_qq	string	C	qq小程序落地页 url，当落地页为QQ小程序时必填 字段长度最小 1 字节，长度最大 100 字节
miniprogram_appid_qq	string	C	qq小程序 appid，当落地页为QQ小程序时必填 字段长度最小 1 字节，长度最大 100 字节
url_h5	string	C	h5落地页url 字段长度最小 1 字节，长度最大 100 字节
url_list	string		可使用该卡券的商品/门店集合页链接
show_start_time	string		卡券展示的开始时间，时间戳，毫秒
show_end_time	string		卡券展示的结束时间，时间戳，毫秒
tag_info	object		卡券的标签信息 数组最大长度 10
custom_tag	array		卡券的标签信息 数组最大长度 50
tag_name	string		标签名称，长度最大 2048 字节
tag_value	string[]		标签值，数组，长度最大 2048 字节
third_promotion_info	object		CPS业务必填，第三方推广信息
commission_rate	float	C	佣金比例，2位小数，不带百分号，如 10% 填10.00
promote_status	integer	C	推广状态；1：推广中；0：停止推广
is_deleted	integer		商家标记卡券已删除，0：未删除；1：已删除，为空默认为 0

请求体示例

{
    "dataSourceId": "101",
    "coupons": [
        {
            "external_coupon_id": "1000000001",
            "coupon_name": "7 折优惠",
            "promotion_ids": [
                "1234",
                "5678"
            ],
            "coupon_codes": [
                "00001",
                "00002"
            ],
            "coupon_type": 1,
            "coupon_sub_type": 2,
            "plan_count": 1000,
            "store_count": 500,
            "start_time": "1572395131732",
            "end_time": "1572395131732",
            "rule_description": "到店消费",
            "discount_coupon": 0.7,
            "amount_minimum": 0,
            "release_status": 1,
            "max_coupon_number_per_user": 1,
            "product": {
                "sku_ids": [
                    "E1111"
                ]
            },
            "url_list": "www.tencent.com",
            "show_start_time": "1572395131732",
            "show_end_time": "1572395131732"
        }
    ]
}

应答体结构

名称	类型	描述
retcode	integer	返回码
errmsg	string	错误信息
data	json object	响应内容

应答示例

{
 "retcode": 0,
 "errmsg": "",
 "data": {}
}