抖音
  1. 预下单
抖音
  • 简介
  • 签名算法
  • 接口调用凭证
    • 经营能力调用凭证
      • BusinessToken 生成
      • BusinessToken 刷新
      • 经营能力当前状态查询
    • 非用户授权调用凭证
      • 获取应用授权调用凭证
      • getAccessToken
    • 用户授权调用凭证
      • 获取用户授权调用凭证
      • 刷新用户授权调用凭证
      • 刷新授权调用凭证
  • 登录
    • code2Session
      POST
  • 小程序码与小程序链接
    • Schema 链接
      • 生成SchemaV2
      • 查询SchemaV2
      • 查询Schema配额V2
    • Link链接
      • 生成 Link V2
      • 查询 Link 配额V2
      • 查询 Link V2
    • 二维码
      • 生成QRCodeV2
  • 私域经营
    • 私信管理
      • IM主动授权webhook
      • 主动发送私信
    • 群聊管理
      • 粉丝群webhook
        • 用户加群申请 webhook
        • 用户加群webhook
      • 查询群信息
      • 设置进群问候语&群公告
      • 创建粉丝群
      • 取消进群问候语&群公告配置
      • 变更用户入群申请状态
      • 查询用户剩余建群额度
      • 查询群主所在群的用户入群申请状态
    • 经营工具
      • 小程序引导卡片
        • 创建/更新小程序引导卡片模板
        • 查询小程序引导卡片模板
        • 删除小程序引导卡片模板
      • 图片上传
  • 线索组建
    • 创建线索组件
    • 查询已创建的线索组件
    • 更新线索组件
    • 删除线索组件
  • 视频能力
    • 视频数据查询
      • 查询特定视频的视频数据
    • 近 30 天用户视频数据
      • 获取视频基础数据
      • 获取视频点赞数据
      • 获取视频评论数据
      • 获取视频播放数据
      • 获取视频分享数据
    • 视频评论数据
      • 置顶评论
      • 评论回复列表
      • 评论列表
      • 回复视频评论
    • videoid转换itemid
    • itemid转换encryptid
  • 搜索能力
    • 创建抖音搜索直达子服务
    • 查询已创建的抖音搜索直达子服务列表
    • 删除抖音搜索直达子服务
    • 校验是否有搜索直达服务的创建权限
  • 电商
    • 注册小程序积分阈值
    • 注册小程序预览图
    • 查询订单的定制完成状态
    • 定制类小程序开发者注册信息
    • 退会
  • 生活服务
    • 店铺接入
      • 商铺同步
      • 查询店铺
      • 获取抖音POI ID
      • 店铺匹配任务结果查询
      • 店铺匹配状态查询
      • 提交门店匹配任务
      • 查询全部店铺信息接口(天级别请求5次)
      • 查询店铺全部信息任务返回内容
    • 商品库接入
      • (老版本)SKU同步
      • (老版本)sku拉取(该接口由接入方实现)
      • (老版本)多门店SPU同步
      • (老版本)多门店SPU状态同步
      • (老版本)多门店SPU库存同步
      • (老版本)多门店SPU信息查询
      • 创建/修改团购商品
      • 免审修改商品
      • 上下架商品
      • 同步库存
      • 查询商品模板
      • 查询商品草稿数据
      • 查询商品线上数据
      • 查询商品线上数据列表
      • 查询商品草稿数据列表
      • 用于创建多 SKU 商品。
      • 查询商品品类
    • 端内消息同步
      • 订单同步
    • poi数据接入
      • 获取POI基础数据
      • POI用户数据
      • POI服务基础数据
      • POI服务成交用户数据
      • POI热度榜
      • POI认领列表
    • poi基础能力
      • 通过高德POI ID获取抖音POI ID
    • 优惠卷接入
      • 优惠券同步
      • 优惠券更新
    • CPS佣金设置与查询
      • 通用佣金计划查询带货数据
      • 通用佣金计划查询达人带货数据
      • 通用佣金计划查询带货达人列表
      • 通用佣金计划查询达人带货详情
      • 查询通用佣金计划
      • 发布/修改通用佣金计划
      • 修改通用佣金计划状态
      • 发布/修改直播间定向佣金计划
      • 发布/修改短视频定向佣金计划
      • 修改定向佣金计划状态
      • 取消定向佣金计划指定的达人
      • 查询达人的定向佣金计划带货数据
      • 通过商品 ID 查询定向佣金计划
      • 查询定向佣金计划带货汇总数据
  • 用户信息
    • 用户抖音主页数据
      • 获取用户视频情况
      • 获取用户粉丝数
      • 获取用户点赞数
      • 获取用户评论数
      • 获取用户分享数
      • 获取用户主页访问数
  • 分享
    • 拍抖音任务
      • 拍抖音任务变更推送
      • 创建任务
      • 查询用户任务进度
    • 拍抖音互动任务
      • 拍抖音互动任务变更推送
      • 创建任务
      • 查询用户任务进度
    • 分享任务
      • 创建任务
      • 查询用户任务进度
  • 客服
    • CustomerServiceUrl
  • 小程序卷
    • 「小程序券」直播玩法接入指南
    • 小程序券API列表
    • 更新日志
    • 用户卷管理
      • 查询用户可用券信息
      • 用户领券结果回调通知
      • 用户撤销核销券
      • 用户手机号授权结果回调通知
      • 用户核销券
    • 主播授权管理
      • 查询主播发券配置信息
      • 修改主播发券权限状态
      • 更新主播发券库存上限
      • 主播发券权限配置
    • 卷模版管理
      • 查询授权用户发放的活动信息
      • 创建券模板
      • 修改券模板
      • 删除券模板
      • 修改券模板库存
      • 修改券模板状态
      • 查询券模板发放统计数据
      • 查询券模板
      • 查询对账单
    • 接口发放管理
      • 创建开发者接口发券活动
      • 开发者接口发券
      • 删除开发者接口发券活动
  • 交易系统
    • 通用交易系统
      • 通用参数
      • 进件
        • 接口进件
          • 图片上传
          • 发起进件
          • 进件查询
        • 获取进件页面链接
          • 开发者获取小程序收款商户/合作方进件页面
          • 服务商获取小程序收款商户进件页面
          • 服务商获取服务商进件页面
          • 服务商获取合作方进件页面
      • 标签
        • 查询标签组信息
      • 订单
        • 查询CPS信息
        • 查询订单信息
        • 支付结果回调
      • 退款
        • 发起退款
        • 查询退款
        • 同步退款审核结果
        • 退款申请回调扩展点
        • 退款结果通知
      • 履约
        • 推送履约状态
      • 结算
        • 发起分账
        • 查询分账
        • 通知分账结果
      • 提现
        • 接口提现
          • 商户余额查询
          • 商户提现
          • 商户提现结果查询
        • 获取提现页面链接
          • 开发者获取小程序收款商户/合作方提现页面
          • 服务商获取小程序收款商户提现页面
          • 服务商获取服务商提现页面
          • 服务商获取合作方提现页面
      • 获取对账单
        • 获取资金账单
        • 获取交易账单
    • 生活服务交易系统(金融合板)
      • 通用参数
      • 错误码和返回码
      • 查询接口
        • 查询订单信息
        • 查询券状态信息
        • 查询 CPS 信息
      • 预下单
        • 预下单扩展点
        • 开发者发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销算价扩展点
      • 支付
        • 支付结果通知
      • 核销
        • 抖音码
          • 验券准备
          • 验券
          • 撤销核销
          • 券码核销通知
          • 撤销核销通知
        • 三方码
          • 推送核销状态
          • 撤销核销
      • 分账
        • 查询分账
      • 退货退款
        • 开发者发起退款
        • 同步退款审核结果
        • 查询退款
        • 退款扩展点
        • 退款结果通知
    • 生活服务交易系统(账号融合版)
      • 错误码和返回码
      • 通用参数
      • 预约
        • 创建预约单
        • 预约接单结果回调
        • 商家取消预约
        • 用户取消预约
        • 查询预约单信息
        • 预约接单超时回调
        • 预约取消/完成通知
      • 查询接口
        • 查询订单信息
        • 查询券状态信息
        • 查询CPS信息
      • 预下单
        • 预下单回调
          POST
        • 关闭订单
          POST
        • 发起下单
          POST
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销信息扩展点
        • 算价扩展点
        • 营销查询算价二合一
      • 支付
        • 通知支付结果
      • 核销
        • 抖音码
          • 验券准备
          • 验券
        • 三方码
          • 推送核销状态
        • 核销工具
          • 查询用户券列表
          • 查询订单可用门店
          • 券核销消息通知
          • 撤销核销消息通知
          • 设置商家展示信息
          • 查询商家配置文案
          • 设置订单详情页按钮白名单接口
          • 设置小程序跳转path
      • 分账
        • 发起分账
        • 查询分账
        • 通知分账结果
      • 退货退款
        • 发起退款
        • 同步退款审核结果
        • 查询退款
        • 退款申请回调
        • 通知退款结果
    • 行业交易系统
      • API 调用
        • 通用参数
        • 错误码和返回码
      • 回调设置
        • 设置回调地址
        • 查询回调地址
      • 预下单
        • 查询 CPS 信息
        • 查询订单信息
        • 预下单回调
        • 开发者发起下单
      • 营销算价
        • 营销算价扩展点介绍
        • 查询营销信息扩展点
        • 设置扩展点
        • 算价扩展点
    • 支付
      • 通知支付结果
    • 核销
      • 抖音码
        • 验券准备
        • 验券
        • 查询劵状态信息
      • 三方码
        • 推送核销状态
      • 分账
        • 发起分账
        • 查询分账
        • 通知分账结果
    • 提货退款
      • 开发者发起退款
      • 同步退款审核结果
      • 查询退款
      • 退款申请回调
      • 通知退款结果
  • 内容安全
    • 内容安全检测
    • 图片检测V2
    • 图片检测V3
  • 泛知识
    • 角色系统
      • 错误码
      • 上传材料
      • 代运营服务商帮老师或代运营模式机构入驻
      • 自营机构/服务商入驻
      • 新增角色
      • 查询基础认证资质
      • 更新基础认证资质
      • 查询类目认证资质
      • 更新类目认证资质
      • 添加类目认证资质
      • 获取审核任务详情
      • 小程序绑定角色
      • 小程序解除绑定角色
      • 查询小程序已绑定的角色
      • 角色授权小程序
      • 解除授权小程序
      • 查询授权小程序
      • 更新授权小程序授权信息
      • 查询抖音号绑定、能力授权
      • 新增抖音号绑定、能力授权
      • 解除抖音号绑定、解除能力授权
      • 查询实体ID
      • 查询实体已绑定抖音号列表
    • 课程库
      • 【泛知识】回调通知
      • 【泛知识】课程库 FAQ
      • 【泛知识】错误码
      • 【泛知识】上传课程资源
      • 【泛知识】查询课程资源上传状态
      • 【泛知识】查询资质
      • 【泛知识】添加课程
      • 【泛知识】修改课程
      • 【泛知识】修改课程状态
      • 【泛知识】查询课程
      • 【泛知识】修改课程免审
      • 【泛知识】查询免审课程
      • 【泛知识】修改商品退款规则
      • 【泛知识】查询可选退款规则
      • 【泛知识】查询课程类目信息
  • 担任支付
    • 进件
      • 进件状态回调
      • 发起进件请求
      • 图片上传接口
      • 进件状态查询
    • 支付
      • 支付结果回调
      • 支付常见问题
      • 预下单接口
      • 唤起收银台
      • 支付结果查询
    • 退款
      • 退款结果回调
      • 退款常见问题
      • 发起退款
      • 退款结果查询
    • 结算及分账
      • 收费规则
      • 结算及分账常见问题
      • 自动结算
        • 自动结算接入说明
        • 自动结算结果回调
        • 自动结算结果查询
      • 发起结算及分账
      • 结算及分账结果查询
      • 结算及分账结果回调
      • 可分账余额查询
    • 退分账
      • 发起退分账
      • 查询分账回退结果
    • 提现
      • 商户余额查询
      • 商户提现
      • 商户提现结果查询
      • 商户提现回调
    • 获取对账单
      • 获取交易账单
      • 获取资金账单
    • 接口获取页面链接
      • 进件
        • 开发者获取小程序收款商户/合作方进件页面
        • 服务商获取小程序收款商户进件页面
        • 服务商获取服务商进件页面
        • 服务商获取合作方进件页面
      • 提取
        • 开发者获取小程序收款商户/合作方提现页面
        • 服务商获取小程序收款商户提现页面
        • 服务商获取服务商提现页面
        • 服务商获取合作方提现页面
    • 订单推送
      • 订单同步
  • 评价
    • 获取评价数据
  • 其他
    • 用户登录态签名
    • 抖音开放平台与小程序视频打通能力
      • 抖音开放平台与小程序视频打通能力
      • 视频使用能力能力
    • 开放能力配置接口
      • 开放能力配置接口
      • 配置开放能力实现接口
      • 查询生效中配置接口
    • 解决方案测试实体管理接口
      • 解决方案测试实体管理接口
      • 新增测试实体接口
      • 查询测试实体接口
      • 删除测试实体接口
    • 直播间自定义封面
    • 上传资源
    • 能力申请
    • 查询能力申请状态
  • 订阅消息
    • 查询订阅消息模版库
    • 发送订阅消息
    • 查询小程序的模版列表
    • 添加模板
    • 删除已添加的模版
    • 查询新建订阅消息模板列表
    • 新建订阅消息模板
  • 小程序推广计划
    • 短视频任务
      • 创建任务
        • 小程序任务台能力
        • 创建任务
      • 查询任务台任务投稿视频数据(明细)
      • 查询任务台任务投稿视频数据
      • 查询小程序任务台任务 ID
      • 更新任务状态
      • 重新提交任务基础信息
      • 查询任务详情
      • 更新专属任务达人
      • 查询视频任务相关实时汇总数据
    • 直播间任务
      • 创建直播间任务
      • 更新直播间任务
  • 挂载
    • 自主挂载
      • 获取作者视频列表
      • 自主挂载存量视频绑定锚点
      • 自主挂载存量视频解绑锚点
    • 小程序直播挂载黑白名单管理能力
    • 拍抖音黑白名单管理能力
    • 申请短视频自主挂载能力
    • 查询短视频自主挂载能力申请状态
    • 申请直播自主挂载能力
    • 查询直播自主挂载能力申请状态
    • 申请短视频达人推广挂载能力
    • 查询短视频达人推广挂载能力申请状态
    • 查询直播达人推广挂载能力申请状态
    • 申请直播达人推广挂载能力
    • 短视频/直播自主挂载能力绑定抖音号
    • 获取短视频/直播自主挂载抖音号绑定二维码
    • 查询短视频/直播自主挂载能力绑定抖音号列表
    • 解除短视频/直播自主挂载能力抖音号绑定
    • 挂载权限校验
    • 修改短视频锚点配置
    • 查询短视频锚点配置
    • 查询短视频锚点配置修改记录及状态
    • 图片上传
    • 图片审核状态查询
    • 图片删除
    • 设置全局默认配置
    • 设置指定页面配置
    • 查询全局默认配置
    • 查询指定页面配置
    • 删除指定页面配置
    • 讲解卡动态更新
  • 分发
    • 添加小程序别名
    • 查询小程序别名
    • 修改小程序别名
    • 删除小程序别名
    • 设置小程序搜索标签
    • 查询小程序搜索标签列表
  • 引导关注抖音号
    • 绑定抖音号
    • 获取抖音号绑定二维码
    • 获取绑定抖音号列表
    • 解除抖音号绑定
  • 数据分析
    • 用户分析
      • 行为分析
      • 实时分析
      • 留存分析
      • 来源分析
      • 用户画像
      • 终端分析
      • 页面分析
    • 交易分析
      • 总览分析
      • 流量转化
      • 短视频交易分析
      • 获取直播房间数据
      • 直播数据分析
      • 直播交易分析
      • 商品分析
    • 短视频分析
      • 短视频投稿数据
      • 短视频总览数据
      • 短视频详细数据
      • 流量来源
    • 直播分析
      • 直播间详细数据
        • 接口 1
        • 接口 2
      • 直播间总览数据
      • 主播分析
    • 小房子直播分析
      • 小房子直播间总览数据
      • 小房子直播间详细数据
      • 小房子直播间订单数据
    • 留资分析
      • 组件使用数据
      • 流量来源
      • 组件详细数据
      • 组件使用对比
  • 服务类目
    • 获取已设置的服务类目
  • 直播间能力
    • 查询跳转抖音直播间能力申请状态
    • 申请跳转抖音直播间能力
    • 查询直播间状态组件能力申请状态
    • 申请直播间状态组件能力
  • 抖音开放能力
    • 查询抖音开放能力列表
    • 申请开通抖音开放能力
    • 查询scope配额详情
    • scope申请提额
    • 查询视频关键词列表
    • 新增视频关键词
    • 删除视频关键词
  • 页面结构自定义
    • 查询页面结构自定义能力申请状态
    • 申请页面结构自定义能力
  • 普通二维码绑定
    • 查询普通二维码绑定列表
    • 新增绑定二维码
    • 更新绑定二维码链接
    • 更新绑定二维码状态
    • 删除绑定二维码链接
  • 抖音号绑定
    • 获取抖音号绑定所需的资质模版列表
    • 获取抖音号绑定所需的资质模版信息
    • 输入抖音号绑定
    • 获取抖音号绑定二维码
    • 查询抖音号绑定列表及状态
    • 解除抖音号绑定
  • 流量主
    • 查询流量主开通状态
    • 开通流量主
    • 查询广告位列表
    • 新增广告位
    • 更新广告位状态
    • 查询广告收入
    • 查询广告结算单列表
  • 抖店绑定
    • 绑定抖店开放平台账号
    • 查询绑定的抖店开放平台账号信息
    • 配置抖店开放平台应用
    • 查询配置的抖店开放平台应用信息
    • 获取绑定抖店账号信息
  1. 预下单

