错误码
汇星国际开放文档

错误码

开放平台全量错误码,按 鉴权 / 参数 / 业务 / 系统 / Webhook 分组,含含义与处理建议。

所有接口统一返回以下结构,业务成功 code 为字符串 "0",其余为错误码:

{ "code": "42201", "message": "字段校验失败:forecast_price 必须大于 0", "data": null }

HTTP 状态码与业务错误码配合使用:4xx 表示客户端错误,5xx 表示服务端错误。

鉴权类(400xx)

错误码含义处理建议
40003ApiKey 无效/失效确认 ApiKey 正确、未过期/撤销,且与所用环境(沙箱/生产)匹配
40101缺少 ApiKey检查是否携带 X-Api-Key 请求头,详见鉴权说明
40301权限不足确认该 ApiKey 已开通对应接口权限

参数类(422xx)

错误码含义处理建议
42201字段校验失败message 指出的字段修正
42202字段格式错误检查类型、长度、枚举值
42203请求体解析失败检查 JSON 格式与编码
42204未上传文件检查是否携带 file 表单字段
42205文件类型不允许仅支持 PDF(扩展名 + 内容魔数双重校验)
42206文件超出大小限制压缩或拆分后重传(默认上限 10MB)
42207文件保存失败重试,持续失败联系技术支持

业务类(409xx / 404xx)

错误码含义处理建议
40401预报单不存在确认 forecastNo / poNumber 正确
40901PO Number 重复同一 poNumber 不可重复提交
40902当前状态不允许操作如预报单已收货不可再修改
40903物流单号重复确认 trackingNumber 未被其他预报单占用

限流类(429xx)

错误码含义处理建议
42901触发限流Retry-After 头退避,指数退避重试

Webhook 类(408xx)

错误码含义处理建议
40801客户端响应超时检查接收端点性能,5s 内返回 2xx
40802客户端返回非 2xx处理成功后返回 2xx,否则触发重试

系统类(500xx)

错误码含义处理建议
50001系统异常重试,持续失败联系技术支持
50002服务暂时不可用稍后重试
50301维护中关注维护公告

处理建议

  • 鉴权类:本地复现并修复,避免重复请求导致 ApiKey 被临时锁定。
  • 参数类:以 message 中的字段为准修正,建议客户端做入参本地校验。
  • 业务类:根据业务语义决定是否提示用户或重试。
  • 限流 / 系统类:实现指数退避重试,并加入告警。