当前位置: API文档

setting.Logistics.queryLogistics(物流公司查询)

¥基础   ¥增值  ¥定制 

1.接口说明

1.1 接口描:获取ERP物流公司信息
1.2 适用版本:客户端 V1.1.8.9及以上版本
1.3 增量获取:不支持
1.4 时间跨度:start_time和end_time最大跨度为30天
1.5注意事项:结果不含已停用的物流

2.调用场景

2.1 举例说明:

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://47.92.239.46/openapi
正式环境正式环境是动态获取的,详情点击

   3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
卖家账号, 由旺店通分配
接口账号keyString
由旺店通分配appkey, 在发送的数据中对应 key 字段
saltString
由旺店通分配appsecret,是由两部分构成, 冒号前面的部分是secret, 冒号后面的部分是salt. 例如一个appsecret是testsecret:testsalt, 那么secret为testsecret, salt为testsalt.
接口名称methodString
调用的接口名称
版本号vString
1.0
秒级时间戳timestampint
秒级时间戳, 当前时间戳减去 2012-01-01 00:00:00(1325347200), 时间与服务器时间差120s内即合法。
签名signString
签名
分页大小page_sizeint
分页大小,分页查询必传
分页编号page_noint
分页编号,分页查询必传
是否计算查询结果的总页数calc_totalint
是否计算查询结果的总页数,分页查询必传

    3.3 业务请求参数

名称字段类型长度
必须描述

查询参数

params

Map<String, Object>


查询参数

分页

pagerPager
分页

params

名称字段类型长度
必须描述
物流编号
logistics_no
String

n
物流编号
物流名称
logistics_nameString
n
物流名称

pager

名称字段类型长度
必须描述
分页大小

page_size

int

4

分页大小

页号page_noint4从0开始

4.响应参数

名称字段类型长度
必须描述
状态码

status

int
y

状态码,0表示调用成功

错误信息

message

String


y

无错误信息不返回

返回信息

data

List<Map<String, Object>>


y

返回信息

data

响应参数说明示例值或者格式、具体含义、使用方法及注意事项(如隐私数据淘系平台不返回,其他平台正常返回

名称字段类型长度
必须描述
总条数total_amountint


总条数

查询结果

details

List<Map<String, Object>>


查询结果

details




物流公司类型

logistics_type

int

物流公司类型

是否支持货到付款

is_support_cod

int

是否支持货到付款,0:  不支持

物流编号

logistics_no

String20

物流编号

物流公司名称

logistics_nameString40

物流公司名称

联系人

contact

String64

联系人

电话

telnoString20

电话

手机

mobile

tring20

手机

地址

addresstring255

地址

电子面单类型

ebill_api

int

0: 普通,1: 线下电子面单,2:  平台电子面单

是否预支单号

is_preset_no

int
是否预支单号

货运方式

send_type

int

0: 标准快速,1:  生鲜速配,2: 冷运速配

最大重量

max_weight

Decimal(19,4)


最大重量

备注

remark

String


备注

5.请求示例

JSON
{
"start_time":"2020-01-01 00:00:00"
"end_time": "2020-01-20 00:00:00"
}
PHP
<?php
header("Content-Type: text/html; charset=UTF-8");
date_default_timezone_set("Asia/Shanghai");
require_once('wdtsdk.php');
 
$client = new WdtErpClient("url", "wdtapi3", "appkey", "secret");
 
$parMap = new stdClass();
$parMap->start_time = "2020-01-01 00:00:00";
$parMap->end_time = "2020-01-20 00:00:00";
 
$pager = new Pager(1, 0, true);
 
$response = $client->pageCall("setting.Logistics.queryLogistics ", $pager, $parMap);
 
?>
JAVA

C#

6.响应示

   6.1 正常响应示例 

JSON
{
"status": 0,
"data": {
"total_count": 177,
"details": [{
"logistics_name": "无需物流",
"address": "",
"is_preset_no": false,
"logistics_no": "001",
"send_type": 0,
"mobile": "",
"remark": "",
"ebill_api": 0,
"telno": "",
"max_weight": 0.0000,
"contact": "",
"logistics_type": 1,
"is_support_cod": true
}]
}
}

   6.2 异常响应示例

JSON
{
"status": 100,
"message": "参数中必须包含起止时间"
}


常用工具