点我达开放物流服务平台接入说明文档_v1.0.doc

点我达 Open API 接口说明书版本 v1.0更改记录版本号拟制/修改人拟制/修改日期主要更改内容V1.0潘罗商/赵启龙2015/07/27创建注1：每次更改归档文件时，需填写此表。注2：文件第一次归档时，“更改理由”、“主要更改内容”栏写“无”。一.点我达 API 1.0 列表接口分类接口名简述系统级输入参数详见接口详细说明订单操作派发订单派发新订单获取订单配送信息查询订单状态、配送员信息、位置等信息。取消订单取消订单修改备注信息修改点我达配送订单的备注信息获取订单状态当配送订单状态改变后，可以通过此接口获得改变后的订单状态。Request Method正式环境URL: /api/v1/Method: postFormat: json编码方式：utf-8二.接入流程接入申请向点我达开放物流服务平台对接负责人提出申请，并通过邮件提交审核材料与信息。审核通过后，就可以获得接口调用相关权限和开发文档，从而调用点我达的API、享受点我达提供的配送服务。审核材料请以邮件形式，发送如下信息到对接负责人处进行审核，我们会及时给您回馈。-申请平台名：-联系人姓名：-联系手机号：-申请方描述：-经营类型：-申请配送服务城市：-愿意支付的配送费（每单）：-其他特别说明：三.服务介绍骑士服务：骑士服务是更为高质量的最后一公里配送服务，点我达对骑士的配送服务质量有更高的要求。骑手服务： 骑手服务的配送人员是来自于众包的社会人员，在参与点我达的培训、并在点我达的服务框架下为客户提供最后一公里的物流配送服务。（服务定价由市场部门统一管理。）四.接口简述4.1接口调用流程*注： 派发订单接口调用成功表示向点我达物流开放平台下单成功、开始派单（在订单派发到某个配送员时才认为派单成功），因此需要后续调用获取订单状态接口监控派发订单的状态。订单若未成功派出，状态会由“派单中”进入“已取消”。4.1订单状态*若对接方在“配送中”状态下取消订单，由于配送服务已经发生，需要由对接方承担相应配送费用。五、接口详细说明5.1 派发订单5.1.1 接口名称order_send5.1.2 接口描述调用接口，向最合适的配送员派发订单配送任务。 5.1.3请求方式正式环境URL: /api/v1/order-send.jsonMethod: post5.1.4认证参数字段名类型是否必须示例描述pkString是123456向点我达平台申请的appkeytimestampLong是1436863897901时间戳,进行接口调用时的时间戳，以秒计算时间formatString是json响应数据格式sigString是F5A5FF4850E7681B0676C4AAD268593353C2D135appkey加密签名(系统级别参数不参与签名加密)，签名使用SHA-1加密5.1.5 请求参数字段名类型是否必须示例描述service_typeInteger是110 = 骑士, 0 = 骑手order_original_idString是fdj7387dskjle42第三方对接平台的订单IDorder_remarkString否富瑞的秘密订单订单备注city_codeString是3100城市编码（邮政编码去掉末两位, 如杭州3100,）seller_nameString是肯德基宅急送（黄龙店）商家店铺名称seller_mobileString家联系方式seller_addressString是西湖区天目山路307号史塔克基地食堂商家文字地址seller_latFloat是302.764454商家纬度坐标.(坐标系为高德地图坐标系，又称火星坐标). （单位：度）seller_lngFloat是120.111227商家经度坐标.(坐标系为高德地图坐标系，又称火星坐标)（单位：度）consignee_nameString是托尼史塔克收货人姓名consignee_mobileString货人手机号码consignee_addressString是下城区白石路300号史塔克集团顶楼收货人地址consignee_latFloat是302.764454收货人纬度坐标.(坐标系为高德地图坐标系，又称火星坐标)（单位：度）consignee_lngFloat是120.111227收货人经度坐标.(坐标系为高德地图坐标系，又称火星坐标)（单位：度）money_rider_prepaidint是5000配送员到店后先行垫付的金额(分)，一般货到付款情况下等于餐品价格。若无，传0。money_rider_chargeint是5000配送员送达到客户时，向客户收取的费用（分）。time_ready_for_deliverLong是1429861698305商品准备完成的时间，也即配送员需要到店取货的时间戳。time_waiting_at_sellerInteger是300商品必须到店才开始准备或是排队购买的情况下，在商家处等待所需时间（秒）。time_expected_arrivalLong否1429861697905用户选择的期望送达时间戳。delivery_fee_from_sellerint是500从平台或商家处收取的配送费*参数说明：-time_ready_for_deliver： 一般情况下，商品准备完成的时间即为商户确认接单的时间 + 餐品准备所需时间。-time_waiting_at_seller： 例如KFC之类的商家，餐品无法预先通知商家准备，而必须配送员到店后排队等待、然后购买。对这类商家，输入值为一般排队等待的时长（秒）。5.1.6返回参数字段名类型是否必须示例描述statusStringYsucceed状态位，succeed表示成功，fail表示调用失败dwd_order_idStringY777777点我达物流配送订单ID5.1.7 返回示例5.2 获取订单信息5.2.1 接口名称order_get5.2.2 接口描述根据点我达配送单号，查询订单状态、配送员信息、位置等内容。 5.2.3请求方式正式环境URL: /api/v1/order-get.jsonMethod: post5.2.4认证参数字段名类型是否必须示例描述pkString是123456向点我达平台申请的appkeytimestampLong是1436863897901时间戳,进行接口调用时的时间戳，以秒计算时间formatString是json响应数据格式sigString是F5A5FF4850E7681B0676C4AAD268593353C2D135appkey加密签名(系统级别参数不参与签名加密)，签名使用SHA-1加密5.2.5 请求参数字段名类型是否必须示例描述dwd_order_idString是777777点我达物流配送订单ID5.2.6返回参数字段名类型是否必须示例描述statusstring是succeed状态位，succeed表示成功，fail表示调用失败order_statustinyint是1订单状态（0派单中,5取货中,15配送中,100已完成,99已取消）time_status_updateLong否1429861697905配送状态更新时间戳rider_nameString否小辣椒配送员姓名(只有在派单后，才为非空)rider_latFloat否302764454配送员纬度(只有在派单后，才为非空)rider_lngFloat否120111227配送员经度(只有在派单后，才为非空)rider_mobileString送员手机号(只有在派单后，才为非空)time_position_updateLong否1429861697905配送员位置更新时间戳(只有在派单后，才为非空)time_estimated_pickupLong是1429861697905预估配送员到达商家时间戳time_estimated_deliveredLong是1429861001846预估配送员到达用户时间戳5.2.7 返回示例5.3 订单取消5.3.1 接口名称order_canle5.3.2 接口描述撤销未成功派单的配送订单。 * 订单取消接口需单独申请。 5.3.3请求方式正式环境URL: /api/v1/order-cancel.jsonMethod: post5.3.4认证参数字段名类型是否必须示例描述pkString是123456向点我达平台申请的appkeytimestampLong是1436863897901时间戳,进行接口调用时的时间戳，以秒计算时间formatString是json响应数据格式sigString是F5A5FF4850E7681B0676C4AAD268593353C2D135appkey加密签名(系统级别参数不参与签名加密)，签名使用SHA-1加密5.3.5 请求参数字段名类型是否必须示例描述dwd_order_idString是777777点我达物流配送订单IDcancle_typeInteger是11 正常取消（派单中、取货中） 2 配送中客服取消 3 配送中运营/风控取消 4 其他cancle_reasonString详见说明用户取消订单取消订单原*参数说明-订单在“派单中”、“取货中”状态下，允许正常取消点我达配送订单，传入cancle_type = 1。-订单在“配送中”状态下，配送费已经产生，此时cancle_type = 2,3,4，视取消方式而定。-订单在“已取消”、“已完成”状态下，调用接口时将返回status = fail和相应error_code5.3.6返回参数字段名类型是否必须示例描述statusString是success状态位，订单成功取消5.3.7 返回示例5.4 修改备注信息5.4.1 接口名称order-update-remark5.4.2 接口描述修改点我达配送订单的配送信息，仅限“派单中”、“配送中”状态时调用。（备注以覆盖方式更新。） 5.4.3请求方式正式环境URL: /api/v1/order-update-remark.jsonMethod: post5.4.4认证参数字段名类型是否必须示例描述pkString是123456向点我达平台申请的appkeytimestampLong是1436863897901时间戳,进行接口调用时的时间戳，以秒计算时间formatString是json响应数据格式sigString是F5A5FF4850E7681B0676C4AAD268593353C2D135appkey加密签名(系统级别参数不参与签名加密)，签名使用SHA-1加密5.4.5 请求参数字段名类型是否必须示例描述dwd_order_idStringY777777点我达物流配送订单IDorder_info_contentStringY客户联系方式错了，送订单备注信息5.4.6返回参数字段名类型是否必须示例描述statusstring是succeed状态位，succeed表示成功，fail表示调用失败5.4.7 返回示例5.5 获取订单状态5.5.1 接口名称Order-notity5.5.2 接口描述第三方派发给点我达的订单，当订单改变后，可以通过此接口获得改变后的订单状态。 5.5.3请求方式正式环境URL: /api/v1/order-notity.jsonMethod: post5.5.4认证参数字段名类型是否必须示例描述pkString是123456向点我达平台申请的appkeytimestampLong是1436863897901时间戳,进行接口调用时的时间戳，以秒计算时间formatString是json响应数据格式sigString是F5A5FF4850E7681B0676C4AAD268593353C2D135appkey加密签名(系统级别参数不参与签名加密)，签名使用SHA-1加密5.5.5 请求参数字段名类型是否必须示例描述无5.5.6返回参数字段名类型是否必须示例描述statusstring是succeed状态位，succeed表示成功，fail表示调用失败dwd_order_idString是777777点我达物流配送订单IDorder_statustinyint是1订单状态（0派单中,5取货中,15配送中,100已完成,99已取消）time_status_updateLong否1429861697905订单状态更新时间戳5.5.7 返回示例附录错误代码错误代码描述01000接口调用成功未知错误1001服务不可用1002无效PK01003缺少签名参数1004签名无效01005HTTP方法0被禁止1006编码错误100