IconCreated with Sketch.

拉个货开放平台接口文档
La Ge Huo

open API

公共信息

**深圳市拉个货供应链物流有限公司对外开放Api **

沙盒测试环境：
    请求域名：https://test.szlagehuo.com

    accountId: 13418477405

    secretKey: ZY666666


正式环境：


    请求域名：https://www.szlagehuo.com


    accountId: 线下沟通通过邮件获取

    secretKey: 线下沟通通过邮件获取

接口列表

获取访问Token

基本信息

Path： /api/v1/open/public/getAccessToken

Method： GET

接口描述：

请求参数

Query

参数名称 是否必须 示例 备注
accountId 是 13418477405 账户Id
secretKey 是 ZY666666 账户秘钥

返回数据

名称类型是否必须默认值备注其他信息
codestring必须1: 成功

mock: 1

messagestring必须描述

mock: success

dataobject必须返回对象
├─ userIdstring必须账户Id

mock: b359d7db1c474b2b925d692ecf808b29

├─ tokenstring必须访问token （有效期30天）

mock: uQHNlJKnl6zeB68R2R2jlM22k2bP+s34mh9JXEi+L2i/O1tzBlKBvnmztUgEiF+Vk6Zv37ZnrvUnXNZ051onMwpIl3tna7w2JI3ZBXQBses=

├─ phoneNumberstring必须AccountId

mock: 13418477405

├─ userItemobject必须用户对象
├─ userIdstring必须用户Id

mock: b359d7db1c474b2b925d692ecf808b29

├─ userNamestring必须用户名

mock: 智园

├─ phoneNumberstring必须AccountId

mock: 13418477405

timestampnumber必须交互时间戳

查询支持的车型及价格

基本信息

Path： /api/v1/open/public/queryVehicleModels

Method： GET

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authorization uQHNlJKnl6zeB68R2R2jlM22k2bP+s34mh9JXEi+L2i/O1tzBlKBvnmztUgEiF+VlN6EuCNxE3nFdpBvzVMiK5Nz9rQU7xVmv88vTh0SSY4= 是 访问token

返回数据

名称类型是否必须默认值备注其他信息
codestring必须1：成功

mock: 1

messagestring必须描述

mock: success

dataobject必须响应体
├─ planDetailobject []必须车型列表

item 类型: object

├─ carMoldstring必须车型code
├─ volumenumber必须货箱容积
├─ heavynumber必须载重
├─ carMoldNamestring必须车型中文描述
├─ mainPicturestring必须车型图片
├─ overallDimensionstring必须外形尺寸

mock: 1500*1400*1200

├─ detailobject []必须里程运费

item 类型: object

├─ projectPricePlanIdnumber必须
├─ typenumber必须
├─ carMoldstring必须
├─ intervalStartnumber必须
├─ intervalEndnumber必须
├─ initialFeenumber必须起步价

mock: 30

├─ perStepFeenumber必须
├─ useInitialFeeSignnumber必须
├─ waitDetailListobject []必须等候费

item 类型: object

├─ projectPricePlanIdnumber必须
├─ typenumber必须
├─ carMoldstring必须
├─ intervalStartnumber必须
├─ intervalEndnumber必须
├─ initialFeenumber必须
├─ perStepFeenumber必须
├─ useInitialFeeSignnumber必须
├─ tailboardListobject []必须尾板费

item 类型: object

├─ projectPricePlanIdnumber必须
├─ typenumber必须
├─ carMoldstring必须
├─ intervalStartnumber必须
├─ intervalEndnumber必须
├─ initialFeenumber必须
├─ perStepFeenumber必须
├─ useInitialFeeSignnumber必须
├─ crossPointListobject []必须串点费

item 类型: object

├─ projectPricePlanIdnumber必须
├─ typenumber必须
├─ carMoldstring必须
├─ intervalStartnumber必须
├─ intervalEndnumber必须
├─ initialFeenumber必须
├─ perStepFeenumber必须
├─ useInitialFeeSignnumber必须
timestampnumber必须

