WxMnpImmediateDeliveryApi (wx-java-miniprogram 1.0.6 API)

java.lang.Object
- top.codewood.wx.common.api.WxBaseHttpApi
- - top.codewood.wx.mnp.api.WxMnpImmediateDeliveryApi

public class WxMnpImmediateDeliveryApi
extends WxBaseHttpApi

构造器概要

构造器
构造器和说明

WxMnpImmediateDeliveryApi()

构造器
构造器和说明
`WxMnpImmediateDeliveryApi()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`abnormalConfirm(String accessToken, ImmeAbnormalConfirmRequest immeAbnormalConfirmRequest)` immediateDelivery.abnormalConfirm 异常件退回商家商家确认收货接口当订单配送异常，骑手把货物退还给商家，商家收货以后调用本接口返回确认收货。
`ImmeAddOrderResult`	`addOrder(String accessToken, ImmeAddOrderRequest immeAddOrderRequest)` immediateDelivery.addOrder 下配送单接口商家可调用本接口向配送公司请求下配送单，配送公司会返回这一单的配送单号、配送费、预计骑手接单时间等信息。
`void`	`addTip(String accessToken, ImmeAddTipRequest request)` immediateDelivery.addTip 可以对待接单状态的订单增加小费。
`void`	`bindAccount(String accessToken, String deliveryId)` immediateDelivery.bindAccount 第三方代商户发起绑定配送公司帐号的请求只能由第三方服务商调用此接口服务商可通过本接口代开发的小程序发起绑定配送公司帐号的操作，当调用成功，小程序管理员将收到模版消息，点击详情进入配送公司网站进行绑定操作参考文档
`ImmeCancelOrderResult`	`cancelOrder(String accessToken, ImmeCancelOrderRequest request)` immediateDelivery.cancelOrder 取消配送单接口调用本接口可向配送公司请求取消配送单，各家取消规则如下：顺丰同城急送: 配送完成前任意节点可取消配送单; 闪送: 配送完成前任意节点可取消配送单; 美团配送: 配送完成前任意节点可取消配送单; 达达: 骑手取货之前可取消配送单; 参考文档
`List<ImmeDeliveryCompany>`	`getAllImmeDelivery(String accessToken)` immediateDelivery.getAllImmeDelivery 获取已支持的配送公司列表接口查询即时配送接口已支持的配送公司和delivery_id 参考文档
`List<ImmeShop>`	`getBindAccount(String accessToken)` immediateDelivery.getBindAccount 拉取已绑定账号使用场景 1、商家可通过本接口查询自己已经在小程序后台绑定的和配送公司签约的账号； 2、服务商可通过本接口查询代开发的小程序在小程序后台绑定的和配送公司签约的账号，为其完成后续的接口代开发业务。
`static WxMnpImmediateDeliveryApi`	`getInstance()`
`ImmeGetOrderResult`	`getOrder(String accessToken, ImmeGetOrderRequest request)` immediateDelivery.getOrder 拉取配送单信息商家可使用本接口查询某一配送单的配送状态，便于商家掌握配送情况。
`void`	`mockUpdateOrder(String accessToken, ImmeMockUpdateOrderRequest request)` immediateDelivery.mockUpdateOrder 该接口只能用于测试模拟配送公司更新配送单状态, 该接口只用于沙盒环境，即订单并没有真实流转到运力方参考文档
`void`	`openDelivery(String accessToken)` immediateDelivery.openDelivery 第三方代商户发起开通即时配送权限使用场景 1、只能由第三方服务商调用此接口 2、服务商可通过本接口代开发的小程序发起开通即时配送接口权限的操作，当调用成功，小程序管理员将收到模版消息，进行开通操作参考文档
`ImmePreAddOrderResult`	`preAddOrder(String accessToken, ImmeAddOrderRequest request)` immediateDelivery.preAddOrder 预下配送单接口使用场景 1、在用户提交外卖订单时，商家可调用本接口查询配送公司是否可接单、预计多久接单、运费预估等。
`ImmeCancelOrderResult`	`preCancelOrder(String accessToken, ImmeCancelOrderRequest request)` immediateDelivery.preCancelOrder 预取消配送单接口使用场景：在正式取消配送单前，商家可调用本接口查询该订单是否可以取消，取消订单配送公司需要扣除的费用是多少。
`void`	`realMockUpdateOrder(String accessToken, ImmeMockUpdateOrderRequest request)` immediateDelivery.realMockUpdateOrder 模拟配送公司更新配送单状态, 该接口用于测试账户下的单，将请求转发到运力测试环境使用场景该接口只能用于测试,请求会转发到运力测试环境, 目前支持顺丰同城和达达: 1、顺丰同城测试号 - shopid: 1534713176, - appsecret: d80400f91e156f63b38886e616d84590 - shopno: 3243279847393 - 支持变更状态: 102 202 202 302 2、达达测试号 - shopid: dadaaee18818d97e236, - appsecret: 1c6f40492d6d89caaad80b85f7d31670 - shopno: 77071-47913 - 支持变更状态: 102 201 202 301 302 304 30 参考文档
`ImmeAddOrderResult`	`reOrder(String accessToken, ImmeAddOrderRequest request)` immediateDelivery.reOrder 重新下单在调用下配送单接口、订单被取消、过期或者投递异常的情况下，可调用此接口，重新下单，需要保持orderid一致。

从类继承的方法 top.codewood.wx.common.api.WxBaseHttpApi
get, getInputStream, post, post, postInputStream, upload, upload

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - WxMnpImmediateDeliveryApi
```
public WxMnpImmediateDeliveryApi()
```
- 方法详细资料
  - getInstance
```
public static WxMnpImmediateDeliveryApi getInstance()
```
  - abnormalConfirm
```
public void abnormalConfirm(String accessToken,
                            ImmeAbnormalConfirmRequest immeAbnormalConfirmRequest)
