OkayAPI Docs


API Path: /api/App/KdAPI/TrackExpress

API Description: 快递查询API,供小程序、APP、需实时返回物流轨迹信息即查即走,快递查询将提供输入运单编号立即获取物流最新轨迹,无需快递编码,自动识别物流公司,返回物流轨迹。使用前请先配置快递鸟API支持大部分快递公司,需要开通快递鸟官方套餐后使用。

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
ShipperCodeStringRequiredMIN: 1快递公司编码,如:EMS物流单号应选择快递公司编码(EMS),查看快递公司编码
LogisticCodeStringRequiredMIN: 1物流单号,按照运单号查询(单个查询)
OrderCodeStringOptaion订单编号
CustomerNameStringOptaionShipperCode 为JD,必填,对应京东的青龙配送编码,也叫商家编码,格式:数字+字母+数字,9 位数字加一个字母,共10 位,举例:001K123450;ShipperCode 为SF,且快递单号非快递鸟渠道返回时,必填,对应收件人/寄件人手机号后四位;ShipperCode 为SF,且快递单号为快递鸟渠道返回时,不填;ShipperCode 为其他快递时,不填

API Debug

KEYREQUIREDVALUE
app_key *Required
ShipperCode *Required
LogisticCode *Required
OrderCode Option
CustomerName Option

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
err_msgString错误提示信息,err_code非0时参考此提示信息
KdAPIObject快递鸟API返回的结果
KdAPI.EBusinessIDString用户ID
KdAPI.OrderCodeString订单编号
KdAPI.ShipperCodeString快递公司编码
KdAPI.LogisticCodeString物流运单号
KdAPI.Successbool成功与否
KdAPI.ReasonString失败原因
KdAPI.StateString物流状态:2-在途中,3-签收,4-问题件
KdAPI.TracesArray跟踪情况
KdAPI.Traces[].AcceptTimeString时间
KdAPI.Traces[].AcceptStationString描述
KdAPI.Traces[].RemarkString备注

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error