发起下单

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/api/apps/trade/v2/create_order

如果用户抖音版本过低,无法使用前端 JSAPI 下单,开发者可用该接口替用户发起下单。

使用限制

预下单 OpenAPI 只针对低版本(低于抖音 19.7.0,基础库 20.43.0.3 版本)使用,我们会统计此类订单占比,如果发现违规使用,会进行惩处。当低版本减少后,会下掉该接口,请不要应用于其它场景,否则会影响业务。

接口说明

该接口发起的下单流程中不会有预下单回调。前端 JS API 下单与服务端 OpenAPI 下单的流程区别如下:

img

请求参数

名称类型是否必填描述
goods_listArray否,goods_list 和 sku_list 二选一传入,不能都为空商品信息,详情见字段描述
sku_listArray否,goods_list 和 sku_list 二选一传入,不能都为空商品sku信息,详情见 sku_list 说明
cp_book_infoobject否 门票类商品下单必传预约信息
total_amountint64是订单总价,单位分
phone_numstring否用户手机号,长度 <= 128 byte
contact_namestring否用户姓名,长度 <= 64 byte
extrastring否下单备注信息,长度 <= 2048byte
open_idstring是用户 OpenID
pay_notify_urlstring否支付结果通知地址,必须是 HTTPS 类型。 若不填,默认使用在行业模板配置-消息通知的支付结果通知地址。
out_order_nostring是开发者的单号,长度 <= 64 byte
pay_expire_secondsint64否支付超时时间,单位秒,例如 300 表示 300 秒后过期;不传或传 0 会使用默认值 300,最大不能超过48小时。
order_entry_schemaobject是订单详情页信息,详情见字段描述
cp_extrastring否开发者自定义透传字段,不支持二进制,长度 <= 2048 byte
discount_amountint64否折扣金额,单位分
price_calculation_detailobject否营销算价结果信息,详情见字段描述

