API文档中心

热门接口:产品ID找同款全量维权查询万能转链字符串ID转换 (有API需求可联系本站)

独立抖客分销订单查询接口

调用权限:核心接口会员卡调用
接口使用场景等说明:

【特别公告】

抖音精选联盟官方平台于3月13日关闭,请参考 https://www.veapi.cn/gonggao/detail_84.html 


做为平替,将由穿山甲接口替代,佣金直接在本站会员中心结算。

详情见穿山甲API说明 https://www.veapi.cn/apidoc/douyindouke/369 



本接口用于查询独立抖客的分销订单,需要独立抖客百应授权。

支持按时间查询,或按指定订单号批量查询。


2023年10月16日起,抖音精选联盟的订单接口仅支持查询支付时间近1年的订单数据。

调用说明

本接口需要您在会员中心授权(如果多用户可传入sessionkey参数)

接口请求地址

环境 http 地址 https 地址
正式环境 http://api.veapi.cn/douke/douke_OrderAds 暂无

请求方式:GETPOST

请求参数

参数名称 参数类型 必填 示例值 描述
vekey String V123M56 公共参数,接口秘钥,请在会员中心获取
size Int64 20 每页订单数目,取值区间: [1, 200]
cursor String 0 下一页索引(第一页传“0”)
start_time String 2006-01-02 15:04:05 支付时间开始,最早支持90天前
end_time String 2006-01-02 15:04:05 支付时间结束
order_ids String 4737996432465788974,4737996432465780075 订单号。多个订单号用英文 , 分隔,最多支持10个订单号
pid String dy_1234_4567_7890 抖客PID
distribution_type String Live 分销类型。Live-直播间,ProductDetail-商品详情,ActivityMaterial-活动物料分销。(【废弃】Activity-活动(百亿补贴/秒杀)Mix-H5自建活动页,推荐使用ActivityMaterial)
time_type String update 查询时间类型。pay: 支付时间(默认); update:联盟侧更新时间,非订单状态更新时间
query_order_type Int64 0 不填或者填0:查询分销订单,1:查询比价订单

请求示例

  • HTTP
  • PHP
  • JAVA
  • PYTHON
GET/POST  http://api.veapi.cn/douke/douke_OrderAds?vekey=xxx&start_time=2023-01-25+20:51:20&end_time=2023-03-25+23:51:20 
【例子】按指定订单号查询
http://api.veapi.cn/douke/douke_OrderAds?vekey=xxx&order_ids=5049400731628723479,5049384353537830167
使用curl函数,curl不是php原生库,需要安装才能使用

$api="http://api.veapi.cn/douke/douke_OrderAds?vekey=xxx&start_time=2023-01-25+20:51:20&end_time=2023-03-25+23:51:20";

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $api);
//curl_setopt($ch, CURLOPT_POST, true);  //POST方式时启用
//curl_setopt($ch, CURLOPT_POSTFIELDS, $postData );  //POST方式时传参

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);  //如果使用https请启用
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);  //如果使用https请启用
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true );   //返回数据流,不直接输出
curl_setopt($ch, CURLOPT_ENCODING, 'gzip'); //使用gzip压缩传输让访问更快
curl_setopt($ch, CURLOPT_TIMEOUT, 6);  //允许执行的最长秒数。这里设定6S
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);

$result = curl_exec($ch);
$info = curl_getinfo($ch);
curl_close($ch);

echo $result; //返回值
使用okhttp3/httpclient/jsoup/hutool,以hutool为例:

import cn.hutool.http.HttpResponse;
import cn.hutool.http.HttpRequest;

public class testGetParam {

    public static void main(String[] args) {
        // API网址
        String url = "http://api.veapi.cn/douke/douke_OrderAds?vekey=xxx&start_time=2023-01-25+20:51:20&end_time=2023-03-25+23:51:20";
        // JDK 8u111版本后,若目标页面为HTTPS协议,请启用proxy用户密码鉴权
        //System.setProperty("jdk.http.auth.tunneling.disabledSchemes", "");

        // 发送请求
        String result = HttpRequest.get(url)
                .timeout(10000)//设置超时,毫秒
                .execute().body();
        System.out.println(result);
    }
}
推荐使用 requests,支持访问http,https网页:

import requests
		
# 要访问的API网页
target_url = "http://api.veapi.cn/douke/douke_OrderAds?vekey=xxx&start_time=2023-01-25+20:51:20&end_time=2023-03-25+23:51:20"

# 发送请求
response = requests.get(target_url)

# 获取页面内容
if response.status_code == 200:
	print response.text

返回值(JSON)

