接口文档

获取管辖运单列表

更新时间：2018-06-13 16:49:23 更新人员：叶洋

文档状态：完成 #314 测试接口

章节导航器

接口基本信息
请求参数
响应数据参数
请求示例

摘要

接口基本信息

接口名称：获取运单列表
请求方法：GET
接口地址：waybill
登录验证：是

请求参数

参数名	参数	数据类型	是否必须	示例值	说明
page	分页	int	否	1
row	每页数量	int	否	15
waybill_no	匹配运单号	string	否
start_net_id	匹配起始网点	string	否
end_net_id	匹配终止网点	string	否
start_time	开单时间起始日期	string	否		对应运单字段：create_time
end_time	开单时间截止日期	string	否		对应运单字段：create_time
payment_method	付款方式	string	否
delivery_method	配送方式	string	否
status	状态	string	否		多个状态用逗号分隔
shipper_name	发货人姓名	string	否
consignee_name	收货人姓名	string	否
createby_name	创建人姓名	string	否
waybill_type	运单类型	int	否	2	1线路运单 2城配运单不传时默认为1
substatus	子状态	string	否		多个用逗号分隔
sortway	排序方法	string	否		不传：默认排序； sdrpt：子状态>6001的放在后面； odri：只获取子状态<6002的； odro：只获取子状态>6001的；
send_start_time	发货时间起始日期	string	否		对应运单字段：send_time
send_end_time	发货时间截止日期	string	否		对应运单字段：send_time
signfor_start_time	签收时间起始日期	string	否		对应运单字段：signfor_time
signfor_end_time	签收时间截止日期	string	否		对应运单字段：signfor_time

响应数据参数

