开发
API

小程序订单同步

产品概述

开发者可通过订单同步接口将订单信息推送到抖音订单中心,便于用户查找订单信息,并提供回访小程序的入口。

备注:该接口有白名单逻辑,需要先将测试用的 uid 加白,然后录屏展示订单全流程给平台确认后开全量,uid 获取方式:抖音 app-我-更多-version 点三下,uid 加白请添加 初纹萱

pushOrder

同步小程序订单,通过该接口实现订单的增加与更新

接口地址

POST https://developer.toutiao.com/api/apps/order/v2/push

输入参数

// Content-type:application/json
{
    "client_key": "", // string 类型, POI订单必传
    "access_token": "", // string类型,必传字段,服务端 API 调用标识,
    "ext_shop_id": "", // 外部商户ID
    "app_name": "douyin", // 必传字段,做订单展示的字节系 app 名称,取值枚举: 抖音-douyin
    "open_id": "", // 小程序open id
    "update_time": 0, // 订单信息变更时间,13位毫秒级时间戳
    "order_detail": "", // 订单细节,根据不同订单类型有不同的结构体
    "order_type": 0, // 订单类型 0 - 小程序订单
    // 订单产生场景
    "scene": "",
    "launch_from": "",
    "location": "",
    "extra": ""
}
名称类型必填描述
client_keystringPOI 订单必传第三方在开放平台申请的 ClientKey
access_tokenstring服务端 API 调用标识,字节小程序 getAccessToken (bytedance.com)
ext_shop_idstringPOI 订单必传POI 外部商户 ID,购买店铺 id
app_namestring做订单展示的字节系 app 名称,取值枚举: 抖音-douyin
open_idstring小程序用户的 open id
order_detailstring根据不同订单类型有不同的结构体。小程序订单格式
order_typeint订单类型,取值:0 - 小程序订单
update_timeint订单信息变更时间,13 位毫秒级时间戳
extrastring自定义字段,用于关联具体业务场景下的特殊参数
scenestring订单生成时的场景值
locationstring
launch_fromstring

输出

返回值为 JSON 形式,返回信息如下:

名称数据类型描述
err_codenumber错误号
err_msgstring错误信息
bodystringpoi 等关联业务推送结果,json 字符串。小程序订单可忽略

具体对应关系为:

错误号描述
0请求成功
-1系统错误
40002access_token 错误
40003openid 错误
40014http 参数错误
40016appname 错误
40022business_line 错误
其它其它参数错误

⚠️ 注意

传入参数错误可能会直接返回 HTTPcode 400,出现此情况请参照实例改变参数或者联系相关同学排查。

附录

小程序订单 detail 格式规范

以下参数均在 JSON body 中。

order_detail 字段

名称必填数据类型描述
order_idstring订单 id
create_timenumber订单创建的时间,UNIX 时间戳
statusstring订单状态
amountnumber订单商品总数,number 类型
total_pricenumber订单总价,必须为 Number 类型,单位为分
detail_urlstring小程序订单详情页 path
detail_url_backendstring订单详情页备用 url,订单详情页 path 不可用时生效
item_listlist子订单商品列表,不可为空

item_list 字段

名称必填数据类型描述
item_codestring子订单 id
imgstrin子订单商品图片 url
titlestring子订单商品介绍标题
sub_titlestring子订单商品介绍副标题
amountnumber单类商品的数目,必须为 number 类型
pricenumber单类商品的总价,必须为 Number 类型,单位为分

小程序订单中,对已存在的订单进行重复 push。会以 AppID 与 OrderID 进行判断。对非空值进行更新。

点击纠错
评价此篇文档