开发 出行解决方案参考手册 服务端相关服务 其他相关 订单信息同步

订单信息同步 最后更新时间: 2020年12月15日

法律声明

版权所有©2019,高德集团。 保留一切权利。 本文档包含的所有内容除特别声明之外,版权均属于高德集团所有,受《中华人民共和国著作权法》及相关法律法规和中国加入的所有知识产权方面的国际条约的保护。未经本公司书面许可,任何单位和个人不得以任何方式(电子或机械,包括影印)翻印或转载本文档的任何部分,否则将视为侵权,高德集团保留依法追究其法律责任的权利。 高德地图API 的一切有关权利属于高德集团所有。 本文档并不代表供应商或其代理的承诺,高德集团可在不作任何申明的情况下对本文档内容进行修改。 本文档中所涉及的软件产品及其后续升级产品均由高德集团制作并负责全权销售。 本文档中提到的其它公司及其产品的商标所有权属于该商标的所有者。

高德地图API 欢迎用户的任何建议或意见。

前言

本文主要对车辆信息传输规范进行介绍,包括信息传输方式、协议、频率、具体信息等内容. 注意

  • 接口URL示例中,使用<用户Key>(含尖括号),请替换为用户在lbs.amap.com中申请的Key.

订单信息同步

概述

订单信息传输是指根据既定协议,按照特定频率,向数据库中进行数据写入行程订单相关信息的过程.

服务协议

HTTP/POST

URL

http://tsapi.amap.com/v1/data/order?key=xxxxx

编码格式

如无特殊声明,所有接口的输入参数和输出数据编码全部统一为UTF-8.

请求

消息体内容

 名称 

 含义 

 字段类型 

 说明 

 是否必填 

 msgID 

 消息唯一ID 

 string 

 每个请求的唯一ID,确保唯一即可。推荐使用UUID策略。 

 type 

 数据类型 

 string 

 描述消息体传递的数据类型,字段值:orders 

 time 

 发送时间 

 long 

 向高德服务器发送数据的时间,发送方服务器的本地时间;以毫秒为单位的Unix时间戳 

 key 

 Key 

 string 

 用户可在lbs.amap.com申请,后台自动分配。

 data.orders 

 订单信息 

 dict 

 订单信息 

 data.orders.orderID 

 订单ID 

 string 

 订单唯一标识

如: 9877234

 data.orders.customerDeviceId 

 下单用户设备号 

 string 

 下单用户设备号

Android系统: IMEI, 例: 862918039347887

iOS系统: IDFA (无IDFA则使用IDFV), 例: 0DF2B2AC-52B9-4CD5-DCEC-200CF8A1664A

 data.orders.

amapOID

 高德订单ID 

 string 

 高德易行平台订单ID。

非高德易行平台订单则传空。

如: 2502789315097779

 data.orders.type 

 订单类型 

 int 

 订单类型, 如:

1:实时订单

2:预约订单

3:接机单

4:送机单

5:日租

6:半日租

 data.orders.status 

 订单状态 

 int 

 具体状态值对应关系见附表。

每次订单状态更新,立即同步一次数据

 data.orders.statusTime 

 订单状态变更时间 

 long 

 订单发生变化时刻的时间,以毫秒为单位的Unix时间戳 

 data.orders.orderCity 

 订单城市 

 string 

 订单所在城市, 使用citycode。

如: 010

 data.orders.vehicleID 

 车辆ID 

 string 

 订单匹配的车辆的唯一标示.

如订单还未分配车辆则传0,0.

如: 9876465

 data.orders.vehicleType 

 订单车辆类型 

 int 

 int车辆级别分类, 如:

0:所有分类

1:出租车

2:新能源

3:舒适型

4:豪华型

5:商务型

和data/vehicle枚举保持一致

 data.orders.vehicleLocation 

 车辆位置 

 string 

 车辆位置经纬度。经度在前,纬度在后,经度和纬度用英文半角逗号","分隔,小数点后不得超过6位,单次只可以传入一组经纬度坐标对。

如订单还未分配车辆则传空.

 data.orders.start 

 出发点经纬度 

 string 

 出发点经纬度。经度在前,纬度在后,经度和纬度用英文半角逗号","分隔,小数点后不得超过6位,单次只可以传入一组经纬度坐标对。

如: 120.147006,30.29442

