# 查询团购优惠详情

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

接口英文名：getlocalproduct

查询团购优惠详情

# 1. 调用方式

# HTTPS 调用

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

# 云调用

本接口不支持云调用

# 第三方调用

本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为：129
服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看第三方调用说明文档。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	示例	说明
access_token	string	是	ACCESS_TOKEN	接口调用凭证，可使用 access_token、authorizer_access_token

# 请求体 `Request Payload`

参数名	类型	必填	示例	说明
product_id	string(uint64)	是		平台生成的id
data_type	number	否	1	默认取1。1:获取线上数据, 2:获取草稿数据, 3:同时获取线上和草稿数据（注意：上架过的商品才有线上数据）

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	说明
errcode	number	错误码
errmsg	string	错误信息
online_data	object	商品线上数据，入参data_type==2时不返回该字段；入参data_type==3且商品从未上架过，不返回该字段
draft_data	object	商品草稿数据，入参data_type==1时不返回该字段

# Res.online_data `Object Payload`

商品线上数据，入参data_type==2时不返回该字段；入参data_type==3且商品从未上架过，不返回该字段

以下参数使用相同结构：

Res.draft_data ：商品草稿数据，入参data_type==1时不返回该字段

参数名	类型	说明	枚举
product_id	number	平台生成的id	-
out_product_id	string	外部系统id，只作为商品字段存储，不用做索引。通常为商家侧的商品id，商家需自动维护好out_product_id和平台侧生成的product_id之间对应关系。	-
product_type	number	券类型。1. 代金券；2. 兑换券；3. 次卡	-
product_name	string	名称	-
category_id	number	三级类目id	-
brand_id	number	品牌id	-
head_imgs	array	主图	-
verify_page	object	核销跳转出口	-
code_source_type	number	1. 平台生成；2. 商家自定义；3. 发券实时传code （实时发券模式暂不开放）	-
attr_kv_map	object	商品属性KV	-
draft_status	number	商品草稿状态，具体枚举值参考下文	枚举值
online_status	number	商品线上状态，具体枚举值参考下文	枚举值
audit_result	object	商品审核结果	-
verify_at_store	number	是否支持到店核销。1. 支持，0. 不支持。默认1.支持。当选择0.不支持时，订单页面将不展示核销二维码，且必须填写verify_page参数。	-
product_qua_infos	objarray	商品资质列表，所创建的商品需核验其他资质时填入（如酒店房间含早餐）；资质列表可参考获取类目信息	-

# Res.online_data.verify_page `Object Payload`

核销跳转出口

参数名	类型	说明
appid	string	小程序appid
path	string	小程序path

# Res.online_data.attr_kv_map `Object Payload`

商品属性KV

参数名	类型	说明	枚举
use_date_rule	string	有效期规则。过期自动下架	-
total_price	string	【兑换券专属属性】兑换套餐门市价，单位分，只 (非实际售价)，门市价与子套餐价格二选一填写价且门市价>售卖价时，原价展示为门市价。次不生效。	-
available_store_desc	string	可用门店说明，最多支持100字。示例:全国门店除机场店外可用	-
use_time	timestamp	全天/仅指定时间可用;时间段	-
exclusive date	string	不可使用日期，指定周几不可用	-
voucher_amount	string	代金券面额，向用户展示，不作为核销规则校验	-
bring_out_type	number	当商品一级类目为“餐饮”时必填。一级类目非“餐饮”时，传入该参数无效	枚举值
appointment	number	是否需要预约;提前X天;提前X小时	枚举值
limit_buy_rule	string	单用户购买限制	-
order_limit_num	number	单笔订单限购数量，取值范围0-25，传0表示不限制，默认限制为平台最大值25。	-
additional_rule	string	支持本地商家录入其他文本规则，最多支持1,000字，\\\n进行换行	-
need_phone_num	number	是否需要用户手机号；1-是，则用户下单时候需填入手机号，才可发起支付0-否，则不需要填写手机号，后续订单信息中不会有用户手机号。默认值为0-否。	-
settle_type	number	结算对象。1. 支持核销后结算至总部（一期不支持门店）	-
refund_policy	number	-	枚举值
detail_imgs	string	优惠券详情图片，最多10张，图片尺寸推荐3:2	-
set_meals	string	套餐内容，最多包含10个子套餐分组	-

