查询商品模板
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
GET
/life/goods/template/get/
查询商品模板,创建商品时的属性列表需与该接口保持一致,否则无法识别。
权限要求
需要权限申请,参考在开发者平台控制台选择行业类目及身份后的入驻指引。
枚举字典
product_type
商品模板举例
团购模板 (1 代表必填属性,2 代表选填属性)
模板 | ||||||||
---|---|---|---|---|---|---|---|---|
1000000 | 3000000 | 4000000 | 6000000 | 7000000 | 8000000 | 17000000 | 18000000 | |
属性 | 美食团购模板 | 运动健身团购模板 | 休闲娱乐团购模板 | 生活服务团购模板 | 教育培训团购模板 | 住宿团购模板 | 丽人团购模板 | 游玩团购模板 |
appointment 预约信息 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
auto_renew 自动延期 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
bring_out_meal 是否可以外带餐食 | 1 | |||||||
can_no_use_date 不可使用日期 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
contains_insurance 是否包含保险 | 1 | |||||||
customer_reserved_info 留资规则 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
Description 商品描述 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | |
description_rich_text 其他说明信息 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
detail_image_list 长图 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
dishes_image_list 菜品图 | 2 | |||||||
EntryType 入口类型 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
environment_image_list 环境图 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
free_pack 是否可以打包 | 1 | |||||||
FrontCategoryTag 前台品类标签 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
holiday_additional_charge 节假日是否额外收费 | 1 | |||||||
image_list 封面图 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
IndustryType 商品行业类型 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
IsConfirmImme 是否立即确认 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
IsNeedPick 是否需要取票 | 1 | |||||||
limit_gender 是否限制性别 | 1 | |||||||
limit_hair_length 是否限制长短发 | 1 | |||||||
original_vip_can_experience 商家原会员是否可以体验 | 1 | |||||||
MpResourceID 小程序资源id | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
MpSettleType 小程序分账类型 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
NearestOrderTime 最早可订时间 | 1 | |||||||
Notification 使用规则 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
private_room 是否可以使用包间 | 1 | |||||||
real_name_info 实名信息 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
RecommendWord 推荐语 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
rec_person_num 建议使用人数 | 1 | |||||||
rec_person_num_max 最多使用人数 | 1 | |||||||
RefundPolicy 退款政策 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
refund_need_merchant_confirm 退款是否需商家审核 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
show_channel 投放渠道 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
SortWeight 排序权重 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
superimposed_discounts 可以享受店内其他优惠 | 1 | |||||||
TagList 标签列表 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
trade_url 小程序提单页跳转 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
use_date 使用日期 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
use_time 使用时间 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
code_source_type 券码生成方式 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
commodity 菜品搭配 | 1 | |||||||
market_price 市场价 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
settle_type 收款方式 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
use_type 团购使用方式 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
limit_rule 限制购买 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
SuitableGroup 适用人群 | 1 | |||||||
TicketType 票种类型 | 2 | |||||||
SubTitle 副标题 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
日历房模板
属性KEY | 属性名称 | 是否列表 | 是否必填 | 描述 |
---|---|---|---|---|
FrontCategoryTag | 前台品类标签 | TRUE | FALSE | ["一日游","代金券","含房套餐","美食套餐","美食单品","门票","旅行跟拍","门店服务","单房型"] |
can_no_use_date | 不可使用日期 | FALSE | FALSE | |
use_time | 使用时间 | FALSE | FALSE | |
Notification | 使用规则 | TRUE | FALSE | |
description_rich_text | 其他说明信息 | TRUE | FALSE | |
superimposed_discounts | 可以享受店内其他优惠 | FALSE | FALSE | |
private_room | 是否可以使用包间 | FALSE | FALSE | |
free_pack | 是否可以打包 | FALSE | FALSE | |
bring_out_meal | 是否可以外带餐食 | FALSE | FALSE | |
add_bed | 加床规则 | FALSE | FALSE | 0-不可加床 1-收费 2-免费 |
add_bed_fee | 加床费用 | FALSE | FALSE | 加床费用/每人,单位人民币分 |
BreakfastRule | 加早规则 | FALSE | FALSE | |
need_charge_if_timeout | 超时是否收费 | FALSE | FALSE | |
charge_rule | 收费规则 | FALSE | FALSE | |
check_in_time | 入住时间 | FALSE | FALSE | |
check_out_time | 退房时间 | FALSE | FALSE | |
appointment | 预约信息 | FALSE | FALSE | |
Area | 房间面积 | FALSE | FALSE | |
BedName | 床型 | FALSE | FALSE | |
breakfast | 早餐 | FALSE | FALSE | 枚举:0-不含早 1-含早 |
image_list | 封面图 | TRUE | TRUE | |
detail_image_list | 长图 | TRUE | FALSE | |
EntryType | 入口类型 | FALSE | FALSE | 1-H5 2-小程序 |
Facility | 酒店设施 | TRUE | FALSE | |
FitNum | 房间适住人数 | FALSE | FALSE | |
smoke | 是否禁烟 | FALSE | FALSE | 枚举:0-不禁烟 1-禁烟 |
SortWeight | 排序权重 | FALSE | FALSE | 按降序排列 |
Floor | 楼层 | FALSE | FALSE | |
Date | 日期 | FALSE | TRUE | 单sku的使用日期,同时代表了当前sku售价和库存的对应日期 value : "20220808" |
sku_image | Sku图片 | TRUE | FALSE | |
limit_rule | 限制购买 | FALSE | FALSE | |
RefundPolicy | 退款政策 | FALSE | FALSE | 1-允许退款 2-不可退款 3-有条件退 |
refund_need_merchant_confirm | 退款是否需商家审核 | FALSE | FALSE | true-需要商家审核 false-无需审核 |
trade_url | 小程序提单页跳转 | FALSE | FALSE | |
MpSettleType | 小程序分账类型 | FALSE | FALSE | 1-包销 2-代销 |
RecommendWord | 推荐语 | FALSE | FALSE | |
SubTitle | 副标题 | FALSE | FALSE | |
commodity | 菜品搭配 | FALSE | TRUE |
门票模板
属性KEY | 属性名称 | 是否列表 | 是否必填 | 描述 |
---|---|---|---|---|
image_list | 封面图 | TRUE | TRUE | |
OrderDependsOnDate | 下单是否以依赖日期 | FALSE | FALSE | |
IndustryType | 商品行业类型 | FALSE | FALSE | |
EntryType | 入口类型 | FALSE | FALSE | 1:H5 2:小程序 3:抖音 4:lynx |
SortWeight | 排序权重 | FALSE | FALSE | |
FrontCategoryTag | 前台品类标签 | TRUE | FALSE | |
RefundPolicy | 退款政策 | FALSE | FALSE | 1-允许退款 2-不可退款 3-有条件退 |
SuitableGroup | 适用人群 | TRUE | TRUE | |
holiday_additional_charge | 节假日是否额外收费 | FALSE | TRUE | |
contains_insurance | 是否包含保险 | FALSE | TRUE | |
NearestOrderTime | 最早可订时间 | FALSE | TRUE | |
IsNeedPick | 是否需要取票 | FALSE | TRUE | |
TicketType | 票种类型 | TRUE | FALSE | |
EntryType | 入口类型 | FALSE | FALSE | 1-H5 2-小程序 |
trade_url | 小程序提单页跳转 | FALSE | FALSE | |
MpSettleType | 小程序分账类型 | FALSE | FALSE | 1-包销 2-代销 |
IsConfirmImme | 是否立即确认 | FALSE | FALSE |
预售券
AttrKey | AttrKeyName | 是否必填 |
---|---|---|
FrontCategoryTag | 前台品类标签 | FALSE |
RecommendWord | 推荐语 | FALSE |
IndustryType | 商品行业类型 | FALSE |
SuitableGroup | 适用人群 | FALSE |
TicketType | 票种类型 | FALSE |
EntryType | 入口类型 | FALSE |
can_no_use_date | 不可使用日期 | FALSE |
use_time | 使用时间 | FALSE |
Notification | 使用规则 | FALSE |
description_rich_text | 其他说明信息 | FALSE |
superimposed_discounts | 可以享受店内其他优惠 | FALSE |
private_room | 是否可以使用包间 | FALSE |
free_pack | 是否可以打包 | FALSE |
bring_out_meal | 是否可以外带餐食 | FALSE |
add_bed | 加床规则 | FALSE |
add_bed_fee | 加床费用 | FALSE |
need_charge_if_timeout | 超时是否收费 | FALSE |
charge_rule | 收费规则 | FALSE |
check_in_time | 入住时间 | FALSE |
check_out_time | 退房时间 | FALSE |
limit_hair_length | 是否限制长短发 | FALSE |
limit_gender | 是否限制性别 | FALSE |
original_vip_can_experience | 商家原会员是否可以体验 | FALSE |
holiday_additional_charge | 节假日是否额外收费 | FALSE |
contains_insurance | 是否包含保险 | FALSE |
appointment | 预约信息 | FALSE |
RefundPolicy | 退款政策 | FALSE |
refund_need_merchant_confirm | 退款是否需商家审核 | FALSE |
image_list | 封面图 | FALSE |
detail_image_list | 长图 | FALSE |
limit_rule | 限制购买 | FALSE |
trade_url | 小程序提单页跳转 | FALSE |
MpSettleType | 小程序分账类型 | FALSE |
一日游模板
属性KEY | 属性名称 | 是否列表 | 是否必填 | 描述 |
---|---|---|---|---|
image_list | 封面图 | TRUE | TRUE | |
OrderDependsOnDate | 下单是否以依赖日期 | FALSE | FALSE | |
IndustryType | 商品行业类型 | FALSE | FALSE | |
EntryType | 入口类型 | FALSE | FALSE | 1:H5 2:小程序 3:抖音 4:lynx |
SortWeight | 排序权重 | FALSE | FALSE | |
FrontCategoryTag | 前台品类标签 | TRUE | FALSE | |
RefundPolicy | 退款政策 | FALSE | FALSE | 1-允许退款 2-不可退款 3-有条件退 |
SuitableGroup | 适用人群 | TRUE | TRUE | |
holiday_additional_charge | 节假日是否额外收费 | FALSE | TRUE | |
contains_insurance | 是否包含保险 | FALSE | TRUE | |
NearestOrderTime | 最早可订时间 | FALSE | TRUE | |
IsNeedPick | 是否需要取票 | FALSE | TRUE | |
TicketType | 票种类型 | TRUE | FALSE | |
EntryType | 入口类型 | FALSE | FALSE | 1-H5 2-小程序 |
trade_url | 小程序提单页跳转 | FALSE | FALSE | |
MpSettleType | 小程序分账类型 | FALSE | FALSE | 1-包销 2-代销 |
IsConfirmImme | 是否立即确认 | FALSE | FALSE |
旅游跟拍模板
属性KEY | 属性名称 | 是否列表 | 是否必填 | 描述 |
---|---|---|---|---|
image_list | 封面图 | TRUE | TRUE | |
OrderDependsOnDate | 下单是否以依赖日期 | FALSE | FALSE | |
IndustryType | 商品行业类型 | FALSE | FALSE | |
EntryType | 入口类型 | FALSE | FALSE | 1:H5 2:小程序 3:抖音 4:lynx |
SortWeight | 排序权重 | FALSE | FALSE | |
FrontCategoryTag | 前台品类标签 | TRUE | FALSE | |
RefundPolicy | 退款政策 | FALSE | FALSE | 1-允许退款 2-不可退款 3-有条件退 |
SuitableGroup | 适用人群 | TRUE | TRUE | |
holiday_additional_charge | 节假日是否额外收费 | FALSE | TRUE | |
contains_insurance | 是否包含保险 | FALSE | TRUE | |
NearestOrderTime | 最早可订时间 | FALSE | TRUE | |
IsNeedPick | 是否需要取票 | FALSE | TRUE | |
TicketType | 票种类型 | TRUE | FALSE | |
EntryType | 入口类型 | FALSE | FALSE | 1-H5 2-小程序 |
trade_url | 小程序提单页跳转 | FALSE | FALSE | |
MpSettleType | 小程序分账类型 | FALSE | FALSE | 1-包销 2-代销 |
IsConfirmImme | 是否立即确认 | FALSE | FALSE |
代金券模板
属性KEY | 属性名称 | 是否列表 | 是否必填 | 描述 |
---|---|---|---|---|
FrontCategoryTag | 前台品类标签 | TRUE | FALSE | |
RecommendWord | 推荐语 | FALSE | FALSE | |
IndustryType | 商品行业类型 | FALSE | FALSE | |
EntryType | 入口类型 | FALSE | FALSE | |
SortWeight | 排序权重 | FALSE | FALSE | |
use_date | 使用日期 | FALSE | TRUE | |
can_no_use_date | 不可使用日期 | FALSE | TRUE | |
use_time | 使用时间 | FALSE | TRUE | |
Notification | 使用规则 | TRUE | TRUE | |
description_rich_text | 其他说明信息 | TRUE | FALSE | |
superimposed_discounts | 可以享受店内其他优惠 | FALSE | TRUE | |
private_room | 是否可以使用包间 | FALSE | TRUE | |
free_pack | 是否可以打包 | FALSE | TRUE | |
bring_out_meal | 是否可以外带餐食 | FALSE | TRUE | |
rec_person_num | 建议使用人数 | FALSE | TRUE | |
rec_person_num_max | 最多使用人数 | FALSE | TRUE | |
need_deposit | 是否需要缴纳押金 | FALSE | TRUE | |
add_bed | 加床规则 | FALSE | TRUE | |
add_bed_fee | 加床费用 | FALSE | TRUE | |
need_charge_if_timeout | 超时是否收费 | FALSE | TRUE | |
charge_rule | 收费规则 | FALSE | TRUE | |
check_in_time | 入住时间 | FALSE | TRUE | |
check_out_time | 退房时间 | FALSE | TRUE | |
FitNum | 房间适住人数 | FALSE | TRUE | |
Area | 房间面积 | FALSE | TRUE | |
BedName | 床型 | FALSE | TRUE | |
breakfast | 早餐 | FALSE | TRUE | |
smoke | 是否禁烟 | FALSE | TRUE | |
Floor | 楼层 | FALSE | TRUE | |
View | 景色 | FALSE | TRUE | |
Window | 是否有窗 | FALSE | TRUE | |
Facility | 酒店设施 | TRUE | TRUE | |
limit_hair_length | 是否限制长短发 | FALSE | TRUE | |
limit_gender | 是否限制性别 | FALSE | TRUE | |
original_vip_can_experience | 商家原会员是否可以体验 | FALSE | TRUE | |
SuitableGroup | 适用人群 | TRUE | TRUE | |
holiday_additional_charge | 节假日是否额外收费 | FALSE | TRUE | |
contains_insurance | 是否包含保险 | FALSE | TRUE | |
NearestOrderTime | 最早可订时间 | FALSE | TRUE | |
IsNeedPick | 是否需要取票 | FALSE | TRUE | |
TicketType | 票种类型 | TRUE | FALSE | |
IsConfirmImme | 是否立即确认 | FALSE | FALSE | |
appointment | 预约信息 | FALSE | TRUE | |
RefundPolicy | 退款政策 | FALSE | TRUE | |
refund_need_merchant_confirm | 退款是否需商家审核 | FALSE | TRUE | |
auto_renew | 是否开启自动延期 | FALSE | TRUE | |
show_channel | 投放渠道 | FALSE | TRUE | |
image_list | 封面图 | TRUE | TRUE | |
environment_image_list | 环境图 | TRUE | FALSE | |
detail_image_list | 长图 | TRUE | FALSE | |
customer_reserved_info | 留资规则 | FALSE | FALSE | |
real_name_info | 实名信息 | FALSE | FALSE | |
use_type | 团购使用方式 | FALSE | TRUE | |
code_source_type | 券码生成方式 | FALSE | TRUE | |
settle_type | 收款方式 | FALSE | TRUE | |
limit_rule | 限制购买 | FALSE | TRUE | |
MpResourceID | 小程序资源id | FALSE | FALSE | |
market_price | 市场价 | FALSE | FALSE | |
TagList | 标签列表 | FALSE | FALSE | |
Description | 商品描述 | TRUE | TRUE | |
trade_url | 小程序提单页跳转 | FALSE | FALSE | |
MpSettleType | 小程序分账类型 | FALSE | FALSE | |
limit_use_rule | 限制使用 | FALSE | TRUE |
attr_key_value_map 的格式
ID | 枚举值 | 含义 | 说明 | 结构定义(thrift格式) | |
---|---|---|---|---|---|
2 | INT64 | 整数 | i64 | ||
3 | BOOL | 布尔值 | bool | ||
4 | STRING | 字符串 | string | ||
6 | DOUBLE | 浮点数 | double | ||
100 | IMAGE | 图片控件(ImageStruct) | url、名称 | struct ImageStruct { 1: optional string name 3: optional string url } | |
101 | USE_TIME | 使用时间控件(UseTimeStruct) | 全天/仅指定时间可用;时间段(比如12:-14:) | enum UseTimeTypeEnum { ALL_DAY = 1 // 全天可用 SPECIFIC_TIME = 2 // 仅指定时间可用 } struct TimePeriodStruct { 2: required string use_start_time // 开始时间 00:00:00 3: required string use_end_time // 结束时间 00:00:00 4: optional bool end_time_is_next_day // 是否跨天 } struct UseTimeStruct { 1: required UseTimeTypeEnum use_time_type // 1全天可用,2仅指定时间可用 2: optional list < TimePeriodStruct > time_period_list // 时间段 } | |
103 | USE_DATE | 可使用日期(UseDateStruct) | 指定日期/指定天数;购买后多少天有效;可用开始时间;可用结束时间; | enum UseDateTypeEnum { SPECIFIC_DATE = 1 // 指定日期 RELATIVE_DATE = 2 // 指定天数 } struct UseDateStruct { 1: required UseDateTypeEnum use_date_type // 1指定日期 2指定天数; 2: optional i32 day_duration // 购买后X天有效,use_date_type=2时有效 3: optional string use_start_date // yyyy-MM-dd 开始日期,use_date_type=1时有效 4: optional string use_end_date // yyyy-MM-dd 结束日期,use_date_type=1时有效 } | |
104 | CAN_NO_USE_DATE | 不可使用日期(CanNoUseDateStruct) | 开关;指定周几不可用;指定节假日不可用;指定日期不可用;节假日具体日期 入参示例:"{"days_of_week":[1],"holidays":[1],"enable":true}" | enum HolidayEnum { NEW_YEAR = 1 // 元旦 SPRING_FESTIVAL = 2 // 春节 TOMB_SWEEPING_DAY = 3 // 清明 MAY_DAY = 4 // 劳动节 DRAGON_BOAT_FESTIVAL = 5 // 端午节 MID_AUTUMN_FESTIVAL = 6 // 中秋节 NATIONAL_DAY = 7 // 国庆节 VALENTINE_DAY = 8 // 情人节 CHRISTMAS = 9 // 圣诞节 } enum DayOfWeekEnum { MONDAY = 1 TUESDAY = 2 WEDNESDAY = 3 THURSDAY = 4 FRIDAY = 5 SATURDAY = 6 SUNDAY = 7 } struct CanNoUseDateStruct { 1: required bool enable // 开关,启用需要为true 2: optional list < DayOfWeekEnum > days_of_week // 指定周几不可用 3: optional list < HolidayEnum > holidays // 指定节假日不可用 4: optional list < string > date_list // yy-MM-dd 指定日期,不可用 5: optional map < HolidayEnum, string > holiday_dates // 节假日不可用具体日期,例如:"holiday_dates":{"1":"2021.01.01-2021.01.03","7":"2021.10.01-2021.10.07"} } | |
105 | APPOINTMENT | 预约控件(AppointmentStruct) | 是否需要预约;提前X天;提前X小时;第三方预约入口;第三方已预约订单查看入口;需预约日期类型(1-指定周期、2-指定日期);需周几;需预约日期 入参示例:"{"need_appointment":true,"ahead_time_type":1,"ahead_day_num":2}" | enum AheadTimeTypeEnum { DAY = 1 HOUR = 2 MINUTE = 3 } struct AppointmentStruct { 1: optional bool need_appointment // 是否需要预约 2: optional i32 ahead_day_num // 需要提前X天电话预约 3: optional string external_link // 第三方提供预约入口,需要过机审。 4: optional string order_appointment_time_url // 第三方提供的查看已预约订单入口,需要过机审 5: optional AheadTimeTypeEnum ahead_time_type // 提前预约时间类型, need_appointment = true时该字段必填 6: optional i32 ahead_hour_num // 需要提前X小时电话预约 7: optional i32 ahead_minute_num // 需要提前X分钟电话预约 } | |
106 | NOTE | 富文本控件(NoteStruct) | 类型(文本/图片);内容 | enum OtherNoteTypeEnum { TEXT = 1 // 文本 IMG = 2 // 图片 } struct NoteStruct { 1: optional OtherNoteTypeEnum note_type 2: optional string content } | |
107 | LIMIT_USE_RULE | 限制使用规则控件(LimitUseRuleStruct) | 是否限制、每人单次消费最多使用代金劵张数 | struct LimitUseRuleStruct { 1: required bool is_limit_use // 是否限用 2: optional i32 use_num_per_consume // 每人单次消费最多使用代金劵张数 } | |
108 | CUSTOMER_RESERVED_INFO | 用户留资规则控件(CustomerReservedInfoStruct) | 是否留资;可以留电话;可以留姓名;可以留身份证;手机号是否必传;是否每张券都要留资;留资原因 | struct CustomerReservedInfoStruct { 1: required bool allow //是否留资 2: optional bool allow_tel //可以留电话 3: optional bool allow_name // 可以留姓名 4: optional bool allow_identity // 可以留身份证 5: optional bool require_for_tel //手机号是否必传 【默认非必传】 10: optional bool need_for_all // 是否每张券都需要留资 } | |
109 | REAL_NAME_INFO | 实名信息控件(RealNameInfoStruct) | 是否实名;场景 | enum RealNameInfoSceneEnum { NAME_AND_TEL = 3 // 出行人姓名与手机号码 ONLY_ONE_INFO = 2 // 仅填写一位游客信息 EVERY_ONE_INFO = 1 // 每张门票都要填写用户信息 } struct RealNameInfoStruct { 1: required bool enable 2: required RealNameInfoSceneEnum scene // 场景(1/2/3) } | |
111 | HIGHLIGHT | 商品亮点标签控件(HighlightStruct) | Content、Priority | struct HighlightStruct{ 1: required string Content 2: required i64 Priority } | |
112 | FACILITY | 酒店设施控件(FacilityStruct) | value、name、icon | struct FacilityStruct { 1: required string value, // 设施ID 1 - 空调; 2 - 电视; 3 - 阳台; 4 - 窗户; 5 - 独立卫浴; 6 - 浴缸; 7 - 吹风机; 8 - 衣架; 9 - 热水; 10 - 洗衣机; 11 - 基本厨具; 12 - 冰箱; 13 - 免费Wifi; 14 - 电热水壶; 15 - 暖气; 16 - 智能马桶; 17 - 微波炉; 18 - 门禁系统; 19 - 智能门锁; 20 - 私家花园; 21 - 私家泳池; 22 - 观景露台; 23 - 免费停车; 24 - 行李寄存 2: optional string name, // 设施名称,code != -1 时展示name,其他情况下展示code对应的名称。长度不超过6字符 } | |
114 | NOTIFICATION | 使用规则控件(NotificationStruct) | 标题;内容 | struct NotificationStruct { 1: required string title, 2: required string content, } | |
116 | ADD_BED_RULE | 加床规则控件(AddBedRuleStruct) | 是否支持加床;加床规则(文本) | struct AddBedRuleStruct { 1: required bool can_add_bed (go.tag = 'json:"can_add_bed"'), //是否支持加床 2: optional string add_bed_rule (go.tag = 'json:"add_bed_rule"'), //加床规则,文本,最多200个 } | |
117 | DATE_RULE | 使用日期规则控件(DateRuleStruct) | 指定周几不可用;指定日期不可用;是否节日不可用 | struct UnavailableDateStruct{ 1: optional list < string > date_list // yyyy-MM-dd 指定日期,不可用 2: optional list < i64 > weekday_list // 1-7对应周一至周日 3: optional bool not_available_on_holidays // 节假日不可用 } struct DateRuleStruct{ 1: optional UnavailableDateStruct unavailable_date } | |
118 | BREAKFAST | 加早规则控件(BreakfastRule) | 是否支持加早;加早规则自定义文本 | struct BreakfastRule { 1: required bool can_add_breakfast (go.tag = 'json:"can_add_breakfast"'), //是否支持加早 2: optional string add_breakfast_rule (go.tag = 'json:"add_breakfast_rule"'), //加早规则,文本,最多200个 } | |
121 | COMMODITY | 商品搭配控件(ItemGroupStruct) | 商品组名 总数 选几 菜品 - 菜名 - 单价 - 总数 - 单位 |
struct ItemStruct { 1: required string name // 菜名 2: required i64 price // 价格 3: required i32 count // 总数 4: optional string unit // 单位 (美食团购必填) } struct ItemGroupStruct { 1: required string group_name // 商品组名 2: optional i32 total_count // 总数 3: required i32 option_count // 选几 4: required list < ItemStruct > item_list // 菜品 } | |||||
---|---|---|---|---|---|
122 | LIMIT_RULE | 限制购买规则控件(LimitRuleStruct) | 是否限购;每人最多购买X张 | struct LimitRuleStruct { 1: required bool is_limit // 是否限购 2: optional i32 total_buy_num // 每人最多购买X张 } | |
126 | CUSTOM_POLICY | 自定义规则控件(CustomPolicyStruct) | 自定义规则控件 | struct CustomPolicyStruct { 1: required i64 policy_rule_type // 规则类型 2: optional string policy_value // 规则值 3: optional NoteStruct note //规则描述 } | |
127 | CHARGE_POLICY | 费用控件(ChargePolicyStruct) | 加早、加床费用,支持添加费用类型,填写名称、单位和价格,价格支持选择免费 | struct ChargePolicyItem { 1: required string item // 费用项名称 3: required i64 qty //数量 4: required string unit //单位 5: required i64 amount // 金额(分) } |
key | name | 内容格式 | 备注 | |
---|---|---|---|---|
NearestOrderTime | 最早可预定时间 | 新接口直接传文本字符串,必须为以下所示的五种类型之一 类型1: value="最早可订今日"类型2: value="最早可订明日"类型3: value="最早可订6月13日"类型4: value="19:59前可订当日"类型5: value="需提前1天预订" | 以下为老接口数据格式,新接入无需关心,供老服务商接入时对比参考struct { 1: optional string time 2: required i64 time_type}Enum time_type { 1 // 转义:最早可订今日 无需传time 2 // 最早可订明日 无需传time 3 // 最早可订5月7日 time格式:"20220517" 4 // xx:xx前可订当日 time格式:"19:59" 5 // 需提前x天预订 time格式:"1"} |
关键属性介绍
属性key | 属性名 | 枚举值说明 | is_multi | 属性类型 | |
---|---|---|---|---|---|
appointment | 预约信息 | 消费提示:做展示使用 | false | APPOINTMENT | |
auto_renew | 是否开启自动延期 | false | BOOL | ||
bring_out_meal | 是否可以外带餐食 | 消费提示:做展示使用 | false | BOOL | |
can_no_use_date | 不可使用日期 | 消费提示里注明的不可使用日期,可以天、星期和节日 | false | CAN_NO_USE_DATE | |
cooperation_mode | 合作模式 | "DIRECT = 1 // 直连; INDIRECT = 2 // 间连 ", | false | INT64 | |
customer_reserved_info | 留资规则 | false | CUSTOMER_RESERVED_INFO | ||
description_rich_text | 其他说明信息 | true | NOTE | ||
detail_image_list | 长图 | 图片比例无限制 | true | IMAGE | |
dishes_image_list | 菜品图 | 图片比例:375:280 | true | IMAGE | |
EntryType | 入口类型 | "1:H5 2:小程序 3:抖音 4:lynx", | false | INT64 | |
environment_image_list | z | 图片比例:375:280 | true | IMAGE | |
free_pack | 是否可以打包 | 消费提示:做展示使用 | false | BOOL | |
FrontCategoryTag | true | STRING | |||
image_list | 封面图 | 图片比例:375:280 | true | IMAGE | |
IndustryType | 商品行业类型 | false | STRING | ||
IsConfirmImme | 是否立即确认 | false | BOOL | ||
MpResourceID | 小程序资源id | false | STRING | ||
MpSettleType | 小程序分账类型 | "1-包销 2-代销",三方分账使用 | false | INT64 | |
Notification | 使用规则 | true | NOTIFICATION | ||
private_room | 是否可以使用包间 | 消费提示:做展示使用 | false | BOOL | |
real_name_info | 实名信息 | false | REAL_NAME_INFO | ||
RecommendWord | 推荐语 | false | STRING | ||
rec_person_num | 建议使用人数 | false | INT64 | ||
rec_person_num_max | 最多使用人数 | false | INT64 | ||
RefundPolicy | 退款政策 | "1-允许退款 2-不可退款 3-有条件退", | false | INT64 | |
refund_need_merchant_confirm | 退款是否需商家审核 | false | BOOL | ||
show_channel | "1-不限制 2-仅直播间可见", | false | INT64 | ||
SortWeight | 排序权重 | false | INT64 | ||
superimposed_discounts | 可以享受店内其他优惠 | 消费提示:做展示使用 | false | BOOL | |
TagList | 标签列表 | false | STRING | ||
trade_url | 小程序提单页跳转 | 提单页URL,直播间下单会使用 | false | STRING | |
use_date | 使用日期 | 券码的可以核销日期,履约核销强依赖 | false | USE_DATE | |
use_time | 使用时间 | 用户可以消费的时间 | false | USE_TIME | |
code_source_type | 券码生成方式 | "1-抖音码 2-三方码 3-预导码", 抖音码 :即交易后,抖音发券码,通过抖音侧进行核销,然后同步到开发者。当前仅针对白名单开发者开放。 三方码 :即交易后,开发者发券码,在开发者侧进行核销,然后核销以及订单状态,同步到抖音。 预导码:可忽略 | false | INT64 | |
commodity | 菜品搭配 | true | COMMODITY | ||
limit_rule | 限制购买 | 最多购买份数 | false | LIMIT_RULE | |
market_price | 即菜品搭配里的总价 | false | INT64 | ||
settle_type | 收款方式 | "1-总店结算 2-分店结算", 总店结算:即商品的结算资金统一结算到商家(不是开发者)的收款账户。 分店结算:按核销POI将资金结算到对应的POI的收款账户,如果POI没有设置收款账户,会将对应的POI的结算资金打款到总店账户; | false | INT64 | |
use_type | 团购使用方式 | "1-到店核销",默认值 | false | INT64 | |
SubTitle | 副标题 | 过期退;随时退;x日内可退;免预约;提前x日预约;多个副标题以|(英文半角)分隔,不要有空格 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://dev-cn.your-api-server.com/life/goods/template/get/?access_token=clt.xxxxx&product_type=1&category_id=1001001'
响应示例响应示例
{
"data": {
"product_attrs": [
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "appointment",
"name": "预约信息",
"value_demo": "",
"value_type": "APPOINTMENT"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "auto_renew",
"name": "是否开启自动延期",
"value_demo": "",
"value_type": "BOOL"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "bring_out_meal",
"name": "是否可以外带餐食",
"value_demo": "",
"value_type": "BOOL"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "can_no_use_date",
"name": "不可使用日期",
"value_demo": "",
"value_type": "CAN_NO_USE_DATE"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "customer_reserved_info",
"name": "留资规则",
"value_demo": "",
"value_type": "CUSTOMER_RESERVED_INFO"
},
{
"desc": "",
"is_multi": true,
"is_required": false,
"key": "description_rich_text",
"name": "其他说明信息",
"value_demo": "",
"value_type": "NOTE"
},
{
"desc": "",
"is_multi": true,
"is_required": false,
"key": "detail_image_list",
"name": "长图",
"value_demo": "",
"value_type": "IMAGE"
},
{
"desc": "",
"is_multi": true,
"is_required": false,
"key": "dishes_image_list",
"name": "菜品图",
"value_demo": "",
"value_type": "IMAGE"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "EntryType",
"name": "入口类型",
"value_demo": "1:H5 2:小程序 3:抖音 4:lynx",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": true,
"is_required": false,
"key": "environment_image_list",
"name": "环境图",
"value_demo": "",
"value_type": "IMAGE"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "free_pack",
"name": "是否可以打包",
"value_demo": "",
"value_type": "BOOL"
},
{
"desc": "",
"is_multi": true,
"is_required": false,
"key": "FrontCategoryTag",
"name": "前台品类标签",
"value_demo": "",
"value_type": "STRING"
},
{
"desc": "",
"is_multi": true,
"is_required": true,
"key": "image_list",
"name": "封面图",
"value_demo": "",
"value_type": "IMAGE"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "IndustryType",
"name": "商品行业类型",
"value_demo": "",
"value_type": "STRING"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "IsConfirmImme",
"name": "是否立即确认",
"value_demo": "",
"value_type": "BOOL"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "MpResourceID",
"name": "小程序资源id",
"value_demo": "",
"value_type": "STRING"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "MpSettleType",
"name": "小程序分账类型",
"value_demo": "1-包销 2-代销",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": true,
"is_required": true,
"key": "Notification",
"name": "使用规则",
"value_demo": "",
"value_type": "NOTIFICATION"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "private_room",
"name": "是否可以使用包间",
"value_demo": "",
"value_type": "BOOL"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "real_name_info",
"name": "实名信息",
"value_demo": "",
"value_type": "REAL_NAME_INFO"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "RecommendWord",
"name": "推荐语",
"value_demo": "",
"value_type": "STRING"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "rec_person_num",
"name": "建议使用人数",
"value_demo": "",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "rec_person_num_max",
"name": "最多使用人数",
"value_demo": "",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "RefundPolicy",
"name": "退款政策",
"value_demo": "1-允许退款 2-不可退款 3-有条件退",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "refund_need_merchant_confirm",
"name": "退款是否需商家审核",
"value_demo": "",
"value_type": "BOOL"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "show_channel",
"name": "投放渠道",
"value_demo": "1-不限制 2-仅直播间可见",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "SortWeight",
"name": "排序权重",
"value_demo": "",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "superimposed_discounts",
"name": "可以享受店内其他优惠",
"value_demo": "",
"value_type": "BOOL"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "TagList",
"name": "标签列表",
"value_demo": "",
"value_type": "STRING"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "trade_url",
"name": "小程序提单页跳转",
"value_demo": "",
"value_type": "STRING"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "use_date",
"name": "使用日期",
"value_demo": "",
"value_type": "USE_DATE"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "use_time",
"name": "使用时间",
"value_demo": "",
"value_type": "USE_TIME"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "SubTitle",
"name": "副标题",
"value_demo": "可选标题:过期退;随时退;x日内可退;免预约;提前x日预约;多个副标题以|(英文半角)分隔,不要有空格",
"value_type": "STRING"
}
],
"sku_attrs": [
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "code_source_type",
"name": "券码生成方式",
"value_demo": "1-抖音码 2-三方码 3-预导码",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": true,
"is_required": true,
"key": "commodity",
"name": "菜品搭配",
"value_demo": "",
"value_type": "COMMODITY"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "limit_rule",
"name": "限制购买",
"value_demo": "",
"value_type": "LIMIT_RULE"
},
{
"desc": "",
"is_multi": false,
"is_required": false,
"key": "market_price",
"name": "市场价",
"value_demo": "",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "settle_type",
"name": "收款方式",
"value_demo": "1-总店结算 2-分店结算",
"value_type": "INT64"
},
{
"desc": "",
"is_multi": false,
"is_required": true,
"key": "use_type",
"name": "团购使用方式",
"value_demo": "1-到店核销",
"value_type": "INT64"
}
]
},
"base": {
"log_id": "202205121547310102120681610A00B9B0",
"gateway_code": 0,
"gateway_msg": "",
"biz_code": 0,
"biz_msg": ""
}
}
请求参数
Query 参数
access_token
string
必需
示例值:
clt.xxxxx
product_type
string
必需
示例值:
1
category_id
string
必需
示例值:
1001001
返回响应
修改于 2023-11-29 09:44:04