参数名	参数	数据类型	示例值	说明
waybill_id	运单ID	string	5e94513d01203517
waybill_no	运单编号	string	WZOHRM
waybill_type	运单类型	int	2	1干线运单 2城配运单
status	主状态	int	1
substatus	子状态	int	1001
is_paid	是否已支付	int	0	0未支付 1已支付
is_paid_receivable	应收是否已下账	int	0	0未下账 1已下账
is_paid_payable	应付是否已下账	int	0	0未下账 1已下账
is_delayed_settlement	是否延迟结算	int	1
is_monthly_balance	是否月结	int	1	月结的都是延迟
is_preset_waybill	是否预制运单	int	0	干线用，预制运单有制单费
unsteady_status	unsteady_status	string
shipper_id	发货人客户ID	string	5e0aa9ed01329366
consignee_id	收货人客户ID	string	5e94513d01519555
start_net_id	起始网点ID	string
end_net_id	目的网点ID	string
create_time	创建时间	string	2020-04-13 19:47:09
create_by{}	创建人信息	object
├ uid	├ uid	string	6c4af3244178febe
├ code	├ code	string	U676459
├ username	├ 用户名	string	lh
├ nickname	├ 昵称	string
└ realname	└ 真实姓名	string	罗浩
create_netid	create_netid	string
create_orgid	create_orgid	string
create_merid	create_merid	string	c17ec996d3ffc85f
create_rimid	create_rimid	string	9a2b52973227f703
update_time	更新时间	string	2020-04-13 19:47:09
update_by{}	更新人	object
├ uid	├ uid	string	6c4af3244178febe
├ code	├ code	string	U676459
├ username	├ 用户名	string	lh
├ nickname	├ 昵称	string
└ realname	└ 真实姓名	string	罗浩
send_time	发货时间	string	2020-04-13 00:00:00
arrive_date	到货日期	string	2020-04-14 00:00:00
arrive_time	到达时间	string
signfor_time	签收时间	string
receipt_by{}	receipt_by	object
├ uid	├ uid	string	6c4af3244178febe
├ code	├ code	string	U676459
├ username	├ username	string	lh
├ nickname	├ nickname	string
└ realname	└ realname	string	罗浩
receipt_time	回单时间	string
receiving_by{}	receiving_by	object
├ uid	├ uid	string	6c4af3244178febe
├ code	├ code	string	U676459
├ username	├ username	string	lh
├ nickname	├ nickname	string
└ realname	└ realname	string	罗浩
receiving_time	receiving_time	int	0
finish_time	完结时间	string
payment_method	付款方式	int	102
delivery_method	送货方式	int	3
time_limit	时限	int	0
need_receipt_copies	需回单份数	int	1
total_weight	总重量	int	0
total_volume	总体积	int	0
total_fee	总费用	int	14
badge	标记	string		多个标记中间以逗号分隔
need_insure	是否需要投保	int	0
dispatch{}	关联调度单信息	object
├ dispatch_id	├ 调度单ID	string	5e94512301086199
├ dispatch_no	├ 调度单号	string	DP32981360
├ create_by	├ create_by	string	3ddb3e1c3824caea
├ create_time	├ create_time	string	2020-04-13 19:46:43
├ update_by	├ update_by	string	6c4af3244178febe
├ update_time	├ update_time	string	2020-04-13 19:47:09
├ lng	├ lng	float	103.99317
├ lat	├ lat	float	30.455317
├ address	├ address	string	四川省成都市双流区正公路南100米普洛斯双流物流园
├ client_name	├ client_name	string	顺丰搬仓
├ client_phone	├ client_phone	string	19130694970
├ client_tel	├ client_tel	string
├ to_lng	├ to_lng	float	104.06987
├ to_lat	├ to_lat	float	30.554342
├ to_address	├ to_address	string	四川省成都市武侯区天府大道中段199号
├ to_client_name	├ to_client_name	string	测试货主
├ to_client_phone	├ to_client_phone	string	15984850858
├ to_client_tel	├ to_client_tel	string
├ cargos[]	├ 调度单货物	array
│ ├ name	│ ├ name	string	货物
│ ├ num	│ ├ num	int	1
│ ├ volume	│ ├ volume	int	0
│ └ weight	│ └ weight	int	0
├ wb_payment	├ wb_payment	int	102
├ wb_fee	├ wb_fee	int	6
├ wb_cfs_fee	├ wb_cfs_fee	int	3
├ weight	├ weight	int	0
├ volume	├ volume	int	0
├ price	├ price	int	0
├ status	├ status	int	2
├ rim_ids	├ rim_ids	string	,9a2b52973227f703,
├ driver_ids	├ driver_ids	string	,6c4af3244178febe,
├ waybill_ids	├ waybill_ids	string	,5e94513d01203517,
├ do_driver_ids	├ do_driver_ids	string	,6c4af3244178febe,
├ note	├ note	string
├ remark	├ remark	string
├ delete_time	├ delete_time	int	0
├ wb_receipt_need_num	├ wb_receipt_need_num	int	1
├ wb_agencyfund_fee	├ wb_agencyfund_fee	int	0
├ wb_intro_fee	├ wb_intro_fee	int	5
├ province_id	├ province_id	int	37491
├ city_id	├ city_id	int	37917
├ district_id	├ district_id	int	0
├ to_province_id	├ to_province_id	int	510000
├ to_city_id	├ to_city_id	int	28
├ to_district_id	├ to_district_id	int	0
├ wb_send_time	├ wb_send_time	string	2020-04-13 00:00:00
├ wb_delayed_settlement	├ wb_delayed_settlement	int	1
├ wb_monthly_balance	├ wb_monthly_balance	int	1
├ wb_third_waybill_no	├ wb_third_waybill_no	string
├ wb_donot_divide	├ wb_donot_divide	int	0
├ dsp_id	├ dsp_id	string
├ tax_type	├ tax_type	int	1
├ tax_rate	├ tax_rate	float	0.09
├ is_outside	├ is_outside	int	0
├ outside_data[]	├ outside_data	arrayo
├ customer_id	├ customer_id	string
├ project_id	├ project_id	string
├ businessmode_id	├ businessmode_id	string
├ groupbox_id	├ groupbox_id	int	0
├ groupbox_sort	├ groupbox_sort	int	0
├ platoonbox_id	├ platoonbox_id	int	0
└ platoonbox_sort	└ platoonbox_sort	int	0
signin	签收信息	string
lineids	所经线路集合	string		干线有，城配无
netids	所经网点集合	string		干线有，城配无
orgids	所辖机构集合	string		干线有，城配无
curr_net_id	当前位置网点	string		干线有，城配无
has_outsourcing_bill	是否存在外包单	int	0	1有 0无
third_waybill_no	第三方运单号	string
customer_id	客户ID	string
businessmode_id	业务模式ID	string
project_id	项目ID	string
prebill_id	关联预约单ID	string
dispatch_id	关联调度单ID	string	5e94512301086199
has_problem	运单是否存在问题	int	0
penalty_id	罚款信息ID	string		若无罚款，此值为空
remark	备注信息	string
tax_type	使用税种	int	1
donot_divide	是否不启用分成	int	0	1不分成，系统不再收取运费分成 0要分成
approval_status	审批状态	int	0
approval_time	审批时间	int	0
approval_by	审批人信息	string
settlement_time	结算时间	int	0
settlement_by	结算人信息	string
dsp_id	分公司ID	string
delete_time	假删除时间	int	0
maxorder	maxorder	string	1
shipper{}	发货人信息	object
├ client_id	├ 客户ID	string	5e0aa9ed01329366
├ rimids	├ 归属区域商	string	,9a2b52973227f703,
├ crtbys	├ 创建所有人	string	,6c4af3244178febe,
├ province_id	├ 省	int	37491
├ city_id	├ 市	int	37917
├ district_id	├ 区	int	38250
├ lng	├ 经度	float	103.99317
├ lat	├ 纬度	float	30.455317
├ name	├ 姓名	string	顺丰搬仓
├ phone	├ 电话	string	19130694970
├ reserve_phone	├ 备用电话	string
└ address	└ 地址	string	四川省成都市双流区正公路南100米普洛斯双流物流园
consignee{}	收货人信息	object
├ client_id	├ 客户ID	string	5e94513d01519555
├ rimids	├ 归属区域商	string	,9a2b52973227f703,
├ crtbys	├ 创建所有人	string	,6c4af3244178febe,
├ province_id	├ 省	int	37491
├ city_id	├ 市	int	37917
├ district_id	├ 区	int	38288
├ lng	├ 经度	float	104.06987
├ lat	├ 纬度	float	30.554342
├ name	├ 姓名	string	测试货主
├ phone	├ 电话	string	15984850858
├ reserve_phone	├ 备用电话	string
└ address	└ 地址	string	四川省成都市武侯区天府大道中段199号
cargos[]	货物信息	array
├ cargo_id	├ 货物ID	string	5e94513d01564001
├ waybill_id	├ 货物关联运单ID	string	5e94513d01203517
├ name	├ 货物名	string	货物
├ num	├ 数量	int	1
├ packing	├ 包装	int	1
├ weight	├ 重量	int	0
├ volume	├ 体积	int	0
├ cost	├ 价值	int	0
├ rates	├ 保率	int	0
└ premium	└ 保费	int	0
fee{}	费用信息	object
├ waybill_id	├ 关联运单ID	string	5e94513d01203517
├ carriage_fee_inp	├ 运费-录	int	6
├ pickup_fee	├ 提货费	int	0
├ cfs_fee	├ 装卸费	int	3
├ cfs_fee_nop	├ 装卸费_nop	int	0
├ forklift_fee	├ 叉车费	int	0
├ intro_fee	├ 信息费	int	5
├ deliver_fee	├ 送货费	int	0
├ insure_fee	├ 保险费-系	int	0
├ insure_fee_inp	├ 保险费-填	int	0
├ agencyfund_fee	├ 代收货款-填	int	0
├ print_show_fee	├ 打印显示费用合计	int	0
├ client_first_payment_fee	├ 客户首期付款	int	0
├ client_middle_payment_fee	├ 客户中期付款	int	0
├ client_last_payment_fee	├ 客户末期付款	int	14
├ client_total_payment_fee	├ 客户付款合计	int	14
├ total_fee_nointro	├ 不含信息的总运费	int	9
├ tax_fee	├ 税费	float	0.54
├ tax_rate	├ 税率	float	0.09
├ system_income_fee	├ 系统收益	float	0.36
├ beused_divide_fee	├ 用于分成的费用	float	5.46
├ divide_data{}	├ 分成费用数据	object
│ ├ divide_sys{}	│ ├ 系统分成	object
│ │ ├ link_type	│ │ ├ 连接类型-系统/子系统	int	1
│ │ ├ link_id	│ │ ├ 系统ID/子系统ID	string	1000000000000000
│ │ └ divide_price	│ │ └ 分成金额	float	0.36
│ ├ divide_regionmerch{}	│ ├ 区域商分成	object
│ │ ├ link_type	│ │ ├ 连接类型-区域商	int	5
│ │ ├ link_id	│ │ ├ 区域商ID	string	9a2b52973227f703
│ │ └ divide_price	│ │ └ 分成金额	int	0
│ └ divide_driver{}	│ └ 司机分成	object
│ ├ link_type	│ ├ 连接类型-司机	int	0
│ ├ link_id	│ ├ 司机ID	string	6c4af3244178febe
│ └ divide_price	│ └ 分成金额	float	5.1
├ forfeit_fee	├ 叉车费	int	0
└ delivery_fee	└ 送货费	int	0
fee_list[]	费用清单	array
├ feelist_id	├ 清单ID	string	5e94513d01100073
├ waybill_id	├ 关联运单ID	string	5e94513d01203517
├ type	├ 费用类型	int	888
├ fee	├ 金额	float	0.54
├ actual_fee	├ 实际支付金额	int	0
├ is_online	├ 是否线上支付	int	1
├ status	├ 状态	int	0
├ create_time	├ 创建时间	string	2020-04-13 19:47:09
├ create_by	├ 创建人	string	6c4af3244178febe
├ update_time	├ 更新时间	string	2020-04-13 19:47:09
├ update_by	├ 更新人	string	6c4af3244178febe
├ strflow	├ 费用流向	string	Sp.1000000000000000-Sy.1000000000000000
└ remark	└ 备注	string	税费
prebill{}	预约单信息	object		从预约单转入的才有
├ prebill_id	├ 预约单id	string
└ prebill_no	└ 预约单号	string
customer	客户	string
platform	平台信息	string
gss_info{}	G7关联信息	object		若未提交此项或为空
├ waybill_id	├ waybill_id	string	5e94513d01203517
├ gss	├ 运单提交G7状态	int	3	0未提交 1已提交 2审核通过 3审核不通过
├ gss_msg	├ 提交G7反馈消息	string	thirdId[5e94513d01203517]货物重量格式错误
├ gss_actual_shipping_time	├ 提交G7装货时间	int	0
├ gss_actual_shipping_status	├ 提交G7装货时间状态	int	0
├ gss_receipt_time	├ 提交G7卸货时间	int	0
├ gss_receipt_status	├ 提交G7卸货时间状态	int	0
├ gss_pay_status	├ G7提交支付计划状态	int	0	0未提交 1已提交 2审核通过 3审核不通过
├ gss_pay_complete	├ G7支付进度	int	0	0=未支付，1=支付完成，2=部分支付
├ gss_pay_msg	├ 提交G7支付消息	string
├ gss_service_fee	├ G7服务费	int	0
├ gss_service_fee_deduct_amouont	├ G7服务费抵扣金额	int	0
├ gss_invoice_status	├ G7开票状态	int	0	0=不可开票,1=可开票,2=开票中,3=已开票
├ gss_invoice_id	├ 关联G7发票ID	string
├ gss_invoice_total_price	├ G7发票总金额	int	0
├ gss_invoice_data	├ G7发票数据内容	string
├ gss_check_status	├ G7检查状态	int	0	0=审验中，1=审验失败，2=审验通过
├ gss_shipping_price	├ 提交G7运费金额	int	0
├ gss_verify_status	├ G7运单状态	int	0	0 待申诉 1 申诉中 2 申诉拒绝 3 正常/审核通过
├ gss_wbid	├ G7的运单ID	string
└ gss_wbdata[]	└ G7的运单数据	arrayo
create_rim{}	创建区域商信息	object
├ rim_id	├ 区域商ID	string	9a2b52973227f703
├ code	├ code	string	R2068
├ province_id	├ province_id	int	34515
├ city_id	├ city_id	int	34516
├ district_id	├ district_id	int	34553
├ lng	├ lng	float	100.191521
├ lat	├ lat	float	34.263148
├ name	├ name	string	测试区域商
├ english_name	├ english_name	string	Test area business
├ address	├ address	string	青海省果洛藏族自治州玛沁县大武镇
├ contacts	├ contacts	string	测试
└ mobile	└ mobile	string	15999999999
synthesize{}	综合数据	object
├ qrcode	├ 二维码地址	string	http://dev3srv.echuan56.com/qrcode/WZOHRM
├ barcode	├ 条码地址	string	http://dev3srv.echuan56.com/barcode/WZOHRM
├ feecalc_receivable	├ 应收	int	14
├ feecalc_payable	├ 应付	float	8.1
├ feecalc_profit	├ 利润	float	5.9
└ feecalc_profit_notax	└ 除税利润	float	5.36
tax_type_text	税种名称	string	增值税
complaint_status	complaint_status	int	0

