Shipping Solution API 文档
目录

LSO下单

  • 接口说明： 提交平台进行LSO订单下单，下单结果需要异步通知或查询
  • 详细说明：
  • 1：由于LSO官方接口仅支持单货物下单，但系统相同发件地，收货地多件货物可一次请求。通过orderDetails列表传入多件货物,详情请见下方请求示例
  • 2：下单参数中systemSenderName为系统发件人名称(可登录系统（LSO运单录入（发件地下拉））查看可用系统发件人，不传则走系统默认发件地)
  • 3：LSO面单官方尺寸为4x5,为了客户打印机能兼容LSO面单及UPS面单固调整尺寸为4X6，下方则会有一段空白。
  • 4：当下单失败请及时调用退款接口，不然会占用余额！
  • 5：LSO为区域服务商，系统会校验发件地和收货地是否有LSO服务，请关注返回信息！
  • 6：系统未提供不同的发件地，收货地批量下单接口，不同的发件地，收货地批量下单请多次请求本接口下单！
  • 7：【返回单号和费用(通用)】及【返回面单(通用)】接口请调用通用接口
  • 8：下单参数中serviceType为LSO服务类型，现系统中仅支持GroundBasic，后续更多服务可关注本文档更新日志！
  • 9：- 下单请求逻辑
    1. 商户获取token(通用) (opens new window) :获取到token,后续接口需要使用此token校验请求合法性
    2. LSO费用预览 (opens new window) :进行运价预览（系统要求调用方先获取价格再进行下单）
    3. LSO下单 (opens new window) :进行下单请求（系统为异步下单，请调用下单后稍后主动调用返回单号和费用(通用) (opens new window) 接口获取下单情况或使用回调方式）
    4. 返回单号和费用(通用) (opens new window) :运单下单后，系统需要异步去执行下单逻辑，期间会存在一定的时间差，所以下单后请稍微间隔几秒后再行调用查询接口。若查询接口返回的code不为200，当code=1024时表示 平台下单还未完成，您可以稍后重试查询直到code为200时获取运单信息，再根据运单状态判断执行后续业务逻辑，其余code值则为下单失败。
    5. 返回面单(通用) (opens new window) :标签为异步生成，当请求状态为1115(标签正在下载，请稍候!) 时候需要稍后重新调用本接口获取)
  • 请求方式： POST
  • 接口地址： https://syco-api.logssc.com/external-interface/lso/orderCommit

# 请求参数

参数名称 类型 是否必填 描述
token String true token
customerNumber String true 客户单号
referenceNo1 String false UPS标签referenceNo1
referenceNo2 String false UPS标签referenceNo2
appId String true 商户APP-KEY
province String true 收件人所在州[缩写]
city String true 收件人所在城市
receiver String true 收件人
receiverPhone String true 收件人电话
postcode String true 收件邮编
address1 String true 地址1
address2 String false 地址2
nationCode String true 国家二字码（现限：US）
receiveCompany String true 收件公司
systemSenderName String false 所选系统发件人名称(可用系统发件人登录系统查看，不传走系统默认)
lsoServiceType String true 服务类型=>现仅：GroundBasic
url String false 订单下单完成回调通知URL[详见说明]
systemSenderName String false 所选系统发件地viewName(可用发件地登录系统查看)
orderDetails List<Object> true 货物明细
 packWeight Decimal true 货箱重量(LBS)
 boxLength Decimal true 长(IN)
 boxWidth Decimal true 宽(IN)
 boxHight Decimal true 高(IN)
 referenceNo1 String true UPS标签referenceNo1
 referenceNo2 String false UPS标签referenceNo2
 lsoDeclaredValue Decimal false 申报价格

请求示例：

