当前位置: API文档

logistics.php(查询物流)

 ¥标准

1.接口说明  

   1.1 接口描述:批量获取ERP内物流档案信息            
   1.2 适用版本:客户端 V2.3.1.6及以上版本  
   1.3 全量获取:该接口是全量获取数据或按照logistics_no获取,无法按照时间段增量获取数据。         


2.调用场景 

  2.1 暂无            

3.请求参数说明 

3.1 请求地址

环境HTTP地址
测试环境http://sandbox.wangdian.cn/openapi2/logistics.php
正式环境http://api.wangdian.cn/openapi2/logistics.php

3.2 公共请求参数

名称字段类型长度
必须描述
卖家账号sidString
购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。
接口账号appkeyString
本开放平台“自助对接”功能模块内自助申请,申请流程单击这里
时间戳timestampint
北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。
签名signString
API输入参数签名结果,签名算法介绍单击这里

3.3 业务请求参数

名称字段类型长度
必须描述
物流编号logistics_novarchar(20)
代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置),用于获取指定物流数据信息
物流公司名称logistics_namevarchar(40)
物流公司名称(ERP中自定义的物流名称)

4.响应参数说明

4.1公共响应参数

名称字段类型长度
必须描述
错误码codeint
错误码,0成功
错误描述messagevarchar
错误描述
物流档案列表节点logistics_listdata[ ]
物流档案列表节点

4.2业务响应参数

名称字段类型长度
必须描述
主键logistics_idint11物流档案主键
物流编号logistics_novarchar20代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置),用于获取指定物流数据信息
物流名称logistics_namevarchar40物流公司名称(ERP中自定义的物流名称)
物流方式logistics_typesmallint6响应值为代表物流方式的数字,数字对应的物流方式名称单击这里
发件地址省份provincevarchar50发件地址省份
发件地址市cityvarchar50发件地址市
发件地址区districtvarchar50发件地址区
联系人contactvarchar64联系人
电话telnovarchar20电话
手机mobilevarchar20手机
地址addressvarchar255地址
物流佣金比例commission_ratiodecimal(5,4)物流佣金比例
货运方式send_typetinyint6货运方式:0.标准快递、1.生鲜速配、2.冷运速配
自定义属性1prop1varchar255自定义属性1
自定义属性2prop2varchar255自定义属性2
自定义属性3prop3varchar255自定义属性3
是否禁用is_disabledtinyint1是否禁用:0.否;1.是
物流的优先级priorityint11物流的优先级,物流界面的顺序,从上至下依次递减
是否支持货到付款is_support_codtinyint1是否支持货到付款:0.否;1.是
业务模块service_masktinyint11销售物流;2采购物流
单号类型bill_typetinyint10表示普通;1表示线下电子面单;2表示平台电子面单
是否启用在线发货is_onlinetinyint1是否启用在线发货:0.否;1.是
是否”不使用接口大头笔”is_dtb_no_apitinyint1是否”不使用接口大头笔”:0.否;1.是
是否”不重复利用单号”un_repeat_logistics_notinyint1是否”不重复利用单号”:0.否;1.是
是否手动获取单号is_manualtinyint1是否手动获取单号:0.否;1.是
快递单的正则表达式logistics_regexvarchar
255
用来检查合法性
单号规则不校验be_uncheck_regexptinyint1
校验物流单号正则表达式:0.校验;1.不校验
备注remarkvarchar128备注
最后修改时间modifieddatetime255最后修改时间
创建时间createddatetime255创建时间
邮编
zip
varchar255邮编

5.请求示例

PHP
<?php
    require_once '../WdtClient.php';
    $c = new WdtClient;
    $c->sid = '';
    $c->appkey = '';
    $c->appsecret = '';
    $c->gatewayUrl = 'http://sandbox.wangdian.cn/openapi2/logistics.php';
    
    $c->putApiParam('logistics_no', 11);
    $json = $c->wdtOpenApi();
    var_dump($json);
?>
JAVA
package com.wangdian.api.basic;

import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

import com.wangdian.api.WdtClient;

public class LogisticsQuery {

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        WdtClient client = new WdtClient("", "", "", "");
        Map<String, String> params = new HashMap<String, String>();
        params.put("logistics_no", "11");

        try {
            String response = client.execute("logistics.php", params);
            System.out.println(response);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

}
C#
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using WdtSdk;

namespace LogisticsQuery
{
    class LogisticsQuery
    {
        static void Main(string[] args)
        {
            WdtClient client = new WdtClient();
            client.sid = "";
            client.appkey = "";
            client.appsecret = "";
            client.gatewayUrl = "http://sandbox.wangdian.cn/openapi2/logistics.php";

            client.putParams("logistics_no", "CSOTHER");
            string result = client.wdtOpenapi();
            Console.WriteLine(result);
            Console.ReadKey();
        }
    }
}

6.响应示例

   6.1 正常响应示例 

JSON
{
    "code": 0,
    "message": "OK",
    "logistics_list": [{
        "logistics_id": "1",
        "logistics_type": "8",
        "is_support_cod": "1",
        "logistics_no": "SF001",
        "logistics_name": "顺丰快递",
        "logistics_regex": "",
        "contact": "小鹏",
        "telno": "13500001111",
        "mobile": "",
        "address": "花园路13",
        "service_mask": "3",
        "bill_type": "0",
        "is_online": "0",
        "is_manual": "0",
        "is_dtb_no_api": "0",
        "un_repeat_logistics_no": "0",
        "prop1": "",
        "prop2": "",
        "prop3": "",
        "is_disabled": "0",
        "commission_ratio": "0.0000",
        "send_type": "0",
        "be_uncheck_regexp": "1",
        "priority": "18",
        "remark": "测试物流",
        "modified": "2019-05-17 14:52:14",
        "created": "2018-11-23 14:56:13",
        "province": "北京",
        "city": "北京市",
        "district": "海淀区",
        "zip": "100089 "
    }]
}

   6.2 异常响应示例

JSON
{
    "code": 1007,
    "message": "接口appkey已停用【解决办法:联系商务人员,重新开启接口appkey】 "
}



常用工具