plugin.booking
基础库 2.74.0.0 开始支持本方法。
该 API 为开发者交易系统提供预约能力。
使用限制
行业插件在抖音 App 版本 31.8.0 及以上,小程序基础库版本 3.4x.0.0 及以上时支持。
语法
plugin.booking(options);
参数说明
object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
orderId | string | -- | 是 | 预约关联订单号 | 2.51.0.0 |
outBookNo | string | -- | 是 | 外部预约单号,每次发起新的预约,都需要在三方侧保证唯一 | 2.51.0.0 |
bookInfo | ItemBookInfo[] | -- | 是 | 预约信息 | 2.51.0.0 |
markupInfo | MakrupInfo | -- | 否 | 加价信息 | 2.51.0.0 |
success | Function | -- | 否 | 接口调用成功的回调函数 | 2.51.0.0 |
fail | Function | -- | 否 | 接口调用失败的回调函数 | 2.51.0.0 |
complete | Function | -- | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 2.51.0.0 |
ItemBookInfo
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
poiId | string | -- | 是 | 预约门店的poiId | 2.51.0.0 |
shopName | string | -- | 是 | 预约门店的名称 | 2.51.0.0 |
outShopId | string | -- | 是 | 预约门店的外部店铺id | 2.51.0.0 |
goodsId | string | -- | 是 | 商品id | 2.51.0.0 |
bookStartTime | number | -- | 是 | 预订的开始时间(ms) | 2.51.0.0 |
bookEndTime | number | -- | 是 | 预订结束时间(ms) | 2.51.0.0 |
userInfo | UserInfo | -- | 否 | 留资信息 | 2.51.0.0 |
extra | BookExtra | -- | 否 | 预约扩展信息 | 2.51.0.0 |
skuInfo | SkuInfo | -- | 是 | 预约商品信息 | 2.51.0.0 |
itemOrderId | string | -- | 否 | 关联子单号 | 2.51.0.0 |
bookRangeType | number | 0 | 否 |
| 2.51.0.0 |
UserInfo
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
name | string | -- | 否 | 使用人名称 | 2.51.0.0 |
phone | string | -- | 否 | 电话号码 | 2.51.0.0 |
idCardNo | string | -- | 否 | 身份证号 | 2.51.0.0 |
BookExtra
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
bizType | number | -- | 是 | 预约类型
| 2.51.0.0 |
hotelTravel | string | -- | 否 | 酒旅信息 | 2.51.0.0 |
SkuInfo
加价信息
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
skuId | string | -- | 是 | 加价的skuId | 2.51.0.0 |
price | number | -- | 否 | 加价的价格 | 2.51.0.0 |
skuType | number | -- | 是 | sku类型 | 2.51.0.0 |
MarkupInfo
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
totalAmount | number | -- | 否 | 加价单需补总价 | 2.51.0.0 |
outMarkNo | string | -- | 否 | 加价单号 注:此字段与outMarkupNo含义相同,新版本将使用outMarkupNo | 2.51.0.0 |
outMarkupNo | string | -- | 否 | 加价单号 | 2.51.0.0 |
notifyUrl | string | -- | 否 | 通知地址 | 2.51.0.0 |
回调成功
object 类型,属性如下:
属性 | 类型 | 说明 | 最低支持版本 |
errMsg | string | 调用结果 | 2.51.0.0 |
回调失败
object 类型,属性如下:
属性 | 类型 | 说明 | 最低支持版本 |
errNo | string | 错误码 | 2.51.0.0 |
errMsg | string | 错误信息提示 | 2.51.0.0 |
errLogId | string | 该数据可供服务端排查问题 | 2.51.0.0 |
代码示例
const plugin = tt.requirePlugin('tta5a3d31e3aecfb9b11'); plugin.booking({ orderId: 'ORDER_ID', bookInfo: [ { bookStartTime: new Date().getTime() + 180000, bookEndTime: new Date().getTime() + 600000, bookRangeType:1, //非日历房不传,或者传0 outShopId: '123', goodsId: '7129406628369008654', poiId: "6814724893138110472", shopName: "lh测试商家", userInfo: [{ "id_card_no": '123456789012345678', "name": "tty", "phone": "12321234322" }], skuInfo: { price: 3, skuId: '123456788', skuType:2 } } ], markupInfo:{ totalAmount: 2, }, })
Bug & Tip
无