```
    immediateDelivery.abnormalConfirm 异常件退回商家商家确认收货接口当订单配送异常，骑手把货物退还给商家，商家收货以后调用本接口返回确认收货。参考文档
    
    参数:
    
    accessToken -
    
    immeAbnormalConfirmRequest -
  - addOrder
```
public ImmeAddOrderResult addOrder(String accessToken,
                                   ImmeAddOrderRequest immeAddOrderRequest)
```
    immediateDelivery.addOrder 下配送单接口商家可调用本接口向配送公司请求下配送单，配送公司会返回这一单的配送单号、配送费、预计骑手接单时间等信息。如遇下单错误，请先确认一下编码方式，python建议 json.dumps(b, ensure_ascii=False)，php建议 json_encode($arr, JSON_UNESCAPED_UNICODE) 可预约时间：达达：72小时内，闪送2小时以后，48小时以内参考文档
    
    参数:
    
    accessToken -
    
    immeAddOrderRequest -
    
    返回:
  - addTip
```
public void addTip(String accessToken,
                   ImmeAddTipRequest request)
```
    immediateDelivery.addTip 可以对待接单状态的订单增加小费。需要注意：订单的小费，以最新一次加小费动作的金额为准，故下一次增加小费额必须大于上一次小费额调用本接口，可以给待接单状态的订单增加小费，各家配送公司增加消费的规则如下：配送公司加小费规则顺丰同城急送支持加小费，小费规则：骑手接单前可加小费，上限10次，200元封顶闪送支持加小费，小费规则：骑手接单前可加小费，需按固定档位加小费，档位为2、3、5、10、15、20、50、100 美团配送不支持加小费达达配送支持加小费，小费规则：骑手接单前可加小费，小费金额以最新一次为准，同一单新增的小费额须大于上一次的小费额，小费不可以超过货值，上限30元参考文档
    
    参数:
    
    accessToken -
    
    request -
  - bindAccount
```
public void bindAccount(String accessToken,
                        String deliveryId)
```
    immediateDelivery.bindAccount 第三方代商户发起绑定配送公司帐号的请求只能由第三方服务商调用此接口服务商可通过本接口代开发的小程序发起绑定配送公司帐号的操作，当调用成功，小程序管理员将收到模版消息，点击详情进入配送公司网站进行绑定操作参考文档
    
    参数:
    
    accessToken -
    
    deliveryId - 配送公司ID
  - cancelOrder
```
public ImmeCancelOrderResult cancelOrder(String accessToken,
                                         ImmeCancelOrderRequest request)
```
    immediateDelivery.cancelOrder 取消配送单接口调用本接口可向配送公司请求取消配送单，各家取消规则如下：顺丰同城急送: 配送完成前任意节点可取消配送单; 闪送: 配送完成前任意节点可取消配送单; 美团配送: 配送完成前任意节点可取消配送单; 达达: 骑手取货之前可取消配送单; 参考文档
    
    参数:
    
    accessToken -
    
    request -
    
    返回:
  - getAllImmeDelivery
```
public List<ImmeDeliveryCompany> getAllImmeDelivery(String accessToken)
```
    immediateDelivery.getAllImmeDelivery 获取已支持的配送公司列表接口查询即时配送接口已支持的配送公司和delivery_id 参考文档
    
    参数:
    
    accessToken -
    
    返回:
  - getBindAccount
```
public List<ImmeShop> getBindAccount(String accessToken)
```
    immediateDelivery.getBindAccount 拉取已绑定账号使用场景 1、商家可通过本接口查询自己已经在小程序后台绑定的和配送公司签约的账号； 2、服务商可通过本接口查询代开发的小程序在小程序后台绑定的和配送公司签约的账号，为其完成后续的接口代开发业务。参考文档
    
    参数:
    
    accessToken -
    
    返回:
  - getOrder
```
public ImmeGetOrderResult getOrder(String accessToken,
                                   ImmeGetOrderRequest request)