解析地址POI定位

基本信息

Path： /api/v1/open/public/addressInputSearch

Method： GET

接口描述：

响应示例：


{
  "code": "1",
  "message": "success",
  "data": [
    {
      "id": "B0HRULIQZU",
      "name": "宝龙街道",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.314604,22.689575",
      "address": "宝龙街道",
      "typecode": "190107",
      "city": "",
      "recordId": "1128697001065332736"
    },
    {
      "id": "B02F38JOGK",
      "name": "深圳市龙岗区宝龙街道宝龙社区诚信大药房茂盛店",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.278240,22.680982",
      "address": "翠宝路32号",
      "typecode": "090601",
      "city": "",
      "recordId": "1128697001065332737"
    },
    {
      "id": "B0FFHQ5MFF",
      "name": "宝龙街道办事处",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.314572,22.689603",
      "address": "宝龙大道",
      "typecode": "130105",
      "city": "",
      "recordId": "1128697001065332738"
    },
    {
      "id": "B0JUVL7ELD",
      "name": "宝龙街道新联",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.303254,22.730387",
      "address": "兰水三街与兰水路交叉口南120米",
      "typecode": "170200",
      "city": "",
      "recordId": "1128697001065332739"
    },
    {
      "id": "B0IB1RH15G",
      "name": "宝龙街道分馆",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.288264,22.721242",
      "address": "宝龙街道龙东社区金井路29号2楼右转",
      "typecode": "140000",
      "city": "",
      "recordId": "1128697001065332740"
    },
    {
      "id": "B0FFKM5X1L",
      "name": "深圳市龙岗区宝龙街道同心社区新布路25号万乐园工业区B栋一楼",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.319745,22.720777",
      "address": "过坜路万乐园工业区",
      "typecode": "120000",
      "city": "",
      "recordId": "1128697001065332741"
    },
    {
      "id": "B0H1XA5MSW",
      "name": "宝龙街道办事处综合行政执法队综合行政执法办公室",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.314269,22.689702",
      "address": "宝龙大道与冬青路交叉口东北角",
      "typecode": "130105",
      "city": "",
      "recordId": "1128697001065332742"
    },
    {
      "id": "BV11073671",
      "name": "宝龙街道办(公交站)",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.314687,22.689147",
      "address": "B922路;M220路;M305路内环;M305路外环;M322路",
      "typecode": "150700",
      "city": "",
      "recordId": "1128697001065332743"
    },
    {
      "id": "B0FFL8DG8D",
      "name": "中共深圳市龙岗区宝龙街道龙东社区吓井二居民小组支部委员会",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.285339,22.721687",
      "address": "新井路与新洲路交叉口西北20米",
      "typecode": "130100",
      "city": "",
      "recordId": "1128697001065332744"
    },
    {
      "id": "B0FFL7L54J",
      "name": "中共深圳市龙岗区宝龙街道龙新社区兰三居民小组支部委员会",
      "district": "广东省深圳市龙岗区",
      "adcode": "440307",
      "location": "114.305726,22.731354",
      "address": "兰水路与兰水二路交叉口东100米",
      "typecode": "130100",
      "city": "",
      "recordId": "1128697001065332745"
    }
  ],
  "timestamp": 1689143935240
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authorization uQHNlJKnl6zeB68R2R2jlM22k2bP+s34mh9JXEi+L2i/O1tzBlKBvnmztUgEiF+VlN6EuCNxE3nFdpBvzVMiK5Nz9rQU7xVmv88vTh0SSY4= 是 访问token

Query

参数名称 是否必须 示例 备注
keywords 是 宝龙街道 搜索关键字
city 否 深圳 搜索城市范围(中文名称)， 如:深圳

返回数据

名称类型是否必须默认值备注其他信息
codestring必须1：成功
messagestring必须描述
dataobject []必须查询到的地址列表

item 类型: object

├─ idstring必须地址poi Id

mock: B0HRULIQZU

├─ namestring必须地址名称

mock: 宝龙街道

├─ districtstring必须区域

mock: 广东省深圳市龙岗区

├─ adcodestring必须
├─ locationstring必须定位经纬度

mock: 114.278240,22.680982

├─ addressstring必须详细地址
timestampnumber必须

运费试算

基本信息

Path： /api/v1/open/projectTask/costCalculation

Method： POST

接口描述：

请求示例：

{
  "paymentType": 1,
  "thirdPartyOrders": {
    "vehicleCarMold": "I493HI",
    "projectTaskDeliveryList": [
      {
        "consigneeAddressName": "深圳市龙岗区明星学校",
        "consigneeAddress": "深圳市龙岗区龙东大埔同昌路16号",
        "consigneeIdLocation": "114.294837,22.713934"
      },
      {
        "consigneeAddressName": "利好工业园",
        "consigneeAddress": "广东省深圳市龙岗区爱南路78号",
        "consigneeIdLocation": "114.287570,22.711522",
        "consigneePoiId" : "B02F38IPWO"
      }
    ]
  }
}

响应示例：

{
  "code": "1",
  "message": "success",
  "data": {
    "totalDistance": 2,
    "totalFee": "50.00",
    "initFee": "50.00",
    "mileageFee": "0.00",
    "crossPointCount": 0,
    "crossPointFee": "0",
    "cacheKey": "f1c2855954b7ec9ce821cb20c40e4b6d",
    "timeStamp": "2023-07-13 10:11:38",
    "projectTaskDeliveryList": [
      {
        "consigneeAddressName": "深圳市龙岗区明星学校",
        "consigneeAddress": "深圳市龙岗区龙东大埔同昌路16号",
        "consigneeIdLocation": "114.294837,22.713934"
      },
      {
        "consigneeAddressName": "利好工业园",
        "consigneeAddress": "广东省深圳市龙岗区爱南路78号",
        "consigneeIdLocation": "114.287570,22.711522",
        "consigneePoiId": "B02F38IPWO"
      }
    ]
  },
  "timestamp": 1689214298534
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization uQHNlJKnl6zeB68R2R2jlM22k2bP+s34mh9JXEi+L2i/O1tzBlKBvnmztUgEiF+VlN6EuCNxE3nFdpBvzVMiK5Nz9rQU7xVmv88vTh0SSY4= 是 访问token

Body

名称类型是否必须默认值备注其他信息
paymentTypenumber必须 1-余额抵扣

mock: 1

thirdPartyOrdersobject必须订单信息
├─ vehicleCarMoldstring必须车型Code (中面)

mock: I493HI

├─ useTailgatenumber非必须是否使用尾板 1-使用， 0-不使用（默认）

mock: 0

├─ projectTaskDeliveryListobject []必须订单配送明细

item 类型: object

├─ consigneeAddressNamestring非必须地址名称

mock: 深圳市龙岗区名星学校

├─ consigneeAddressstring必须地址全称

mock: 深圳市龙岗区龙东大埔同昌路16号

├─ consigneeDoorplatestring非必须详细门牌号

mock: 1001-1

├─ consigneeIdLocationstring必须地址经纬度

mock: 114.294837,22.713934

├─ consigneePoiIdstring非必须地址定位poi Id（为了定位的精确建议使用poi Id）

mock: B02F30A54F

返回数据

名称类型是否必须默认值备注其他信息
codestring必须1: 成功
messagestring必须描述
dataobject必须响应体
├─ totalDistancenumber必须总里程
├─ totalFeestring必须总费用
├─ initFeestring必须起步费用
├─ mileageFeestring必须超里程费用
├─ crossPointCountnumber必须串点数量
├─ crossPointFeestring必须串点费用
├─ cacheKeystring必须费用试算临时code
├─ timeStampstring必须交互时间戳
├─ projectTaskDeliveryListobject []必须路线列表

item 类型: object

├─ consigneeAddressstring必须详细地址
├─ consigneeIdLocationstring必须地址定位
├─ consigneePoiIdstring必须地址poi
timestampnumber必须

在线下单

基本信息

Path： /api/v1/open/projectTask/submit

Method： POST

接口描述：

请求示例：

{
   "thirdPartyOrders": {
      "vehicleCarMold": "I493HI",
      "payMileage": 36,
      "payFee": "203.30",
      "initialFee": "63.80",
      "mileageFee": "139.50",
      "crossPointCount": 0,
      "crossPointFee": "0",
      "cacheKey": "a00bee1aa962a8655b72a12506027f6e",
      "entourageNums": 0,
      "executionDate": "2023-07-13 10:53:12",
      "projectTaskDeliveryList": [{
            "deliveryId": "",
            "consigneeAddressName": "深圳市龙岗区名星学校",
            "consigneeAddress": "广东省深圳市龙岗区龙东大埔同昌路16号",
            "consigneeDoorplate": "1002",
            "consigneeIdLocation": "114.294837,22.713934",
            "consigneePoiId": "B02F30A54F",
            "consigneeName": "中",
            "consigneePhone": "13058132230",
            "remark": "纸箱包装",
            "goodsNum": "2",
            "goodsWeight": "1.3",
            "goodsVolume": "5.3"
         },
         {
            "deliveryId": "",
            "consigneeAddressName": "深华科技工业园",
            "consigneeAddress": "广东省深圳市福田区梅秀路2号",
            "consigneeDoorplate": "1003",
            "consigneeIdLocation": "114.049603,22.563014",
            "consigneePoiId": "B0FFG760G8",
            "consigneeName": "是",
            "consigneePhone": "13058123300",
            "remark": "需要小拖车",
            "goodsNum": "3",
            "goodsWeight": "1.5",
            "goodsVolume": "5.6"
         }
      ]
   },
   "paymentType": 1,
}

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization 是 访问token

Body

名称类型是否必须默认值备注其他信息
paymentTypenumber必须 1-余额抵扣

mock: 1

thirdPartyOrdersobject必须订单信息
├─ projectTaskIdnumber非必须任务订单Id,（修改必传）
├─ vehicleCarMoldstring必须车型code （中面）

mock: I493HI

├─ payMileagestring非必须总计费里程（Km）

mock: 25

├─ payFeestring非必须总计费金额（单位元）

mock: 15.32

├─ initialFeestring非必须起步费（单位元）

mock: 35

├─ mileageFeestring非必须超里程费用（单位元）

mock: 12.36

├─ crossPointCountstring非必须串点数量

mock: 1

├─ crossPointFeestring非必须串点费用（单位元）

mock: 15

├─ projectTaskDeliveryListobject []必须地址信息。 可填入多个地址，第一个是发货地址，最后一个是收货地址，中间是经停点，最多10个地址

item 类型: object

├─ deliveryIdstring非必须明细Id （修改时，如果有明细Id需要传）

mock: 1012

├─ goodsTypeNamestring非必须货物名称

mock: 书本

├─ goodsNumstring非必须货物数量（件、箱）

mock: 1

├─ goodsWeightstring非必须货物重量（kg）

mock: 200

├─ goodsVolumestring非必须体积（方）

mock: 5.5

├─ consigneeNamestring非必须联系人名称
├─ consigneePhonestring必须联系人电话
├─ consigneeAddressNamestring非必须地址名称

mock: 明星学校

├─ consigneeAddressstring必须地址全称

mock: 深圳市龙岗区宝龙街道同昌路30号明星学校

├─ consigneeDoorplatestring非必须详细门牌号

mock: 1001-1

├─ consigneeIdLocationstring必须地址经纬度(gcj02坐标系)

mock: 114.1233,22.2365

├─ consigneePoiIdstring非必须地址定位poi Id

mock: I493HIDF56

├─ consigneeArriveTimestring非必须
├─ remarkstring非必须备注
├─ executionDatestring必须用车时间 yyyy-MM-dd HH:mm:ss

mock: 2023-07-13 10:53:12

├─ entourageNumsnumber必须随行人员数量

mock: 0

├─ cacheKeystring必须费用试算返回的临时code
├─ useTailgatestring必须

返回数据

名称类型是否必须默认值备注其他信息
codestring必须1：成功
messagestring必须描述
dataobject必须响应体
├─ projectTaskIdnumber必须任务订单Id
timestampnumber必须交易时间戳

取消订单

基本信息

Path： /api/v1/open/projectTask/cancel

Method： POST

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是
Authorization uQHNlJKnl6zeB68R2R2jlM22k2bP+s34mh9JXEi+L2i/O1tzBlKBvnmztUgEiF+VlN6EuCNxE3nFdpBvzVMiK5Nz9rQU7xVmv88vTh0SSY4= 是 访问token

Body

名称类型是否必须默认值备注其他信息
projectTaskIdnumber必须订单Id

mock: 5838

返回数据

名称类型是否必须默认值备注其他信息
codestring必须1:成功
messagestring必须描述

mock: success

datanumber必须1：操作成功

mock: 1

timestampnumber必须交易时间戳

查询订单列表

基本信息

Path： /api/v1/open/projectTask/queryListWithPage

Method： GET

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authorization uQHNlJKnl6zeB68R2R2jlM22k2bP+s34mh9JXEi+L2i/O1tzBlKBvnmztUgEiF+VlN6EuCNxE3nFdpBvzVMiK5Nz9rQU7xVmv88vTh0SSY4= 是 访问token

Query

参数名称 是否必须 示例 备注
page 否 1 第几页
pageSize 否 10 每页条数
projectTaskNo 否 任务订单编号
userName 否 收货人姓名
userPhone 否 收货人电话
address 否 收货地址
projectTaskStatus 否 0-待接单，1-已接单，2-运输配送中，3-已配送，4-已取消
executionStartDate 否 用车时间开始
executionEndDate 否 用车时间结束

Body

名称类型是否必须默认值备注其他信息
projectTaskIdnumber必须订单Id

mock: 5838

返回数据

名称类型是否必须默认值备注其他信息
codestring必须1：成功

mock: 1

messagestring必须描述
dataobject必须响应体
├─ pagenumber必须第几页

mock: 1

├─ pageSizenumber必须每页条数

mock: 10

├─ pagesnumber必须总页数

mock: 1

├─ totalnumber必须总记录条数

mock: 5

├─ itemsobject []必须数据集合

item 类型: object

├─ projectTaskIdnumber必须任务订单Id
├─ projectTaskNostring必须任务订单编号
├─ projectRouteNamestring必须计费模板名称
├─ payFeestring必须任务订单总金额
├─ initialFeestring必须起步费用
├─ mileageFeestring必须超里程费用
├─ couponFeestring必须优惠金额
├─ paymentTypenumber必须
├─ payMileagenumber必须总路线里程（km）
├─ vehicleCarMoldstring必须车型code
├─ planDistributionTimestring必须用车时间
├─ entourageNumsnumber必须随行人员数量
├─ sourcePartyIdnumber必须
├─ sourcePartyNamestring必须
├─ remarkstring必须备注
├─ useTailgatenumber必须是否使用尾板
├─ waitTimeValuenumber必须等候时间（分钟）
├─ projectTaskStatusnumber必须任务订单配送状态（0-待接单，1-已接单，2-运输配送中，3-已配送，4-已取消）
├─ projectPaymentStatusnumber必须任务订单支付状态(0未支付 1已支付 2申请退款中 3已退款)
├─ crossPointCountnumber必须串点个数
├─ crossPointFeenumber必须串点费用
├─ createdTimestring必须下单时间
├─ listobject []必须配送地址明细

item 类型: object

├─ deliveryIdnumber必须配送单Id
├─ deliveryNostring必须配送单编号
├─ projectTaskIdnumber必须任务订单Id
├─ deliverySortnumber必须配送顺序
├─ goodsNumnumber必须数量（件/箱）
├─ goodsWeightnumber必须重量（kg）
├─ goodsVolumenumber必须体积（方）
├─ deliveryStatusnumber必须配送状态(1:待配送、2:配送中、3:已配送)
├─ consigneeNamestring必须收货客户名称
├─ consigneePhonestring必须收货客户电话
├─ consigneeAddressNamestring必须收货地址名称
├─ consigneeAddressstring必须收货地址
├─ consigneeDoorplatestring必须收货地址门牌号
├─ consigneeIdLocationstring必须收货地址定位
├─ consigneePoiIdstring必须收货地址高德POI Id
├─ remarkstring必须备注
├─ waitTimeValuenumber必须等候时长
timestampnumber必须交易时间戳

查询订单详情

基本信息

Path： /api/v1/open/projectTask/queryDetail

Method： GET

接口描述：

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Authorization uQHNlJKnl6zeB68R2R2jlM22k2bP+s34mh9JXEi+L2i/O1tzBlKBvnmztUgEiF+VlN6EuCNxE3nFdpBvzVMiK5Nz9rQU7xVmv88vTh0SSY4= 是 访问token

Query

参数名称 是否必须 示例 备注
projectTaskId 是 5835 任务订单Id

Body

名称类型是否必须默认值备注其他信息
projectTaskIdnumber必须订单Id

mock: 5838

返回数据

名称类型是否必须默认值备注其他信息
codestring必须1: 成功
messagestring必须描述
dataobject必须响应体
├─ projectTaskIdnumber必须任务订单Id
├─ projectTaskNostring必须任务订单编号
├─ projectRouteNamestring必须计费模板名称
├─ payFeestring必须任务订单总金额
├─ initialFeestring必须起步费用
├─ mileageFeestring必须超里程费用
├─ couponFeestring必须优惠金额
├─ paymentTypenumber必须支付方式
├─ payMileagenumber必须总路线里程
├─ vehicleCarMoldstring必须车型code
├─ vehicleCarMoldNamestring必须车型名称
├─ planDistributionTimestring必须用车时间
├─ entourageNumsnumber必须随行人员数量
├─ remarkstring必须备注
├─ useTailgatenumber必须是否使用尾板 1-使用 0-未使用
├─ waitTimeValuenumber必须等候时间（分钟）
├─ projectTaskStatusnumber必须任务订单配送状态（0-待接单，1-已接单，2-运输配送中，3-已配送，4-已取消）
├─ projectPaymentStatusnumber必须任务订单支付状态(0未支付 1已支付 2申请退款中 3已退款)
├─ crossPointCountnumber必须串点个数
├─ crossPointFeenumber必须串点费用
├─ createdTimestring必须下单时间
├─ listobject []必须配送地址明细

item 类型: object

├─ deliveryIdnumber必须配送单Id
├─ deliveryNostring必须配送单编号
├─ projectTaskIdnumber必须任务订单Id
├─ deliverySortnumber必须配送顺序
├─ goodsNumnumber必须数量（件/箱）
├─ goodsWeightnumber必须重量（kg）
├─ goodsVolumenumber必须体积（方）
├─ deliveryStatusnumber必须配送状态(1:待配送、2:配送中、3:已配送)
├─ consigneeNamestring必须收货客户名称
├─ consigneePhonestring必须收货客户电话
├─ consigneeAddressNamestring必须收货地址名称
├─ consigneeAddressstring必须收货地址
├─ consigneeDoorplatestring必须收货地址门牌号
├─ consigneeIdLocationstring必须收货地址定位
├─ consigneePoiIdstring必须收货地址高德POI Id
├─ remarkstring必须备注
├─ waitTimeValuenumber必须等候时长
├─ driverVehicleResobject必须接单司机和车辆
├─ userNamestring必须司机姓名
├─ phoneNumberstring必须司机电话
├─ vehicleNostring必须车牌号
├─ longitudestring必须司机当前定位经度
├─ latitudestring必须司机当前定位纬度
├─ payListstring []必须

item 类型: string

├─ 非必须
timestampnumber必须交易时间戳