YCS EXPRESS
  1. API List
YCS EXPRESS
  • Prepare
  • API List
    • 1.realname
    • 2.createOrder
    • 3.reverseOrder
    • 4.getBagLabel
    • 5.tracking
    • 6.getPackageLabel
    • 7.orderDetail
    • 8.getShopInfo
  • Product Code
  • Appendix
  1. API List

4.getBagLabel

服务能力:获取包袋面单 ---->获取大箱标签(含清关条码)
请求地址:host:/getBagLabel
请求方式:POST
Header 请求参数(用于token校验):
参数名示例值
token4e411a926e7a33ca9d04cd1942ac54a2
Body 请求参数:
参数名描述是否必填数据类型字段长度
bagRefNo大箱参考号
客户自定义大箱号
是String30
productCode服务编码
取Product Code的值
是String10
请求示例:
{
    "bagRefNo":"BOX123456789",
    "productCode":"TWYCS-PP"
}
响应:
字段名描述数据类型
successtrue 或者 falseBoolean
code200:成功
其他:失败
Integer
message请求返回信息String
requestId请求IDString
dataObject
 bagRefNo大箱参考号String
 productCode服务编码String
 cclBarcodeNo并袋海关编码String
 labelUrl面单url地址,pdf格式String
成功响应示例:
{
    "success": true,
    "code": 200,
    "message": "success",
    "requestId": "66b07711c9fff13126",
    "data": {
        "bagRefNo": "BOX-TEST20240805001",
        "productCode": "TWFMART-COD",
        "cclBarcodeNo": "0V3GE001",
        "labelUrl": "https://openapi.ycs.express/pdf-file/0V3GE001/84181be4-52f7-11ef-94b9-00163e0cad28.pdf"
    }
}
错误代码说明:
错误代码错误描述
1001Token验证错误,请检查传入的Token是否正确
1002请求参数数据结构错误,请检测后重新传入
1003传入参数长度不符合要求
大箱参考号/服务编码不能为空
1004接口异常
错误示例返回:
{
    "success":false,
    "code":1001,
    "message":"Token验证错误,请检查传入的Token是否正确",
    "requestId":"655c00af45b3a785"
}
修改于 2025-02-21 06:32:58
上一页
3.reverseOrder
下一页
5.tracking
Built with