goods_list 字段

POI 商品会从商品库里查询商品信息,不会使用开发者传的数据。

名称类型是否必填描述示例值
goods_imagestring否商品图片链接,长度 <= 512 byte 注意:非 POI 商品必传https://xxx
goods_titlestring否商品标题/商品名称,长度 <= 256 byte 注意:非 POI 商品必传火锅团购
labelsstring否商品标签,最多设置三个标签,例如:随时退|免预约|提前3日预约(“|”是中文类型),详见 pay-button 支付 的 type 的合法值 部分,注意不是 good-type 的合法值。 注意:非 POI 商品必传随时退|免预约
date_rulestring否使用规则,如 “周一至周日可用”、“周一至周五可用”、“非节假日可用”,默认“周一至周日可用”周一至周日可用
priceint64否商品价格,单位(分) 注意:非 POI 商品必传100
quantityint32是商品数量1
goods_idstring是商品 idgoods_1
goods_id_typeint32是商品 id 类别, POI 商品传 1 非 POI 商品传 21
goods_pageobject否商品详情页,详情见字段描述
order_valid_timeobject否券的有效期,详情见字段描述 注意: 非 POI 商品必传,POI 商品会从 POI 库里查询有效期信息,不会使用开发者传的数据。 如果是非 POI 商品,每个 goods_id 都要传券的有效期信息,否则会下单失败。
discount_amountint64否折扣金额,单位分1
goods_book_infoobject否预约信息,详情见字段描述 注意:需要预约的商品必传
merchant_uidstring否开发者自定义收款商户号,须申请白名单

