# 添加团购优惠

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:addlocalproduct

通过本接口可以创建本地团购优惠。创接口不支持直接设置库存,请在创建完成后调用库存管理接口进行设置。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/product/locallife/add?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:129

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
out_product_idstring外部系统id,只作为商品字段存储,不用做索引。通常为商家侧的商品id,商家需自动维护好out_product_id和平台侧生成的product_id之间对应关系
product_typenumber券类型。1. 代金券;2. 兑换券;3. 次卡。创建后不支持修改
product_namestring名称(最少3字符,最多60字符),中文文字/英文字母/数字,都各算1个有效字符数,且不得仅为数字或英文,不得含非法字符,允许的特殊字符集为:`·~~!@#$%^&()!@#¥%……&*()\-_——=+[\]\\【】、{}||;';’:":‘“”,./,。、<>?《》?°C\u00A0\u0020\u3000\u03B2\u2764\u3010\u3011\u300E\u300F\u25C6,最多60字符。 合规商品标题举例: 1.糖醋排骨【预订价10元】; 2.CheddarCheese切达干酪; 3.百岁山天然矿泉水1L*15瓶。 不合规商品标题举例: 1.正宗五指毛桃根√; 2.Classic Whole Wheat; 3.便携式折叠扇第Ⅲ代; 4.iPhone 13; 5.Mac999
category_idstring(uint64)三级类目id,通过接口[获取所有的类目
brand_idstring(uint64)品牌id,店铺可用接口通过[[获取生效中的品牌资质列表
head_imgsarray主图。必使用接口[上传图片
product_qua_infosobject商品资质列表,所创建的商品需核验其他资质时填入(如酒店房间含早餐);资质列表可参考获取类目信息中的字段product_qua_list
verify_pageWxAppPath核销跳转出口。订单详情用户可前往小程序核销。 如小程序核销流程无法满足体验规范的商家,将予以断播处罚
verify_at_storenumber是否支持到店核销。1. 支持;0. 不支持。不填则默认1.支持。当选择0.不支持时,订单页面将不展示核销二维码,且必须填写verify_page参数
code_source_typenumber1. 平台生成;2. 商家预存code,用户支付成功后平台发放。创建后不支持修改
attr_kv_mapmap商品属性kv,具体字段参照团购商品结构体定义【代金券属性KV】或者【兑换券属性KV】小节
skusarray售卖单元,本接口不支持直接设置库存,请调用修改团购优惠库存的接口设置库存

# Body.product_qua_infos Object Payload

商品资质列表,所创建的商品需核验其他资质时填入(如酒店房间含早餐);资质列表可参考获取类目信息中的字段product_qua_list

参数名类型必填说明
qua_idnumber商品资质id,对应获取类目信息中的字段product_qua_list[].qua_id
qua_urlarray商品资质图片列表(单个商品资质id下,最多10张)

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
dataobjectdata

# Res.data Object Payload

data

参数名类型说明
product_idstring(uint64)平台生成的商品id
sku_idsarray和请求参数中的 sku列表顺序保持一致

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "out_product_id": "test_120719261",
    "product_type": 1,
    "product_name": "测试商品",
    "category_id": "545201",
    "brand_id": "10010719",
    "head_imgs":[
        "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HPfcDsYrzbTlVSFQI9Qar0uzDhKI-EB7Efryf-dxlUE",
        "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HAOY-e61JPVNI5fsTlOcy-1r_rSxqnAsIUWqXXWNJSE",
        "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HLD6dz9RbUkPzBQGHnpb9Z7BcK9kF1HYeLkwxiK9RtI"
    ],
    "verify_page": {
        "appid":"wxca8d4b8e8feedc2a",
        "path": "main/channels/buy/buy.html?productId=123"
    },
    "code_source_type": 1,
    "attr_kv_map": {
        "use_date_rule": "{\"validate_type\":1,\"use_date\":{\"use_start_date\":\"2023-11-29\",\"use_end_date\":\"2023-12-31\"}\}",
        "use_time":"{\"use_time_type\":2,\"time_periods\":[{\"use_start_time\":\"10:00:00\",\"use_end_time\":\"20:00:00\"}]}",
        "detail_imgs":"[\"https://mmecimage.cn/xxxxxxxxxx\",\"https://mmecimage.cn/yyyyyyyyyy\",\"https://mmecimage.cn/zzzzzzzzzz\"]",
        "set_meals":"[{\"group_name\": \"套餐名称\", \"items\": [{\"item_count\": 1, \"item_name\": \"项目名称\",\"item_price\": 28800}],\"option_count\": 1}]",
        "exclusive_date": "{\"enable\": 0}",
        "voucher_amount": "100",
        "bring_out_type": "1",
        "appointment": "{\"need_appointment\":0}",
        "need_phone_num": "0",
        "additional_rule": "\"附加规则\"",
        "available_store_desc": "\"可用门店描述\"",
        "settle_type": "1",
        "refund_policy": "1"
    },
    "skus": [
        {
            "sale_price": 100
        }
    ]
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "data": {
        "product_id": "15000000000000",
        "sku_ids": [
            "1234567890"
        ]
    }
}

# 6. 错误码

此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

# 7. 适用范围

本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。