参数名称 参数类型 示例值 描述
cursor String 4737996432465788974 下一页的索引
confirm_time String 2006-01-02 15:04:05 收货时间
material_id String 7208154716478685497 活动页物料ID
author_buyin_id String 1234567 被分销达人百应ID(仅直播间分销订单拥有)
order_id String 4737996432465788974 订单号
product_id String 3450632721376902816 商品id
product_name String 测试商品 商品名称
product_img String https://tosv.boe.byted.org/obj/temai/7e92a281163e33cedef99d8735d1e90bwww828-708 商品图片URL
author_account String 我的昵称 作者账号昵称(抖音/火山作者)(仅直播间分销订单有)
shop_name String 我的店铺 商家名称
total_pay_amount Int64 2100 订单支付金额,单位分
flow_point String PAY_SUCC 订单状态。PAY_SUCC:支付完成; REFUND:退款; SETTLE:结算;CONFIRM:确认收货
update_time String 2006-01-02 15:04:05 更新时间 [联盟侧订单更新时间]
pay_success_time String 2006-01-02 15:04:05 付款时间
settle_time String 2006-01-02 15:04:05 结算时间,结算前为空字符串
pay_goods_amount Int64 1100 预估参与结算金额
settled_goods_amount Int64 0 实际参与结算金额
shop_id Int64 1234 店铺ID
pid_info Struct - 分销订单相关参数
 └─ pid String dy_1234_33_455 PID
 └─ external_info String 1222_2333 跟单自定义参数回传,您在转链接口设置的参数,在这里透出,可以用于跟单。
 └─ media_type_name String Live 分销回流类型。live: 直播间分销; ProductDetail:商品分销; Activity: 百补和秒杀推广;Shop:店铺导流
item_num Int64 2 商品数目
refund_time String 2006-01-02 15:04:05 退款订单退款时间
ads_estimated_commission Int64 100 预估推广费收入,单位分
ads_real_commission Int64 100 实际推广费收入,单位分
author_short_id String okfowenfwo 达人抖音号(仅直播间分销订单有)
ads_promotion_rate Int64 20 推广费率
media_type String shop_list 带货体裁。shop_list:橱窗;video:视频;live:直播;others:其他
ads_activity_id Int64 1001 【废弃】推荐使用material_id字段;活动页推广活动Id,1000-超值购 1001-秒杀;若distribution_type为Mix,则为Mix活动ID
ads_estimated_tech_service_fee Int64 1000 推广技术服务费
ads_fans_type String old 直播间分销订单:新老粉
product_activity_id String 1 【废弃】推荐使用product_tags字段;商品参与的活动id,0: 未参加活动 1: 超值购(活动页单品推广)
product_tags Struct - 商品分销订单-商品标签信息product_activity_id
 └─ has_supermarket_tag Bool true 是否抖音超市(次日达)商品
 └─ has_subsidy_tag Bool true 是否超值购商品

返回示例

【提示】推广链接通常有时效性,示例中的链接为创建文档时生成,仅用于展示返回结果使用,有可能已失效。
{ "error": "0", "msg": "查询成功!", "data": { "cursor": "5049384353537830167", "orders": [ { "ads_activity_id": 0, "ads_estimated_commission": 209, "ads_estimated_tech_service_fee": 23, "ads_fans_type": null, "ads_promotion_rate": 1800, "ads_real_commission": 0, "author_account": "", "author_buyin_id": null, "author_short_id": "0", "confirm_time": null, "flow_point": "PAY_SUCC", "item_num": 12, "material_id": null, "media_type": null, "order_id": "5049400731628723479", "pay_goods_amount": 1290, "pay_success_time": "2023-03-25 21:54:37", "pid_info": { "external_info": "m23_56565266554_20230325215126", "media_type_name": "ProductDetail", "pid": "dy_107213597798095225100_20865_2675084869" }, "product_activity_id": "0", "product_id": "3550945007122962547", "product_img": "https://p3-aio.ecombdimg.com/obj/ecom-shop-material/v1_npuvHFKx_71018825340362427220507_d43969fee8b46e0322f38edb0834101e_sx_331281_www800-800", "product_name": "【整箱十二枚】猫山王榴莲饼爆浆流心美味榴莲酥好吃夹心网红零食", "refund_time": null, "settle_time": null, "settled_goods_amount": 0, "shop_id": 31259507, "shop_name": "梦想食品专营店", "total_pay_amount": 1290, "update_time": "2023-03-25 21:54:48" } ] }, "request_id": "wAFXlrc" }

错误码

如果error不为0时,请点此查看错误码表格

在线
客服

会员请加QQ群交流:

微信
咨询

加微信咨询
顶部