goods_page 字段

名称类型是否必填描述示例值
pathstring否商品详情页路径,长度 <= 512bytegoods/info
paramsstring否商品详情页路径参数,长度 <= 512byte{"id":"12312"}

order_entry_schema 字段

名称类型是否必填描述示例值
pathstring是订单详情页跳转路径,没有前导的“/”,长度 <= 512bytepages/xxxindexxx
paramsstring否订单详情页路径参数,自定义的 json 结构,序列化成字符串存入该字段,平台不限制,但是写入的内容需要能够保证生成访问订单详情的 schema 能正确跳转到小程序内部的订单详情页,长度 <= 512byte{"id":"xxxxxx"}

order_valid_time 字段

名称类型是否必填描述示例值
valid_start_timeint64否券的有效期开始时间,单位毫秒,须大于 0
valid_end_timeint64否券的有效期结束时间,单位毫秒,须大于 0,且须大于 valid_start_time 和当前时间
valid_durationint64否券的相对有效时间,单位毫秒,须大于 0 与 valid_start_time、valid_end_time 组合,至少回传一个,否则会下单失败 都合法优先使用 valid_start_time、valid_end_time 组合 当 valid_duration 有效时, 券的有效期开始时间 S = 订单支付完成时间 券的有效期结束时间 E = 1天 + 向下按天截断(S + valid_duration))。 例如:valid_duration = 86400000 ms(一天),S = 2021.1.1 6:00,E = 2021.1.3 00:00100000

