第三方平台
接口说明

POI 商品同步

接口介绍

该接口用于同步 POI 的商品。

注意:

  • 需有生活服务商品上传及分发权限才能调用该接口。

请求

基本信息

基本
HTTP URLhttps://open.microapp.bytedance.com/openapi/v1/microapp/operation/poi/spu/sync
HTTP MethodPOST
权限要求授权小程序授予运营管理权限

查询参数

参数名参数类型是否必须备注
component_appidstring第三方应用 appid
authorizer_access_tokenstring授权小程序接口调用凭据

请求体(json)

参数名参数类型是否必须备注
attributeobjectSPU 属性字段
entry_infoobject小程序跳转信息
front_category_tagArray<string>前台品类标签,可选标签:一日游,代金券,含房套餐,美食套餐,美食单品,门票,旅行跟拍,门店服务,单房型
highlightsArray<object>商品亮点标签
image_listArray<string>商品图片
namestring商品名称
order_depends_on_datebool下单是否依赖日期
origin_priceint原价,单位分
priceint现价,单位分
recommend_wordstring推荐语,5~20 个字
sort_weightint排序权重,按降序排列
spu_ext_idstring外部商品 ID
spu_typeint商品类型,30:预售券,90:门票,91:团购券
statusint商品状态,1:上线
stockint库存
supplier_ext_id_listArray<string>外部商铺 ID 列表
take_rateint商品的抽佣率,万分数,100 表示抽佣万分之一百,即 1%

entry_info 说明:

参数名参数类型是否必须备注
entry_miniAppobject小程序启动参数

entry_info.entry_miniApp 说明:

参数名参数类型是否必须备注
paramsstring页面参数,传入 json 格式的 string,例如: {"params_a":"xxx", "params_b":"xxx"}
pathstring页面路径

注意:

  • path 开头不要带有 /,合法的例子: pages/result,不合法的例子: /pages/result

highlights 说明:

参数名参数类型是否必须备注
contentstring介绍,字符串长度<=5
priorityint优先级,数字越小优先级越高

attribute 说明:

参数名参数类型是否必须备注
3001object预约券商品属性
9001object门票商品属性
9101object团购券商品属性

attribute.3001 说明:

参数名参数类型是否必须备注
add_bed_ruleobject加床规则
appointment_infoobject预约信息
arrive_rulestring到达方式
breakfast_ruleobject加早规则
check_rulestring入离店时间
date_ruleobject使用日期规则
groupon_detailArray<object>预售券图文详情
groupon_valid_endstring预售有效期结束
groupon_valid_startstring预售有效期开始
notificationArray<object>使用须知详情
order_limitint单个用户购买数量限制
order_valid_endstring订单(券码)有效期结束
order_valid_startstring订单(券码)有效期开始
pet_rulestring携带宠物规则
product_groupArray<object>商品组
service_phone_infoobject服务电话信息
suitable_groupint适用人群,1:成人,2:儿童,3:老年,4:学生,5:特殊人群,6:男士,7:女士,8:1 大 1 小,9:2 大 1 小,10:团体,11:情侣,12:通用人群,13:其他人群
ticket_typeint票种类型,1:单景点/门店单门票,2:游玩项目票,3:景区/门店含门票套餐,4:景区/门店不含门票套餐,5:景区交通票,6:演出票,7:景区餐饮票,8:景区/门店卡券,9:多景点联票,10:景区/门店服务,11:语音导览,12:人工讲解,13:景区纪念品,14:门店活动体验,15:其他票种

attribute.3001.add_bed_rule 说明:

参数名参数类型是否必须备注
add_bed_rulestring加床规则,文本,最多 200 个字
can_add_bedbool是否支持加床

attribute.3001.appointment_info 说明:

参数名参数类型是否必须备注
need_appointmentint是否需要提前预约,1-是,0-否
order_appointment_detail_urlstring查看订单预约结果链接
appointment_daysint提前多少天预约
appointment_detailstring预约补充说明,最多 500 字
appointment_phone_infoobject电话预约信息,appointment_type=1 时必填
appointment_typeint预约方式:1-电话,2-在线
appointment_urlstring外部预约链接

