当前位置: API文档
logistics.php(查询物流)
1.1 接口描述:批量获取旺店通ERP内物流档案信息 |
1.2 适用版本:客户端 V2.4.5.0及以上版本 |
1.3 全量获取:该接口是全量获取数据或按照logistics_no获取,无法按照时间段增量获取数据。 |
2.1 暂无 |
环境 | HTTP地址 |
---|---|
测试环境 | https://sandbox.wangdian.cn/openapi2/logistics.php |
正式环境 | https://api.wangdian.cn/openapi2/logistics.php |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
卖家账号 | sid | String | 是 | 购买ERP时由旺店通分配给ERP购买方,请从ERP购买方获取。 | |
接口账号 | appkey | String | 是 | 本开放平台“自助对接”功能模块内自助申请,获取方式点击这里 | |
时间戳 | timestamp | int | 是 | 北京时间1970-01-01 08:00:00起至现在的总秒数,10位int值,旺店通企业版API服务端允许请求最大时间误差为5min,date.timezone = Asia/Shanghai。 | |
签名 | sign | String | 是 | API输入参数签名结果,签名算法介绍单击这里 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
物流编号 | logistics_no | varchar | 20 | 否 | 代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置),用于获取指定物流数据信息 |
物流公司名称 | logistics_name | varchar | 40 | 否 | 物流公司名称(ERP中自定义的物流名称) |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
错误码 | code | int | 是 | 错误码,0成功 | |
错误描述 | message | varchar | 是 | 错误描述 | |
物流档案列表节点 | logistics_list | data[ ] | 是 | 物流档案列表节点 |
名称 | 字段 | 类型 | 长度 | 必须 | 描述 |
---|---|---|---|---|---|
主键 | logistics_id | int | 11 | 是 | 物流档案主键 |
物流编号 | logistics_no | varchar | 20 | 是 | 代表物流所有属性的唯一编码,用于物流区分,ERP内支持自定义(ERP物流界面设置),用于获取指定物流数据信息 |
物流名称 | logistics_name | varchar | 40 | 是 | 物流公司名称(ERP中自定义的物流名称) |
物流类型 | logistics_type | smallint | 6 | 是 | 响应值为代表物流方式的数字,数字对应的物流方式名称单击这里 |
发件地址省份 | province | varchar | 50 | 是 | 发件地址省份 |
发件地址市 | city | varchar | 50 | 是 | 发件地址市 |
发件地址区 | district | varchar | 50 | 是 | 发件地址区 |
联系人 | contact | varchar | 64 | 是 | 联系人 |
联系电话 | telno | varchar | 20 | 是 | 电话 |
手机 | mobile | varchar | 20 | 是 | 手机 |
地址 | address | varchar | 255 | 是 | 地址 |
佣金比例 | commission_ratio | decimal | (5,4) | 是 | 物流佣金比例 |
货运方式 | send_type | tinyint | 6 | 是 | 货运方式:0.标准快递、1.生鲜速配、2.冷运速配 |
自定义属性1 | prop1 | varchar | 255 | 是 | 自定义属性1 |
自定义属性2 | prop2 | varchar | 255 | 是 | 自定义属性2 |
自定义属性3 | prop3 | varchar | 255 | 是 | 自定义属性3 |
停用 | is_disabled | tinyint | 1 | 是 | 是否禁用:0.否;1.是 |
分组 | group_name | varchar | 40 | 是 | 物流分组 |
剩余单量 | abled_num | int | 11 | 是 | 剩余单量 |
物流的优先级 | priority | int | 11 | 是 | 物流的优先级,物流界面的顺序,从上至下依次递减 |
是否支持货到付款 | is_support_cod | tinyint | 1 | 是 | 是否支持货到付款:0.否;1.是 |
业务模块 | service_mask | tinyint | 1 | 是 | 1销售物流;2采购物流 |
单号类型 | bill_type | tinyint | 1 | 是 | 0表示普通;1表示线下电子面单;2表示平台电子面单 |
是否启用在线发货 | is_online | tinyint | 1 | 是 | 是否启用在线发货:0.否;1.是 |
是否”不使用接口大头笔” | is_dtb_no_api | tinyint | 1 | 是 | 是否”不使用接口大头笔”:0.否;1.是 |
是否”不重复利用单号” | un_repeat_logistics_no | tinyint | 1 | 是 | 是否”不重复利用单号”:0.否;1.是 |
手动获取单号 | is_manual | tinyint | 1 | 是 | 是否手动获取单号:0.否;1.是 |
快递单的正则表达式 | logistics_regex | varchar | 255 | 是 | 用来检查合法性 |
单号规则不校验 | be_uncheck_regexp | tinyint | 1 | 是 | 校验物流单号正则表达式:0.校验;1.不校验 |
备注 | remark | varchar | 128 | 是 | 备注 |
最后修改时间 | modified | datetime | 255 | 是 | 最后修改时间 格式:yyyy-MM-dd HH:mm:ss |
创建时间 | created | datetime | 255 | 是 | 创建时间 格式:yyyy-MM-dd HH:mm:ss |
邮编 | zip | varchar | 255 | 是 | 邮编 |
JSON | { "code": 1007, "message": "接口appkey已停用【解决办法:联系商务人员,重新开启接口appkey】 " } |