sku_list 字段说明

poi 商品会从商品库里查询商品信息,不会使用开发者传的数据

  • sku 为商品库,对应的 goods 必须是商品库
  • sku 为商品库商品,goodsInfo 可以不传
  • sku 为非商品库商品,需要传 goodsInfo
名称类型是否必填描述
quantityInt32是下单SKU数量
sku_idstring是商品sku_id
sku_id_typeint32是sku_id类型 1-商品库skuId 2-非商品库skuId sku_id 为 POI商品库的sku_id时 ,goods_info 可以不传入 sku_id 为 非POI 商品库的sku_id时,goods_info必传
priceInt64否 非poi的SKU必传SKU价格
discount_amountint64否优惠金额,单位(分)
attsobject否sku属性
goods_infoobject否商品信息,详情见 goods_info 字段

atts 字段说明

名称类型是否必填描述
ticket_namestring否 非POI商品库的门票类SKU必传门票-票种类型,长度 <= 128 byte
datestring否 非POI商品库的门票类SKU必传门票日期,示例 2006-01-02,日期格式需为 yy-mm-dd

goods_info 字段说明

名称类型是否必填描述
goods_imagestring否 非poi商品必传商品图片链接,长度 <= 512 byte
goods_titlestring否 非poi商品必传商品标题/商品名称,长度 <= 256 byte
labelsstring否 非poi商品必传商品标签,最多设置三个标签,例如:随时退|免预约|提前3日预约(“|”是中文类型),详见 pay-button 支付 的 type 的合法值 部分,注意不是 good-type 的合法值。 注意:非 POI 商品必传
date_rulestring否使用规则,如 “周一至周日可用”、“周一至周五可用”、“非节假日可用”,默认“周一至周日可用”
goods_idstring是商品id
goods_id_typeint32是商品id类别,poi商品传 1,非poi商品传 2
goods_pageobject否商品详情页,详情见 goods_page 说明
order_valid_timeobject否 非poi商品必传券的有效期,注意: 非poi商品必传,poi商品会从poi库里查询有效期信息,不会使用开发者传的数据 如果是非poi商品,每个goods_id都要传券的有效期信息,否则会下单失败 详情见 order_valid_time 说明
goods_book_infoobject否 预售券商品必传 门票商品不用传入预约信息,详情见 goods_book_info说明

