快递上门取件API接口代码
官网：快递鸟
API列表
| 功能 | 功能描述 | 应用场景 |
|---|---|---|
| 超区校验接口 | 校验该地区是否支持上门取件，以及3天内可支持的上门取件时间段。 | 场景一：寄件人老七，选择从深圳向北极村寄快递，通过超区检验接口，提前了解到深圳寄北极村线上平台没有快递支持。于是选择线下找快递公司寄快递。 |
| 场景二：寄件人老七，选择从深圳向北京寄快递，通过超区校验接口，通过校验通知了解到，北京两会期间，停止快递。于是老七决定等两会过去再寄快递。 | ||
| 场景三：寄件人老七，选择从深圳向广州寄快递，通过超区校验接口，发现是支持的。并根据支持的预约时段9～14.14～19点，选择14～19点进行下单。 | ||
| 单渠道预估运费接口 | 用于根据客户收寄地址预估运费，仅做参考，不作为最终结算运费。 | 寄件人老七，在客户平台手机端下单上门取件，在填写完成寄收信息和预估重量后，看到手机端提示预估运费10元，于是选择下单。 |
| 多渠道预估运费接口 | 用于根据客户收寄地址、预估重量计算返回预估运费，仅做参考，不作为最终结算运费，当前端展示多个快递公司预估运费时使用此接口 | 寄件人老七，选择客户的手机端进行寄快递，在填写完寄收信息和预估重量后，看到手机端展示的每家快递公司的快递费是不同的，于是选择申通快递进行下单。 |
| 下单接口 | 1、用于创建客户预约快递上门取件订单（以下文中统称为“订单”） 2、客户创建订单成功后（快递鸟已接收到此订单，但未提交到快递公司），快递鸟智能调度向快递公司下单，结果会通过回调类接口把订单状态、快递公司编码、运单号、网点、快递员等信息回推给客户。 | 场景一：移动端APP、公众号、电商等提供的散客寄件下单模块，通过上门取件直接预约快递员上门揽件，支持在线支付运费。 |
| 场景二：电商平台、自营电商售后退货退款时，买家通过平台直接预约快递员上门揽件，支持在线支付运费。 | ||
| 场景三：保价相关 | ||
| 订单取消接口 | 1、用于取消客户创建的订单 2、已取件状态后的订单无法取消 | 售后场景： 1、寄件人【老七】，在客户电商平台申请售后审核通过后，选择下单上门取件，因各种原因，取消售后业务（同步取消上门取件）。 1、寄件人【老七】，在客户电商平台申请售后审核通过后，选择下单上门取件，因各种原因，取消上门取件，重新下单（上门取件） |
| 正向寄件场景： 1、寄件人【老七】，在客户平台选择下单上门取件，因各种原因，取消上门取件，不再寄快递。 | ||
| 修改订单接口 | 下单成功并且未取件的订单进行基本信息修改，接口调用成功之后，修改结果通过修改订单通知回推给客户 | 场景一：寄件人老七，选择上门取件时间为周六上午9～11点寄件，下单完成后，发现周六上午没时间，于是修改上门取件新的预约时间为周日的13～15点。 快递员最终在周日14点上门揽件。 |
| 场景二：寄件人老七，选择上门取件时间为周六上午9～11点从家里寄件，下单完成后，发现物品在公司，于是修改上门取件新的寄件地点。快递员最终在周六11点在公司上门揽件。 | ||
| 订单信息查询接口 | 用于查询客户创建成功的订单基本信息 | 用户的上门取件订单下单后，用户查看上门取件订单详情。如：寄收地址信息，预约时段、订单最新状态。 |
| 订单状态查询接口 | 此接口用于快递鸟订单状态列表查询，获取最新订单状态。 | 客户订单状态长时间未更新，可用此接口查询最新订单状态信息，作为订单状态更新的一个补偿机制。 |
| 工单类型查询 | 此接口用于获取快递鸟工单类型，提交工单的时候需要根据此类型进行提交。 | 客户在后台或用户端，通过查询工单类型，查看快递鸟支持的工单类型。然后用户选择对应的工单类型进行提交工单。 |
| 工单提交接口 | 此接口用于提交工单，工单处理结果通过推送工单结果接口推回给客户 | 场景一：对接客户有自己的后台工单系统，为便于统一运营管理，于是对接快递鸟工单接口。 |
| 场景二：客户的用户端提供工单业务，于是对接快递鸟工单接口，让用户直接使用工单。 | ||
| 工单详情查询接口 | 此接口用于获取快递鸟工单详情 | 寄件人老七，在客户手机端有多个上门取件工单，老七在进入工单列表页，查看所有的上门取件工单。客户调用此接口，快递鸟返回工单列表给到客户，客户在手机端展示给用户老七。老七点开第一个工单，查看工单详情。 |