商品发布和查询能力
业务介绍
说明:请商家侧先和销售经理沟通,由销售经理提出申请并且经过我们确认后,再进行此项对接。
小程序和生活服务商家应用共用商品相关接口,有些小程序单独的逻辑,会在文档中进行描述
接入前准备
根据以下文档完成开发者账号开通认证、生活服务应用的创建、申请解决方案和接口权限。
技术服务商(ISV):技术服务商接入指南
自研商家:自研商家接入指南
小程序商家/服务商:小程序文档指引
商品发布
团购发布能力帮助商家创建/修改/上架/下架团购,由于该能力对商家端和用户端影响比较大,平台仅针对自研商家和代运营服务商开放。
需要申请的能力
技术服务商&自研商家申请:商品发布
代运营服务商:无需申请权限
业务流程
对接接口
接口文档 | 能力(权限) | 接口描述 | 调用方 |
商品查询 | 查询商品模板,创建商品时的属性列表需与该接口保持一致,否则无法识别。根据商品类目及商品类型获取商品模版信息。 | 商家/服务商 | |
商品查询 | 商家/服务商 | ||
商品发布 | 用于创建和修改商品。 | 商家/服务商 | |
商品发布 | | 商家/服务商 | |
商品发布 | 商家/服务商 | ||
商品发布 | 商家/服务商 | ||
商品发布 | 用于餐饮团购商品审核流程结束以后向商家通知审核结果 生活服务应用:生活服务消息推送 小程序应用:小程序配置商品审核回调地址 | 抖音 |
商品查询
业务场景
用于商家或者服务商将两方团购映射绑定管理,这样券核销时,商家侧才知道这张券对应商家后台要出哪个套餐,以及可以知道商品在抖音侧的配置规则如适用门店、价格、库存等。
需要申请的能力
技术服务商&自研商家申请:商品查询
代运营服务商:无需申请权限
业务流程
- 1.商品信息查询:通过接口查询对应商品信息,与商家侧商品模板做校验,目前仅支持查询到通过团购发布创建的商品。
- 2.商品映射:
方式一:在抖音本地商家端新建团购后,由 BD 进行双方团购 ID 映射绑定。在创建团购的页面填写“商家平台团购 ID”,券核销时会回传商家平台团购 ID。
方式二:调用查询接口,一次查询到商家抖音后台团购,并在服务商/商家侧做手动映射维护。
对接接口
接口 | 接口描述 | 调用方 |
查询商品模板,创建商品时的属性列表需与该接口保持一致,否则无法识别。根据商品类目及商品类型获取商品模版信息。 | 商家/服务商 | |
用于查询商品草稿数据。 | 商家/服务商 | |
用于查询商品草稿数据列表。 | 商家/服务商 | |
用于查询商品线上数据。 | 商家/服务商 | |
查询本client_key(或绑定的账号)对应的商品线上列表 | 商家/服务商 |
枚举字典
product_type
1 : 团购套餐
3 : 预售券
4 : 日历房
5 : 门票
7 : 旅行跟拍
8 : 一日游
11 : 代金券
12: 新预售券
14: 外卖
15: 次卡
22: 预约
商品二级类型product_sub_type
一级类型 | 二级类型 |
12 | 1201(旅行社预售) |
字段约定
- •接口中所有涉及到的金额,单位均为分
- •接口中所有涉及到的时间戳,均指秒级时间戳
属性结构详解
枚举值 | 含义 | 说明 | 结构定义(thrift格式) |
INT64 | 整数 | | i64 |
BOOL | 布尔值 | | bool |
STRING | 字符串 | | string |
DOUBLE | 浮点数 | | double |
COMMON_ENUM | 通用枚举控件(CommonEnumStruct) | 对应属性字段: application_gender service_effect | // 通用枚举控件 value必须非空字符串 // key等于0时为用户自定义,value也必须非空字符串 struct CommonEnumStruct{ 1: required i64 key 2: required string value } |
IMAGE | 图片控件(ImageStruct) | url、名称 | struct ImageStruct { 1: optional string name 3: optional string url } |
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 // 时间段 } |
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时有效 } |
CAN_NO_USE_DATE | 不可使用日期(CanNoUseDateStruct) | 开关;指定周几不可用;指定节假日不可用;指定日期不可用;节假日具体日期 | enum HolidayEnum { UNSET = 0 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 // 圣诞节 LANTERN_FESTIVAL = 10 // 元宵节 NETWORK_VALENTINE_DAY = 11 // 520 INTERNATIONAL_CHILDREN_DAY = 12 // 儿童节 CHINESE_VALENTINE_DAY = 13 // 七夕节 FEBRUARY_SECOND = 14 // 二月二 MOTHER_DAY = 15 // 母亲节 FATHER_DAY = 16 // 父亲节 TEACHER_DAY = 17 // 教师节 } 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"} } |
APPOINTMENT | 预约控件(AppointmentStruct) | 是否需要预约;提前X天;提前X小时;第三方预约入口;第三方已预约订单查看入口;需预约日期类型(1-指定周期、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分钟电话预约 } |
NOTE | 富文本控件(NoteStruct) | 类型(文本/图片);内容 | enum OtherNoteTypeEnum { TEXT = 1 // 文本 IMG = 2 // 图片 } struct NoteStruct { 1: optional OtherNoteTypeEnum note_type 2: optional string content } |
LIMIT_USE_RULE | 限制使用规则控件(LimitUseRuleStruct) | 是否限制、每人单次消费最多使用代金劵张数(小程序商品不生效) | struct LimitUseRuleStruct { 1: required bool is_limit_use // 是否限用 2: optional i32 use_num_per_consume // 每人单次消费最多使用代金劵张数 } |
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 // 是否每张券都需要留资 } |
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) } |
HIGHLIGHT | 商品亮点标签控件(HighlightStruct) | Content、Priority | struct HighlightStruct{ 1: required string Content 2: required i64 Priority } |
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字符 } |
NOTIFICATION | 使用规则控件(NotificationStruct) | 标题;内容 | struct NotificationStruct { 1: required string title, 2: required string content, } |
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个 } |
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 } |
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个 } |
COMMODITY | 商品搭配控件(ItemGroupStruct) | 商品组名 总数 选几 菜品 - 菜名 - 单价 - 总数 - 单位 | struct ItemGroupStruct { 1: required string group_name // 商品组名 2: optional i32 total_count // 总数 3: required i32 option_count // 选几 4: required list<ItemStruct> item_list // 菜品 } struct ItemStruct { 1: required string name // 菜名 2: required i64 price // 价格(次卡商品不要传) 3: required i32 count // 总数 4: optional string unit // 单位 5: required list<ItemAttrStruct>attr_list// } struct ItemAttrStruct { 1: required AssemblyTypeEnum assembly_type // 属性组件类型 2: required string attr_key // 属性key 3: required string attr_key_name // 属性key中文名 4: required string attr_value // 属性值 5: required bool is_multi // 是否是列表 } |
LIMIT_RULE | 限制购买规则控件(LimitRuleStruct) | 是否限购;每人最多购买X张(小程序商品不生效) | struct LimitRuleStruct { 1: required bool is_limit // 是否限购 2: optional i32 total_buy_num // 每人最多购买X张 } |
CUSTOM_POLICY | 自定义规则控件(CustomPolicyStruct) | 自定义规则控件 | struct CustomPolicyStruct { 1: required i64 policy_rule_type // 规则类型 2: optional string policy_value // 规则值 3: optional NoteStruct note //规则描述 } |
CHARGE_POLICY | 费用控件(ChargePolicyStruct) | 加早、加床费用,支持添加费用类型,填写名称、单位和价格,价格支持选择免费 | struct ChargePolicyItem { 1: required string item // 费用项名称 3: required i64 qty //数量 4: required string unit //单位 5: required i64 amount // 金额(分) } |
SERVICE_ITEM_IMAGE | 菜品图(ServiceItemImageStruct) | 菜品图 | type ServiceItemImageStruct struct { 1: optional string name //菜品名称 2: required string uri 3: optional string url 4: optional string item_id //不用传 } |
LIMIT_BUY_RULE | 限购规则(LimitBuyRuleStruct) | 限购规则 | enum SubjectTypeEnum { UID = 1, // UID CONTACT_TEL = 2, // 联系人手机号 IDCARD = 3, // 身份证 DEVICEID = 4, // 设备ID CONSUMER_TEL = 5, // 消费者手机号(游玩类) } enum RangeTypeEnum { USE_DATE = 1, // 使用日期 ORDER_DATE = 2, // 下单日期 LIFE_LONG = 3, // 终身 ORDER = 4, // 订单 } struct LimitRuleItem { 1: required SubjectTypeEnum subject_type // 限购主体 2: required RangeTypeEnum range_type // 限购范围 3: required i32 limit_num // 限购数量 4: required string unit // 限购单位 } struct LimitBuyRuleStruct { 1: required bool enable_limit, // 是否启用限制购买 2: optional list<LimitRuleItem> rule_list // 限购规则 } 限购规则,你不会在抖音来客上面映射,来客后台展示不生效 但是不影响c端展示,c端正常展示 |
APPLICATION_SCOPE | ApplicationScopeStruct | 适用范围 | enum ApplicationScopeTypeEnum { ALL = 1, // 全场适用 ONLY_SPECIAL = 2, // 仅特殊消费适用 EXCLUDE_SPECIAL = 3, // 排除特殊消费 } struct ApplicationScopeStruct { 1: required ApplicationScopeTypeEnum application_scope_type, // 适用范围类型 2: optional string special_consumption_desc, // 特殊消费描述 } |
ORDER_SETTLE_RULE | 结算规则(OrderSettleRuleStruct) | 结算规则 | enum OrderSettleTypeEnum { BY_ORDER = 1, // 整单结算 BY_TIMES = 2, // 按使用次数结算 } type OrderSettleRuleStruct struct { 1: required OrderSettleTypeEnum order_settle_type // 结算类型 } |
DOUYIN_MOVIE_LIMIT | 电影适用影片字段 | 电影适用影片 | type DouyinMovieLimitStruct struct { LimitType CommonLimitTypeEnum MovieList []*DouyinMovieInfoStruct } const ( CommonLimitTypeEnum_Unlimited CommonLimitTypeEnum = 1 //不限制影片 CommonLimitTypeEnum_LimitedAvailable CommonLimitTypeEnum = 2 //限制影片可用 CommonLimitTypeEnum_LimitedNotAvailable CommonLimitTypeEnum = 3 //限制影片不可用 ) type DouyinMovieInfoStruct struct { MovieName string //电影名称 ChineseMovieCode *string //专资码 } |
QUALIFICATION_INFO | 商品资质信息类型(qualification_identity) | 商品资质信息 | type QualificationIdentityEnum int64 const ( // 营业性演出准予许可证 QualificationIdentityEnum_Organizer QualificationIdentityEnum = 1 // 演出主办方授权书 QualificationIdentityEnum_TicketAagent QualificationIdentityEnum = 2 ) 配合资质ID使用: "key": "host_approval_qual","name": "主办批文资质" "key": "ticket_agent_qual","name": "票务代理资质" 对应资质中心查询的资质的枚举: 主办方资质要传“营业性演出准予许可决定” 5006 票务代理资质要传 “营业性演出准予许可决定” 5006 和 “演出主办方授权书” 5005 |
| 电影适用影厅 | 电影适用影厅 | // 通用枚举控件 value必须非空字符串 // key等于0时为用户自定义,value也必须非空字符串 struct CommonEnumStruct{ 1: required i64 key 2: required string value } 1:适用全部 2:限定可用 3:限定不可用 |
| 适用影厅信息 | 适用影厅信息 | // 通用枚举控件 value必须非空字符串 // key等于0时为用户自定义,value也必须非空字符串 struct CommonEnumStruct{ 1: required i64 key 2: required string value } 0 自定义 1 普通厅 2 杜比厅 3 IMAX厅 4 3D影厅 5 4D影厅 6 Luxe巨幕厅 7 RealID影厅 8 激光厅 9 VIP影厅 10 情侣厅 11 4K厅 12 60帧厅 |
ATTACH_ITEM_DETAIL | 附赠项目 | 附赠项目 | // 附赠项目 struct AttachItemDetailStruct { 1: optional list<AttachItem> attach_item_list // 附赠项目明细列表 } struct AttachItem { 1: string item_name // 项目名称 2: i32 item_count // 项目份数 3: i32 item_total_price // 总价值 } |
FREEBIE_INFO | 赠品信息 | 支持美食类团购配置 | // 赠品信息 struct FreebieInfoStruct { 1: required bool has_freebie // 是否有增品 2: optional string freebie_name // 赠品名称 3: optional bool has_stock // 增品是否有库存 4: optional i32 total_stock_num // 赠品库存总量 5: optional string valid_date_desc // 赠品有效期说明 6: optional string exchange_rule_desc // 增品兑换规则说明 } |
REAL_NAME_BUY_TICKET_RULE | 实名购票规则 | 用于演出描述实名购票规则 | // 使用人填写范围 enum UserFillScopeReservedInfoEnum{ NO_NEED = 1 // 不需要填写 ONE_ORDER_ONE_USER = 2 // 一单一证 ALL_USER = 3 // 一票一证 } struct RealNameBuyTicketRuleStruct { 1: required bool is_real_name // 是否实名 2: optional UserFillScopeReservedInfoEnum real_name_method // 实名方式 3: optional bool limit_buy_id_card // 是否按身份证限购 4: optional i64 limit_num // 身份证限购数量 } |
TICKETS_RULE | 票务规则 | 电子票不需要传取票方式 和取票信息 | // 凭证方式枚举 enum VoucherMethodEnum{ IdCard = 1 // 身份证号码 Paper = 4 // 纸质票 ETicket = 5 // 电子票 } //取票方式 enum TicketCollectionEnum{ FreeShipping = 1 // 邮寄-商家包邮 UserPayment = 2 // 邮寄-用户支付 FixedPoint = 3 // 定点取票 PayOnDelivery = 4 // 邮寄-邮费到付 } //邮费收取方式 enum PostageCollectionEnum{ FixedPostage = 1 // 固定邮费 } enum LatestDeliveryTimeEnum{ Unset = 1 // 不确定 SpecificDate = 2 // 指定日期 RelativeDate = 3 //指定天数 } // 通用时长控件 struct CommonTimeStruct{ 1: required i32 time // 时长 2: required CommonTimeTypeEnum time_type // 时间单位 } struct TicketCollectionInfo{ 1: optional PostageCollectionEnum postage_collection //邮费收取方式 2: optional i64 postage_amount // 邮费 单位分 3: optional LatestDeliveryTimeEnum lastest_delivery_time //最晚配送时间类型 4: optional CommonTimeStruct delivery_time_duration // 购买日多少天、小时发货 lastest_delivery_time=3时生效 5: optional string delivery_date // yyyy-MM-dd lastest_delivery_time=2时生效 6: optional string ticket_collection_address // 取票地址 7: optional CommonTimeStruct ticket_collection_time //取票时间(演出开始前x小时、天取票 time=-1为随时可取) 8: optional TicketCollectionVoucherEnum ticket_collection_voucher //取票凭证 } //取票凭证(TicketCollectionVoucherEnum) enum TicketCollectionVoucherEnum{ IDCard = 1 // 身份证 Tel = 2 // 手机号 Other = 3 // 其他 } // 票务规则(TicketsRuleStruct) struct TicketsRuleStruct{ 1: required list<VoucherMethodEnum> voucher_method // 凭证方式 5: optional TicketCollectionEnum ticket_collection //取票方式 6: optional TicketCollectionInfo ticket_collection_info // 取票信息 } |
COMMON_TIME | 通用时长控件 | | enum CommonTimeTypeEnum{ Minute = 1, // 分钟 Hour = 2, // 小时 Day = 3, // 天 Month = 4, // 月 } // 通用时长控件 struct CommonTimeStruct{ 1: required i32 time // 时长 2: required CommonTimeTypeEnum time_type // 时间单位 } |
COMMON_QUANTITY | 通用数量(带单位)控件 | {"num":1, "unit":"FEN"} | // 通用数量(带单位)控件(CommonQuantityStruct) struct CommonQuantityStruct { 1: required string num // 数值 2: required string unit // 单位 }(assembly_type = '9') |
BREAK_RULES_DEPOSIT | 违章押金(break_rules_deposit) | {"num":1,"unit":"元"} | // 通用数量(带单位)控件(CommonQuantityStruct) struct CommonQuantityStruct { 1: required string num // 数值 2: required string unit // 单位 }(assembly_type = '9') 单位固定"元" |
APPLICABLE_MODELS | 适用车型(applicable_models) | {"key":6,"value":"皮卡"} | / 通用枚举控件 value必须非空字符串 // key等于0时为用户自定义,value也必须非空字符串 struct CommonEnumStruct{ 1: required i64 key 2: required string value } 1:全车型 2:轿车 3:SUV/MPV 4:7座SUV 5:5座SUV 6:皮卡 7:仅MPV 8:仅SUV 9:仅油车 10:仅电车 |
MEMBER_EXCLUSIVE_PRODUCT | 会员专享品信息(member_exclusive_product_info) | 是否设置为会员专享 | struct MemberExclusiveProductStruct { 1: required MemberExclusiveProductTypeEnum product_type } enum MemberExclusiveProductTypeEnum { MemberExclusiveProduct = 1 // 商家会员专享品 NormalProduct = 2 // 商家普通商品 Undefined = 3 // 未定义 } |
APPLICABLE_BRANDS | 代金券适用品牌(ApplicableBrandsStruct) | 代金券适用品牌 | enum ApplicableBrandTypeEnum { ALL_BRAND = 1 // 全部品牌适用 PART_BRAND = 2 // 部分品牌适用 NOT_PART_BRAND = 3 // 部分品牌不适用 } // 适用品牌 struct ApplicableBrandStruct { 1: required CommonEnumStruct applicable_brand_type // 适用品牌类型:1=全部品牌适用,2=仅同品类下部分品牌适用,3=同品类除下述品牌外均适用 2: optional list<string> applicable_brand_list // 品牌列表 }(assembly_type = '203') |
APPLICABLE_CATEGORY | 代金券适用品类(ApplicableCategoryStruct) | 代金券适用品类 | enum ApplicableCategoryTypeEnum { ALL_CATEGORY = 1 // 全部品类适用 PART_CATEGORY = 2 // 部分品类适用 NOT_PART_CATEGORY = 3 // 部分品类不适用 } // 适用品类 struct ApplicableCategoryStruct { 1: required CommonEnumStruct applicable_category_type // 适用品类类型:1=全部品类适用,2=仅同品牌下部分品类适用,3=同品牌除下述品类外均适用 2: optional list<string> applicable_category_list // 品类列表 }(assembly_type = '202') |
关键属性介绍
属性key | 属性名 | 枚举值说明 | is_multi | 属性类型 | 结构体 |
appointment | 预约信息 | 消费提示:做展示使用 | FALSE | APPOINTMENT | |
auto_renew | 是否开启自动延期(只有闭环商品生效) | "true"/"false" | 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 | |
Description | 商品描述 | 如果不需要,传"[]" | | | |
detail_image_list | 长图 | 图片比例无限制 | TRUE | IMAGE | |
dishes_image_list | 菜品图 | 图片比例:375:280 | TRUE | IMAGE | |
EntryType | 入口类型 | "1:H5 2:小程序 3:抖音", | FALSE | STRING | |
environment_image_list | 环境图 | 图片比例:375:280 | TRUE | IMAGE | |
free_pack | 是否可以打包 | 消费提示:做展示使用 | FALSE | BOOL | |
FrontCategoryTag | | 枚举 "测试", "门票", "项目", "团购", "一日游", "旅行跟拍", "含房套餐", "美食套餐", "美食单品", "单景区门票", "单景区套票", "多景区联票", "游玩项目票", "门店项目票", "代金券", "日历房", "其他", "多日游", "门店服务", "单房型", | TRUE | STRING | |
image_list | 封面图 | 图片比例:375:280 | TRUE | IMAGE | |
IndustryType | 商品行业类型 | 枚举: "门票", "一日游", "多日游", "旅拍", "其他", | FALSE | STRING | |
IsConfirmImme | 是否立即确认 | 酒旅专用 | FALSE | BOOL | |
| FALSE | STRING | | ||
"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 | |
release_source | 商品发布渠道 | "MERCHANT = 1 // 商家; BD = 2 // BD; FACILITATOR = 3 // 服务商;", | FALSE | INT64 | |
show_channel | 投放渠道 | UNLIMIT = 1//不限制 ONLY_LIVING_ROOM=2//仅直播间展示 NOT_FOR_SALE=3 //废弃。不售卖,仅交易可见 ONLY_TRADE=4 //仅交易可见 OFFLINE=5,//线下活动 INFLUENCER=6,//商单 NEWBIE=7, //新人 ONLINE=8,//线上 ONLY_COUPON_PACKAGE=9//仅限省钱券包 LIVE_AND_VIDEO=10,//直播+短视频 VIDEO=11,/仅短视频 SUPER_SKU = 12,//超级sku EXCHANGE =13,//兑换可见 LIVE_AND_NEG=14,//直播间+协商订 SP_FREE=15,//仅大促免费领 SP_RANK=16,//仅大促排行榜 ONLY_EASY_BUY = 17, // 仅顺手买渠道 ONLY_FREE_TRY = 18, // 仅免费试 ONLY_OFFLINE_MACHINE = 19 // 仅线下机器售卖 ONLY_FUN_BUDDY = 21 // 仅趣玩搭子 ONLY_GROUPON_MALL = 22 //仅团购商城 LIVING_ROOM_AND_CUSTOMER_ACQUISITION_CARD = 23 // 直播间+获客卡 ONLY_CUSTOMER_ACQUISITION_CARD = 24 // 仅获客卡 ONLY_MARKETING_ACTIVITY = 25 // 仅活动报名 GUIDE_BLOCK = 26 //导购屏蔽 | 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 | STRING | |
settle_type | 收款方式 | "1-总店结算 2-分店结算 3-区域结算", 总店结算:即商品的结算资金统一结算到商家(不是开发者)的收款账户。 分店结算:按核销POI将资金结算到对应的POI的收款账户,如果POI没有设置收款账户,会将对应的POI的结算资金打款到总店账户; 区域结算:按核销POI将资金结算到对应的区域账户,如未绑定区域账户,默认打款到总店账户(团购、代金券可用,次卡综合餐饮行业可用) | FALSE | INT64 | |
use_type | 团购使用方式 | "1-到店核销",默认值 | FALSE | INT64 | |
SubTitle | 副标题 | 过期退;随时退;x日内可退;免预约;提前x日预约;多个副标题以|(英文半角)分隔,不要有空格(目前只有 退款相关的生效) | FALSE | | |
qualification_identity | 资质身份 | 演出类目必填 1:主办方 :主办方资质必填 2:票务代理:主办方资质和票务代理资质必填 主办方资质对应资质查询接口中的“营业性演出准予许可决定” 票务代理资质对应资质查询接口中的“演出主办方授权书” | FALSE | INT64 | |
host_approval_qual | 主办方资质 | 最多5个 | TRUE | QualificationInfoStruct | |
ticket_agent_qual | 票务代理资质 | 最多10个 | TRUE | QualificationInfoStruct | |
suitable_group_with_multi_enum(养发) | 适宜人群 | 最多4个 | TRUE | COMMON_ENUM | |
user_num_limit(养发) | 使用人数限制 | | FALSE | USER_NUM_LIMIT | |
product_features(养发) | 功能作用 | 最多4个 | TRUE | COMMON_ENUM | |
limit_buy_rule_note | 限购规则 | 用于展示对应规则,接口无限制,仅做透传使用 | FALSE | STRING | |
real_name_ticket_rule_note | 实名购票规则 | 仅作规则描述,不生效 | FALSE | REAL_NAME_BUY_TICKET_RULE | |
refund_rule_note | 是否支持退款 | 退款规则描述,不生效 policy_rule_type: 2-不可退 4-条件退 | FALSE | CUSTOM_POLICY | |
tickets_rule_note | 入场规则 | 仅作规则描述,不生效 | FALSE | TICKETS_RULE | |
transfer_rule_note | 转赠规则 | 仅作规则描述,不生效 | FALSE | STRING | |
child_ticket_rule_note | 儿童票规则 | 仅作规则描述,不生效 | FALSE | STRING | |
performance_duration | 演出时长 | | FALSE | COMMON_TIME | |
applicable_models | 适用车型 | | FALSE | COMMON_ENUM | |
voucher_type | 代金券类型 | 1-品牌券 2-品类券 3-通用券 注意事项: - voucher_type=1时,适用品牌类型只能传2-部分品牌适用,并且适用品牌列表只能传一个品牌;适用品类没有限制; - voucher_type=2时,适用品类类型只能传2-部分品类适用,并且适用品类列表只能传一个品类;适用品牌无限制; | FALSE | COMMON_ENUM | |
applicable_brands | 代金券适用品牌 | 适用品牌类型applicable_brand_type: 1-全部品牌适用;2-部分品牌适用;3-部分品牌不适用; 类型2、3需同时传入品牌列表applicable_brand_list | FALSE | APPLICABLE_BRANDS | |
applicable_category | 代金券适用品类范围 | 适用品牌类型applicable_category_type: 1-全部品类适用;2-部分品类适用;3-部分品类不适用; 类型2、3需同时传入品类列表applicable_category_list | FALSE | APPLICABLE_CATEGORY | |
groupon_supplementary_instruction | 补充说明 | | FALSE | STRING | |
fulfillment_method | 履约方式 | fulfillment_type内枚举值 3-闭环配送到家,代表团购支持配送 | false | FULFILLMENT_METHOD | |
can_microapp_delivery | 小程序随心团 | true-开通 | FALSE | bool | |
additional_poi_support_history | 历史订单新增门店 | "true" "false"(false可不传) | FALSE | BOOL | |
团购模板 (1代表必填属性,2代表选填属性)
| 模板 | | | | | |||||||
| 1000000 | 3000000 | 4000000 | 6000000 | 7000000 | 8000000 | 17000000 | 18000000 | 19000000 | 21000000 | 22000000 | 23000000 |
属性 | 美食团购模板 | 运动健身团购模板 | 休闲娱乐团购模板 | 生活服务团购模板 | 教育培训团购模板 | 住宿团购模板 | 丽人团购模板 | 游玩团购模板 | 汽车团购模版 | 亲子团购模板 | 结婚团购模板 | 宠物团购模板 |
appointment 预约信息 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
auto_renew 自动延期 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
bring_out_meal 是否可以外带餐食 | 1 | | | | | | | | | | | |
can_no_use_date 不可使用日期 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
contains_insurance 是否包含保险 | | | | | | | | 1 | | | | |
customer_reserved_info 留资规则 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
Description 商品描述 | | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
description_rich_text 其他说明信息 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
detail_image_list 长图 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
dishes_image_list 菜品图 | 2 | | | | | | | | | | | |
EntryType 入口类型 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
environment_image_list 环境图 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
free_pack 是否可以打包 | 1 | | | | | | | | | | | |
FrontCategoryTag 前台品类标签 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
holiday_additional_charge 节假日是否额外收费 | | | | | | | | 1 | | | | |
image_list 封面图 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
IndustryType 商品行业类型 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
IsConfirmImme 是否立即确认 | 2 | 2 | 2 | 2 | 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 | 2 | 2 | 2 | 2 |
MpSettleType 小程序分账类型 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
NearestOrderTime 最早可订时间 | | | | | | | | 1 | | | | |
Notification 使用规则,小程序生效 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
private_room 是否可以使用包间 | 1 | | | | | | | | | | | |
real_name_info 实名信息 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
RecommendWord 推荐语 | 2 | 2 | 2 | 2 | 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 | 1 | 1 | 1 | 1 |
refund_need_merchant_confirm 退款是否需商家审核 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
show_channel 投放渠道 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
superimposed_discounts 可以享受店内其他优惠 | 1 | | | | | | | | | | | |
TagList 标签列表 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
trade_url 小程序提单页跳转 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
use_date 使用日期 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
use_time 使用时间 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
code_source_type 券码生成方式 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
commodity 菜品搭配 | 1 | | | | | | | | | | | |
market_price 市场价 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
settle_type 收款方式 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
use_type 团购使用方式 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
limit_rule 限制购买 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
SuitableGroup 适用人群 | | | | | | | | 1 | | | | |
TicketType 票种类型 | | | | | | | | 2 | | | | |
SubTitle 副标题 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 | 2 |
account_name 商家名称 | 1 | | | | | | | | | | | |
actual_amount 顾客实际支付金额 | 1 | | | | | | | | | | | |
client_key 券码服务商 | 2 | | | | | | | | | | | |
origin_amount 商品原价 | 1 | | | | | | | | | | | |
out_id 商家平台商品ID | 2 | | | | | | | | | | | |
platform_unified_description 平台统一使用说明 | 2 | | | | | | | | | | | |
poi_list 适用门店 | 1 | | | | | | | | | | | |
product_name 商品名称 | 1 | | | | | | | | | | | |
refund_type 退款信息 | 2 | | | | | | | | | | | |
sold_end_time 售卖结束时间 | 1 | | | | | | | | | | | |
sold_start_time 售卖开始时间 | 1 | | | | | | | | | | | |
stock_info 库存信息 | 1 | | | | | | | | | | | |
limit_buy_rule 限购规则 | 2 | | | | | | | | | | | |
fulfillment_method 配送方式 | 2 | | | | | | | | | | | |
FAQ 问题
1、团购商品价格校验
团购商品(product_type=1)价格校验规则
默认价格规则:
单菜品原价(元) | 实付价(元) |
2000 | 2000 |
特定三级类目价格规则:
类目ID | 单菜品原价(元) | 实付价(元) |
22001001 | 100000 | 100000 |
4016001 | 100000 | 100000 |
4016002 | 100000 | 100000 |
4016003 | 100000 | 100000 |
4016004 | 100000 | 100000 |
6001003 | 100000 | 100000 |
6001004 | 100000 | 100000 |
6001001 | 8000 | 5000 |
6001005 | 8000 | 5000 |
6001006 | 8000 | 5000 |
6001008 | 8000 | 5000 |
8001004 | 8000 | 5000 |
8001006 | 8000 | 5000 |
8002001 | 8000 | 5000 |
8001003 | 8000 | 5000 |
5002001 | 5000 | 5000 |
2、out_url 格式
商品类型为小程序时,out_url 格式为 json,需要包含三个字段:
- •app_id: 小程序的 app_id
- •path: 小程序服务页面路径
- •params: 上面 path 需要使用到的服务参数
样例如下:
{ "app_id": "xxxxxxx", "params": "{\"productId\":\"1\",\"packageId\":2,\"channelLinkId\":3}", "path": "pages/any/path" }
注意:params 格式为 json ,上述实例为举例具体的 params 按具体小程序 path 需要的参数来自行填写
params 包含 aweme_useTemplate = 1 或者 2 商品中台会自动填充 spuId 到 outUrl 里
out_url 传入格式:
"out_url":"{\"params\":\"{\"spuId\":\"xxxxx\",\"skuId\":\"xxxxxx\"}\",\"path\":\"pages/any/path\",\"app_id\":\"xxxxx\"}"
3、团购套餐菜品组单位枚举
单位枚举的范围如下 :{"份","例","包","次","串","袋","对","根","个","盒","斤","块","两","盘","条","碗","