cp_book_info 字段说明

名称类型是否必填描述
out_book_nostring是外部预约单号
item_book_info_listArray是每个item的预约信息,详见 ItemBookInfo

ItemBookInfo 字段说明

名称类型是否必填描述
poi_idstring是预约门店的poiId
shop_namestring是预约门店的名称,参考商铺同步接口中的店铺名称(name)
ext_shop_idstring是预约门店的外部店铺id,参考商铺同步接口中的接入方店铺id(supplier_ext_id)
goods_idstring否预约的商品id
sku_idstring否 goods_id 和 sku_id 只能二选一传入 使用 sku_list 下单,传入 sku_id 即可预约的sku_id
book_start_timeint64是预约的开始时间(ms),13位毫秒时间戳
book_end_timeint64是预约的结束时间(ms),13位毫秒时间戳
user_info_listArray否用户信息,详见UserInfo

UserInfo 字段说明

名称类型是否必填描述
namestring否使用人名称
phonestring否电话号码
id_card_nostring否身份证号码

price_calculation_detail 字段

名称类型是否必填描述示例值
calculation_typeint32是算价类型, 1:商户单维度,item 单价格按分摊比例计算。 2:item 单维度,item 单价格由开发者计算。1
goods_discount_detailArray否商品算价结果,详情见字段描述
order_discount_detailobject否订单算价结果,详情见字段描述
item_discount_detailArray否单商品算价结果,详情见字段描述

goods_discount_detail 字段

名称类型是否必填描述示例值
goods_idstring是商品 id,此处为课程 id,注意这里是 string 类型goods_1
quantitynumber是购买数量1
total_amountnumber是商品总价,单位分100
total_discount_amountnumber是该商品总优惠金额,该商品的实付金额 = total_amount - total_discount_amount20
marketing_detail_infoArray否营销明细,详情见字段描述

order_discount_detail 字段

名称类型是否必填描述示例值
order_total_discount_amountnumber是订单维度总优惠金额,单位分10
goods_total_discount_amountnumber是商品(SKU)维度总优惠金额,单位分10
marketing_detail_infoArray否营销明细,详情见字段描述

item_discount_detail 字段

名称类型是否必填描述示例值
goods_idstring是商品 idgoods_1
total_amountnumber是商品总价,单位分100
total_discount_amountnumber是该商品总优惠金额 该商品的实付金额 = total_amount - total_discount_amount20
marketing_detail_infoArray否营销明细,详情见字段描述

marketing_detail_info 字段

名称类型是否必填描述示例值
idstring是营销 id(用户身份 id、优惠券 id、积分 id 或者活动 id)activity_id_12
typenumber是营销类型: 1:用户身份 2:优惠券 3: 积分 4:活动4
discount_amountnumber是该营销策略优惠金额,单位分10
titlestring是营销名称[活动] 满 10.00 减 7.00 元
notestring否营销备注活动优惠
discount_rangenumber是优惠范围1
subtypestring否营销子类型商家侧子营销类型
valuei64否不同 type 含义不同,若 type = 3,value 则为积分值

goods_book_info 字段

名称类型是否必填描述示例值
book_typeint32是预约类型, 1:不需要预约 2:在线预约2
cancel_policyint32否取消政策, 1:预约后不可取消 2:预约后可取消 3:预约中可取消,预约成功须提前x小时取消1
cancel_advance_hourint64否提前取消的小时限制1

请求示例

商品库 good_list 下单

curl --location --request POST 'https://open.douyin.com/api/apps/trade/v2/create_order'\

--header 'Content-Type: application/json' \

--header 'access-token: clt.xxx' \

--data-raw='{

"goods_list": [

​ {

​ "quantity": 1,

​ "price": 100,

​ "goods_title": "火锅团购",

​ "goods_image": "https://xxx",

​ "labels": "随时退|免预约",

​ "goods_id": "goods_1",

​ "goods_id_type": 2,

​ "discount_amount": xxx,

​ "date_rule": "周一至周日可用",

​ "goods_page": {

​ "path": "goods/infoxxxx",

​ "params":"{"id":"xxxxxx"}"

​ },

​ "order_valid_time": {

​ "valid_duration": 100000

​ },

​ "goods_book_info": {

​ "book_type": 2,

​ "cancel_policy": 1

​ },

​ "merchant_uid":"商户号xxx"

​ }

],

"total_amount": 100,

"discount_amount": 20,

"app_id": "tt07e3715e98c9aac0",

"phone_num": "19273654356",

"contact_name": "张三",

"extra": "xxx",

"open_id": "xxx",

"out_order_no": "132324",

"pay_notify_url":"https://xxxx",

"pay_expire_seconds": 500,

"order_entry_schema": {

​ "path":"pages/xxxindexxxx",

​ "params":"{"id":"xxxxxx"}"

},

"cp_extra": "xxxxx",