attribute.3001.appointment_info.appointment_phone_info 说明:

参数名参数类型是否必须备注
shop_phonestring不同门店不同预约电话,和商品适用商铺数保持一致,key:supplier_ext_id,value:电话列表,例子: {"supplier_ext_id1":["123456","123456"]}
unified_phoneArray<string>多门店统一预约电话:最多三个

注意:

  • 当传入appointment_phone_info时,shop_phoneunified_phone 不能都不传入,必须二选一或两者都传。

attribute.3001.breakfast_rule 说明:

参数名参数类型是否必须备注
add_breakfast_rulestring加早规则,文本,最多 200 个字
can_add_breakfastbool是否支持加早

attribute.3001.date_rule 说明:

参数名参数类型是否必须备注
increase_price_dateobject加价可用日期,与 unavailable_date 不可重复
unavailable_dateobject不可用日期

attribute.3001.date_rule.increase_price_date 说明:

参数名参数类型是否必须备注
weekday_listArray<int>星期列表,1-7 代表周一到周天,例子: [1,2] 代表周一周二不可用
date_listArray<string>日期列表,格式 yyyy-mm-dd,最多传 100 个 例子: ["2021-01-01", "2021-01-02"]
increase_price_rulestring加价规则,最多 1000 字

attribute.3001.date_rule.unavailable_date 说明:

参数名参数类型是否必须备注
date_listArray<string>日期列表,格式 yyyy-mm-dd,最多传 100 个 例子: ["2021-01-01", "2021-01-02"]
weekday_listArray<int>星期列表,1-7 代表周一到周天,例子: [1,2] 代表周一周二不可用

attribute.3001.groupon_detail 说明:

参数名参数类型是否必须备注
contentstring内容, type = 2 时,传图片的链接,例子:https://xxx.xx.xx
typeint类型,1:图片,2:文字

attribute.3001.notification 说明:

参数名参数类型是否必须备注
contentstring内容
titlestring使用须知标题

attribute.3001.product_group 说明:

参数名参数类型是否必须备注
cash_couponobject代金券,product_group_type=5 时必传
guest_roomobject客房信息,product_group_type=1 时必传
product_group_contentArray<object>商品内容,product_group_type=2,3,4,6 时必填
product_group_typeint商品组类型,1:客房,2:餐饮,3:景区门票,4:休闲娱乐,5:代金券,6:其他

attribute.3001.product_group.cash_coupon 说明:

参数名参数类型是否必须备注
coupon_contentstring商品内容,文本,最多 20 字
coupon_numint商品数量
coveragestring适用范围,文本,最多 100 字

attribute.3001.product_group.guest_room 说明:

参数名参数类型是否必须备注
room_numint房间数量
stay_numint入住天数
guest_numint入住人数
has_breakfastbool是否含早
room_detailstring适用房型信息

attribute.3001.product_group.product_group_content 说明:

参数名参数类型是否必须备注
contentstring内容
numint数量

attribute.3001.service_phone_info 说明:

参数名参数类型是否必须备注
shop_phonestring不同门店不同预约电话,和商品适用商铺数保持一致,key:supplier_ext_id,value:电话列表,例子: {"supplier_ext_id1":["123456","123456"]}
unified_phoneArray<string>多门店统一预约电话:最多三个

注意:

  • shop_phoneunified_phone 不能都不传入,必须二选一或两者都传。

attribute.9001 说明:

参数名参数类型是否必须备注
suitable_groupint适用人群,1:成人,2:儿童,3:老年 4:学生,5:特殊人群,6:男士,7:女士,8:1 大 1 小,9:2 大 1 小,10:团体,11:情侣,12:通用人群,13:其他人群
ticket_typeint票种类型,1:单景点/门店单门票,2:游玩项目票,3:景区/门店含门票套餐,4:景区/门店不含门票套餐,5:景区交通票,6:演出票,7:景区餐饮票,8:景区/门店卡券,9:多景点联票,10:景区/门店服务,11:语音导览,12:人工讲解,13:景区纪念品,14:门店活动体验,15:其他票种
is_confirm_immebool是否立即确认
is_need_pickbool是否需要取票
nearest_order_timeobject从当前时刻看,最早能被订到的门票时间
refund_policyint退款策略,1:随时退,2:不可退, 3:有条件退

