{
    "openapi": "3.0.0",
    "info": {
        "title": "快递物流查询 - API文档",
        "version": "1.0.0",
        "description": "支持全球快递物流动态查询，默认自动识别单号。注意：顺丰、中通等需传入寄件或收件人手机后四位。另外，带上物流公司编码查询更稳定速度更快，且部分物流数据必须传入物流公司编码才能查询，如汇通的编码是huitong。具体请参考：<a target=\"_blank\" href=\"https:\/\/www.tianapi.com\/article\/181\">常见物流公司编码表<\/a>"
    },
    "servers": [
        {
            "url": "https:\/\/apis.tianapi.com"
        }
    ],
    "paths": {
        "\/kuaidi\/index": {
            "get": {
                "summary": "查询物流动态",
                "tags": [
                    "快递物流查询"
                ],
                "description": "根据快递单号查询物流动态信息",
                "parameters": [
                    {
                        "name": "key",
                        "in": "query",
                        "description": "API密钥",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "description": "API密钥"
                        }
                    },
                    {
                        "name": "number",
                        "in": "query",
                        "description": "快递单号",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "example": "9896725849291",
                            "description": "快递单号"
                        }
                    },
                    {
                        "name": "company",
                        "in": "query",
                        "description": "物流公司编码：如百世汇通：huitong",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "huitong",
                            "description": "物流公司编码：如百世汇通：huitong"
                        }
                    },
                    {
                        "name": "senderphone",
                        "in": "query",
                        "description": "收寄人手机尾号：目前顺丰系和中通强制要求，其他建议传入",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "example": "1288",
                            "description": "收寄人手机尾号：目前顺丰系和中通强制要求，其他建议传入"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功响应",
                        "content": {
                            "application\/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "time": {
                                            "type": "string",
                                            "example": "2019-10-25 16:48:08",
                                            "description": "物流节点时间"
                                        },
                                        "status": {
                                            "type": "int",
                                            "example": 4,
                                            "description": "0无记录、1揽件、2在途中、3 派送中、4已签收、5用户拒签、6疑难件、7无效单、8超时单、9签收失败、10退回、11转投、12待签"
                                        },
                                        "address": {
                                            "type": "string",
                                            "example": "嘉定安亭网点",
                                            "description": "物流节点地址"
                                        },
                                        "content": {
                                            "type": "string",
                                            "example": "【上海市】已签收, 签收人凭取货码签收......",
                                            "description": "物流节点详情"
                                        },
                                        "telephone": {
                                            "type": "string",
                                            "example": "95311",
                                            "description": "快递公司客服电话"
                                        },
                                        "kuaidiname": {
                                            "type": "string",
                                            "example": "中通快递",
                                            "description": "快递公司中文名"
                                        },
                                        "updatetime": {
                                            "type": "string",
                                            "example": "2019-11-11 16:53:45",
                                            "description": "更新时间"
                                        },
                                        "enkuaidiname": {
                                            "type": "string",
                                            "example": "pingyou",
                                            "description": "快递公司英文名"
                                        }
                                    }
                                },
                                "example": {
                                    "msg": "success",
                                    "code": 200,
                                    "result": {
                                        "list": [
                                            {
                                                "time": "2019-11-01 15:27:46",
                                                "address": "上海安亭网点",
                                                "content": "【嘉定安亭揽投部】安排投递,投递员:樊*亮,电话:1550****995"
                                            },
                                            {
                                                "time": "2019-11-01 13:20:43",
                                                "address": "上海安亭网点",
                                                "content": "到达【嘉定安亭揽投部】"
                                            },
                                            {
                                                "time": "2019-11-01 12:12:08",
                                                "address": "上海市徐汇区",
                                                "content": "离开【上海市徐德路处理中心】，下一站【嘉定安亭揽投部】（经转）"
                                            },
                                            {
                                                "time": "2019-11-01 08:05:19",
                                                "address": "安徽省合肥市",
                                                "content": "上海市徐德路处理中心机构代收入库"
                                            },
                                            {
                                                "time": "2019-11-01 06:00:18",
                                                "address": "上海市徐汇区",
                                                "content": "离开【无锡集散】，下一站【上海市徐德路处理中心】（经转）"
                                            },
                                            {
                                                "time": "2019-11-01 00:09:15",
                                                "address": "安徽省合肥市",
                                                "content": "离开【合肥中心】，下一站【无锡集散】（经转）"
                                            },
                                            {
                                                "time": "2019-10-30 19:52:15",
                                                "address": "安徽省合肥市",
                                                "content": "离开【肥西快包】，下一站【合肥中心】"
                                            },
                                            {
                                                "time": "2019-10-30 19:50:59",
                                                "address": "合肥市肥西县网点",
                                                "content": "【肥西快包】已收件,揽投员:徐洁"
                                            }
                                        ],
                                        "status": 4,
                                        "telephone": "11185",
                                        "kuaidiname": "中国邮政快递\/包裹\/挂号信\/小包",
                                        "updatetime": "2019-11-11 16:51:12",
                                        "enkuaidiname": "pingyou"
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "summary": "查询物流动态",
                "tags": [
                    "快递物流查询"
                ],
                "description": "根据快递单号查询物流动态信息",
                "requestBody": {
                    "content": {
                        "application\/x-www-form-urlencoded": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "key": {
                                        "type": "string",
                                        "description": "API密钥"
                                    },
                                    "number": {
                                        "type": "string",
                                        "example": "9896725849291",
                                        "description": "快递单号"
                                    },
                                    "company": {
                                        "type": "string",
                                        "example": "huitong",
                                        "description": "物流公司编码：如百世汇通：huitong"
                                    },
                                    "senderphone": {
                                        "type": "string",
                                        "example": "1288",
                                        "description": "收寄人手机尾号：目前顺丰系和中通强制要求，其他建议传入"
                                    }
                                },
                                "required": [
                                    "key",
                                    "number"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "成功响应",
                        "content": {
                            "application\/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "time": {
                                            "type": "string",
                                            "example": "2019-10-25 16:48:08",
                                            "description": "物流节点时间"
                                        },
                                        "status": {
                                            "type": "int",
                                            "example": 4,
                                            "description": "0无记录、1揽件、2在途中、3 派送中、4已签收、5用户拒签、6疑难件、7无效单、8超时单、9签收失败、10退回、11转投、12待签"
                                        },
                                        "address": {
                                            "type": "string",
                                            "example": "嘉定安亭网点",
                                            "description": "物流节点地址"
                                        },
                                        "content": {
                                            "type": "string",
                                            "example": "【上海市】已签收, 签收人凭取货码签收......",
                                            "description": "物流节点详情"
                                        },
                                        "telephone": {
                                            "type": "string",
                                            "example": "95311",
                                            "description": "快递公司客服电话"
                                        },
                                        "kuaidiname": {
                                            "type": "string",
                                            "example": "中通快递",
                                            "description": "快递公司中文名"
                                        },
                                        "updatetime": {
                                            "type": "string",
                                            "example": "2019-11-11 16:53:45",
                                            "description": "更新时间"
                                        },
                                        "enkuaidiname": {
                                            "type": "string",
                                            "example": "pingyou",
                                            "description": "快递公司英文名"
                                        }
                                    }
                                },
                                "example": {
                                    "msg": "success",
                                    "code": 200,
                                    "result": {
                                        "list": [
                                            {
                                                "time": "2019-11-01 15:27:46",
                                                "address": "上海安亭网点",
                                                "content": "【嘉定安亭揽投部】安排投递,投递员:樊*亮,电话:1550****995"
                                            },
                                            {
                                                "time": "2019-11-01 13:20:43",
                                                "address": "上海安亭网点",
                                                "content": "到达【嘉定安亭揽投部】"
                                            },
                                            {
                                                "time": "2019-11-01 12:12:08",
                                                "address": "上海市徐汇区",
                                                "content": "离开【上海市徐德路处理中心】，下一站【嘉定安亭揽投部】（经转）"
                                            },
                                            {
                                                "time": "2019-11-01 08:05:19",
                                                "address": "安徽省合肥市",
                                                "content": "上海市徐德路处理中心机构代收入库"
                                            },
                                            {
                                                "time": "2019-11-01 06:00:18",
                                                "address": "上海市徐汇区",
                                                "content": "离开【无锡集散】，下一站【上海市徐德路处理中心】（经转）"
                                            },
                                            {
                                                "time": "2019-11-01 00:09:15",
                                                "address": "安徽省合肥市",
                                                "content": "离开【合肥中心】，下一站【无锡集散】（经转）"
                                            },
                                            {
                                                "time": "2019-10-30 19:52:15",
                                                "address": "安徽省合肥市",
                                                "content": "离开【肥西快包】，下一站【合肥中心】"
                                            },
                                            {
                                                "time": "2019-10-30 19:50:59",
                                                "address": "合肥市肥西县网点",
                                                "content": "【肥西快包】已收件,揽投员:徐洁"
                                            }
                                        ],
                                        "status": 4,
                                        "telephone": "11185",
                                        "kuaidiname": "中国邮政快递\/包裹\/挂号信\/小包",
                                        "updatetime": "2019-11-11 16:51:12",
                                        "enkuaidiname": "pingyou"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "\/kuaidi\/comcodelist": {
            "get": {
                "summary": "物流编码表",
                "tags": [
                    "快递物流查询"
                ],
                "description": "查询快递物流公司编码表",
                "parameters": [
                    {
                        "name": "key",
                        "in": "query",
                        "description": "API密钥",
                        "required": true,
                        "schema": {
                            "type": "string",
                            "description": "API密钥"
                        }
                    }
                ],
                "responses": {
                    "200": {
                        "description": "成功响应",
                        "content": {
                            "application\/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "code": {
                                            "type": "string",
                                            "example": "shunfeng",
                                            "description": "物流编码"
                                        },
                                        "name": {
                                            "type": "string",
                                            "example": "顺丰速运",
                                            "description": "物流名称"
                                        }
                                    }
                                },
                                "example": {
                                    "msg": "success",
                                    "code": 200,
                                    "result": {
                                        "list": [
                                            {
                                                "code": "shunfeng",
                                                "name": "顺丰速运"
                                            },
                                            {
                                                "code": "ems",
                                                "name": "EMS"
                                            },
                                            {
                                                "code": "bgpyghx",
                                                "name": "邮政包裹\/平邮"
                                            },
                                            {
                                                "code": "shentong",
                                                "name": "申通快递"
                                            },
                                            {
                                                "code": "zhongtong",
                                                "name": "中通快递"
                                            },
                                            {
                                                "code": "yuantong",
                                                "name": "圆通速递"
                                            },
                                            {
                                                "code": "yunda",
                                                "name": "韵达快递"
                                            },
                                            {
                                                "code": "jt",
                                                "name": "极兔快递"
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "post": {
                "summary": "物流编码表",
                "tags": [
                    "快递物流查询"
                ],
                "description": "查询快递物流公司编码表",
                "requestBody": {
                    "content": {
                        "application\/x-www-form-urlencoded": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "key": {
                                        "type": "string",
                                        "description": "API密钥"
                                    }
                                },
                                "required": [
                                    "key"
                                ]
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "成功响应",
                        "content": {
                            "application\/json": {
                                "schema": {
                                    "type": "object",
                                    "properties": {
                                        "code": {
                                            "type": "string",
                                            "example": "shunfeng",
                                            "description": "物流编码"
                                        },
                                        "name": {
                                            "type": "string",
                                            "example": "顺丰速运",
                                            "description": "物流名称"
                                        }
                                    }
                                },
                                "example": {
                                    "msg": "success",
                                    "code": 200,
                                    "result": {
                                        "list": [
                                            {
                                                "code": "shunfeng",
                                                "name": "顺丰速运"
                                            },
                                            {
                                                "code": "ems",
                                                "name": "EMS"
                                            },
                                            {
                                                "code": "bgpyghx",
                                                "name": "邮政包裹\/平邮"
                                            },
                                            {
                                                "code": "shentong",
                                                "name": "申通快递"
                                            },
                                            {
                                                "code": "zhongtong",
                                                "name": "中通快递"
                                            },
                                            {
                                                "code": "yuantong",
                                                "name": "圆通速递"
                                            },
                                            {
                                                "code": "yunda",
                                                "name": "韵达快递"
                                            },
                                            {
                                                "code": "jt",
                                                "name": "极兔快递"
                                            }
                                        ]
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}