"price_calculation_detail": {

​ "calculation_type": 1,

​ "order_discount_detail": {

​ "goods_total_discount_amount": 1,

​ "marketing_detail_info": [

​ {

​ "discount_amount": 10,

​ "discount_range": 1,

​ "id": "activity_id_xxxxxxx",

​ "note": "活动优惠",

​ "subtype": "商家侧子营销类型",

​ "title": "[活动] 满 10.00 减 7.00 元",

​ "type": 4

​ },

​ {

​ "discount_amount": 10,

​ "discount_range": 2,

​ "id": "coupon_id_xxxxxxx",

​ "note": "用券优惠",

​ "subtype": "商家侧子营销类型默认值",

​ "title": "[券] 减 0.01 元",

​ "type": 2

​ }

​ ],

​ "order_total_discount_amount": 20

​ },

​ "goods_discount_detail": [

​ {

​ "goods_id": "goods_1",

​ "marketing_detail_info": [

​ {

​ "discount_amount": 10,

​ "discount_range": 1,

​ "id": "activity_id_xxxxxxx",

​ "note": "活动优惠",

​ "subtype": "商家侧子营销类型默认值",

​ "title": "[活动] 满 10.00 减 7.00 元",

​ "type": 4

​ },

​ {

​ "discount_amount": 10,

​ "discount_range": 2,

​ "id": "coupon_id_xxxxxxx",

​ "note": "用券优惠",

​ "subtype": "商家侧子营销类型默认值",

​ "title": "[券] 减 0.01 元",

​ "type": 2

​ }

​ ],

​ "quantity": 1,

​ "total_amount": 100,

​ "total_discount_amount": 20

​ }

​ ],

​ "item_discount_detail": [

​ {

​ "goods_id": "goods_1",

​ "marketing_detail_info": [

​ {

​ "discount_amount": 10,

​ "discount_range": 1,

​ "id": "activity_id_xxxxxxx",

​ "note": "活动优惠",

​ "subtype": "商家侧子营销类型默认值",

​ "title": "[活动] 满 10.00 减 7.00 元",

​ "type": 4

​ },

​ {

​ "discount_amount": 10,

​ "discount_range": 2,

​ "id": "coupon_id_xxxxxxx",

​ "note": "用券优惠",

​ "subtype": "商家侧子营销类型默认值",

​ "title": "[券] 减 0.01 元",

​ "type": 2

​ }

​ ],

​ "total_amount": 100,

​ "total_discount_amount": 20

​ }

​ ]

}

}'

非商品库 SKU、商品库 Goods 下单

curl --location --request POST 'https://open.douyin.com/api/apps/trade/v2/create_order'\

--header 'Content-Type: application/json' \

--header 'access-token: clt.xxx' \

--data-raw='{

"sku_list": [

{

​ "quantity": 2,

​ "sku_id": "7128346098909300749",

​ "sku_id_type": 2,

​ "price": 240,

​ "discount_amount": 0,

​ "goods_info": {

​ "date_rule": "周一至周日可用",

​ "goods_id": "7128346098909300749",

​ "goods_id_type": 1

​ }

}

],

"total_amount": 480,

"discount_amount": 0,

"phone_num": "31",

"contact_name": "且题化话",

"extra": "nisi sit",

"open_id": "xxxxxxx",

"out_order_no": "27753r4e5rrr7fer43",

"order_entry_schema": {

​ "path": "2qerrw"

}

}'

返回参数

item_order_detail_list

名称类型是否必填描述
item_order_idstring是item单id
pricei64是商品优惠后价格
goods_idstring是商品id
goods_id_typeint32是商品id类别, 1-商品库goods_id 2-非商品库商品goods_id
sku_idstring否商品sku_id
sku_id_typeint32否sku_id类型 1-商品库skuId 2-非商品库skuId

open_book_info** **字段说明