# Res.online_data.audit_result `Object Payload`

商品审核结果

参数名	类型	说明
audit_status	number	审核状态: 1. 等待审核中 2.审核失败 3.审核成功
audit_reason	string	审核失败时表示失败原因

# Res.online_data.product_qua_infos(Array) `Object Payload`

商品资质列表，所创建的商品需核验其他资质时填入（如酒店房间含早餐）；资质列表可参考获取类目信息

参数名	类型	说明
qua_id	number	商品资质id，可参考获取类目信息
qua_url	array	商品资质图片列表（单个商品资质id下，最多10张）；必使用接口上传图片

# 4. 枚举信息

# Res.online_data.draft_status `Enum`

商品草稿状态，具体枚举值参考下文

枚举值	描述
0	初始化
1	编辑中

# Res.online_data.online_status `Enum`

商品线上状态，具体枚举值参考下文

枚举值	描述
5	上架售卖中
11	自主下架
13	违规下架/风控系统下架
14	保证金不足下架
15	品牌过期下架
20	商品被封禁

# Res.online_data.attr_kv_map.bring_out_type `Enum`

当商品一级类目为“餐饮”时必填。一级类目非“餐饮”时，传入该参数无效

枚举值	描述
1	本优惠支持堂食和外带
2	本优惠仅支持堂食，不支持外带
3	本优惠仅支持外带，不支持堂食

# Res.online_data.attr_kv_map.appointment `Enum`

是否需要预约;提前X天;提前X小时

枚举值	描述
1	无需预约，高峰期可能需要排队，到店直接出示使用
2	需要提前预约后才可到店使用
3	无需预约填0

# Res.online_data.attr_kv_map.refund_policy `Enum`

枚举值	描述
0	不支持退款
1	随时可退，过期未核销自动退（一期必须选1）

# 5. 注意事项

本接口无特殊注意事项

# 6. 代码示例

请求示例

{
    "product_id":"15000000134007",
    "data_type":2
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok",
    "draft_data": {
        "product_id": "15000000134007",
        "out_product_id": "test1",
        "product_type": 1,
        "product_name": "测试商品改",
        "category_id": "1452",
        "brand_id": "2100000000",
        "head_imgs": [
            "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HA7ukhipcfggnDP8l5EqCwX1YsvxMZwAFvoPNqG-IbU",
            "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HO7eONXc8Y9uLHr0q0Rs6UvJ0iC0oAuQD3whJEA5Sc4",
            "https://mmecimage.cn/p/wx2b255582a7b4bfd0/HKBXBm8pze5WcayaDacjfSveBYQIQzKrVaR3zi2tja4"
        ],
        "verify_page": {
            "appid": "wxca8d4b8e8feedc2a",
            "path": "main/channels/buy/buy.html?productId=123"
        },
        "code_source_type": 1,
        "attr_kv_map": {
            "voucher_amount": "222",
            "use_date_rule": "{\"validate_type\":1,\"use_date\":{\"use_start_date\":\"2023-11-29\",\"use_end_date\":\"2023-12-15\"}}",
            "exclusive_date": "{\"days_of_week\":[]}",
            "settle_type": "2",
            "need_phone_num": "0",
            "bring_out_type": "1",
            "refund_policy": "0",
            "use_time": "{\"use_time_type\":1,\"time_periods\":[]}"
        },
        "skus": [
            {
                "sku_id": "1930992007",
                "sale_price": 123,
                "stock_num": 21
            }
        ],
        "draft_status": 1,
        "audit_result": {
            "audit_status": 0
        }
    }
}

# 7. 错误码

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

# 8. 适用范围

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

# 查询团购优惠详情

# 1. 调用方式

# HTTPS 调用

# 云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

# Res.online_data Object Payload

# Res.online_data.verify_page Object Payload

# Res.online_data.attr_kv_map Object Payload

# Res.online_data.audit_result Object Payload

# Res.online_data.product_qua_infos(Array) Object Payload