淘宝客私域用户备案信息查询api接口-渠道推广专属
需要授权
20859人使用

淘宝客信息查询

接口地址: http://api.tbk.dingdanxia.com/tbk/publisher_get 在线测试

接口支持https,非大陆服务器(含港澳台)调用接口会出现网络缓慢现象,请联系客服获取国外专线接口

请求参数、 调用方式 GET/POST

参数接口

参数类型

必填

示例

说明

apikey

string

接口秘钥,请登录后台获取

info_type

Number

1

类型,必选 1:渠道信息;2:会员信息

relation_app

String

common

备案的场景:common(通用备案),etao(一淘备案),minietao(一淘小程序备案),offlineShop(线下门店备案),offlinePerson(线下个人备案)。如不填默认common。查询会员信息只需填写common即可

relation_id

Number

2323

渠道独占 - 渠道关系ID

page_no

Number

1

第几页

page_size

Number

10

每页数据条数

special_id

String

1212

会员独占 - 会员运营ID

external_id

String

12345

淘宝客外部用户标记,如自身系统账户ID;微信ID等

返回参数说明

标记

类型

例子

说明

root_pid_channel_list

String[]

渠道专属pidList

total_count

Number

2

共享字段 - 总记录数

L inviter_list

MapData[]

inviterList

共享字段 - 渠道或会员列表

L relation_app

String

common

共享字段 - 备案场景:common(通用备案),etao(一淘备案),minietao(一淘小程序备案),offlineShop(线下门店备案),offlinePerson(线下个人备案)

L create_date

Date

2018-06-01 11:12:23

共享字段 - 备案日期

L account_name

String

s**x

共享字段 - 渠道/会员昵称

L real_name

String

xxx

共享字段 - 渠道/会员姓名

L relation_id

Number

123456

渠道独有 - 渠道关系ID

L offline_scene

String

门店

渠道独有 - 线下场景信息,1 - 门店,2- 学校,3 - 工厂,4 - 其他

L online_scene

String

微信群

渠道独有 - 线上场景信息,1 - 微信群,2- QQ群,3 - 其他

L note

String

订单侠

渠道独有 - 媒体侧渠道备注信息

L root_pid

String

mm_1_1_1

共享字段 - 渠道/会员专属pid

L rtag

String

123

共享字段 - 渠道/会员原始身份信息

L offline_info

RegisterInfoDto

线下

线下备案专属信息

L L shop_name

String

日用百货店

渠道独有 -店铺名称

L L shop_type

String

生活服务类 电信营业厅

渠道独有 -店铺类型

L L phone_number

String

1590000000

渠道独有 -手机号码

L L detail_address

String

**街道**号楼

渠道独有 -详细地址

L L location

String

内蒙古自治区 呼和浩特市

渠道独有 -地区

L L shop_certify_type

String

营业执照

渠道独有 -证件类型

L L certify_number

String

123445677

渠道独有 -对应的证件证件类型编号

L L career

String

个人 快递员

渠道独有 -经营类型

L special_id

Number

12345

会员独有 - 会员运营ID

L punish_status

String

1

渠道独有 - 处罚状态 0 -正常 1-失效

L external_id

String

12345

淘宝客外部用户标记,如自身系统账户ID;微信ID等

返回示例
{
    "code": 200,
    "msg": "请求成功【success】",
    "data": {
        "inviter_list": {
            "map_data": [
                {
                    "account_name": "为**现",
                    "create_date": "2019-01-22 21:37:49",
                    "note": "牛",
                    "offline_scene": "其他",
                    "online_scene": "其他",
                    "real_name": "牛**阳",
                    "relation_app": "common",
                    "relation_id": 510087482,
                    "root_pid": "mm_128849468_45454135_44105700493"
                }
            ]
        },
        "root_pid_channel_list": {
            "string": [
                "mm_128849468_45454135_44105700493"
            ]
        },
        "total_count": 1
    }
}			  
返回错误码说明

错误码

错误描述

解决办法

200

返回成功

-1

数据返回失败

请查看 msg 返回提示

4001

接口秘钥不能为空

请传入接口秘钥

4002

接口秘钥出错

登录后台查看接口秘钥是否一致

4003

参数不正确

请检查参数是否符合文档要求

4004

服务已到期请及时续费

登录后台续费

4005

该接口当日调用量已超限

升级套餐

4006

无权调用该接口

升级套餐

4007

接口不存在

4008

signature不正

查看签名构建规则确保正确无误。

4009

点卡已用完

请登录控制台-服务购买-充值点卡

4010

请购买接口次数包才能调用此接口

需充值次数包

4011

次数包已用完,请重新购买

需充值次数包

4012

请求客户端ip未加入白名单

将ip加入白名单

4013

联盟账号授权已过期

请登录控制台【授权管理】下重新授权您的相关账号

4014

PID异常

请登录控制台【授权管理】-【淘宝授权】,检查您的推广位PID是否填写,或是否填写正确。

4015

系统异常

服务端处理异常,请等待......或联系网站在线客服反馈。

4017

请求拒绝

调用请求被拒绝,您的账号状态存在异常,请联系平台管理员解除限制。