名称类型是否必填描述
book_idstring是预约单id
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/api/apps/trade/v2/create_order' \
--header 'access-token: clt.xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "goods_list": [
        {
            "quantity": 1,
            "price": 100,
            "goods_title": "火锅团购",
            "goods_image": "https://xxx",
            "labels": "随时退|免预约",
            "goods_id": "goods_1",
            "goods_id_type": 2,
            "discount_amount": xxx,
            "date_rule": "周一至周日可用",
            "goods_page": {
                "path": "goods/infoxxxx",
                "params":"{\"id\":\"xxxxxx\"}"
            },
            "order_valid_time": {
                "valid_duration": 100000
            },
            "goods_book_info": {
                "book_type": 2,
                "cancel_policy": 1
            },
            "merchant_uid":"商户号xxx"
        }
    ],
    "total_amount": 100,
    "discount_amount": 20,
    "app_id": "tt07e3715e98c9aac0",
    "phone_num": "19273654356",
    "contact_name": "张三",
    "extra": "xxx",
    "open_id": "xxx",
    "out_order_no": "132324",
    "pay_notify_url":"https://xxxx",
    "pay_expire_seconds": 500,
    "order_entry_schema": {
        "path":"pages/xxxindexxxx",
        "params":"{\"id\":\"xxxxxx\"}"
    },
    "cp_extra": "xxxxx",
    "price_calculation_detail": {
        "calculation_type": 1,
        "order_discount_detail": {
            "goods_total_discount_amount": 1,
            "marketing_detail_info": [
                {
                    "discount_amount": 10,
                    "discount_range": 1,
                    "id": "activity_id_xxxxxxx",
                    "note": "活动优惠",
                    "subtype": "商家侧子营销类型",
                    "title": "[活动] 满 10.00 减 7.00 元",
                    "type": 4
                },
                {
                    "discount_amount": 10,
                    "discount_range": 2,
                    "id": "coupon_id_xxxxxxx",
                    "note": "用券优惠",
                    "subtype": "商家侧子营销类型默认值",
                    "title": "[券] 减 0.01 元",
                    "type": 2
                }
            ],
            "order_total_discount_amount": 20
        },
        "goods_discount_detail": [
            {
                "goods_id": "goods_1",
                "marketing_detail_info": [
                    {
                        "discount_amount": 10,
                        "discount_range": 1,
                        "id": "activity_id_xxxxxxx",
                        "note": "活动优惠",
                        "subtype": "商家侧子营销类型默认值",
                        "title": "[活动] 满 10.00 减 7.00 元",
                        "type": 4
                    },
                    {
                        "discount_amount": 10,
                        "discount_range": 2,
                        "id": "coupon_id_xxxxxxx",
                        "note": "用券优惠",
                        "subtype": "商家侧子营销类型默认值",
                        "title": "[券] 减 0.01 元",
                        "type": 2
                    }
                ],
                "quantity": 1,
                "total_amount": 100,
                "total_discount_amount": 20
            }
        ],
        "item_discount_detail": [
            {
                "goods_id": "goods_1",
                "marketing_detail_info": [
                    {
                        "discount_amount": 10,
                        "discount_range": 1,
                        "id": "activity_id_xxxxxxx",
                        "note": "活动优惠",
                        "subtype": "商家侧子营销类型默认值",
                        "title": "[活动] 满 10.00 减 7.00 元",
                        "type": 4
                    },
                    {
                        "discount_amount": 10,
                        "discount_range": 2,
                        "id": "coupon_id_xxxxxxx",
                        "note": "用券优惠",
                        "subtype": "商家侧子营销类型默认值",
                        "title": "[券] 减 0.01 元",
                        "type": 2
                    }
                ],
                "total_amount": 100,
                "total_discount_amount": 20
            }
        ]
    }
}'
响应示例响应示例
{
  "data": {
    "order_id": "ot7072366682238",
    "out_order_no": "121321432",
    "pay_order_id": "12423414234",
    "pay_order_token": "544352343",
    "item_order_info_list": [
      {
        "item_order_id_list": [
          "ot70939408076069"
        ],
        "goods_id": "700843652",
        "item_order_detail": [
          {
            "item_order_id": "ot70939408076069",
            "price": 80
          }
        ]
      }
    ]
  },
  "extra": {
    "sub_error_code": 0,
    "sub_description": "success",
    "logid": "2022092115392201020812109511046",
    "now": 1663745962686,
    "error_code": 0,
    "description": "success"
  }
}

请求参数

Header 参数
Content-Type
string 
必需
示例值:
application/json
access-token
string 
必需
示例值:
clt.xxx
Body 参数application/json
goods_list
array [object {12}] 
可选
goods_list 和 sku_list 二选一传入,不能都为空
商品信息,详情见字段描述
quantity
integer 
可选
price
integer 
可选
goods_title
string 
可选
goods_image
string 
可选
labels
string 
可选
goods_id
string 
可选
goods_id_type
integer 
可选
date_rule
string 
可选
goods_page
object 
可选
order_valid_time
object 
可选
goods_book_info
object 
可选
merchant_uid
string 
可选
total_amount
integer 
订单总价,单位分
必需
discount_amount
integer 
必需
app_id
string 
必需
phone_num
string 
必需
contact_name
string 
必需
extra
string 
必需
open_id
string 
必需
out_order_no
string 
必需
pay_notify_url
string 
必需
pay_expire_seconds
integer 
必需
order_entry_schema
object 
必需
path
string 
必需
params
string 
必需
cp_extra
string 
必需
price_calculation_detail
object 
必需
calculation_type
integer 
必需
order_discount_detail
object 
必需
goods_discount_detail
array [object {5}] 
必需
item_discount_detail
array [object {4}] 
必需
示例

返回响应

🟢200成功
application/json
Body
data
object 
返回数据信息
可选
order_id
string 
必需
抖音开平侧生成的订单号
out_order_no
string 
必需
开发者系统生成的订单号
pay_order_id
string 
必需
调起收银台的支付订单号
pay_order_token
string 
必需
调起收银台的 token
item_order_info_list
array [object {3}] 
必需
商品 item_order 信息,详情见字段描述
extra
object 
额外信息
必需
sub_error_code
integer 
必需
sub_description
string 
必需
logid
string 
必需
now
integer 
必需
error_code
integer 
必需
description
string 
必需
上一页
关闭订单
下一页
营销算价扩展点介绍
Built with