请求示例

请求例子：

 
apirq('waybill')

返回数据结果：

 
{
    "code": 0,
    "msg": "ok",
    "time": "1528355132",
    "data": {
        "page": 1,
        "row": 15,
        "count": 1,
        "total_count": 1,
        "total_page": 1,
        "lists": [
            {
                "waybill_id": "5b179f7501076844",
                "waybill_no": "A10011",
                "is_preset_waybill": 0,
                "status": 0,
                "substatus": 0,
                "unsteady_status": "",
                "shipper_id": "5b179f7501704559",
                "consignee_id": "5b179f7501069001",
                "start_net_id": "2c4da2ba57bcfcf6",
                "end_net_id": "c97bea48dc2af334",
                "create_time": "2018-06-06 16:46:45",
                "create_by": "",
                "create_netid": "",
                "create_orgid": "",
                "create_merid": "c17ec996d3ffc85f",
                "update_time": "2018-06-06 16:46:45",
                "update_by": "",
                "send_time": "2018-06-05 00:00:00",
                "arrive_date": "2018-06-22 00:00:00",
                "arrive_time": "",
                "signfor_time": "",
                "receipt_time": "",
                "finish_time": "",
                "payment_method": 101,
                "delivery_method": 1,
                "time_limit": 0,
                "need_receipt_copies": 0,
                "total_weight": 58,
                "total_volume": 9,
                "total_fee": 370,
                "badge": "",
                "need_insure": 0,
                "dispatch": null,
                "signin": null,
                "lineids": "e756e30f22ed34ee",
                "netids": ",2c4da2ba57bcfcf6,5c941225fa6c62cd,c97bea48dc2af334,",
                "orgids": null,
                "curr_net_id": "",
                "has_outsourcing_bill": 0,
                "third_waybill_no": "",
                "has_problem": 0,
                "remark": "",
                "delete_time": null,
                "shipper": {
                    "client_id": "5b179f7501704559",
                    "province_id": "37491",
                    "city_id": "37917",
                    "district_id": "37983",
                    "lng": "103.575248",
                    "lat": "30.974482",
                    "name": "王小烟",
                    "phone": "13722567786",
                    "reserve_phone": "",
                    "address": "四川省成都市都江堰市玉堂镇苏家山"
                },
                "consignee": {
                    "client_id": "5b179f7501069001",
                    "province_id": "37491",
                    "city_id": "37917",
                    "district_id": "38320",
                    "lng": "104.149363",
                    "lat": "30.817605",
                    "name": "洛天依",
                    "phone": "13955321145",
                    "reserve_phone": "",
                    "address": "四川省成都市新都区新都镇邮电小区邮电小区(电子路)"
                },
                "start_net": {
                    "net_id": "2c4da2ba57bcfcf6",
                    "code": "N33664",
                    "com_id": "35bd69f599698d1f",
                    "province_id": "37491",
                    "city_id": "37917",
                    "district_id": "37983",
                    "lng": "103.640746",
                    "lat": "30.978321",
                    "name": "壹川都江堰点",
                    "english_name": "Dujiangyan point of one Sichuan Province",
                    "address": "四川省成都市都江堰市幸福镇彩虹二苑流虹苑",
                    "contacts": "江民枫",
                    "mobile": "13466214478"
                },
                "end_net": {
                    "net_id": "c97bea48dc2af334",
                    "code": "N61685",
                    "com_id": "35bd69f599698d1f",
                    "province_id": "37491",
                    "city_id": "37917",
                    "district_id": "38320",
                    "lng": "104.141566",
                    "lat": "30.791908",
                    "name": "壹川新都点",
                    "english_name": "Xindu new capital",
                    "address": "四川省成都市新都区新都镇物流大道30号传化国际新城",
                    "contacts": "都先生",
                    "mobile": "13541226655"
                },
                "curr_net": null
            }
        ]
    }
}