小程序开放平台

文档中心
API 简介
登录
接口调用凭证
小程序码与链接
小程序基础信息
本地担保交易能力
业务接入流程
API列表
商品-获取信息
商品-批量获取信息
商品同步-生活服务
专业号主页商品排序
sku商品-批量删除
sku商品-批量上架
sku商品-批量下架
订单新增
订单-状态同步
获取订单支付token
担保支付订单-获取订单信息
凭证核销
预约单状态同步
发起预约
售后单-新增
同步售后单状态
获取售后订单详情
查询结算
结算咨询
结算明细查询
查询核销信息
通用担保交易能力
电商担保交易能力
地点管理能力
客服能力
群聊能力
小说能力
短剧能力
服务组件能力
直播能力

[交易组件]发起预约

开发
>
服务端 API
>
本地担保交易能力
>
API列表
>
发起预约
>
更新时间:2025-05-22 21:15:42

支持第三方调用

支持沙箱环境调用

禁止个人开发者调用

不支持直连支付

请求地址

POST https://miniapp.xiaohongshu.com/api/rmp/mp/deal/pre_sale/book

公共请求参数

名称
类型
是否必须
描述
app_idstring小程序appid
access_tokenstring小程序调用凭证

业务请求参数

名称
类型
是否必须
描述
product_typeint32商品类型,2=预售券,3=日历商品
open_idstring用户id
out_order_idstring外部订单id,预售券:表示主单订单id,日历商品:不需要传
out_product_idstring外部商品id,预售券:商品主品id即可(不需要传小品id),日历商品:预约品id
out_sku_idstring外部sku id,预售券:商品主品sku id即可(不需要传小品id),日历商品:预约品sku id
poi_idstring门店id,若订单的商品是分账到门店的商品,则必传
book_info
struct预约信息
out_book_order_id
string预约订单外部订单id
total_price
int64预约单总金额,预售券模式下可为0,即不需要补差价,单位到分
book_detail
list_struct预约明细,日历商品明细只有一条
voucher_code
string小红书侧凭证code,预售券:用于预约的凭证CODE,日历商品:不需要传
price
int64差价金额,预售券模式下可为0,即不需要补差价
check_in_date
string入住日期,yyyy-MM-dd格式
check_out_date
string离店日期,yyyy-MM-dd格式
pathstring商品小程序打开路径,/开头

请求示例

{
    "product_type":0,
    "open_id":"string",
    "out_order_id":"string",
    "out_product_id":"string",
    "out_sku_id":"string",
    "poi_id":"string",
    "book_info":{
        "out_book_order_id":"string",
        "total_price":0,
        "book_detail":[
            {
                "voucher_code":"string",
                "price":0,
                "check_in_date":"string",
                "check_out_date":"string"
            }
        ]
    },
    "path":"string"
}

响应参数

名称
类型
是否必须
描述
data
struct
out_order_id
string外部订单id,预售券:表示主单订单id,日历商品:不需要传
out_book_order_id
string预约订单外部订单id
pay_detail
struct支付明细,服务商基于该信息唤起收银台,如果是预售券不需要补差价,该字段为空
order_id
string小红书订单id,等待该订单的支付成功消息,成功之后认为预约流程完成,可以发起预约单状态同步流程
final_price
int64支付的订单总金额,单位到分
pay_token
string订单支付用token,用于拉起小程序支付api
expired_time
int64订单支付到期时间,时间戳精确到秒
book_result
list_struct预约结果信息,服务商需要建立mapping关系,日历商品只有1个
book_id
string小红书侧预约id,服务商侧建立mapping关系,后续的预约单状态同步,退款交互都基于该单号
voucher_code
string小红书侧凭证code,日历商品订单该字段为空
successbool是否成功
msgstring说明,正确响应时为 success,错误响应时为错误描述
codeint32错误码,正确响应时为 0,错误响应时非0

响应示例

{
    "data":{
        "out_order_id":"string",
        "out_book_order_id":"string",
        "pay_detail":{
            "order_id":"string",
            "final_price":0,
            "pay_token":"string",
            "expired_time":0
        },
        "book_result":[
            {
                "book_id":"string",
                "voucher_code":"string"
            }
        ]
    },
    "success":true,
    "msg":"string",
    "code":0
}

业务错误码

参见错误码