抖音开放平台Logo
开发者文档
小程序
控制台
  • OpenAPI 简介
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 触达与营销
  • 支付
  • 运营
  • 生活服务
  • 核销工具解决方案
  • 通用能力
  • poi基础能力
  • CPS佣金设置与查询
  • 生活服务交易系统（全融合版）
  • 通用参数
  • 错误码和返回码
  • 查询接口
  • 预下单
  • 预下单扩展点
  • 开发者发起下单
  • 营销算价
  • 支付
  • 核销
  • 分账
  • 退货退款
  • 生活服务交易系统（账号融合版）
  • 历史版本（不推荐使用）
  • 垂直行业
  • 其它
    • 如果用户抖音版本过低，无法使用前端模板下单，开发者可用该接口替用户发起下单。

    使用限制

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

    接口说明

    该接口发起的下单流程中不会有预下单回调。前端模板/JSAPI 下单与服务端 OpenAPI 下单的流程区别如下：

    基本信息

    基本信息
    HTTP URL
    https://open.douyin.com/api/apps/trade/v2/order/create_order
    HTTP Method
    POST
    Scope
    industry_open.trade.order_create
    权限要求
    不需要用户授权

    请求头

    参考通用参数

    请求参数

    名称
    类型
    是否必填
    描述
    示例值
    goods_list
    Array<object>
    是
    商品信息，详情见goods_list 字段。
    见请求示例
    total_amount
    int64
    是
    订单总价，单位分
    100
    phone_num
    string
    否
    用户手机号，长度 <= 128 byte
    1927365435
    contact_name
    string
    否
    用户姓名，长度 <= 64 byte
    张三
    extra
    string
    否
    下单备注信息，长度 <= 2048byte
    extra
    open_id
    string
    是
    用户 OpenID
    user
    pay_notify_url
    string
    否
    支付结果通知地址，必须是 HTTPS 类型。
    若不填，默认使用在行业模板配置-消息通知的支付结果通知地址。
    https://xxx
    out_order_no
    string
    是
    开发者的单号，长度 <= 64 byte
    132324
    pay_expire_seconds
    int64
    否
    支付超时时间，单位秒，例如 300 表示 300 秒后过期；不传或传 0 会使用默认值 300。
    500
    order_entry_schema
    object
    是
    订单详情页信息，详情见order_entry_schema 字段。
    见请求示例
    cp_extra
    string
    否
    开发者自定义透传字段，不支持二进制，长度 <= 2048 byte
    cp_extra
    discount_amount
    int64
    否
    折扣金额，单位分
    20

    goods_list 字段

    POI 商品会从商品库里查询商品信息，不会使用开发者传的数据。
    名称
    类型
    是否必填
    描述
    示例值
    goods_image
    ​
    string
    否
    商品图片链接，长度 <= 512 byte
    注意：非 POI 商品必传
    ​
    https://xxx
    goods_title
    ​
    string
    否
    商品标题/商品名称，长度 <= 256 byte
    注意：非 POI 商品必传
    ​
    火锅团购
    ​
    labels
    ​
    string
    否
    商品标签，最多设置三个标签，例如：随时退｜免预约｜提前3日预约（“｜”是中文类型），详见 pay-button 支付 的 type 的合法值 部分，注意不是 good-type 的合法值。
    注意：非 POI 商品必传
    随时退｜免预约
    date_rule
    string
    否
    ​
    使用规则，如 “周一至周日可用”、“周一至周五可用”、“非节假日可用”，默认“周一至周日可用”
    周一至周日可用
    price
    ​
    int64
    否
    商品价格，单位（分）
    注意：非 POI 商品必传
    ​
    100
    ​
    quantity
    int32
    是
    商品数量
    1
    goods_id
    string
    是
    商品 id
    goods_1
    goods_id_type
    int32
    是
    商品 id 类别，
      •POI 商品传 1
      •非 POI 商品传 2
    1
    goods_page
    object
    否
    商品详情页，详情见goods_page 字段
    ​
    order_valid_time
    ​
    object
    ​
    否
    券的有效期，详情见order_valid_time 字段
    注意：
      1.非 POI 商品必传，POI 商品会从 POI 库里查询有效期信息，不会使用开发者传的数据。
      2.如果是非 POI 商品，每个 goods_id 都要传券的有效期信息，否则会下单失败。
    ​
    discount_amount
    int64
    否
    折扣金额，单位分
    1
    goods_book_info
    object
    否
    预约信息，详情见goods_book_info 字段
    注意：需要预约的商品必传
    ​

    goods_page 字段

    名称
    类型
    是否必填
    描述
    示例值
    path
    string
    否
    商品详情页路径，长度 <= 512byte
    goods/info
    params
    string
    否
    商品详情页路径参数，长度 <= 512byte
    {\"id\":\"12312\"}

    order_entry_schema 字段

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

    order_valid_time 字段

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

    goods_book_info 字段

    名称
    类型
    是否必填
    描述
    示例值
    book_type
    int32
    是
    预约类型，
      •1：不需要预约
      •2：在线预约
    2
    cancel_policy
    int32
    否
    取消政策，
      •1：预约后不可取消
      •2：预约后可取消
      •3：预约中可取消，预约成功须提前 x 小时取消
    1
    cancel_advance_hour
    int64
    否
    提前取消的小时限制
    1

    请求示例

    curl --location --request POST 'https://open.douyin.com/api/apps/trade/v2/order/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
            }
        }
    ],
    "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"
}'

    响应参数

    名称
    类型
    是否必填
    描述
    示例值
    err_no
    int64
    是
    状态码 0，业务处理成功，具体错误码参见错误码/返回码
    0
    err_tips
    string
    是
    错误提示信息
    success
    data
    Json Object
    否
    返回数据信息
    ​

    data 说明

    名称
    类型
    是否必填
    描述
    示例值
    error_code
    int
    是
    错误码，0为成功
    0
    description
    string
    是
    错误码描述
    success
    order_id
    string
    是
    抖音开平侧生成的订单号
    ot7072366682238
    out_order_no
    string
    是
    开发者系统生成的订单号
    121321432
    pay_order_id
    string
    是
    调起收银台的支付订单号
    12423414234
    pay_order_token
    string
    是
    调起收银台的 token
    544352343
    item_order_info_list
    Array<object>
    是
    商品 item_order 信息，详情见item_order_info_list 字段
    ​

    item_order_info_list 字段

    名称
    类型
    是否必填
    描述
    示例值
    goods_id
    string
    是
    商品 id
    700843652
    item_order_id_list
    Array
    是
    item_order_id 列表，id 个数与下单时对应 goods_id 的 quantity 一致
    ​
    item_order_detail
    Array<object>
    是
    商品 item_order 详细信息，详情见item_order_detail 字段
    ​

    item_order_detail 字段

    名称
    类型
    是否必填
    描述
    示例值
    item_order_id
    string
    是
    item 单 id
    ot70939408076069
    price
    i64
    是
    商品优惠后价格
    80

    响应示例

    正常示例

    {
  "data": {
    "error_code": 0,
    "description": "success",
    "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"
  }
}

    异常示例

    {
  "data": {
    "error_code": 13000,
    "description": "系统错误"
  },
  "extra": {
    "sub_error_code": 13000,
    "sub_description": "系统错误",
    "logid": "2022092115392201020812109511046",
    "now": 1663745962686,
    "error_code": 2191000,
    "description": ""
  }
}

    错误码

    详情参见错误码/返回码 。
    ​