支持第三方调用
支持沙箱环境调用
公共请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
app_id | string | 是 | 小程序appid |
access_token | string | 是 | 小程序调用凭证 |
业务请求参数
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
solution_code | string | 是 | 组件类型 |
service_name | string | 否 | 服务名称:最长64位中文字符; 服务类型为“FREE_RESERVATION”、“LEAVE_INFO”、“COUPON”时必填; 其他服务类型不填(会默认使用绑定的商品名称); |
service_img | string | 否 | 服务图片:外部图片链接,仅支持jpg、jpeg、png格式; 服务类型为“FREE_RESERVATION”、“LEAVE_INFO”、“COUPON”时必填; 其他服务类型不填(会默认使用绑定的商品头图); |
category_id | string | 否 | 类目id,获取小程序设置的工业类目; 服务类型为“FREE_RESERVATION”、“LEAVE_INFO”、“COUPON”时必填; 其他服务类型不填(会默认使用绑定的商品类目); |
service_link | string | 否 | 服务链接,“/”开头; 服务类型为“FREE_RESERVATION”、“LEAVE_INFO”、“COUPON”时必填; 其他服务类型不填(会默认使用绑定的商品path); |
component_attrs | enum_map | 是 | 组件属性 |
out_component_id | string | 是 | 外部组件id:商家自定义的唯一业务id,最长64位英文字符 |
service_time_type | string | 否 | 服务时间类型:LONG_TERM:长期;TIME_LIMITED:限时; |
service_start_time | string | 否 | 服务开始时间,格式"yyyy-MM-dd hh:mm:ss",例如"2025-01-15 12:00:00" |
service_end_time | string | 否 | 服务结束时间,格式"yyyy-MM-dd hh:mm:ss",例如"2025-01-15 12:00:00" |
请求示例
团购套餐(通用)类型服务组件:
{ "solution_code": "GROUP_BUY", "out_component_id":"6594bb3edc5f5c004442b228", "component_attrs": { "product_id": "out-item-id-49kd23", "shop_list": "[ { \"shop_id\": \"4230494B3553525A4650\"},{ \"shop_id\": \"42304646484C534B4E31\"}]", "service_instant_confirm": "false", "service_change_reservation": "true", "stock_type": "POI_DATE_TIME_STOCK", "stock_detail": "[ { \"shop_id\": \"4230494B3553525A4650\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" },{ \"shop_id\": \"42304646484C534B4E31\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" } ]", "price_type": "POI_DATE_TIME_PRICE", "price_detail": "[ { \"shop_id\": \"4230494B3553525A4650\", \"max_price\": \"2000\", \"min_price\": \"1\", \"price_date\": \"2024-12-20\", \"origin_price\": \"2000\", \"price_end_time\": \"16:00\", \"discount_price\": \"1\", \"price_start_time\": \"15:00\" } ]" } }
免费预订类型服务组件:
{ "solution_code": "FREE_RESERVATION", "service_name": "上海测试餐厅订座", "service_img": "http://qimg.xiaohongshu.com/arkcamp/1040g0qo317aegd8in6005pm80sqgldo4cp6ukfg", "category_id": "65a610def28520000165ec3d", "service_link": "/item/6594bb3edc5f5c004442b227", "out_component_id":"6594bb3edc5f5c004442b227", "component_attrs": { "service_instant_confirm": "false", "shop_list": "[ { \"shop_id\": \"SHOP67ad6dba688d07222022e0bb\"]", "service_change_reservation": "true", "stock_type": "POI_DATE_TIME_STOCK", "stock_detail": "[{ \"shop_id\": \"SHOP67ad6dba688d07222022e0bb\", \"stock_date\": \"2025-04-05\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" },{ \"shop_id\": \"SHOP67ad6dba688d07222022e0bb\", \"stock_date\": \"2025-04-05\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" }]", "price_type": "FREE" } }
购票(休闲娱乐通用版)类型服务组件:
{ "solution_code": "EXHIBITION_TICKET", "out_component_id":"6594bb3edc5f5c004442b228", "component_attrs": { "product_id": "out-item-id-49kd23", "shop_list": "[ { \"shop_id\": \"4230494B3553525A4650\"},{ \"shop_id\": \"42304646484C534B4E31\"}]", "service_instant_confirm": "false", "service_change_reservation": "true", "stock_type": "POI_DATE_TIME_STOCK", "stock_detail": "[ { \"shop_id\": \"4230494B3553525A4650\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" },{ \"shop_id\": \"42304646484C534B4E31\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" } ]", "price_type": "POI_DATE_TIME_PRICE", "price_detail": "[ { \"shop_id\": \"4230494B3553525A4650\", \"max_price\": \"2000\", \"min_price\": \"1\", \"price_date\": \"2024-12-20\", \"origin_price\": \"2000\", \"price_end_time\": \"16:00\", \"discount_price\": \"1\", \"price_start_time\": \"15:00\" } ]" } }
购票(电影专用)类型服务组件:
{ "solution_code": "MOVIE_TICKET", "out_component_id":"6594bb3edc5f5c004442b228", "component_attrs": { "product_id": "out-item-id-49kd23", "shop_list": "[ { \"shop_id\": \"4230494B3553525A4650\",\"service_link\":\"/shop/1\"},{ \"shop_id\": \"42304646484C534B4E31\",\"service_link\":\"/shop/2\"}]", "service_instant_confirm": "false", "service_change_reservation": "true", "stock_type": "POI_DATE_TIME_STOCK", "stock_detail": "[ { \"shop_id\": \"4230494B3553525A4650\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" },{ \"shop_id\": \"42304646484C534B4E31\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" } ]", "price_type": "POI_DATE_TIME_PRICE", "price_detail": "[ { \"shop_id\": \"4230494B3553525A4650\", \"max_price\": \"2000\", \"min_price\": \"1\", \"price_date\": \"2024-12-20\", \"origin_price\": \"2000\", \"price_end_time\": \"16:00\", \"discount_price\": \"1\", \"price_start_time\": \"15:00\" } ]" } }
领券类型服务组件:
{ "solution_code": "COUPON", "service_name": "优惠券名称", "service_img": "http://qimg.xiaohongshu.com/arkcamp/1040g0qo317aegd8in6005pm80sqgldo4cp6ukfg", "category_id": "664f11c73a863d0001bee208", "service_link": "/item/66ee31d0b6a09d0001f4e136", "out_component_id":"6594bb3edc5f5c004442b227", "component_attrs": { "service_choose_time": "true", "service_instant_confirm": "false", "shop_list": "[ { \"shop_id\": \"423047323334384B3132\"} ]", "service_change_reservation": "true", "stock_type": "WHOLE", "stockDetail": "[{\"available_stock\": \"1000\",\"stock_start_time\": \"15:00\" }]", "price_type": "FREE" } }
留资类型服务组件:
{ "solution_code": "LEAVE_INFO", "service_name": "上海测试小区8栋302室", "service_img": "http://qimg.xiaohongshu.com/arkcamp/1040g0qo317aegd8in6005pm80sqgldo4cp6ukfg", "category_id": "66ee74b2003be20001e583ac", "service_link": "/item/66ee31d0b6a09d0001f4e136", "out_component_id":"6594bb3edc5f5c004442b226", "component_attrs": { "service_choose_time": "true", "service_instant_confirm": "false", "shop_list": "[ { \"shop_id\": \"SHOP67ad6dba688d07222022e0bb\"}]", "service_change_reservation": "true", "stock_type": "POI_DATE_TIME_STOCK", "stock_detail": "[{ \"shop_id\": \"SHOP67ad6dba688d07222022e0bb\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" },{ \"shop_id\": \"SHOP67ad6dba688d07222022e0bb\", \"stock_date\": \"2024-12-21\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" }]", "price_type": "FREE" } }
活动组局类型服务组件-有门店:
{ "solution_code": "ACTIVITY", "out_component_id":"20250429-1", "component_attrs": { "product_id": "out-item-id-49kd23", "shop_list": "[ { \"shop_id\": \"4230494B3553525A4650\"},{ \"shop_id\": \"42304646484C534B4E31\"}]", "service_instant_confirm": "false", "service_change_reservation": "true", "stock_type": "POI_DATE_TIME_STOCK", "stock_detail": "[ { \"shop_id\": \"4230494B3553525A4650\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" },{ \"shop_id\": \"42304646484C534B4E31\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" } ]", "price_type": "POI_DATE_TIME_PRICE", "price_detail": "[ { \"shop_id\": \"4230494B3553525A4650\", \"max_price\": \"2000\", \"min_price\": \"1\", \"price_date\": \"2024-12-20\", \"origin_price\": \"2000\", \"price_end_time\": \"16:00\", \"discount_price\": \"1\", \"price_start_time\": \"15:00\" } ]" } }
活动组局类型服务组件-无门店:
{ "solution_code": "ACTIVITY", "service_name": "上海测试免费活动0610", "service_img": "http://qimg.xiaohongshu.com/arkcamp/1040g0qo317aegd8in6005pm80sqgldo4cp6ukfg", "category_id": "668cd63962b1e300010d7329", "service_link": "/item/66ee31d0b6a09d0001f4e136", "out_component_id":"6594bb3edc5f5c004442b226", "component_attrs": { "service_choose_time": "true", "service_instant_confirm": "false", "service_change_reservation": "true", "stock_type": "DATE_STOCK", "stock_detail": "[ {\"stock_date\": \"2024-12-20\", \"available_stock\": \"9\"}]", "price_type": "FREE" } }
组件属性是Map<String,String>结构,属性值如果是有子属性的结构,需要转换成jsonString格式作为值
属性key | 含义 | 类型 | 是否必填 | 描述 |
---|---|---|---|---|
service_instant_confirm | 服务是否立即确认 | boolean | 服务类型为“GROUP_BUY”、“COUPON”时不填; 其他服务类型必填; | true、false |
service_change_reservation | 服务是否支持修改预订 | boolean | 服务类型为“GROUP_BUY”、“COUPON”时不填; 其他服务类型必填; | true、false |
shop_list | 门店列表 | list | 服务类型为“ACTIVITY”时非必填,其他服务类型必填 | 详见子属性说明。子元素个数不能超过100,如果超过,请调用更新服务接口继续增加门店 |
shop_id | 门店id | string | 是 | 服务类型为 “GROUP_BUY”、“EXHIBITION_TICKET”、“MOVIE_TICKET”、“PAID_RESERVATION”、“ACTIVITY”时,如果组件关联的商品类目需要认领门店,则组件的门店必须在商品门店范围内; 服务类型为“FREE_RESERVATION”、“COUPON”、“LEAVE_INFO”时,如果组件类目需要认领门店,组件的门店必须在商家已认领的门店范围内; 如果组件类目不需要认领门店,则门店id查询方式:查询可用的地点 接口查询结果中的place_id即为门店id; 类目是否需要认领门店,可获取小程序设置的工业类目中require_claim_store字段。 |
service_link | 门店服务链接 | string | 服务类型为“MOVIE_TICKET”时必填; 其他服务类型不填; | 小程序内的门店服务路径,“/”开头 |
product_id | 商品id | string | 服务类型为“GROUP_BUY”、“EXHIBITION_TICKET”、“MOVIE_TICKET”、“PAID_RESERVATION”、“ACTIVITY”时必填; 其他服务类型不填; | 商家同步商品的三方商品id。商品需要先通过商品同步-生活服务或商品同步-实物电商创建 |
stock_type | 库存类型 | enum | 是 | 支持以下类型: WHOLE:单一库存 UNLIMIT:不限库存 DATE_STOCK:日期库存 DATE_TIME_STOCK:日期-时段库存 POI_DATE_TIME_STOCK:门店-日期-时段库存 POI_DATE_STOCK:门店-日期库存 |
stock_detail | 库存详情 | list | 库存类型为“UNLIMIT”时不填;其他库存类型时必填; | 详见子属性说明。子元素个数不能超过100,如果超过,请调用更新服务接口继续增加库存详情 |
shop_id | 门店id | string | 库存类型为“POI_DATE_TIME_STOCK”、“POI_DATE_STOCK”时必填; 其他库存类型不填; | 门店id必须在shopList属性中的shopId范围 |
stock_date | 库存日期 | string | 库存类型为“DATE_STOCK”、“DATE_TIME_PRICE”、 “POI_DATE_TIME_STOCK”、“POI_DATE_STOCK”时必填; 其他库存类型不填; | 格式"yyyy-MM-dd",例如"2025-01-15" |
stock_start_time | 库存时段开始时间 | string | 库存类型为“DATE_TIME_PRICE”、“POI_DATE_TIME_STOCK”时必填; 其他库存类型不填; | 格式"hh-mm",例如"15:00" |
stock_end_time | 库存时段结束时间 | string | 库存类型为“DATE_TIME_PRICE”、“POI_DATE_TIME_STOCK”时必填; 其他库存类型不填; | 格式"hh-mm",例如"18:00" |
available_stock | 剩余库存 | int64 | 是 | 非负整数 |
price_type | 价格类型 | enum | 是 | 服务类型为“GROUP_BUY”、“EXHIBITION_TICKET”、“MOVIE_TICKET”、“PAID_RESERVATION”时支持以下类型: WHOLE:单一价格 DATE_PRICE:日期价格 DATE_TIME_PRICE:日期-时段价格 POI_DATE_TIME_PRICE:门店-日期-时段价格 POI_DATE_PRICE:门店-日期价格; 服务类型为“FREE_RESERVATION”、“COUPON”、“LEAVE_INFO”时支持以下类型: FREE:免费 服务类型为“ACTIVITY”时支持所有类型 |
price_detail | 价格详情 | list | 价格类型为“FREE”不填; 其他价格类型必填; | 详见子属性说明。子元素个数不能超过100,如果超过,请调用更新服务接口继续增加价格详情 |
shop_id | 门店id | string | 库存类型为“POI_DATE_TIME_STOCK”、“POI_DATE_STOCK”时必填; 其他库存类型不填; | 门店id必须在shopList属性中的shopId范围 |
price_date | 价格日期 | string | 库存类型为“DATE_PRICE”、“DATE_TIME_PRICE”、 “POI_DATE_TIME_STOCK”、“POI_DATE_STOCK”时必填; 其他库存类型不填; | 格式"yyyy-MM-dd",例如"2025-01-15" |
price_start_time | 价格时段开始时间 | string | 库存类型为“DATE_TIME_PRICE”、“POI_DATE_TIME_STOCK”时必填; 其他库存类型不填; | 格式"hh-mm",例如"15:00" |
price_end_time | 价格时段结束时间 | string | 库存类型为“DATE_TIME_PRICE”、“POI_DATE_TIME_STOCK”时必填; 其他库存类型不填; | 格式"hh-mm",例如"18:00" |
min_price | 价格下限 | int64 | 是 | 单位:分,正整数 |
max_price | 价格上限 | int64 | 是 | 单位:分,正整数 |
origin_price | 原价 | int64 | 是 | 单位:分,正整数 |
discount_price | 折扣价 | int64 | 是 | 单位:分,正整数 |
名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
data | struct | 否 | |
component_id | string | 否 | 服务组件id |
success | bool | 否 | 是否成功 |
msg | string | 否 | 说明,正确响应时为 success,错误响应时为错误描述 |
code | int32 | 否 | 错误码,正确响应时为 0,错误响应时非0 |
{ "data":{ "component_id":"string" }, "success":true, "msg":"string", "code":0 }
参见错误码