Prepare · 环境配置
测试环境

URL: https://openapitest.ycs.express

Token: 咨询客服

生产环境

URL: https://openapi.ycs.express

Token: 咨询客服

所有接口请求均需在Header中携带Token进行鉴权
1. realname 实名认证查询POST
服务能力：查询实名认证信息。请求地址：host:/realname
Header参数
参数名 示例值
token 4e411a926e7a33ca9d04cd1942ac54a2
Body 请求参数
参数名 描述 必填 数据类型 长度
realname 用户真实姓名 是 String 20
phone 用户手机号码
建议格式：0开头+9位数字		 是 String 20
id 用户身份证号码
台湾身份证号码格式10码		 否 String 20
请求示例
{
    "realname": "张三",
    "phone": "0985532043",
    "id":"A123456789"
}
响应字段说明
字段名 描述 数据类型
success true/false Boolean
code 200：成功 其他：失败 Integer
message 返回信息 String
requestId 请求ID String
data 对象 Object
realname 用户真实姓名 String
phone 用户电话 String
id 身份证号码 String
result A.已實名無需預委任 B.已實名需預委任 C.未實名 D.信息不符 String
成功返回示例
{
    "success": true,
    "code": 200,
    "message": "success",
    "requestId": "656db3a31d512291",
    "data": {
        "realname": "张三",
        "phone": "0985532043",
        "id": "",
        "result": "A"
    }
}
错误代码
错误代码描述
1001Token验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
2. submitAppointment 预委任信息提交POST
服务能力：提交预委任信息。请求地址：host:/submitAppointment
Header参数 (token)
token示例值
token4e411a926e7a33ca9d04cd1942ac54a2
Body 参数 (含嵌套)
参数名描述必填数据类型
packageNo分提单号是String
realname真实姓名是String
phone手机号码是String
email用户邮箱是String
id身份证号否String
packageWeight包裹重量kg否Number
goodsPrice商品货值否Number
goodsPriceCurrency币种(TWD)是String
items包裹详情是Array
goodsName商品名称是String
goodsNumber数量是Number
goodsUnitPrice单价是Number
{
    "packageNo": "TEST102301203",
    "realname": "张三",
    "phone": "0985532043",
    "email":"zhangsan@test.com",
    "id": "A123456789",
    "packageWeight": 0.9,
    "goodsPrice": 190,
    "goodsPriceCurrency": "TWD",
    "items": [
        {
            "goodsName": "无线蓝牙耳机",
            "goodsNumber": 2,
            "goodsUnitPrice": 45
        },
        {
            "goodsName": "Type-C 数据线",
            "goodsNumber": 5,
            "goodsUnitPrice": 12
        },
        {
            "goodsName": "手机保护壳",
            "goodsNumber": 1,
            "goodsUnitPrice": 40
        }
    ]
}
响应字段说明
字段名 描述 数据类型
success true 或者 false Boolean
code 200：成功
其他：失败		 Integer
message 请求返回信息 String
requestTime 委任数据提交时间 String
requestId 请求ID String
data 对象 Object
packageNo 分提单号
包裹包/订单号		 String
realname 用户真实姓名 String
phone 用户电话 String
email 用户邮箱 String
id 用户身份证号码 String
packageWeight 包裹重量 Number
goodsPrice 商品货值 Number
goodsPriceCurrency 商品货值币种
如：TWD		 String
items 包裹详情 Object
goodsName 商品名称 String
goodsNumber 商品数量 Number
goodsUnitPrice 商品单价 Number
成功返回示例
{
    "success": true,
    "code": 200,
    "message": "success",
    "requestTime": "2025-12-02 09:23:02",
    "requestId": "656db3a31d512291",
    "data": {
        "packageNo": "TEST102301203",
        "realname": "张三",
        "phone": "0985532043",
        "email": "zhangsan@test.com",
        "id": "",
        "packageWeight": 0.9,
        "goodsPrice": 190,
        "goodsPriceCurrency": "TWD",
        "items": [
            {
                "goodsName": "无线蓝牙耳机",
                "goodsNumber": 2,
                "goodsUnitPrice": 45
            },
            {
                "goodsName": "Type-C 数据线",
                "goodsNumber": 5,
                "goodsUnitPrice": 12
            },
            {
                "goodsName": "手机保护壳",
                "goodsNumber": 1,
                "goodsUnitPrice": 40
            }
        ]
    }
}
错误代码
错误代码描述
1001Token验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
3. getAppointmentResult 委任结果查询POST
服务能力：获取委任结果。请求地址：host:/getAppointmentResult，Body为Array分提单号(≤50)
请求示例
[
    "TEST102301203",
    "TEST102301204"
]
响应字段说明
字段名 描述 数据类型
success true 或者 false Boolean
code 200：成功
其他：失败		 Integer
message 请求返回信息 String
requestId 请求ID String
data 数组，每个元素为对象 Array
packageNo 分提单号
包裹号/订单号		 String
realname 姓名 String
phone 手机号码 String
id 身份证号 String
appointmentSubmitTime 委任提交时间 String
appointmentResult 委任状态
已确认/已拒绝/待确认		 String
appointmentConfirmTime 委任确认时间
已确认状态为用户确认时间
已拒绝状态为用户拒绝时间
待确认的情况下为空		 String 
{
    "success": true,
    "code": 200,
    "message": "success",
    "request_id": "655c779c9af8b772",
    "data": [
        {
            "packageNo": "TEST102301203",
            "realname": "张三",
            "phone": "0985532043",
            "id": "A123456789",
            "appointmentSubmitTime": "2026-01-22 23:32:27",
            "appointmentResult": "待确认",
            "appointmentConfirmTime": null
        },
        {
            "packageNo": "TEST102301204",
            "realname": "李四",
            "phone": "0985532044",
            "id": "A123456788",
            "appointmentSubmitTime": "2026-01-22 23:32:28",
            "appointmentResult": "待确认",
            "appointmentConfirmTime": null
        }
    ]
}
错误代码
错误代码描述
1001Token验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
4. createOrder 预报包裹创建POST
服务能力：创建预报包裹，支持宅配/店配/UPS多种渠道。请求地址：host:/createOrder
Body 请求参数
参数名 描述 是否必填 数据类型 字段长度
referenceNo客户自定义单号，唯一是String30
productCode服务编码
取Product Code的值		是String10
orderNo客户订单号否String30
packageType包裹类型(默认B2C)
B2B/B2C/C2C		否String30
incoterms贸易条款(DDU、DDP二选一)否String30
reasonForExport报关用途(UPS渠道必填)
枚举值：
SALE:我要銷售這些物品
GIFT:我要送禮物
INTERCOMPANYDATA:我要寄送包含
數據的物理設備
SAMPLE：我要寄送產品樣品
REPAIR:我要將這些物品送修
RETURN:我要退回物品		否String30
storeId取件店代码（店铺ID）
---店配模式必填
店铺ID从getShopInfo接口中获取		是String20
codAmount包裹COD金额
服务编码为：
TWYCS-COD，TWFMART-COD
TW711-COD时为必填		是Number10
isTransfer是否转单
0：正常订单
1：转单
正常订单默认不用传该字段		否Number1
feePayer转单费用支付方
客户代码
正常订单默认不用传该字段		否String20
remark包裹派送备注否String100
sender发件人信息是Object
company发件人公司否String100
contact发件人是String50
phone发件人电话是String20
emailemail否String50
country发件人国家是String50
province发件人省/州是String100
city发件人城市是String100
address发件人详细地址是String200
postCode发件人邮编是String10
vat发件人税号/ID否String20
receiver收件人信息是Object
company收件人公司否String100
contact收件人是String50
phone收件人电话是String20
emailemail否String50
country收件人国家/区域
---店配模式非必填		是String50
province收件人省/州否String100
city收件人市/县
---店配模式非必填		是String100
suburb收件人行政区否String100
address收件人详细地址
---店配模式非必填		是String200
UPS渠道：35
address2收件人详细地址2
---仅对UPS渠道有效		否String35
address3收件人详细地址3
---仅对UPS渠道有效		否String35
postCode收件人邮编
---店配模式非必填		是String10
vat收件人税号/ID否String20
packageList包裹商品信息是Array[PackageList]
packType包装类型（UPS渠道必填）
枚举值
01:UPS Letter
02:自行包装
04:UPS Pak		是String2
description包裹描述
UPS渠道必填		是Number5
weight包裹实际重量，单位：kg
精确到3位小数		是Number8
length包裹长，单位：cm
精确到1位小数		否Number5
width包裹宽，单位：cm
精确到1位小数		否Number5
height包裹高，单位：cm
精确到1位小数		否Number5
packageItemList包裹物品明细是array[PackageItemList]
skuSKU编码是String30
goodsNameEn英文品名/当地品名是String100
goodsNameCn中文品名是String100
countryOfOrigin原产地(UPS渠道必填)
国家/地区两位代码
如：TW、CN		是String100
fullDescEn销售描述是String1000
hsCodeHS CODE否String10
quantity数量是Number10
unitType单元类型(UPS渠道必填)
枚举值：详情见附录appendix		是Number10
itemWeight重量，单位：kg
精确到3位小数		是Number7
itemValue商品价值是String10
currency货币单位
（比如：TWD、USD）		是String5
itemSellingUrl商品销售链接否String1000
imageUrl商品图片链接否String500
📦 宅配模式示例
{
    "referenceNo": "TEST190107003",
    "productCode": "TWYCS-COD",
    "orderNo": "OD190107003",
    "incoterms": "DDU",
    "remark": "备注",
    "sender": {
        "company": "TEST",
        "contact": "测试",
        "phone": "0977777777",
        "email": "test@test.com",
        "country": "",
        "province": "台北市",
        "city": "北投區",
        "address": "中央南路3段16號3樓501",
        "postCode": "112"
    },
    "receiver": {
        "company": "",
        "contact": "林青霞",
        "phone": "0977560001",
        "email": "test@test.com",
        "country": "",
        "province": "台灣",
        "city": "台南市",
        "suburb": "中西區",
        "address": "武聖路１５３號１樓",
        "postCode": "700",
        "vat": "A123456789"
    },
    "packageList": [
        {
            "weight": "13.109",
            "length": "50",
            "width": "80",
            "height": "45",
            "codAmount": 3980,
            "packageItemList": [
                {
                    "sku": "td2902sx880",
                    "goodsNameEn": "洗地機",
                    "goodsNameCn": "洗地机",
                    "fullDescEn": "【TiDdi】乾濕兩用仿生洗地機(SX880)",
                    "hsCode": "36890233",
                    "quantity": "1",
                    "itemWeight": "5.102",
                    "itemValue": "3390",
                    "currency": "TWD",
                    "itemSellingUrl": "https://24h.pchome.com.tw/prod/DMAX5B-A900H2OI7",
                    "imageUrl": "https://cs-a.ecimg.tw/items/DMAX5BA900H2OI7/000001_1706836797.jpg"
                },
                {
                    "sku": "dy102348",
                    "goodsNameEn": "吸塵器",
                    "goodsNameCn": "吸尘器",
                    "fullDescEn": "Dyson V12 Origin SV44 輕量智能吸塵器 銀灰",
                    "hsCode": "36890235",
                    "quantity": "1",
                    "itemWeight": "7.88",
                    "itemValue": "15900",
                    "currency": "TWD",
                    "itemSellingUrl": "https://24h.pchome.com.tw/prod/DMBF05-1900GQDCH?fq=/S/DMAX00",
                    "imageUrl": "https://cs-a.ecimg.tw/items/DMBF051900GQDCH/l000001_1706866075.jpg"
                }
            ]
        }
    ]
}
🏪 店配模式示例
{
    "referenceNo": "TEST190107005",
    "productCode": "TWFMART-COD",
    "orderNo": "OD190107005",
    "incoterms": "DDU",
    "storeId": "022172",
    "codAmount": "5960",
    "remark": "备注",
    "sender": {
        "company": "TEST",
        "contact": "测试",
        "phone": "0977777777",
        "email": "test@test.com",
        "country": "",
        "province": "台北市",
        "city": "北投區",
        "address": "中央南路3段16號3樓501",
        "postCode": "112"
    },
    "receiver": {
        "contact": "林青霞",
        "phone": "0977560001"
    },
    "packageList": [
        {
            "weight": "13.109",
            "length": "50",
            "width": "80",
            "height": "45",
            "packageItemList": [
                {
                    "sku": "td2902sx880",
                    "goodsNameEn": "洗地機",
                    "goodsNameCn": "洗地机",
                    "fullDescEn": "【TiDdi】乾濕兩用仿生洗地機(SX880)",
                    "hsCode": "36890233",
                    "quantity": "1",
                    "itemWeight": "5.102",
                    "itemValue": "3390",
                    "currency": "TWD",
                    "itemSellingUrl": "https://24h.pchome.com.tw/prod/DMAX5B-A900H2OI7",
                    "imageUrl": "https://cs-a.ecimg.tw/items/DMAX5BA900H2OI7/000001_1706836797.jpg"
                },
                {
                    "sku": "dy102348",
                    "goodsNameEn": "吸塵器",
                    "goodsNameCn": "吸尘器",
                    "fullDescEn": "Dyson V12 Origin SV44 輕量智能吸塵器 銀灰",
                    "hsCode": "36890235",
                    "quantity": "1",
                    "itemWeight": "7.88",
                    "itemValue": "15900",
                    "currency": "TWD",
                    "itemSellingUrl": "https://24h.pchome.com.tw/prod/DMBF05-1900GQDCH?fq=/S/DMAX00",
                    "imageUrl": "https://cs-a.ecimg.tw/items/DMBF051900GQDCH/l000001_1706866075.jpg"
                }
            ]
        }
    ]
}
🌍 UPS渠道示例
{
    "referenceNo": "TEST20020726018",
    "productCode": "TWUPS-WES",
    "incoterms": "DDP",
    "reasonForExport": "GIFT",
    "sender": {
        "company": "Company",
        "contact": "Test",
        "phone": "091234124",
        "country": "TW",
        "province": "TP",
        "city": "Taibei",
        "address": "Industrial Park",
        "postCode": "100",
        "vat": "00000000"
    },
    "receiver": {
        "contact": "Jenna",
        "phone": "0985532043",
        "country": "KR",
        "province": "Seoul",
        "city": "Gangnam-gu",
        "suburb": "Yeoksam-dong",
        "address": "123 Teheran-ro, Gangnam-gu",
        "postCode": "06123",
        "vat": "0000000"
    },
    "packageList": [
        {
            "packType": "02",
            "description": "TEST GOODS",
            "weight": "0.177",
            "length": 37,
            "width": 28,
            "height": 0,
            "packageItemList": [
                {
                    "sku": "sku001",
                    "goodsNameEn": "One-piece underwear",
                    "goodsNameCn": "连体内衣",
                    "countryOfOrigin": "TW",
                    "fullDescEn": "Topless Crotchless Jumpsuit",
                    "hsCode": "6108920010",
                    "quantity": 1,
                    "unitType": "BOX",
                    "itemWeight": 0.1,
                    "itemValue": "64.56",
                    "currency": "TWD"
                },
                {
                    "sku": "sku002",
                    "goodsNameEn": "Lingerie set",
                    "goodsNameCn": "女式内衣套装",
                    "countryOfOrigin": "TW",
                    "fullDescEn": "Lingerie",
                    "hsCode": "6212101000",
                    "quantity": 1,
                    "unitType": "BG",
                    "itemWeight": 0.1,
                    "itemValue": "139.87",
                    "currency": "TWD"
                }
            ]
        }
    ]
}
响应字段说明
字段名 描述 数据类型
success true 或者 false Boolean
code 200：成功
其他：失败		 Integer
message 请求返回信息 String
requestId 请求ID String
data 对象 Object
waybill 运单号 String
referenceNo 客户自定义单号，唯一 String
productCode 服务编码 String
labelUrl 面单url地址，pdf格式 String 
{
    "success": true,
    "code": 200,
    "message": "success",
    "requestId": "65bcecc674687425",
    "data": [
        {
            "waybill": "T80000045",
            "referenceNo": "TEST240202005",
            "productCode": "TEST",
            "labelUrl": "https://openapitest.ycs.express/pdf-file/T80000045/3a8df10c-c1ce-11ee-8445-00163e0cad28.pdf"
        }
    ]
}
错误代码
错误代码描述
1001Token验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
5. reverseOrder 退件包裹创建POST
服务能力：创建退件包裹。请求地址：host:/reverseOrder
Body 请求参数
参数名 描述 是否必填 数据类型 字段长度
referenceNo 客户自定义单号，唯一 是 String 30
productCode 服务编码
取Product Code的值
如：TWFMART-DTO		 是 String 10
orderAmount 商品货值
本地币种。如：TWD		 是 Number 30
senderName 寄件人姓名 是 String 50
senderPhone 寄件人电话 否 String 20
remark 备注 否 String 100 
{
    "referenceNo": "TEST2023213009",
    "productCode": "TWFMART-DTO",
    "orderAmount": "201",
    "senderName": "张三",
    "senderPhone": "0912345678",
    "remark": "备注"
}
响应字段说明
字段名 描述 数据类型
success true 或者 false Boolean
code 200：成功
其他：失败		 Integer
message 请求返回信息 String
requestId 请求ID String
data 对象 Object
waybill 运单号 String
returnShippingCode 退货寄件码 String
referenceNo 客户自定义单号，唯一 String
productCode 服务编码 String
响应 data
{
    "success": true,
    "code": 200,
    "message": "success",
    "requestId": "67b7f6e924bb914695",
    "data": {
        "waybill": "15000416771",
        "returnShippingCode": "150004167716",
        "referenceNo": "TEST2023213009",
        "productCode": "TWFMART-DTO"
    }
}
错误代码
错误代码描述
1001Token验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
6. getBagLabel 大箱标签/并袋海关码POST
服务能力：获取包袋面单 ---->获取大箱标签(含清关条码)。请求地址：host:/getBagLabel
Body 请求参数
参数名 描述 是否必填 数据类型 字段长度
bagRefNo 大箱参考号
客户自定义大箱号		 是 String 30
productCode 服务编码
取Product Code的值		 是 String 10 
{
    "bagRefNo":"BOX123456789",
    "productCode":"TWYCS-PP"
}
响应字段说明
字段名 描述 数据类型
success true 或者 false Boolean
code 200：成功
其他：失败		 Integer
message 请求返回信息 String
requestId 请求ID String
data 对象 Object
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验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
7. tracking 物流轨迹追踪POST
服务能力：包裹物流轨迹追踪。请求地址：host:/tracking
Body 请求参数
参数名 描述 是否必填 数据类型 字段长度
—
（运单号数组）		 运单号
一次最多支持查询50单		 是 Array
（字符串数组）		 30（每个运单号长度） 
[
    "14232473333",
    "14232477430",
    "70000273865"
]
响应字段说明
字段名 描述 数据类型
success true 或者 false Boolean
code 200：成功
其他：失败		 Integer
message 请求返回信息 String
requestId 请求ID String
data 数组 Array
waybill 运单号 String
referenceNo 参考号
客户包裹号		 String
latestStatus 最新状态 String
latestStatusTime 最新状态时间 String
events 轨迹节点详情 Array
location 轨迹发生地点 String
description 轨迹详情描述（本地文） String
localTime 轨迹节点发生时间（本地时间） String 
{
    "success": true,
    "code": 200,
    "message": "success",
    "requestId": "66c19570e43d2479",
    "data": [
        {
            "waybill": "14232473333",
            "referenceNo": "TEST240109001",
            "latestStatus": "已完成取件",
            "latestStatusTime": "2024-01-16 08:19:00",
            "events": [
                {
                    "location": "全家大溪松樹店",
                    "description": "已完成取件",
                    "localTime": "2024-01-16 08:19:00"
                },
                {
                    "location": "全家大溪松樹店",
                    "description": "貨件配達取件店鋪，取件截止時間是2024-01-16",
                    "localTime": "2024-01-09 16:02:00"
                },
                {
                    "location": "",
                    "description": "貨件等待配送中",
                    "localTime": "2024-01-09 15:02:00"
                },
                {
                    "location": "",
                    "description": "貨件進行配送中",
                    "localTime": "2024-01-09 14:43:00"
                },
                {
                    "location": "",
                    "description": "貨件已完成理貨",
                    "localTime": "2024-01-09 11:38:00"
                },
                {
                    "location": "",
                    "description": "貨件抵達物流中心",
                    "localTime": "2024-01-09 11:27:00"
                },
                {
                    "location": "",
                    "description": "已創建包裹面單，派送單號是14232473333",
                    "localTime": "2024-01-09 10:11:38"
                },
                {
                    "location": "",
                    "description": "訂單成立",
                    "localTime": "2024-01-09 10:11:00"
                }
            ]
        },
        {
            "waybill": "14232477430",
            "referenceNo": "TEST240109002",
            "latestStatus": "貨件已退回賣家",
            "latestStatusTime": "2024-01-20 18:51:00",
            "events": [
                {
                    "location": "",
                    "description": "貨件已退回賣家",
                    "localTime": "2024-01-20 18:51:00"
                },
                {
                    "location": "",
                    "description": "貨件已退回物流中心",
                    "localTime": "2024-01-18 07:17:00"
                },
                {
                    "location": "",
                    "description": "未取退回物流中心",
                    "localTime": "2024-01-17 22:20:00"
                },
                {
                    "location": "全家大溪松樹店",
                    "description": "貨件配達取件店鋪，取件截止時間是2024-01-16",
                    "localTime": "2024-01-09 16:02:00"
                },
                {
                    "location": "",
                    "description": "貨件等待配送中",
                    "localTime": "2024-01-09 15:02:00"
                },
                {
                    "location": "",
                    "description": "貨件進行配送中",
                    "localTime": "2024-01-09 14:43:00"
                },
                {
                    "location": "",
                    "description": "貨件已完成理貨",
                    "localTime": "2024-01-09 11:38:00"
                },
                {
                    "location": "",
                    "description": "貨件抵達物流中心",
                    "localTime": "2024-01-09 11:27:00"
                },
                {
                    "location": "",
                    "description": "已創建包裹面單，派送單號是14232477430",
                    "localTime": "2024-01-09 10:31:36"
                },
                {
                    "location": "",
                    "description": "訂單成立",
                    "localTime": "2024-01-09 10:31:00"
                }
            ]
        },
        {
            "waybill": "70000273865",
            "referenceNo": "TEST190107003",
            "latestStatus": "已實名無需委任",
            "latestStatusTime": "2024-08-16 10:44:54",
            "events": [
                {
                    "location": "",
                    "description": "已實名無需委任",
                    "localTime": "2024-08-16 10:44:54"
                },
                {
                    "location": "",
                    "description": "已創建包裹面單，派送單號是70000273865",
                    "localTime": "2024-08-16 10:44:53"
                }
            ]
        }
    ]
}
错误代码
错误代码描述
1001Token验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
8. getPackageLabel 获取包裹面单GET
服务能力：获取包裹面单。请求地址：host:/getPackageLabel
Body 请求参数
参数名 描述 是否必填 数据类型 字段长度
waybill 运单号 是 String 30 
https://openapitest.ycs.express/getPackageLabel?waybill=70000000366
响应字段说明
字段名 描述 数据类型
success true 或者 false Boolean
code 200：成功
其他：失败		 Integer
message 请求返回信息 String
requestId 请求ID String
data 对象 Object
waybill 运单号 String
labelUrl 面单url地址 String
响应
{
    "success":true,
    "code":200,
    "message":"success",
    "request_id":"655c779c9af8b772",
    "data":{
        "waybill":"70000000366",
        "labelUrl":"https://openapitest.ycs.express/pdf-file/70000000366/ef7ce42a-8807-11ee-ae09-00163e0cad28.pdf"
    }
}
错误代码
错误代码描述
1001Token验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
9. orderDetail 预报包裹详情GET
服务能力：获取预报包裹详细信息。请求地址：host:/orderDetail
Body 请求参数
参数名 描述 是否必填 数据类型 字段长度
waybill 运单号 是 String 30 
{
    "success":true,
    "code":200,
    "message":"success",
    "request_id":"655c83cc7fc56951",
    "data":{
        "packageCreateTime":"2023-11-21 08:50:15",
        "waybill":"70000000366",
        "packageNo":"TEST00011",
        "referenceNo":"TEST00011",
        "productCode":"YCS",
        "remark":null,
        "sender":{
            "company":"TEST",
            "contact":"测试",
            "phone":"0977777777",
            "email":"test@test.com",
            "country":"",
            "province":"雲林縣",
            "city":"斗六市",
            "address":"雲林路二段203號12樓",
            "postCode":"36100"
        },
        "receiver":{
            "company":null,
            "contact":"林先生",
            "phone":"0988888888",
            "email":"lin@email.com",
            "country":"",
            "province":"雲林縣",
            "city":"斗六市",
            "address":"雲林路二段 203 號 9 樓 ",
            "postCode":"08868"
        },
        "packageList":[
            {
                "packageDescription":null,
                "weight":"1.897",
                "length":"20.0",
                "width":"30.0",
                "height":"13.0",
                "packageItemList":[
                    {
                        "sku":"asda",
                        "goodsNameEn":"手套",
                        "goodsNameCn":"手套",
                        "quantity":"2",
                        "weight":"1.098",
                        "value":"23.50",
                        "hsCode":"00000000"
                    }
                ]
            }
        ]
    }
}
错误代码
错误代码描述
1001Token验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
10. getShopInfo 店铺信息POST
服务能力：获取店铺信息--数据每天会更新一次，建议一天获取一次最新店铺数据。请求地址：host:/getShopInfo
Body 请求参数
参数名 描述 是否必填 数据类型 字段长度
productCode 服务编码
全家店铺：TWFMART-PP或者TWFMART-COD
711店铺：TW711-PP或者TW711-COD
莱尔富店铺：TWLEF-PP或者TWLEF-COD\n 		是 String 20 
{
    "productCode":"TWFMART-PP"
}
响应字段说明
参数名 描述 数据类型
success true 或者 false Boolean
code 200：成功
其他：失败		 Integer
message 请求返回信息 String
requestId 请求ID String
data 数组 Array
storeId 店铺编码ID String
shopName 店铺名 String
tel 电话 String
city 市/县 String
town 行政区 String
road 路/街 String
streetNo 街道号/门牌号 String
address 店铺地址 String
startDate 开店日期 Date
endDate 适用结束日期 Date
closeDate 关店日期 Date
dataUpdateTime 店铺数据更新时间 Datetime
storeStatus 店铺状态
1：正常营业
2：闭店装修/结束营业
3：转换店号		 Integer
businessHours 店铺营业时间
24小时营业：24H
非24小时营业：空值		 String 
{
    "success": true,
    "code": 200,
    "message": "success",
    "requestId": "669e068feb28a52677",
    "data": [
        {
            "storeId": "002816",
            "shopName": "板橋板農店",
            "tel": "0222723346",
            "city": "新北市",
            "town": "板橋區",
            "road": "府中路",
            "streetNo": "２９—１號１樓",
            "address": "新北市板橋區府中路２９—１號１樓",
            "startDate": "2018-01-31",
            "endDate": null,
            "closeDate": null,
            "dataUpdateTime": "2024-07-22 15:03:38",
            "storeStatus": 1,
            "businessHours": "24H"
        },
        {
            "storeId": "003564",
            "shopName": "溪湖雙溪店",
            "tel": "048851178",
            "city": "彰化縣",
            "town": "溪湖鎮",
            "road": "大竹里彰水路二段",
            "streetNo": "７４５號１樓",
            "address": "彰化縣溪湖鎮大竹里彰水路二段７４５號１樓",
            "startDate": "2019-01-25",
            "endDate": null,
            "closeDate": null,
            "dataUpdateTime": "2024-07-22 15:03:38",
            "storeStatus": 1,
            "businessHours": "24H"
        },
        {
            "storeId": "004114",
            "shopName": "台中惠中店",
            "tel": "0423816112",
            "city": "台中市",
            "town": "南屯區",
            "road": "惠中路三段",
            "streetNo": "４６號、４８號、５０號",
            "address": "台中市南屯區惠中路三段４６號、４８號、５０號",
            "startDate": "2021-04-30",
            "endDate": null,
            "closeDate": null,
            "dataUpdateTime": "2024-07-22 15:03:38",
            "storeStatus": 1,
            "businessHours": "24H"
        },
        {
            "storeId": "005989",
            "shopName": "中賓店",
            "tel": "0225230023",
            "city": "台北市",
            "town": "中山區",
            "road": "中山里中山北路二段",
            "streetNo": "５９之３號１樓",
            "address": "台北市中山區中山里中山北路二段５９之３號１樓",
            "startDate": "2023-01-27",
            "endDate": null,
            "closeDate": null,
            "dataUpdateTime": "2024-07-22 15:03:38",
            "storeStatus": 1,
            "businessHours": "24H"
        }
    ]
}
店铺状态说明: 1正常营业;2闭店;3转换店号
错误代码
错误代码描述
1001Token验证错误
1002数据结构错误
1003参数长度不符合要求
1004接口异常
Product Code · 服务编码表
服务编码 是否COD 重量限制kg 金额限制 面单尺寸 面单方向 服务编码说明
TWYCS-PP否<=25<100,000 TWD100x150mm竖向YCS宅配预付包裹
TWYCS-COD是<=25<30,000 TWD100x150mm竖向YCS货到付款包裹
TWFMART-PP否<=10<100,000 TWD100x150mm竖向全家店配预付包裹
TWFMART-COD是<=10<20,000 TWD100x150mm竖向全家店配货到付款包裹
TW711-PP否<=6<100,000 TWD100x150mm竖向711预付包裹
TW711-COD是<=6<20,000 TWD100x150mm竖向711货到付款包裹
TWFMART-DTO是<=10<20,000 TWD100x150mm竖向全家退件包裹
TWLEF-PP是<=10<20,000 TWD100x150mm竖向莱尔富预付包裹
TWLEF-COD是<=10<20,000 TWD100x150mm竖向莱尔富货到付款包裹
TWLEF-DTO是<=10<20,000 TWD100x150mm竖向莱尔富退件包裹
TWUPS-WES是<=70<20,000 TWDA4(210*297mm)竖向(推薦)全球優捷快遞(1-3天，工作日結束前送達)
TWUPS-WED是<=70<20,000 TWDA4(210*297mm)竖向全球藍色捷運(3-5天，工作日結束前送達)
TWUPS-WEP是<=70<20,000 TWDA4(210*297mm)竖向全球特急快遞(1-3天，優先處理，早上9點或11點前送達)
TWUPS-WE是<=70<20,000 TWDA4(210*297mm)竖向全球快遞(1-3天，中午12點或下午2點前送達)
TWUPS-WWE是<=70<20,000 TWDA4(210*297mm)竖向經濟型服務(5-8個工作天送達)
Appendix · UPS渠道单元类型
适用服务：TWUPS-WES, TWUPS-WED, TWUPS-WEP, TWUPS-WE, TWUPS-WWE
Code Descritpion
BABarrel
BEBundle
BGBag
BHBunch
BOXBox
BTBolt
LBPound
LBSPounds
LLiter
MMeter
NMBNumber
PAPacket
BUButt
CICanister
CMCentimeter
CONContainer
CRCrate
CSCase
CTCarton
CYCylinder
DOZDozen
EAEach
ENEnvelope
FTFeet
KGKilogram
KGSKilograms
PALPallet
PCPiece
PCSPieces
PFProof Liters
OTHOther
PKGPackage
PRPair
PRSPairs
RLRoll
SETSet
SMESquare Meters
SYDSquare Yards
TUTube
YDYard
详细单元类型请参考API文档附录表格(已涵盖常见枚举值)
 YCS Express OpenAPI