当前位置: API文档

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

¥标准

1.接口说明

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

2.调用场景

2.1 举例说明:

3.请求参数说明

   3.1 请求地址

环境HTTP地址
测试环境http://47.92.239.46/openapi
正式环境http://wdt.wangdian.cn/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
分页编号,分页查询必传,标准接口page_no从0开始
是否计算查询结果的总条数calc_totalint
是否计算查询结果的总条数, 需要计算则1, 否则填0         

    3.3 业务请求参数

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

查询参数

params

Map<String, Object>


查询参数

分页

pagerPager
分页

params

名称字段类型长度
必须描述
物流编号
logistics_no
String
40n
物流编号
物流名称
logistics_nameString
n
物流名称
是否隐藏已停用
hide_deleteboolean1n
true:隐藏;false:不隐藏

pager

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

page_size

Int

4

分页大小

页号page_noInt4从0开始

4.响应参数

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

status

Int
y

状态码,0表示调用成功

错误信息

message

String


y

无错误信息不返回

返回信息

data

List<Map<String, Object>>


y

返回信息

data

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

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


总条数

查询结果

details

List<Map<String, Object>>


查询结果

details




物流id

logistics_id

Int6

物流唯一键

物流类型

logistics_type

Int6

物流类型,点击查看物流代码表

是否支持货到付款

is_support_cod

boolean

true:支持   

false:不支持

物流编号

logistics_no

String40

物流编号

物流名称

logistics_nameString40

物流名称

联系人

contact

String64

联系人

固话/联系电话

telnoString20

固话/联系电话

手机

mobile

String20

手机

地址

addressString255

地址

单号来源

ebill_api

Int

0:纸质面单 1:线下热敏 2:菜鸟电子面单(淘宝云栈)3:京东无界 4:拼多多金虹桥 5:区域零售 6:云集电子面单 11:唯品JIT电子面单 16:ASCP电子面单 18:抖音电子面单 19:得物品牌直发 20:快手电子面单 21:美团电子面单 22:唯品MP电子面单

是否预支单号

is_preset_no

boolean

true:是

false:否

货运方式

send_type

Int

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

是否已停用

is_disabled

boolean

true:已停用   

false:未停用

(当hide_delete传true时返回)

重量上限

max_weight

Decimal(19,4)


重量上限

备注

remark

String


备注

5.请求示例

JSON
[{"logistics_no":"001"}]
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->logistics_no = "3456789876789";

$pager = new Pager(1, 0, true);
 
$response = $client->pageCall("setting.Logistics.queryLogistics", $pager, $parMap);
 
?>
JAVA

C#

6.响应示

   6.1 正常响应示例 

JSON
{
	"total_count": 245,
	"details": [{
		"logistics_name": "无需物流",
		"address": "",
		"is_preset_no": false,
		"logistics_no": "001",
		"send_type": 0,
		"mobile": "13333333333",
		"remark": "",
		"ebill_api": 0,
		"telno": "020-0765222",
		"logistics_id": 1,
		"max_weight": 0.0000,
		"contact": "aaa",
		"logistics_type": 1,
		"is_support_cod": false
	}]
}

   6.2 异常响应示例

JSON
{
"status": 100,
"message": "XXXX "
}


常用工具