{
    "customerNumber": "客户单号",
    "referenceNo1": "LSO标签referenceNo1（与orderDetails.referenceNo1(优先) 二选一 ）",
    "referenceNo2": "LSO标签referenceNo2（与orderDetails.referenceNo2(优先) 二选一 ）",
	"appId": "商户APP-KEY",
	"city": "收件人所在城市",
	"province": "收件人所在州[缩写]",
	"receiver": "收件人",
	"receiverPhone": "收件人电话",
	"postcode": "收件邮编",
	"address1": "地址1",
	"address2": "地址2",
	"nationCode": "国家二字码",
	"receiveCompany": "收件公司",
    "systemSenderName": "XXX",
    "lsoServiceType": "GroundBasic",
	"url": "回调URL",
	"orderDetails": [
		{
			"boxHight": "高",
			"boxLength": "长",
			"boxWidth": "宽",
			"packWeight": "货箱重量",
			"referenceNo1": "LSO标签referenceNo1",
			"referenceNo2": "LSO标签referenceNo2",
           "lsoDeclaredValue": "申报价格"
		},
          {
            "boxHight": "高",
            "boxLength": "长",
            "boxWidth": "宽",
            "packWeight": "货箱重量",
            "referenceNo1": "LSO标签referenceNo1",
            "referenceNo2": "LSO标签referenceNo2",
            "lsoDeclaredValue": "申报价格"
          }
	],
	"token": "token"
}

# 返回结果

参数名称 类型 描述
data
 orderNumber String 订单号
 orderDetails List 细单明细
  packWeight Decimal 货箱重量(LSB)
  boxHight Decimal 高(IN)
  boxLength Decimal 长(IN)
  boxWidth Decimal 宽(IN)
  referenceNo1 String 备注1
  referenceNo2 String 备注2
  detailNumber String 子单号
code Integer 状态码
err string 错误信息
msg String 结果描述

返回示例：

{
    "code": 200,
    "data": {
        "orderNumber": "订单号",
        "orderDetails":[{
              "packWeight": "货箱重量",
              "boxLength": "长",
              "boxWidth": "宽",
              "boxHight": "高",
              "referenceNo1": "备注1",
              "referenceNo2": "备注2",
              "detailNumber": "子单号"
        }]
    },
    "err": "",
    "msg": "数据请求成功!"
}

# 回调通知

订单下单完成会主动往此接口推送单号和费用数据。当通知失败时,平台最多尝试5次,每次尝试间隔5分钟。下单成功时回调报文与接口返回单号和费用响应报文一致。与若一直没有收到回调请主动调用返回单号和费用 (opens new window)接口查询订单下单结果。

下单成功时回调报文示例：

{
  "code": 200,
  "data": {
    "serviceNumber": "服务商主单号",
    "orderNumber": "订单号",
    "customerNumber": "客户单号",
    "prepaidPrice": "运费金额",
    "averagePrice": "平均价格/KG",
    "status": "状态",
    "piece": "件数",
    "weight": "重量",
    "nationName": "所属国家名称",
    "province": "收件省",
    "city": "收件城市",
    "postcode": "收件邮编",
    "address1": "地址1",
    "address2": "地址2",
    "address3": "地址3",
    "closeWeightAll": "计费重量（LB）",
    "averageFee": "平均价格",
    "commission": "佣金",
    "totalWeightlbs": "计费总重量(LB)",
    "totalWeightkg": "计费总重量(KG)",
    "masterServiceNumbers":["服务商主单号1", "服务商主单号2"],
    "details": [
      {
        "boxHight":  "长",
        "boxLength":  "宽",
        "boxWidth":  "高",
        "serviceNumber":  "服务单号",
        "masterServiceNumber":  "服务主单号（区分拆单）",
        "referenceNo1":  "备注1",
        "referenceNo2":  "备注2",
        "packWeight":  "货箱重量"
      }
    ]
  },
  "err": "",
  "msg": "订单下单已完成!"
}

下单失败时回调报文示例：

{
  "code": 1001,
  "data": {
    "orderNumber": "订单编号",
    "errorMessage": "下单失败的具体错误信息描述"
  },
  "err": "",
  "msg": "下单失败"
}
上次更新: 2023/07/17, 02:58:45
MI渠道费用预览
LSO费用预览

← LSO费用预览→

Theme by Vdoing | Copyright © 2022-2025 hnfsu