OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
ShipperCode | String | Required | MIN: 1 | 快递公司编码,如:EMS物流单号应选择快递公司编码(EMS),查看快递公司编码。注意:主流快递仅支持申通快递、圆通速递、百世快递、天天快递 4 家,不支持 EMS、邮政 快递包裹、顺丰速运、韵达速递、京东快递、中通快递。 | |
LogisticCode | String | Required | MIN: 1 | 物流单号,按照运单号查询(单个查询) | |
OrderCode | String | Optaion | 订单编号 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
ShipperCode | *Required | |
LogisticCode | *Required | |
OrderCode | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
KdAPI | Object | 快递鸟API返回的结果 |
KdAPI.EBusinessID | String | 用户ID |
KdAPI.OrderCode | String | 订单编号 |
KdAPI.ShipperCode | String | 快递公司编码 |
KdAPI.LogisticCode | String | 物流运单号 |
KdAPI.Success | bool | 成功与否 |
KdAPI.Reason | String | 失败原因 |
KdAPI.State | String | 物流状态:2-在途中,3-签收,4-问题件 |
KdAPI.Traces | Array | 跟踪情况 |
KdAPI.Traces[].AcceptTime | String | 时间 |
KdAPI.Traces[].AcceptStation | String | 描述 |
KdAPI.Traces[].Remark | 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 |