2.3-创建/更新外卖商品接口
接口补充说明:
- •创建或更新商品
- •对于同一服务商,相同的out_id会被认为是同一商品
- •商品和SKU属性,需要通过查询商品模板获取
- •创建/修改商品需要审核,通常2小时内出审;
附录
attr_key_value_map的格式
根据「查询外卖商品模板」查出的模板,可以获取到商品对应的相关属性,技术需要关心的字段主要是以下几个:
- 1.key - 属性主键,attr_key_value_map 的 key 是什么;
- 2.is_required - 是否必传;
- 3.is_multi - 是否列表,需要和 value_type 组合起来看。例如:
- a.value_type=STRING(表示字符串,具体参见下文),is_multi=true,则表示 value 是一个字符串列表(也就是 list)类型;
- b.value_type=IMAGE(表示图片控件,具体参见下文),is_multi=true,则表示 value 是一个图片控件结构体列表(也就是 list)类型;
- 4.value_type - 属性value 类型,枚举可参见后文的表格-属性value_type结构详解;
attr_key_value_map的类型是map<string,string>,如果value_type为其他值类型需转换为string
- •value_type为整数/浮点数:转为十进制格式的string
- •value_type为布尔值:转为"true"或"false"
- •value_type为结构体或结构体列表:需要使用json序列化
属性value_type结构详解
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 } | |
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) | 开关;指定周几不可用;指定节假日不可用;指定日期不可用;节假日具体日期 | 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"} } | |
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 // 每人单次消费最多使用代金劵张数 } | |
114 | NOTIFICATION | 使用规则控件(NotificationStruct) | 标题;内容 | struct NotificationStruct { 1: required string title, 2: required string content, } | |
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 } | |
121 | COMMODITY | 商品搭配控件(ItemGroupStruct) | 商品组名 总数 选几 菜品 - 菜名 - 单价 - 总数 - 单位 | struct ProductGroupStruct { 1: string group_name // 商品组名称 2: optional i32 total_count // 总数 3: optional i32 option_count // 选几 4: optional list<ProductItemStruct> item_list // 单品列表 } struct ProductItemStruct { 1: required string name // 名称 2: optional i64 price // 原价 单位:分 3: optional i64 count // 数量 4: optional string unit // 单位 5: optional bool spec_switch // 多规格开关 6: optional list<MaterialStruct> primary_materials // 主料 20: optional list<SpecStruct> quantity // 规格 21: optional list<CustomizeSpecStruct> customize_spec // 属性 22: optional list<AddDishGroup> dish_group // 加料 23: optional string product_id // 单品product_id 24: optional string out_id // 第三方id 外部单品ID } struct SpecStruct { 1: list<SpecItemStruct> item_list // 规格项列表 2: string group_name // 规格组名 } struct SpecItemStruct { 1: string item_name // 规格项名称,如 大杯/中杯/小杯 2: optional i32 add_price // 加价金额,单位为分 3: optional string weight // 份量大小 4: optional string unit // 单位 6: optional string sku_id // 单品规 格sku_id 多规格单品时有值 每个规格对应一个sku_id 7: optional string out_sku_id //单品规格第三方sku_id 对应为外部SKU码 } struct CustomizeSpecStruct { 1: list<CustomizeSpecItemStruct> item_list // 属性列表 2: string group_name // 属性组名 } struct CustomizeSpecItemStruct{ 1: string item_name // 属性名称 } struct AddDishGroup { 1: string group_name // 加料组名称 2: list<AddDish> item_list } struct AddDish { 1: string item_name // 加料组属性名称 2: i32 add_price // 加料组属性价格 3: optional i32 stock // 加料组属性库存,暂不支持传入,默认最大 4: optional string product_id // 加料product_id 5: optional string out_id // 加料外部ID } // 原材料 struct MaterialStruct { 1: string name // 原材料名称 } | |
132 | SERVICE_ITEM_IMAGE | 菜品图(ServiceItemImageStruct) | 菜品图 | type ServiceItemImageStruct struct { 1: optional string name //菜品名称 2: required string uri 3: optional string url 4: optional string item_id //不用传 } | |
130 | LIMIT_BUY_RULE | 限购规则(LimitBuyRuleStruct) | 限购规则 | struct LimitBuyRuleStruct { 1: required bool enable_limit, // 是否启用限制购买 2: optional list<LimitRuleItem> rule_list // 限购规则 } struct LimitRuleItem { 1: required SubjectTypeEnum subject_type // 限购主体 2: required RangeTypeEnum range_type // 限购范围 3: required i32 limit_num // 限购数量 4: required string unit // 限购单位 } enum SubjectTypeEnum { UID = 1, // UID } enum RangeTypeEnum { ORDER = 4, // 订单 } | |
关键属性解析
属性key | 属性名 | 枚举值说明 | is_multi | 属性类型 | 示例 |
delivery_method | 配送商品的配送方式 | 1-立即配送 2-先囤后约 | true | INT64 | "[1,2]" |
apply_date | 先囤后约有效期 | | false | USE_DATE | "{\"use_date_type\":1,\"use_start_date\":\"2023-05-13\",\"use_end_date\":\"2024-05-06\"}" |
| | ||||
| |||||
show_channel | 投放渠道 | "1-不限制 2-仅直播间可见", | false | INT64 | "1" |
auto_renew | 是否开启自动延期 | "true"/"false" | false | BOOL | "true" |
limit_buy_rule | 限制购买 | 最多购买份数。目前外卖商品限制每个UID每笔订单最多购买2份 | false | LIMIT_BUY_RULE | 固定值:"{\"enable_limit\":true,\"rule_list\":[{\"subject_type\":1,\"range_type\":4,\"limit_num\":1,\"unit\":\"份\"}]}" |
description_rich_text | 其他说明信息 | | true | NOTE | |
superimposed_discounts | 可以享受店内其他优惠 | 消费提示:做展示使用 | false | BOOL | "true"/"false" |
rec_person_num | 建议使用人数 | | false | INT64 | |
rec_person_num_max | 最多使用人数 | | false | INT64 | |
commodity | 菜品搭配、商品搭配 | | true | COMMODITY | 1、普通商品:"[{\"group_name\":\"荤菜\",\"total_count\":1,\"option_count\":1,\"item_list\":[{\"name\":\"红烧肉\",\"price\":1000,\"count\":1,\"unit\":\"份\",\"out_id\":\"红烧肉外部菜品ID\"}]},{\"group_name\":\"素菜\",\"total_count\":1,\"option_count\":1,\"item_list\":[{\"name\":\"油菜\",\"price\":2000,\"count\":2,\"unit\":\"份\",\"out_id\":\"油菜外部菜品ID\"}]}]" 2、多规格商品:"[{\"group_name\":\"奶茶\",\"total_count\":1,\"option_count\":1,\"item_list\":[{\"product_id\":\"123\",\"name\":\"芋泥波波\",\"price\":100,\"count\":1,\"unit\":\"份\",\"out_id\":\"芋泥波波外部单品ID\",\"spec_switch\":true,\"quantity\":[{\"item_list\":[{\"sku_id\":\"123\",\"item_name\":\"大杯\",\"add_price\":200,\"weight\":\"300\",\"unit\":\"毫升\",\"out_sku_id\":\"大杯SKU码\"},{\"sku_id\":\"123\",\"item_name\":\"中杯\",\"add_price\":100,\"weight\":\"200\",\"unit\":\"毫升\",\"out_sku_id\":\"中杯SKU码\"}],\"group_name\":\"杯型\"}],\"customize_spec\":[{\"item_list\":[{\"item_name\":\"常温\"},{\"item_name\":\"加冰\"}],\"group_name\":\"温度\"}],\"dish_group\":[{\"group_name\":\"糖浆\",\"item_list\":[{\"product_id\":\"123\",\"item_name\":\"糖浆1\",\"add_price\":100,\"out_id\":\"糖浆1外部小料ID\"},{\"product_id\":\"123\",\"item_name\":\"糖浆2\",\"add_price\":200,\"out_id\":\"糖浆2外部小料ID\"}]}]}]},{\"group_name\":\"果汁\",\"total_count\":2,\"option_count\":1,\"item_list\":[{\"product_id\":\"123\",\"name\":\"苹果汁\",\"price\":1300,\"count\":1,\"unit\":\"份\",\"out_id\":\"苹果汁外部单品ID\",\"spec_switch\":false},{\"product_id\":\"123\",\"name\":\"梨汁\",\"price\":1200,\"count\":1,\"unit\":\"份\",\"out_id\":\"梨汁外部单品ID\",\"spec_switch\":false}]}]" |
image_list | 封面图 | 图片比例:375:280 | true | IMAGE | "[{\"url\":\"xxx\"},{\"url\":\"xxx\"}]" |
dishes_image_list | 菜品图 | 图片比例:375:280 | true | IMAGE | "[{\"url\":\"xxx\"},{\"url\":\"xxx\"}]" |
environment_image_list | 环境图 | 图片比例:375:280 | true | IMAGE | "[{\"url\":\"xxx\"},{\"url\":\"xxx\"}]" |
settle_type | 收款方式 | "1-总店结算 2-分店结算", 总店结算:即商品的结算资金统一结算到商家(不是开发者)的收款账户。 分店结算:按核销POI将资金结算到对应的POI的收款账户,如果POI没有设置收款账户,会将对应的POI的结算资金打款到总店账户; | false | INT64 | |
trade_url | 小程序提单页跳转 | 提单页URL,直播间下单会使用 | false | STRING | |
TagList | 标签列表 | | false | STRING | |
SubTitle | 副标题 | 过期退;随时退;x日内可退;多个副标题以|(英文半角)分隔,不要有空格 | false | STRING | |
SortWeight | 排序权重 | | false | INT64 | |
RecommendWord | 推荐语 | | false | STRING | |
Notification | 使用规则 | | true | NOTIFICATION | "[{\"title\":\"标题\",\"content\":\"内容美食1.1\"}]" |
MpResourceID | 小程序资源id | | false | STRING | |
MpSettleType | 小程序分账类型 | "1-包销 2-代销",三方分账使用 | false | INT64 | |
IndustryType | 商品行业类型 | 枚举: "门票", "一日游", "多日游", "旅拍", "其他", | false | STRING | |
IsConfirmImme | 是否立即确认 | | false | BOOL | "true"/"false" |
FrontCategoryTag | | 枚举: "测试", "门票", "项目", "团购", "一日游", "旅行跟拍", "含房套餐", "美食套餐", "美食单品", "单景区门票", "单景区套票", "多景区联票", "游玩项目票", "门店项目票", "代金券", "日历房", "其他", "多日游", "门店服务", "单房型", | true | STRING | |
EntryType | 入口类型 | "1:H5 2:小程序 3:抖音 4:lynx", | false | INT64 | |
| | | | | |
| | | | | |
商品搭配中单品单位枚举
"份","例","包","次","串","袋","对","根","个","盒","斤","块","两","盘","条","碗","张","只","支","棵","头","盆","碟","箱","杯","罐","扎","壶","瓶","听","桶","升"
商品搭配中多规格单品份量单位枚举
类目全名称 | 一级类目ID | 二级类目ID | 三级类目ID | 份量单位枚举 |
美食-热门特色菜-小龙虾 | 1000000 | 1018000 | 1002001 | ["克","千克","两","斤","英寸","磅","盎司","毫升","升","寸","厘米"] |
美食-快餐小吃-快餐 | 1000000 | 1017000 | 1017001 | ["克","千克","两","斤","英寸","磅","盎司","毫升","升","寸","厘米"] |
美食-快餐小吃-零食 | 1000000 | 1017000 | 1017003 | ["克","千克","两","斤","英寸","磅","盎司","毫升","升","寸","厘米"] |
美食-快餐小吃-熟食 | 1000000 | 1017000 | 1017004 | ["克","千克","两","斤","英寸","磅","盎司","毫升","升","寸","厘米"] |
美食-面包甜点 | 1000000 | 1014000 | | ["克","千克","两","斤","英寸","磅","盎司","毫升","升","寸","厘米"] |
美食-饮品 | 1000000 | 1015000 | | ["毫升","升","克","千克","两","斤"] |
美食 | 1000000 | | | ["克","千克","两","斤","英寸","磅","盎司","毫升","升","寸","厘米"] |