attribute.9001.nearest_order_time 说明:

参数名参数类型是否必须备注
timestringtime_type 为 3 时该字段必选(yyyyMMdd 格式),time_type 为 4 时该字段必选(HH:mm 格式), time_type 为 5 时该字段必选(x 格式)
time_typeint时间格式,1:最早可订今日,2:最早可订明日, 3:最早可订 MM 月 dd 日, 4:HH:mm 前可订当日, 5:需提前 x 天预订

attribute.9101 说明:

参数名参数类型是否必须备注
contact_namestring商家联系人姓名
date_ruleobject使用日期规则
description_rich_textstring富文本格式的商品介绍,最大不超过 5mb
groupon_valid_endstring团购售卖时间结束
groupon_valid_startstring团购售卖时间开始
merchant_namestring商家名称
notificationArray<object>使用须知
notification_rich_textstring富文本格式的购买须知,最大不超过 5mb
order_limitint单个用户购买数量限制
order_valid_endstring券有效期结束
order_valid_startstring券有效期开始
pay_item_groupsArray<object>团购详情
post_purchase_dayint购买后 xxx 天内可使用
service_phoneArray<string>商家客服电话,最多传 3 个
sub_titlestring副标题,可选标题:过期退、随时退、x 日内可退,x>=3、免预约、提前 x 日预约,x>=1,多个以 | 分隔
suitable_groupint适用人群,1:成人,2:儿童,3:老年 4:学生,5:特殊人群,6:男士,7:女士,8:1 大 1 小,9:2 大 1 小,10:团体,11:情侣,12:通用人群,13:其他人群
ticket_typeint票种类型,1:单景点/门店单门票,2:游玩项目票,3:景区/门店含门票套餐,4:景区/门店不含门票套餐,5:景区交通票,6:演出票,7:景区餐饮票,8:景区/门店卡券,9:多景点联票,10:景区/门店服务,11:语音导览,12:人工讲解,13:景区纪念品,14:门店活动体验,15:其他票种

注意:

  • post_purchase_dayorder_valid_start&order_valid_end 是二选一关系,必须传入其中一个。

attribute.9101.date_rule 说明:

参数名参数类型是否必须备注
unavailable_dateobject不可用日期

attribute.9101.date_rule.unavailable_date 说明:

参数名参数类型是否必须备注
date_listArray<string>日期列表,格式 yyyy-mm-dd,最多传 100 个 例子: ["2021-01-01", "2021-01-02"]
weekday_listArray<int>星期列表,1-7 代表周一到周天,例子: [1,2] 代表周一周二不可用

attribute.9101.notification 说明:

参数名参数类型是否必须备注
contentstring内容
titlestring使用须知标题

attribute.9101.pay_item_groups 说明:

参数名参数类型是否必须备注
group_namestring标题
item_listArray<object>菜品

attribute.9101.pay_item_groups.item_list 说明:

参数名参数类型是否必须备注
countint数量
namestring菜名
priceint单价,分

请求体示例

团购商品示例

{
  "attribute": {
    "9101": {
      "groupon_valid_end": "2022-06-20 00:00:00",
      "groupon_valid_start": "2021-06-20 00:00:00",
      "order_valid_end": "2022-06-20 00:00:00",
      "order_valid_start": "2022-06-20 00:00:00",
      "notification": [
        {
          "title": "测试标题",
          "content": "测试内容"
        }
      ],
      "pay_item_groups": [
        {
          "group_name": "套餐商品",
          "item_list": [
            {
              "count": 1,
              "name": "老肥瘦",
              "price": 2000
            }
          ]
        }
      ],
      "service_phone": ["18500643444"],
      "sub_title": "过期退|随时退"
    }
  },
  "entry_info": {
    "entry_miniApp": {
      "params": "{\"id\":43235}",
      "path": "pages/goodsDetail/goodsDetail/3"
    }
  },
  "image_list": ["http://xxxxx.xxxx"],
  "name": "xxxxxxx",
  "origin_price": 20200,
  "price": 16200,
  "spu_ext_id": "test-sync-spu-1",
  "spu_type": 91,
  "status": 1,
  "stock": 999,
  "supplier_ext_id_list": ["test-1"]
}

