Shipping Solution API 文档 Shipping Solution API 文档
首页
  • 商户获取token(通用)
  • UPS下单
  • UPS费用预览
  • UPS发件地信息
  • MI下单
  • MI费用预览
  • LSO下单
  • LSO费用预览
  • LSO轨迹查询
  • UPS轨迹查询
  • Fedex下单
  • Fedex费用预览
  • Fedex轨迹查询
  • Amazon下单
  • Amazon费用预览
  • Amazon轨迹查询
  • 返回单号和费用(通用)
  • 退款申请(通用)
  • 返回面单(通用)
  • FEDEX发件地信息
  • 下单常见问题
首页
  • 商户获取token(通用)
  • UPS下单
  • UPS费用预览
  • UPS发件地信息
  • MI下单
  • MI费用预览
  • LSO下单
  • LSO费用预览
  • LSO轨迹查询
  • UPS轨迹查询
  • Fedex下单
  • Fedex费用预览
  • Fedex轨迹查询
  • Amazon下单
  • Amazon费用预览
  • Amazon轨迹查询
  • 返回单号和费用(通用)
  • 退款申请(通用)
  • 返回面单(通用)
  • FEDEX发件地信息
  • 下单常见问题
  • 接口说明

    • 接口说明
      • 接口请求声明
      • 接口数据返回说明
      • 下单接口说明
      • 试算接口说明
      • 接口调用逻辑
      • 接口响应状态码说明
    • 更新日志
  • 接口定义

    • 商户获取token(通用)
    • UPS下单
    • UPS费用预览
    • UPS轨迹查询
    • UPS发件地信息
    • MI渠道下单
    • MI渠道费用预览
    • LSO下单
    • LSO费用预览
    • LSO轨迹查询
    • Fedex下单
    • Fedex费用预览
    • Fedex轨迹查询
    • Fedex发件地信息
    • AMAZON下单
    • AMAZON费用预览
    • AMAZON轨迹查询
    • AMAZON发件地信息
    • 返回单号和费用(通用)
    • 退款申请(通用)
    • 返回面单(通用)
目录

接口说明

本接口文档面向Shipping Solution所有入驻商户开放,通过此接口文档您可以快速自定义实现自己的下单流程。

# 接口请求声明

  • 除了商户获取token (opens new window)接口外,所有业务接口请求必须传递token和appId
{
    "token": "获取的商户Token",
    "appId": "商户APP-KEY"
}
  • 获取到的商户Token,时效为2小时,若失效请重新获取
  • 数据请求参数请统一采用application/json格式,并且字符编码为UTF-8(Content-Type=application/json;charset=UTF-8)进行传输

# 接口数据返回说明

  • code:接口业务编码,所有接口业务逻辑请以"code==200"为成功判断标识
  • msg:作为较为友好的描述信息返回给客户展示,成功和失败或者报错都会返回此信息。
  • err:记录服务端异常或者数据库异常的详细错误信息,用于日志记录给开发人员查看,应避免直接展示给客户
  • data:作为数据存储对象,仅在查询接口请求成功时直接返回查询数据。

示例:

{
    "code": 200,
    "data": null,
    "err": "",
    "msg": "数据请求成功"
}

# 下单接口说明

  • 关于UPS,AMAZON,FEDEX渠道试算和下单接口的说明

  • 下单接口:仅接口地址不同,其余入参及返回字段一致。

  • 接口调用方可通过渠道去请求不同地址:https://syco-api.logssc.com/external-interface/${渠道代码}/orderCommit

  • 例子:UPS=${渠道代码}=空:https://syco-api.logssc.com/external-interface/orderCommit

  • 例子:AMAZON=${渠道代码}=amazon:https://syco-api.logssc.com/external-interface/amazon/orderCommit

  • 例子:FEDEX=${渠道代码}=fedex:https://syco-api.logssc.com/external-interface/fedex/orderCommit

# 试算接口说明

  • 试算接口:仅接口地址不同,其余入参及返回字段一致。

  • 接口调用方可通过渠道去请求不同地址:https://syco-api.logssc.com/external-interface/${渠道代码}/orderPreFee

  • 例子:UPS=${渠道代码}=空:https://syco-api.logssc.com/external-interface/orderPreFee

  • 例子:AMAZON=${渠道代码}=amazon:https://syco-api.logssc.com/external-interface/amazon/orderPreFee

  • 例子:FEDEX=${渠道代码}=fedex:https://syco-api.logssc.com/external-interface/fedex/orderPreFee

# 接口调用逻辑

  • 下单请求逻辑
  1. 商户获取token(通用) (opens new window) :获取到token,后续接口需要使用此token校验请求合法性
  2. UPS费用预览 (opens new window) :进行运价预览(系统要求调用方先获取价格再进行下单)
  3. UPS下单 (opens new window) :进行下单请求(系统为异步下单,请调用下单后稍后主动调用返回单号和费用(通用) (opens new window) 接口获取下单情况或使用回调方式)
  4. 返回单号和费用(通用) (opens new window) :运单下单后,系统需要异步去执行UPS下单逻辑,期间会存在一定的时间差,所以下单后请稍微间隔几秒后再行调用查询接口。若查询接口返回的code不为200,当code=1024时表示 平台下单还未完成,您可以稍后重试查询直到code为200时获取运单信息,再根据运单状态判断执行后续业务逻辑,其余code值则为下单失败。
  5. 返回面单(通用) (opens new window) :标签为异步生成,当请求状态为1115(标签正在下载,请稍候!) 时候需要稍后重新调用本接口获取)

# 接口响应状态码说明

code msg err 备注
200 请求成功 无 请求成功,有查询数据时将附加数据至data参数返回
201 请求参数不能为空 无 当请求接口必传参数未传入时返回
202 未查询到数据 无 当查询无任何数据时返回
400 缺少请求参数 无 请求参数缺失时返回
401~403 参数解析异常 无 请求参数传入缺失或者异常时返回
405 该接口不支持当前请求方式 无 POST或者GET请求方式错误时返回
500 请求失败 详细记载了具体错误信息 服务端发生异常或部分业务错误时返回
1009 订单不存在! 无 订单已删除或订单号传入有误
1015 商户信息不存在 无 商户信息不存在,商户被禁用或者未注册成功
1023 订单仅在下单失败、已支付、下单中状态可申请退款! 无 检查订单状态,确认是否可以申请退款
1026 未找到合适报价 无 当前运单在系统中没有匹配到合适的价格,请和管理员联系
1049 已有实际费用,无法申请退款! 无 请核对退款信息是否准确
1060 货物信息不能为空 无 检查货物信息是否传入
1072~1073 收件邮编有误 无 检查收件邮编是否传入并且格式正确
1099 无效或已过期的token 无 指定接口验证token时失败,请重新登录获取token
1115 标签正在下载,请稍候! 无 标签正在从UPS下载生成中,需要稍后重试获取
1024 运单正在下单中,请稍后... 无 查询运单时运单正在下单中,稍后再继续请求查询接口即可
  • 备注: 业务编码将随着业务逻辑扩展而逐渐增加和完善,如果调试中遇到新的code未在文档中描述请给予反馈,谢谢。
上次更新: 2025/01/13, 20:45:28
更新日志

更新日志→

Theme by Vdoing | Copyright © 2022-2025 hnfsu
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式