数据缺失情况下可以传0.0,0.0

 data.orders.startName 

 出发点名称 

 string 

 出发点名称。

数据缺失情况下可以传空

 data.orders.end 

 目的地经纬度 

 string 

 目的地经纬度。经度在前,纬度在后,经度和纬度用英文半角逗号","分隔,小数点后不得超过6位,单次只可以传入一组经纬度坐标对。

如: 120.147006,30.29444

数据缺失情况下可以传0.0,0.0

 data.orders.endName 

 目的地名称 

 string 

 目的地名称。

数据缺失情况下可以传空

 data.orders.userLocation 

 用户叫车时的位置 

 string 

 用户叫车时的位置

如: 120.147006,30.29446

数据缺失情况下可以传0.0,0.0

 data.orders.serviceStart 

 开始服务位置 

 string 

 开始服务位置

如: 120.147006,30.2946

数据缺失情况下可以传0.0,0.0

 data.orders.chargeStart 

 开始计费位置 

 string 

 开始计费位置

如: 120.147006,30.2947

数据缺失情况下可以传0.0,0.0

 data.orders.chargeEnd 

 结束计费位置 

 string 

 

结束计费位置如: 120.147006,30.29448

数据缺失情况下可以传0.0,0.0


POST 消息体JSON数据示例

{
"msgID": "63453A44-4D6F-1226-9C60-9300E4C000987",
"type": "orders",
"key": "2di95fe01a20ede3018a1c77d4a71078",
"time": 1480070652,
"data": {
"orders": [{
"orderID": "9877234",
"customerDeviceId": "862918039347887",
"amapOID": "2502789315097779",
"type": 1,
"status": 2,
"statusTime": 1480070499,
"orderCity": "010",
"vehicleID": "29003",
"vehicleType": 1,
"vehicleLocation": "116.473195,39.993253",
"start": "116.473195,39.993253",
"startName": "出发点名称",
"end": "116.447469,39.972678",
"endName": "目的地名称",
"userLocation": "104.470732,25.70567",
"serviceStart": "116.473195,39.99323",
"chargeStart": "116.473195,39.993253",
"chargeEnd": "116.447469,39.972668"}]}}


响应结果示例

{
"errcode":0,
"errmsg":"OK"}

附录

订单状态说明

 状态码 

 订单状态 

1

 未派单 

2

 已派单 

3

 开始计费 

4

 订单撤销 

5

 订单待支付(结算)

6

 订单已评价 

7

 订单待评价(已支付)

8                     

 结束行程

9

 开始服务 

10

 撤单待支付 

错误码对照表

 序号 

 errcode 

 errmsg 

 状态描述 

 问题排查策略 

1

 10000 

 OK 

 请求正常 

 请求正常 

2

 10001 

 INVALID_USER_KEY 

 key不正确或过期 

 发起请求时,传入的key不正确或者过期 

3

 10002 

 SERVICE_NOT_AVAILABL E,Solution URL "http://lbs.a map.com/api/webservice/inf o/" 

 没有权限使用相应 的服 务或者请求 接口的路径 拼写 错误 

 

1.没有权限使用相应的服务,例如:申请了WEB定位功能的key,却使用该key访问逆地理编码功能时,就会返回该错误。反之亦然

2.请求接口的路径拼写错误

4

 10003 

 DAILY_QUERY_OVER_LIMI T,Solution URL "http://lbs.am ap.com/api/webservice/info/" 

 访问已超出日访问 量 

 日访问量超限,被系统自动封停,第二天0:0 0会自动解封

5

 10004 

 ACCESS_TOO_FREQUEN T,Solution URL"http://lbs.am ap.com/api/webservice/info/" 

 单位时间内访问过 于频 繁 

 单位时间内(1分钟)访问量超限,被系统 自 动封停,下一分钟自动解封。 

6

 10005 

 INVALID_USER_IP 

 IP白名单出错,发 送请求的服务器IP 不在IP白名单内 

 在LBS官网控制台设置的IP白名单不正确。 白名单中未添加对应服务器的出口IP。可 到"控制台>配置"中设定IP白名单

7

 10006 

 INVALID_USER_DOMAIN 

 绑定域名无效 

 为Key绑定的域名无效,需要在官网控制台 重 新设置 