门票商品示例

{
  "attribute": {
    "9001": {
      "is_need_pick": true,
      "nearest_order_time": {
        "time_type": 5,
        "time": "3"
      },
      "refund_policy": 1,
      "is_confirm_imme": true,
      "suitable_group": 13,
      "ticket_type": 15
    }
  },
  "entry_info": {
    "entry_miniApp": {
      "params": "{\"id\":43235}",
      "path": "pages/goodsDetail/goodsDetail/3"
    }
  },
  "image_list": ["http://xxxxxx.xxxx.xx"],
  "name": "xxxxxxx",
  "origin_price": 20200,
  "price": 16200,
  "spu_ext_id": "test-sc-spu-1",
  "spu_type": 90,
  "status": 1,
  "stock": 999,
  "supplier_ext_id_list": ["test-1"]
}

预售券商品示例

{
  "attribute": {
    "3001": {
      "service_phone_info": {
        "shop_phone": "{\"test-2\": [\"asdads\", \"asdasdasd\"]}",
        "unified_phone": ["xxxxxxx"]
      },
      "product_group": [
        {
          "guest_room": {
            "guest_num": 72,
            "has_breakfast": false,
            "room_detail": "xxxxxx",
            "stay_num": 15,
            "room_num": 20
          },
          "product_group_type": 1
        }
      ],
      "order_valid_start": "2021-09-26 00:00:00",
      "order_valid_end": "2021-10-23 23:59:59",
      "notification": [
        {
          "content": "xxxx",
          "title": "xxxxx"
        }
      ],
      "groupon_valid_start": "2021-09-26 16:54:54",
      "groupon_valid_end": "2021-10-23 23:59:59",
      "groupon_detail": [
        {
          "content": "http://xxxxx",
          "type": 1
        },
        {
          "content": "测试文本",
          "type": 2
        },
        {
          "content": "http://xxxxxx",
          "type": 1
        }
      ],
      "appointment_info": {
        "appointment_url": "https://xxxxx",
        "need_appointment": 1,
        "order_appointment_detail_url": "https://xxxxxx",
        "appointment_type": 1,
        "appointment_phone_info": {
          "shop_phone": "{\"test-2\": [\"asdads\", \"asdasdasd\"]}",
          "unified_phone": ["14734839632"]
        },
        "appointment_detail": "xxxxxxx",
        "appointment_days": 123
      }
    }
  },
  "entry_info": {
    "entry_miniApp": {
      "path": "page/index/index",
      "params": "{\"poi\":\"6601248937917548558\"}"
    }
  },
  "image_list": ["http://xxxxx.xxxxx"],
  "name": "xxxxxxx",
  "origin_price": 6109,
  "price": 615,
  "spu_ext_id": "test-presale-0001",
  "spu_type": 30,
  "status": 1,
  "stock": 99,
  "supplier_ext_id_list": ["test-2"]
}

响应

响应体

参数名参数类型备注
errnoint错误码
messagestring错误信息
dataobject

data 说明:

参数名参数类型备注
spu_idstring抖音 SPU ID

响应体示例

{
  "errno": 0,
  "message": "success",
  "data": {
    "spu_id": "702066657411231231"
  }
}

错误码

错误码message
40001参数错误
40003找不到相关第三方应用
40004找不到相关授权小程序
40020第三方应用 authorizer_access_token 不正确或者已过期
40051没有生活服务商品上传及分发权限
41301同步过于频繁,请稍后再试
41323保存分佣费率失败
41341预售券不可更新
点击纠错
评价此篇文档