```
    immediateDelivery.getOrder 拉取配送单信息商家可使用本接口查询某一配送单的配送状态，便于商家掌握配送情况。参考文档
    
    参数:
    
    accessToken -
    
    request -
    
    返回:
  - mockUpdateOrder
```
public void mockUpdateOrder(String accessToken,
                            ImmeMockUpdateOrderRequest request)
```
    immediateDelivery.mockUpdateOrder 该接口只能用于测试模拟配送公司更新配送单状态, 该接口只用于沙盒环境，即订单并没有真实流转到运力方参考文档
    
    参数:
    
    accessToken -
    
    request -
  - openDelivery
```
public void openDelivery(String accessToken)
```
    immediateDelivery.openDelivery 第三方代商户发起开通即时配送权限使用场景 1、只能由第三方服务商调用此接口 2、服务商可通过本接口代开发的小程序发起开通即时配送接口权限的操作，当调用成功，小程序管理员将收到模版消息，进行开通操作参考文档
    
    参数:
    
    accessToken -
  - preAddOrder
```
public ImmePreAddOrderResult preAddOrder(String accessToken,
                                         ImmeAddOrderRequest request)
```
    immediateDelivery.preAddOrder 预下配送单接口使用场景 1、在用户提交外卖订单时，商家可调用本接口查询配送公司是否可接单、预计多久接单、运费预估等。预估运费可作为展示给用户的运费参考值。 2、举个例子：商家通过预下配送单接口返回的预估运费是8元，商家可决定前端顾客下外卖单时展示给顾客看的运费是真实的8元，还是其他商家指定的金额。 3、说明：本接口非必须调用接口，若不需要获取配送公司是否可接单、预计多久接单、运费预估等，也可不调用本接口，直接下配送单。 4、顺丰同城可返回配送费用、配送距离、预计骑手接单时间，不支持返回delivery_token。 5、闪送可返回配送费用、配送距离、预计骑手接单时间，不支持返回delivery_token。 6、美团配送返回0时表示校验通过，不支持返回配送费用、配送距离、预计骑手接单时间和delivery_token。 7、达达支持预下单查询配送费用、配送距离、预计骑手接单时间和delivery_token(有效期3分钟)。参考文档
    
    参数:
    
    accessToken -
    
    返回:
  - preCancelOrder
```
public ImmeCancelOrderResult preCancelOrder(String accessToken,
                                            ImmeCancelOrderRequest request)
```
    immediateDelivery.preCancelOrder 预取消配送单接口使用场景：在正式取消配送单前，商家可调用本接口查询该订单是否可以取消，取消订单配送公司需要扣除的费用是多少。各家取消规则如下：顺丰同城急送: 配送完成前任意节点可取消配送单; 闪送: 配送完成前任意节点可取消配送单; 美团配送: 配送完成前任意节点可取消配送单; 达达: 骑手取货之前可取消配送单; 参考文档
    
    参数:
    
    accessToken -
    
    request -
  - realMockUpdateOrder
```
public void realMockUpdateOrder(String accessToken,
                                ImmeMockUpdateOrderRequest request)
```
    immediateDelivery.realMockUpdateOrder 模拟配送公司更新配送单状态, 该接口用于测试账户下的单，将请求转发到运力测试环境使用场景该接口只能用于测试,请求会转发到运力测试环境, 目前支持顺丰同城和达达: 1、顺丰同城测试号 - shopid: 1534713176, - appsecret: d80400f91e156f63b38886e616d84590 - shopno: 3243279847393 - 支持变更状态: 102 202 202 302 2、达达测试号 - shopid: dadaaee18818d97e236, - appsecret: 1c6f40492d6d89caaad80b85f7d31670 - shopno: 77071-47913 - 支持变更状态: 102 201 202 301 302 304 30 参考文档
    
    参数:
    
    accessToken -
    
    request -
  - reOrder
```
public ImmeAddOrderResult reOrder(String accessToken,
                                  ImmeAddOrderRequest request)
```
    immediateDelivery.reOrder 重新下单在调用下配送单接口、订单被取消、过期或者投递异常的情况下，可调用此接口，重新下单，需要保持orderid一致。备注：美团不支持重新下单接口，如果订单被取消商家需要重新下单，请修改orderid之后，调用下配送单接口下单。参考文档
    
    参数:
    
    accessToken -
    
    request -

类 WxMnpImmediateDeliveryApi

构造器概要

方法概要

从类继承的方法 top.codewood.wx.common.api.WxBaseHttpApi

从类继承的方法 java.lang.Object

构造器详细资料

WxMnpImmediateDeliveryApi

方法详细资料

getInstance

abnormalConfirm

addOrder

addTip

bindAccount

cancelOrder

getAllImmeDelivery

getBindAccount

getOrder

mockUpdateOrder

openDelivery

preAddOrder

preCancelOrder

realMockUpdateOrder

reOrder