8

 10007 

 INVALID_USER_SIGNATURE

 数字签名未通过验 证 

 数字签名未通过。在key控制台中,开启 了"数字签名"功 能,但没有按照指定算法生 成"数字签名

9

 10008 

 INVALID_USER_SCODE 

 MD5安全码未通过 验证 

 需要判定key绑定的SHA1,package是否与sd k包里的一致 

10

 10009 

 USERKEY_PLAT_NOMATCH 

 请求key与绑定平 台不 符 

 请求中使用的key与绑定平台不符,例如: 申 请的是JS A PI的key,却用来调Web服务 接口 

11

 10010 

 IP_QUERY_OVER_LIMIT,So lution URL "http://lbs.amap.c om/api/webservice/info/" 

 IP访问超限 

 未设定IP白名单的开发者使用Key发起请 求, 从单个IP向 服务器发送的请求次数超 出限 制,被系统自动封停

12

 10011 

 NOT_SUPPORT_HTTPS 

 服务不支持https请 求 

 服务不支持https请求,如果需要申请支持, 请提交工单联系我们 

13

 10012 

 INSUFFICIENT_PRIVILEGE S 

 权限不足,服务请 求被 拒绝 

 由于不具备请求该服务的权限,所以服务被 拒绝

14

 

 10013

 USER_KEY_RECYCLED 

 Key被删除 

 Key被删除后无法正常使用 

15

 10014 

 QPS_HAS_EXCEEDED_TH E_LIMIT 

 QPS超限 

 QPS超出限制,超出部分的请求被拒绝。限 流阈值内的请求依旧会正常返回 

16

 

 10015

 GATEWAY_TIMEOUT 

 受单机QPS限流限 制 

 受单机QPS限流限制时出现该问题,建议降 低请求的QPS或在控制台提工单联系我们 

17

 10016 

 SERVER_IS_BUSY 

 服务器负载过高 

 服务器负载过高,请稍后再试 

18

 10017

 RESOURCE_UNAVAILABLE

 

所请求的资源不可用

 所请求的资源不可用 

19

 10019

 CQPS_HAS_EXCEEDED_THE_LIMIT

使用的某个服务总QPS超限


20

 10020

CKQPS_HAS_EXCEEDED_THE_LIMIT 

某个Key使用某个服务接口QPS超出限制


21

 10021

 CIQPS_HAS_EXCEEDED_THE_LIMIT 

来自于同一IP的访问,使用某个服务QPS超出限制


22

 10022

 CIKQPS_HAS_EXCEEDED_THE_LIMIT

 某个Key,来自于同一IP的访问,使用某个服务QPS 超出限制


23

 10023

KQPS_HAS_EXCEEDED_THE_LIMIT 

某个KeyQPS超出限制


24

20000 

INVALID_PARAMS 

请求参数非法

请求参数的值没有按照规范要求填写。例如,某参数值域范围为[1,3],开发者误填了"4" 

25

20001  

MISSING_REQUIRED_PARAMS  

缺少必填参数  

缺少接口中要求的必填参数 

26

20002  

ILLEGAL_REQUEST  

请求协议非法  

请求协议非法 

27

20003  

UNKNOWN_ERROR  

其他未知错误  

其他未知错误 

28

20011

INSUFFICIENT_ABROAD_PRIVILEGES

查询坐标或规划点(包括起点、终点、途经点)在海 外,但没有海外地图权限


29

20012

ILLEGAL_CONTENT 

查询信息存在非法内容


30

20051

TERMINAL_NOT_FOUND 

设备不存在,即查询使用的车辆ID没有通过 data/vehicle上传


31

20052

TRACK_NOT_FOUND

轨迹不存在,即查询使用的订单ID没有通过 data/vehicle上传


32

20800

OUT_OF_SERVICE 

规划点(包括起点、终点、途经点)不在中国陆地范 围内


33

20801

NO_ROADS_NEARBY

划点(起点、终点、途经点)附近搜不到路


34

20802

ROUTE_FAIL 

路线计算失败,通常是由于道路连通关系导致


35

20803

OVER_DIRECTION_RANGE 

 起点终点距离过长


36

300**  

ENGINE_RESPONSE_DATA_ERROR  

 服务响应失败 

出现3开头的错误码,建议先检查传入参数是否正确,若无法解决,请详细描述错误复现信息,提工单给我们 

 


返回顶部 示例中心 常见问题 智能客服 公众号
二维码