Lingxing
切换旧版

查询物流 - 头程物流商

POST/basicOpen/logistics/headLogisticsProvider/query/list

支持查询物流-头程物流商，默认返回已启用现结api对接的物流商。

接口信息

API Path请求协议请求方式令牌桶容量
/basicOpen/logistics/headLogisticsProvider/query/listHTTPSPOST1

请求参数

searchobject
搜索参数对象
隐藏子属性
lengthinteger
分页长度，每页显示的记录数
pageinteger
页码，从1开始
enabledinteger
启用状态，枚举值：0-禁用, 1-启用，默认启用
isAuthinteger
是否api对接，枚举值：0-否, 1-是，默认是
payMethodinteger
结算方式，枚举值：1-现结, 2-月结，默认现结
searchFieldstring
搜索字段，指定搜索的目标字段名称，code 代码 ，name 物流商，默认物流商
searchValuestring
搜索值，用于模糊搜索物流商名称、编码等

请求cURL示例

curl --location 'https://openapi.lingxing.com/basicOpen/logistics/headLogisticsProvider/query/list?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{
    "search": {
        "page": 1,
        "length": 20
    }
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
totalinteger必填
总记录数
示例 100
providersarray<object>必填
物流商列表
隐藏子属性
providerIdstring
物流商id
namestring
物流商名
codestring
物流商代码
enabledinteger
是否启用 0禁用 1 启用
logisticsTypeinteger
类型
0 API物流
1 自定义物流
2 第三方仓物流
3 头程物流
4 平台物流
isAuthinteger
是否api对接
0 否
1 是
supplierCodeinteger
授权方code
supplierNamestring
授权方
statusinteger
授权状态
0 未授权
1 已授权
remarkstring
备注
payMethodinteger
结算方式
contactNamestring
联系人
contactPhonestring
联系电话
creatorIdinteger
创建人id
creatorNamestring
创建人名
createdAtinteger
创建时间，Unix时间戳（秒）
error_detailsarray<any>必填
错误详情
messagestring必填
提示信息
request_idstring必填
请求id
response_timestring必填
响应时间
totalinteger必填
总记录数

返回成功示例

{
    "code": 0,
    "message": "success",
    "error_details": [],
    "request_id": "a0d54debf93140f3b58d1ed81e8e3583.178.17255922733991817",
    "response_time": "2024-11-12 16:00:00",
    "data": {
        "total": 3,
        "providers": [
            {
                "providerId": "PROV001",
                "name": "顺丰速运",
                "code": "SFEXPRESS",
                "enabled": 1,
                "logisticsType": 1,
                "isAuth": 1,
                "supplierCode": 1001,
                "supplierName": "顺丰集团",
                "status": 1,
                "remark": "国内主要快递服务商",
                "payMethod": 1,
                "contactName": "王经理",
                "contactPhone": "13812345678",
                "creatorId": 10001,
                "creatorName": "管理员A",
                "createdAt": 1704067200
            },
            {
                "providerId": "PROV002",
                "name": "DHL国际快递",
                "code": "DHLINTL",
                "enabled": 1,
                "logisticsType": 3,
                "isAuth": 1,
                "supplierCode": 2001,
                "supplierName": "DHL集团",
                "status": 1,
                "remark": "全球领先的国际快递服务商",
                "payMethod": 2,
                "contactName": "李女士",
                "contactPhone": "13987654321",
                "creatorId": 10002,
                "creatorName": "管理员B",
                "createdAt": 1704067300
            },
            {
                "providerId": "PROV003",
                "name": "菜鸟裹裹",
                "code": "CAINIAO",
                "enabled": 1,
                "logisticsType": 4,
                "isAuth": 1,
                "supplierCode": 3001,
                "supplierName": "阿里巴巴",
                "status": 1,
                "remark": "平台聚合物流服务",
                "payMethod": 1,
                "contactName": "赵先生",
                "contactPhone": "13700112233",
                "creatorId": 10001,
                "creatorName": "管理员A",
                "createdAt": 1704067400
            }
        ]
    },
    "total": 3
}