支持第三方调用
支持沙箱环境调用
公共请求参数
名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | string | 是 | 小程序appid |
| access_token | string | 是 | 小程序调用凭证 |
业务请求参数
名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| component_id | string | 是 | 组件id |
| update_type | string | 是 | 更新类型（SINGLE_ATTR_OVERWRITE：单属性覆盖更新，SINGLE_ATTR_ADD：单属性批量新增/更新，目前仅用于门店、库存、价格更新，SINGLE_ATTR_REMOVE：单属性批量删除） |
| version | int32 | 否 | 组件版本（暂时无需填写，未来支持组件升级时使用） |
| service_name | string | 否 | 服务名称：最长64位中文字符 |
| service_img | string | 否 | 服务图片：外部图片链接，仅支持jpg、jpeg、png格式 |
| category_id | string | 否 | 类目id：从https://miniapp.xiaohongshu.com/doc/DC104157 获取小程序设置的工业类目 |
| service_link | string | 否 | 服务链接：“/”开头，，小程序内部的访问路径 |
| component_attrs | enum_map | 否 | 组件属性 |
| 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" |
请求示例
1、单属性覆盖式更新（SINGLE_ATTR_OVERWRITE，历史的更新类型ALL_ATTR_OVERWRITE已合并至此类型）：入参的属性值将完全替换已有的属性值。入参的每个属性最多100个元素，如果超过则需要使用单属性批量新增/更新（SINGLE_ATTR_ADD）方式更新。
以下示例是变更库存类型和库存详情，库存详情在更新后将只有2条记录。
{
"component_id": "678082f6b8b5eb00012bf600",
"update_type": "SINGLE_ATTR_OVERWRITE",
"component_attrs": {
"stock_type": "POI_DATE_TIME_STOCK",
"stock_detail": "[ { \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpqSkdPeEFETXdBak55Z2pZa1ZtWXpnek4zY2pO\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" },{ \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpq1kdPeEFETXdBak55Z2pZa1ZtWXpnek4zY2pO\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" } ]"
}
}
2、单属性批量新增/更新（SINGLE_ATTR_ADD，历史的更新类型SINGLE_ATTR_CONDITION_UPDATE已合并至此类型）：仅支持更新子属性是数组类型属性（即shop_list、price_detail、stock_detail），单次调用限制100个元素。
以下示例是库存类型为“门店-日期-时段库存”的库存更新操作，有2个库存信息，如果stock_detail中存在相应门店-日期-时段属性（shop_id、stock_date、stock_start_time、stock_end_time）的库存值则会更新available_stock值，否则会插入一条新的库存记录。
{
"component_id": "678082f6b8b5eb00012bf600",
"update_type": "SINGLE_ATTR_ADD",
"component_attrs": {
"stock_detail": "[ { \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpqSkdPeEFETXdBak55Z2pZa1ZtWXpnek4zY2pO\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" },{ \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpq1kdPeEFETXdBak55Z2pZa1ZtWXpnek4zY2pO\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" } ]"
}
}
以下示例是价格类型为“门店-日期-时段价格”的价格更新操作，有1个价格信息，如果price_detail中存在相应门店-日期-时段属性（shop_id、price_date、price_start_time、price_end_time）的价格值，则“价格下限”（min_price）、“价格上限”（max_price）、“原价”（origin_price）、“折扣价”（discount_price）属性将更新，否则会插入一条新的价格记录。
{
"component_id": "678082f6b8b5eb00012bf600",
"update_type": "SINGLE_ATTR_ADD",
"component_attrs": {
"price_detail": "[ { \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpqSkdPeEFETXdBak55Z2pZa1ZtWXpnek4zY2pO\", \"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\" } ]"
},{
"price_detail": "[ { \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpqSkdPe5FETXdBak55Z2pZa1ZtWXpnek4zY2pO\", \"max_price\": \"2000\", \"min_price\": \"1\", \"price_date\": \"2025-12-20\", \"origin_price\": \"2000\", \"price_end_time\": \"16:00\", \"discount_price\": \"1\", \"price_start_time\": \"15:00\" } ]"
}
}
以下示例是门店更新操作，如果门店列表中原来没有入参中的门店信息，将会插入一条新的门店记录。
{
"component_id": "678082f6b8b5eb00012bf600",
"update_type": "SINGLE_ATTR_ADD",
"component_attrs": {
"shop_list": "[ { \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpqSkdPeEFETXdBak55Z2pZa1ZtWXpnek4zY2pO\"},{ \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpqSkdPe5FETXdBak55Z2pZa1ZtWXpnek4zY2pO\"} ]"
}
}
3、单属性批量删除（SINGLE_ATTR_REMOVE）：仅支持更新子属性是数组类型属性（即shop_list、price_detail、stock_detail），单次调用限制100个元素。 以下示例是库存类型为“门店-日期-时段库存”的库存更新操作，有2个库存信息，如果stock_detail中存在相应门店-日期-时段属性（shop_id、stock_date、stock_start_time、stock_end_time）的库存记录，则会删除这2条库存。
{
"component_id": "678082f6b8b5eb00012bf600",
"update_type": "SINGLE_ATTR_REMOVE",
"component_attrs": {
"stock_detail": "[ { \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpqSkdPeEFETXdBak55Z2pZa1ZtWXpnek4zY2pO\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" },{ \"shop_id\": \"SHOPMFVUUTFnVE40TXpOemt6TTFVRE8wQXpNeVF6SDJNVFpq1kdPeEFETXdBak55Z2pZa1ZtWXpnek4zY2pO\", \"stock_date\": \"2024-12-20\", \"stock_end_time\": \"16:00\", \"available_stock\": \"9\", \"stock_start_time\": \"15:00\" } ]"
}
}
名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
data | struct | 否 | |
component_id | string | 否 | 组件id |
| success | bool | 否 | 是否成功 |
| msg | string | 否 | 说明，正确响应时为 success，错误响应时为错误描述 |
| code | int32 | 否 | 错误码，正确响应时为 0，错误响应时非0 |
{
"data":{
"component_id":"678082f6b8b5eb00012bf600"
},
"success":true,
"msg":"string",
"code":0
}
参见错误码