Mission Express API 文档

Mission Express API 文档

根据你上传的 API 原始文档整理出的网页版本,已改成和主站一致的页头页脚风格。

概览

这份页面把原始 API 文档整理成更适合直接挂网展示的网页版本。除 PDF 展示接口外,所有接口统一使用 HTTP POST;请求与响应统一使用 UTF-8 编码的 JSON 格式。

正式请求地址
https://me.missionexpress.ca/api/post/out
请求头
Content-Type: application/x-www-form-urlencoded
端点名称和参数名称按原始文档保留不变,页面只对版式和英文说明做了整理。

鉴权与签名

app_keyapp_secret 由平台提供。业务参数需要先转成 JSON 字符串,再通过 data 字段提交。

签名规则:

sign = SHA256(request_json + "app_secret=" + app_secret)

PHP 示例:

private function createSign(string $request_str, string $key) {
    return hash("sha256", $request_str . "app_secret=" . $key);
}

通用请求参数

参数名必选类型说明
app_keystring平台提供的 app_key
signstring验签参数
datastring业务参数的 JSON 字符串

统一响应格式

code = 1 时表示成功,其余值为错误。

{
  "code": 1,
  "msg": "ok",
  "time": "1690796144",
  "data": {
    "orderNo": "491d930ef328d4ec142233c82cc28816",
    "time": 1690796144
  }
}

错误码

code说明
1001请求缺少参数 sign
1003请求数据解析失败
1004请求数据缺少 app_key
1005app_key 不存在
1006签名验证失败
0普通错误
GET/pdf

PDF 展示

用于展示 PDF。根据原始文档,这是唯一一个使用 GET 的接口。

参数名必选类型说明
tokenstring从“获取 pdf 连接 / token”接口中获取
order_nostring物流单号,多个用逗号连接

更多错误代码请参考前面的统一错误码说明。

POST/create

创建订单

创建新的订单。

通用请求字段

参数名必选类型说明
app_keystring平台提供的 app_key
signstring验签 sign
datastring业务参数的 JSON 字符串

业务参数

参数名必选类型说明
shop_order_nostring商户订单号
goods_descstring包裹物品信息
from_usernamestring发件人姓名
from_mobilestring发件人电话
from_provincestring发件人省
from_citystring发件人城市
from_addressstring发件人地址
from_address1string发件人门牌号
from_zip_codestring发件人邮编
to_usernamestring收件人姓名
to_mobilestring收件人电话
to_provincestring收件人省
to_citystring收件人城市
to_addressstring收件人地址
to_address1string收件人门牌号
to_zip_codestring收件人邮编
remarkstring备注
is_directstring是否直送:0=否,1=是

返回示例

{
  "code": 1,
  "msg": "ok",
  "time": "1773801661",
  "data": {
    "shop_id": 1,
    "shop_order_no": "69ba0e778bf94",
    "order_no": "1075638798736",
    "from_username": "aa",
    "from_mobile": "1234567891",
    "from_province": "aa",
    "from_city": "bb",
    "from_address": "sdfsd",
    "from_address1": "sdfsd",
    "from_zip_code": "12345",
    "to_username": "aaab",
    "to_mobile": "1236547896",
    "to_province": "sdf",
    "to_city": "sdf",
    "to_address": "ggg",
    "to_address1": "ss",
    "to_zip_code": "1263",
    "goods_desc": "包裹物品",
    "remark": "订单备注",
    "is_direct": 1,
    "createtime": 1773801661,
    "updatetime": 1773801661,
    "id": "8"
  }
}
POST/cancel

取消订单

取消已创建的订单。

通用请求字段

参数名必选类型说明
app_keystring平台提供的 app_key
signstring验签 sign
datastring业务参数的 JSON 字符串

业务参数

参数名必选类型说明
order_nostring物流单号

响应示例

{
  "code": 0,
  "message": "取消成功",
  "data": ""
}
POST/getPdf

获取订单打印 Token / URL

返回用于打开 PDF 展示接口的 URL token。

通用请求字段

参数名必选类型说明
app_keystring平台提供的 app_key
signstring验签 sign
datastring业务参数的 JSON 字符串

业务参数

参数名必选类型说明
non_strstring随机字符串,长度 6–12 位

返回示例

{
  "code": 1,
  "msg": "ok",
  "time": "1773804544",
  "data": {
    "url": "http://test.jianadame.com/index.php/api/post/out/pdf?token=..."
  }
}
POST/detail

订单详情

返回订单的详细信息。

通用请求字段

参数名必选类型说明
app_keystring平台提供的 app_key
signstring验签 sign
datastring业务参数的 JSON 字符串

业务参数

参数名必选类型说明
order_nostring快递 / 物流单号

返回示例

{
  "code": 1,
  "msg": "ok",
  "time": "1773803058",
  "data": {
    "id": 8,
    "type": 1,
    "order_no": "1075638798736",
    "shop_id": 1,
    "shop_order_no": "69ba0e778bf94",
    "weight": "0.00",
    "charge_weight": "0.00",
    "length": 0,
    "width": 0,
    "height": 0,
    "goods_desc": "包裹物品",
    "status": 0,
    "dis_status": 0,
    "images": null,
    "remark": "订单备注",
    "post_price": "0.00",
    "order_price": "0.00",
    "insure_amount": "0.00",
    "insure_price": "0.00",
    "pickup_time": 0,
    "pay_type": "",
    "pay_status": 0,
    "pay_time": 0,
    "from_username": "aa",
    "from_mobile": "1234567891",
    "from_province": "aa",
    "from_city": "bb",
    "from_address": "sdfsd",
    "from_address1": "sdfsd",
    "from_zip_code": "12345",
    "to_username": "aaab",
    "to_mobile": "1236547896",
    "to_province": "sdf",
    "to_city": "sdf",
    "to_address": "ggg",
    "to_address1": "ss",
    "to_zip_code": "1263",
    "delivery_num": 0,
    "delivery_status": 0,
    "createtime": 1773801661,
    "updatetime": 1773801661,
    "rider_amount": "0.00",
    "rider_id": 0,
    "delete_time": null,
    "is_direct": 1
  }
}

Mission Rush 状态参考

以下内容用于 Mission Rush App 的 Orders 页面或其他客户端状态展示。该说明基于当前 Mission Rush 直送单创建逻辑及后端状态流转整理而成。

post_order.status建议客户端显示说明
1Waiting for pick upMission Rush 已支付直送单创建成功后的初始状态。
2Waiting for pick up待揽收;客户端可与状态 1 统一归类为待取件。
3Delivering已揽收 / 配送中。
10Completed订单已完成。

客户端分组建议

分组建议条件
All所有订单
In progressstatus in [1, 2, 3]
Completedstatus = 10
补充说明:Mission Rush 已支付直送单创建成功后,服务端返回的支付成功状态为 pay_status = 2,同时订单初始状态为 status = 1。如需“已评价 / 未评价”,建议由客户端或业务侧单独维护,不直接复用 post_order.status