OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| com | String | Required | 查询的快递公司的编码， 一律用小写字母，点击查看全部快递公司编码。常用快递公司编码有，圆通速递：yuantong、韵达快递：yunda、中通快递：zhongtong、申通快递：shentong、邮政快递包裹：youzhengguonei、百世快递：huitongkuaidi、顺丰速运：shunfeng、京东物流：jd、天天快递：tiantian、EMS：ems、邮政标准快递：youzhengbk、极兔速递：jtexpress、宅急送：zhaijisong、德邦：debangwuliu、德邦快递：debangkuaidi、中通快运：zhongtongkuaiyun、优速快递：youshuwuliu、百世快运：baishiwuliu、韵达快运：yundakuaiyun、安能快运：annengwuliu | ||
| num | String | Required | MAX: 32 | 查询的快递单号， 单号的最大长度是32个字符 | |
| phone | String | Optaion | 收件人或寄件人的手机号或固话（顺丰单号必填，也可以填写后四位，如果是固话，请不要上传分机号）。例如：13800138000 | ||
| from | String | Optaion | 出发地城市，省-市-区，例如：广东省广州市黄埔区 | ||
| to | String | Optaion | 目的地城市，省-市-区，例如：北京市朝阳区 | ||
| resultv2 | Enum | Optaion | 1 | Range: 0/1/2 | 添加此字段表示开通行政区域解析功能。0：关闭（默认），1：开通行政区域解析功能，2：开通行政解析功能并且返回出发、目的及当前城市信息 |
| order | Enum | Optaion | Range: asc/desc | 返回结果排序方式。desc：降序（默认），asc：升序 |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| com | *Required | |
| num | *Required | |
| phone | Option | |
| from | Option | |
| to | Option | |
| resultv2 | Option | |
| order | Option |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景 |
| err_msg | String | 错误提示信息，err_code非0时参考此提示信息 |
| kuaidi | Object | 快递查询结果，失败时为null |
| kuaidi.state | Int | 快递单当前状态，包括0在途，1揽收，2疑难，3签收，4退签，5派件，6退回，7转投，10待清关，11清关中，12已清关，13清关异常，14拒签 等13个状态 |
| kuaidi.ischeck | Int | 是否签收标记 |
| kuaidi.com | String | 快递公司编码,一律用小写字母，点击查看快递公司编码 |
| kuaidi.nu | String | 快递单号 |
| kuaidi.data | Array | 数组，包含多个对象，每个对象字段如展开所示 |
| kuaidi.data[].context | String | 物流轨迹节点内容 |
| kuaidi.data[].time | String | 时间，原始格式，如：2012-08-28 16:33:19 |
| kuaidi.data[].ftime | String | 格式化后时间，如：2012-08-28 16:33:19 |
| kuaidi.data[].status | String | 本数据元对应的签收状态。 |
| kuaidi.data[].areaName | String | 本数据元对应的行政区域的名称 |
HTTP Response Code
| HTTP Status Code | Description |
|---|---|
| Http Status = 200 | Success |
| Http Status = 400 | Illegal-Params |
| Http Status = 401 | Illegal-Token |
| Http Status = 402 | IP-Banned |
| Http Status = 404 | API-NOT-Exsits |
| Http Status = 406 | Illegal-APPKEY |
| Http Status = 407 | APPKEY-Expired-Out |
| Http Status = 408 | APPKEY-Busy |
| Http Status = 409 | Illegal-Sign |
| Http Status = 413 | API-Traffic-NOT-Enough |
| Http Status = 415 | API-LOCKED |
| Http Status = 500 | Internal-Server-Error |