接口使用场景等说明:查询某个应用下通过商品转链和直播间转链,或活动页转链产生的订单。
有两种查询方式:
1、分批次滚动拉取。需要填写size, cursor, start_time, end_time, order_type, time_type(选填)
2、按照订单id查询。需要填写order_ids
订单数据每10秒更新一次。关于佣金结算,请注意返回值“estimated_commission”字段的说明。
环境 | http 地址 | https 地址 |
---|---|---|
正式环境 | http://api.veapi.cn/douke/csj_ordersearch | 暂无 |
参数名称 | 参数类型 | 必填 | 示例值 | 描述 |
---|---|---|---|---|
vekey | String | 是 | V123M56 | 公共参数,接口秘钥,请在会员中心获取 |
size | Int | 否 | 默认20 | 拉取数量,取值区间: [1, 50],默认20.如果传递order_ids参数,则是忽略本参数。 |
cursor | String | 否 | 0 | 上一次订单查询返回的游标,首次查询可不传或传入"0".如果传递了order_ids参数则本参数失效.第一次查询应为"0",后面查询应使用前一次请求返回的Cursor。直到查询返回cursor为""。可用于分批拉取订单. |
start_time | Int | 否 | 支持2024-03-03 16:21:42格式(请urlencode),或10位时间戳格式 | 支付或更新的开始时间。如果没有传递order_ids参数,则是。开始时间不能大于结束时间,且为北京时间的时间戳,单位为秒。注意:订单数据每10秒更新一次 |
end_time | Int | 否 | 支持2024-03-03 16:21:42格式(请urlencode),或10位时间戳格式 | 支付或更新的结束时间。如果没有传递order_ids参数,则是。结束时间与开始时间间隔不超过90天 |
order_ids | String | 否 | 1111,2222,3333 | 订单号,可以查询1-10个订单号,用逗号相连。最多支持10个订单号,如果这个字段填了,start_time/end_time/cursor/size不会使用 |
order_type | Int | 否 | 默认0 | 0-查询全部订单,1-商品分销订单,2-直播间分销订单,3-活动类型订单。 |
time_type | String | 否 | pay默认 | 查询时间类型方式:pay-按照支付时间查询特定时间范围内的订单。update-按照订单更新时间查询特定时间范围内的订单。当使用start_time/end_time/cursor/size生效 |
GET/POST http://api.veapi.cn/douke/csj_ordersearch?vekey=xxx&cursor=&start_time=2024-03-03%2016:21:42&end_time=2024-04-19%2016:21:42【例子】查询指定订单
http://api.veapi.cn/douke/csj_ordersearch?vekey=xxx&order_ids=6918598319523671223
$api="http://api.veapi.cn/douke/csj_ordersearch?vekey=xxx&cursor=&start_time=2024-03-03%2016:21:42&end_time=2024-04-19%2016:21:42"; $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; //返回值
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/csj_ordersearch?vekey=xxx&cursor=&start_time=2024-03-03%2016:21:42&end_time=2024-04-19%2016:21:42"; // JDK 8u111版本后,若目标页面为HTTPS协议,请启用proxy用户密码鉴权 //System.setProperty("jdk.http.auth.tunneling.disabledSchemes", ""); // 发送请求 String result = HttpRequest.get(url) .timeout(10000)//设置超时,毫秒 .execute().body(); System.out.println(result); } }
import requests # 要访问的API网页 target_url = "http://api.veapi.cn/douke/csj_ordersearch?vekey=xxx&cursor=&start_time=2024-03-03%2016:21:42&end_time=2024-04-19%2016:21:42" # 发送请求 response = requests.get(target_url) # 获取页面内容 if response.status_code == 200: print response.text
参数名称 | 参数类型 | 示例值 | 描述 |
---|---|---|---|
cursor | String | 37783209931712716472 | 供查询下一页订单的游标,仅在按时间区间分页查询时才会返回,按订单id查询不会返回。返回为""时代表后面没有订单了。 |
order_id | String | 订单id | |
app_id | String | 应用id | |
product_id | String | 商品id | |
product_name | String | 商品名称 | |
author_account | String | 直播间达人昵称,仅直播间分销订单才会有该字段 | |
ads_attribution | String | 结算方式,intersect为跨播,directIn为直推 | |
product_img | String | 商品图片url | |
total_pay_amount | Int | 总付款金额,单位分 | |
pay_success_time | String | 支付成功时间 | |
refund_time | String | 退款时间 | |
pay_goods_amount | Int | 预估结算金额,单位分。如果有支付优惠,pay_goods_amount会略大于total_pay_amount | |
estimated_commission | Float | 预估佣金收入,单位分。该字段已扣除10%技术服务费了,也是本站和穿山甲结算的金额。后续本站再扣除5%税收和维护成本,就是和您结算的金额。 | |
ads_real_commission | Float | 实际可结算金额,单位分.每笔订单在用户确认收货后15天左右,该字段有值 | |
split_rate | Float | 推广费率,单位万分之一,10代表推广费率为0.10% | |
after_sales_status | Int | 售后状态,1-空,2-产生退款 | |
flow_point | String | PAY_SUCC:支付完成;REFUND:退款;SETTLE:结算。此状态代表商家确定会结算佣金.CONFIRM: 确认收货 | |
settle_time | String | 结算时间 | |
confirm_time | String | 确认收货时间 | |
update_time | String | 订单状态更新时间 | |
estimated_tech_service_fee | Int | 预估技术服务费,为pay_goods_amount*split_rate*0.1。 | |
external_info | String | 跟单用。开发者在转链时自己上传的external_info | |
media_type_name | String | 分销类型名称:Live-直播间,ProductDetail-商品详情,ActivityMaterial-活动页 | |
pid | String | 穿山甲唯一pid | |
shop_id | Int | 店铺id | |
shop_name | String | 店铺名称 | |
item_num | Int | 商品数量 | |
material_id | Int | 活动id |
{ "error": "0", "msg": "抖客订单查询成功!(订单数据每10秒更新一次)", "cursor": "21051025101712735630", "data": [ { "order_id": "6928535482621498461", "app_id": "5493085", "product_id": "3657270007152426945", "product_name": "【5.99元30包】巴旦木瓜子仁酥葵花籽仁坚果干果网红零食独立小包装", "author_account": "中国邮政·合肥邮政", "ads_attribution": "", "product_img": "https://p3-aio.ecombdimg.com/obj/ecom-shop-material/eODauEkH_m_df833c58e4f78a12db5c214eec4f36cc_sx_387145_www800-800", "total_pay_amount": "1198", "pay_success_time": "1712311295", "refund_time": "0", "pay_goods_amount": "1198", "estimated_commission": "1", "ads_real_commission": "0", "split_rate": "7", "after_sales_status": "1", "flow_point": "PAY_SUCC", "settle_time": "0", "confirm_time": "0", "update_time": "1712311307", "estimated_tech_service_fee": "0", "external_info": "live23", "media_type_name": "Live", "pid": "dy_107254589800274903311_59712_18032120", "shop_id": "141486248", "shop_name": "董小姐甄选食品店", "item_num": "2", "material_id": "" } ], "request_id": "m6ZkiN2" }