文档中心
一、国际件查价接口 二、国际件下单接口 三、回调接口 四、国际件订单取消接口 五、国际件订单详情接口 附录:国家编码表

国际寄件API接口文档

一、国际件查价接口

该接口用于查询国际件运费。

1.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

1.2 请求地址

https://api.kuaidi100.com/apisentquery/international/queryPrice

请求参数:

参数名是否必填类型说明
key是string授权码,请申请企业版获取
sign是string32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上"+"号,secret在企业管理后台查看
t是string时间戳如:1576123932000
param是param由其他字段拼接

param数据结构:

参数名是否必填类型说明
kuaidiCom是string快递公司编码(目前仅支持圆通国际,编码:yuantongguoji)
weight是string重量(单位:KG)
cargo是string物品类型,输入:文件/包裹
recCountry否Integer收件人国家(英文)
serviceType是string业务类型

1.3 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述
dataobject

data数据结构

字段类型说明备注
firstPricestring首重价格
overPriceUnitString续重每公斤价格
priceString总价格
defPriceString默认价格
defFirstPriceString默认首重价格
defOverPriceString默认续重价格
overUnitWeightString续重单位重量(kg)
overUnitPriceString续重单位价格
overWeightString续重重量(kg)
firstWeightString首重重量(kg)
shippingFeeString运费
fuelAdditionalFeeString燃油附加费
resourceAdjustmentFeeString资源调节费

1.4 请求参数示例

key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
    "kuaidiCom": "yuantongguoji",
    "weight": "2.6",
    "serviceType": "国际标快",
    "cargo": "文件",
    "recCountry": "South Korea"
}

返回结果示例

{
    "result": true,
    "returnCode": 200,
    "message": "SUCCESS",
    "data": {
        "firstPrice": "176.40",
        "overPriceUnit": "{\"0-0\":\"86.40\"}",
        "price": "392.40",
        "defPrice": "392.40",
        "defFirstPrice": "176.40",
        "defOverPrice": "{\"0-0\":\"86.40\"}",
        "overUnitWeight": "0.50",
        "overUnitPrice": "43.20",
        "overWeight": "2.50",
        "firstWeight": "0.50",
        "shippingFee": null,
        "fuelAdditionalFee": null,
        "resourceAdjustmentFee": null
    }
}

二、国际件下单接口

该接口用于创建国际件订单。

2.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

2.2 请求地址

https://api.kuaidi100.com/international/createOrder

请求参数:

参数名是否必填类型说明
key是string授权码,请申请企业版获取
sign是string32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上"+"号,secret在企业管理后台查看
t是string时间戳如:1576123932000
param是param由其他字段拼接

param数据结构:

参数名是否必填类型说明
kuaidiCom是String快递公司编码(目前仅支持圆通国际,编码:yuantongguoji)
weight是String重量
senderInfo是SenderInfo寄件人信息(嵌套对象)
receiverInfo是ReceiverInfo收件人信息(嵌套对象)
cargo是String物品类型,输入:文件/包裹
comment否String备注(可选)
orderInvoices否List申报信息列表(若存在则需校验内部字段)
thirdId是String业务方订单ID
serviceType是String业务类型
length否String长度(尺寸可选,若需必填可加 @NotBlank)
width否String宽度
height否String高度
insuredValue否String保价金额(可选)
callbackUrl是String订单回调地址
pollCallbackUrl否String轮询回调地址(可选)
salt否String盐值(可选)

SenderInfo(寄件人信息)

参数名是否必填字段类型说明
name是String寄件人姓名
ename否String英文名(可选)
mobile是String寄件人手机号
country是String寄件人国家
province是String寄件人省份
city是String寄件人城市
district是String寄件人区县
address是String寄件人详细地址
company否String公司(可选)
postCode否String邮编(可选)
areaCode否String区号(可选)
email否String邮箱(可选)

ReceiverInfo(收件人信息)

参数名是否必填字段类型说明
name是String收件人姓名
ename否String英文名(可选)
mobile是String收件人手机号
country是String收件人国家
province是String收件人省份
city是String收件人城市
district否String收件人区县(可选)
address是String收件人详细地址
company否String公司(可选)
postCode否String邮编(可选)
areaCode否String区号(可选)
email否String邮箱(可选)

OrderInvoiceInfo(申报物品信息)

参数名是否必填字段类型说明
ename是String申报物品英文品名
cname是String申报物品中文品名
quantity是Integer申报物品数量(必须大于0)
unitPrice是String申报物品单价
currencyCode是String申报币种
originCountry否String原产国(可选)

2.3 返回结果

字段类型说明备注
resultboolean提交结果true处理成功,false处理失败
returnCodestring返回编码
messagestring返回报文描述
dataobject 成功 返回 true
失败 返回 失败原因

data数据结构

字段类型说明备注
taskIdstring
orderIdString订单id
kuaidiNumString快递单号
distributeCodeString三段码
pollTokenString查询密钥,调用实时快递查询接口时入参此字段可免费查询该快递单号,一个快递单号对应一个密钥

2.4 请求参数示例

key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
    "serviceType": "国际标快",
    "thirdId": 80000000103438,
    "receiverInfo": {
        "country": "Singapore",
        "ename": "ruoheng lyua",
        "address": "sydney epping derby 2A",
        "province": "New South Wales",
        "city": "New South Wales",
        "name": "ruoheng lyua",
        "mobile": "+61  0480 392 958",
        "postCode": "546080"
    },
    "length": "50",
    "weight": "1.0",
    "senderInfo": {
        "country": "china",
        "ename": "一枚",
        "address": "高新园金蝶大厦",
        "province": "广东",
        "city": "深圳市",
        "district": "南山区",
        "name": "一枚",
        "mobile": "18000000000"
    },
    "orderInvoices": [
        {
            "unitPrice": "5020",
            "ename": "pc",
            "quantity": "1",
            "cname": "电脑",
            "originCountry": "中国",
            "currencyCode": "RMB"
        }
    ],
    "kuaidiCom": "yuantongguoji",
    "width": "10",
    "comment": "",
    "cargo": "包裹",
    "height": "10",
    "callbackUrl": "http://123:9100/apiOrder/callback",
    "pollCallbackUrl": "http://123:9100/apiOrder/callback",
    "salt": "112233"
}

返回结果示例

{
    "result": true,
    "returnCode": 200,
    "message": "SUCCESS",
    "data": {
        "taskId": "69794C5DF8D04E51BA1F5620AD626842",
        "orderId": "1040",
        "kuaidiNum": "G011123",
        "distributeCode": null,
        "pollToken": "VuKzV8A8PSqc479ZLq58IiX/g7EaizZurZ42gvu4P2Q="
    }
}

三、回调接口

该接口用于国际件订单的状态变化。

3.1 接口格式

提供统一格式的HTTP POST,并返回统一格式JSON数据。

请求报头:Content-Type=application/x-www-form-urlencoded;charset=UTF-8

3.2 请求参数

参数名是否必填类型说明
taskId是string
sign是string32位大写签名,MD5 (param +salt)
param是param由其他字段拼接

param数据结构:

参数名是否必填字段类型说明
orderId否String订单ID
kuaidiCom否String快递公司编码
kuaidiNum否String快递单号
thirdId否String业务方订单ID
serviceType否String业务类型
status否Integer订单状态:0=下单成功 1=已接单 10=已取件 11=已到达国际转运仓 12=国际转运仓已发出 13=已清关 14=运输中 15=已完成 90=退回 99=订单取消
payStatus否Integer结算标识:1:结算消息 0 :非结算
cancleMsg否String用户取消原因
cancleMsg99否String系统取消原因
courierName否String快递员姓名
courierMobile否String快递员手机号
price否String运费
firstPrice否String首重价格
firstWeight否String首重重量
overPrice否String续重价格
overWeight否String续重重量
weight否String实际重量,单位 kg
volume否String体积,单位 cm³
volumeWeight否String体积重,单位 kg
length否String客户订单货物总长,精确到小数点后2位,默认单位 CM
width否String客户订单货物总宽,精确到小数点后2位,默认单位 CM
height否String客户订单货物总高,精确到小数点后2位,默认单位 CM
pollToken否String查询密钥,调用实时快递查询接口时入参此字段可免费查询该快递单号,一个快递单号对应一个密钥
feeDetails否List费用明细列表(嵌套对象)

FeeDetail(费用明细)

参数名是否必填字段类型说明
feeType否String费用类型编码(如:DELIVERY、INSURANCE)
feeDesc否String费用描述(如:基础运费、保价费)
amount否String费用金额

3.3 返回结果

字段类型说明备注
resultboolean提交结果true提交成功,false失败
returnCodestring返回编码
messagestring返回报文描述

3.4 请求参数示例

orderId=694509391680
sign=4BBDE07660E5EFF90873642CFAE9A8DD
param={
    "courierMobile": "13800138000",
    "courierName": "张三",
    "firstPrice": "63.60",
    "firstWeight": "0.50",
    "height": "10.00",
    "kuaidiCom": "yuantongguoji",
    "kuaidiNum": "G0310122",
    "length": "10.00",
    "orderId": "1039",
    "overPrice": "79.20",
    "overWeight": "1.50",
    "payStatus": 1,
    "pollToken": "uKdZVppmpxqFkUj4d7O1ibhl8ezHyMu4tA/miRvR5DI=",
    "price": "142.80",
    "serviceType": "国际标快",
    "status": 14,
    "thirdId": "80000000103438",
    "volume": "0.40",
    "volumeWeight": "0.40",
    "width": "20.00"
}

返回结果示例

{
    "result": true,
    "returnCode": 200,
    "message": "SUCCESS"
}

四、国际件订单取消接口

该接口用于取消国际件订单。

4.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

4.2 请求地址

https://api.kuaidi100.com/internatioanl/cancelOrder

请求参数:

参数名是否必填类型说明
key是string授权码,请申请企业版获取
sign是string32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上"+"号,secret在企业管理后台查看
t是string时间戳如:1576123932000
param是param由其他字段拼接

param数据结构:

参数名是否必填类型说明
orderId是string订单id
cancelMsg是string取消原因,长度不超过64

4.3 返回结果

字段类型说明备注
resultboolean提交结果true处理成功,false处理失败
returnCodestring返回编码
messagestring返回报文描述
dataobject 成功 返回 true
失败 返回 失败原因

4.4 请求参数示例

key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
    "orderId": "694509391663",
    "cancelMsg": "测试取消"
}

返回结果示例

{
    "result": true,
    "returnCode": 200,
    "message": "SUCCESS",
    "data": "取消成功"
}

五、国际件订单详情接口

该接口用于查询国际件订单详情。

5.1 接口格式

提供统一格式的HTTP POST调用接口,并返回统一格式JSON数据。

5.2 请求地址

https://api.kuaidi100.com/apisentquery/international/orderDetail

请求参数:

参数名是否必填类型说明
key是string授权码,请申请企业版获取
sign是string32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上"+"号,secret在企业管理后台查看
t是string时间戳如:1576123932000
param是param由其他字段拼接

param数据结构:

参数名是否必填类型说明
orderId是string订单id

5.3 返回结果

字段类型说明备注
resultboolean提交结果true处理成功,false处理失败
returnCodestring返回编码
messagestring返回报文描述
dataobject 数据结构如下

data数据结构

字段类型说明备注
orderIdLong系统内部订单ID
taskIdString任务ID,用于异步处理流程跟踪
kuaidiComString快递公司编码如:SF、EMS、FEDEX
kuaidiNumString快递单号由快递公司生成的运单号
thirdIdString业务方订单ID客户系统提交的唯一订单编号
serviceTypeString业务类型
preWeightString用户输入重量单位:kg,下单时填写的预估重量
lastWeightString结算重量单位:kg,实际计费重量(取实际重与体积重较大者)
senderNameString寄件人姓名(中文)
senderEnameString寄件人姓名(英文)国际运输必填
senderMobileString寄件人手机号用于联系取件
senderCountryString寄件人国家
senderProvinceString寄件人省份
senderCityString寄件人城市
senderDistrictString寄件人区/县
senderAddressString寄件人详细地址
senderCompanyString寄件人公司名称可选
senderPostCodeString寄件人邮政编码
senderAreaCodeString寄件人电话区号如:+86
senderEmailString寄件人邮箱用于通知
receiverNameString收件人姓名(中文)
receiverEnameString收件人姓名(英文)国际运输必填
receiverMobileString收件人手机号用于派送联系
receiverCountryString收件人国家
receiverProvinceString收件人省份
receiverCityString收件人城市
receiverDistrictString收件人区/县可选
receiverAddressString收件人详细地址
receiverCompanyString收件人公司名称可选
receiverPostCodeString收件人邮政编码
receiverAreaCodeString收件人电话区号如:+1
receiverEmailString收件人邮箱用于通知
cargoString物品名称如:包裹、文件
remarkString备注客户附加信息
volumeString体积单位:cm³
volumeWeightString体积重单位:kg,计算方式:长×宽×高 / 体积系数(如5000或6000)
lengthString货物总长单位:cm,精确到小数点后2位
widthString货物总宽单位:cm,精确到小数点后2位
heightString货物总高单位:cm,精确到小数点后2位
goodsDetailString商品信息申报明细,如 JSON 或逗号分隔字符串
insuredValueString保价金额若未保价则为空或0
statusInteger订单状态0=下单成功1=已接单10=已取件11=已到达国际转运仓12=国际转运仓已发出13=已清关14=运输中15=已完成90=退回99=订单取消
payStatusInteger结算标识1:结算消息;0 或 null:非结算
cancleMsgString用户取消原因由用户主动取消时填写
cancleMsg99String系统取消原因系统自动取消原因说明
courierNameString快递员姓名取件或派送人员姓名
courierMobileString快递员手机号用于联系快递员
priceString运费总运费金额
firstPriceString首重价格首段重量对应价格
firstWeightString首重重量首段计费重量,单位 kg
overPriceString续重价格超出首重后每单位重量价格
overWeightString续重重量超出首重部分的重量,单位 kg
createTimeDate创建时间订单创建时间,格式:yyyy-MM-dd HH:mm:ss
feeDetailsList费用明细列表包含各项费用的详细信息(见下表)

费用明细对象:FeeDetail

字段类型说明备注
feeTypeString费用类型如:DELIVERY(运费)、INSURANCE(保价费)、FUEL(燃油附加费)等
feeDescString费用描述人类可读的费用名称,如"基础运费"、"保价服务费"
amountString费用金额单位:元,保留两位小数

5.4 请求参数示例

key = ******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1647258957705
param = {
    "orderId": "694509391663"
}

返回结果示例

{
    "result": true,
    "returnCode": 200,
    "message": "SUCCESS",
    "data": {
        "orderId": 1041,
        "taskId": "803C274B9FBD40C5AE345402BC402367",
        "kuaidiCom": "yuantongguoji",
        "kuaidiNum": "G03100035948",
        "thirdId": "80000000103438",
        "serviceType": "国际标快",
        "preWeight": "1.0",
        "lastWeight": null,
        "senderName": "一枚",
        "senderEname": "一枚",
        "senderMobile": "18000000000",
        "senderCountry": "china",
        "senderProvince": "广东",
        "senderCity": "深圳市",
        "senderDistrict": "南山区",
        "senderAddress": "高新园金蝶大厦",
        "senderCompany": null,
        "senderPostCode": null,
        "senderAreaCode": null,
        "senderEmail": null,
        "receiverName": "ruoheng lyua",
        "receiverEname": "ruoheng lyua",
        "receiverMobile": "+61  0480 392 958",
        "receiverCountry": "Singapore",
        "receiverProvince": "New South Wales",
        "receiverCity": "New South Wales",
        "receiverDistrict": null,
        "receiverAddress": "sydney epping derby 2A",
        "receiverCompany": null,
        "receiverPostCode": "546080",
        "receiverAreaCode": null,
        "receiverEmail": null,
        "capacityId": 92,
        "capacityName": "圆通国际-官方-线上",
        "cargo": "包裹",
        "remark": null,
        "volume": null,
        "volumeWeight": null,
        "length": "50",
        "width": "10",
        "height": "10",
        "goodsDetail": "[{\"cname\":\"电脑\",\"currencyCode\":\"RMB\",\"ename\":\"pc\",\"originCountry\":\"中国\",\"quantity\":1,\"unitPrice\":\"5020\"}]",
        "insuredValue": null,
        "status": 99,
        "payStatus": 0,
        "cancleMsg": "测试取消",
        "cancleMsg99": null,
        "courierName": null,
        "courierMobile": null,
        "price": null,
        "firstPrice": null,
        "firstWeight": null,
        "overPrice": null,
        "overWeight": null,
        "createTime": "2025-08-18 15:27:44",
        "feeDetails": null
    }
}

状态码含义

信息代码信息内容描述原因及建议处理方式
200SUCCESS请求成功。无需额外处理,表示操作已正常完成。
400参数错误请求参数不符合校验规则(如格式错误、值越界等)。请检查请求中的参数是否完整、合法,并按 API 文档要求调整后重试。
500服务器错误服务端内部异常。
501重复取消同一订单被多次提交取消请求。请确保取消操作幂等性,避免重复提交。
503签名验证失败请求签名不匹配
600您不是合法的用户客户身份未识别,API Key 不存在或未注册。请确认使用的 appKey 是否正确,是否已完成接入申请。
601KEY已过期账号权限失效,可能因未续费、额度用尽或被禁用。请登录管理平台查看账户状态,及时充值或联系商务支持。
700错误的回调地址提供的 callbackUrl 不合法或不被允许
102缺少必填参数请求中缺失必需字段。请对照 API 文档检查请求体或查询参数,补全所有必填项后再提交。
103非法请求请求内容包含敏感词、恶意字符或触发风控规则。建议检查提交数据是否含有特殊符号、SQL 注入特征或违规内容,清理后重试。
104订单记录不存在查询或操作的订单在系统中无记录。
105操作失败业务操作未能执行成功。

订单状态码含义

状态描述
0下单成功
1已接单
10已取件
11已到达国际转运仓
12国际转运仓已发出
13已清关
14运输中
15已完成
90退回
99订单取消

国家编码对照表

国家country编码
中国香港Hong Kong,China
中国澳门Macau,China
中国台湾Taiwan,China
日本Japan
韩国South Korea
阿联酋United Arab Emirates
沙特阿拉伯Saudi Arabia
巴林Bahrain
塞浦路斯Cyprus
以色列Israel
伊拉克Iraq
约旦Jordan
科威特Kuwait
黎巴嫩Lebanon
阿曼Oman
卡塔尔Qatar
土耳其Turkey
印度India
马尔代夫Maldives
尼泊尔Nepal
巴基斯坦Pakistan
斯里兰卡Sri Lanka
新加坡Singapore
马来西亚Malaysia
印度尼西亚Indonesia
泰国Thailand
菲律宾Philippines
越南Viet Nam
柬埔寨Cambodia
老挝Lao
巴勒斯坦Palestine
不丹Bhutan
阿富汗Afghanistan
东帝汶East Timor
文莱Brunei Darussalam
哈萨克斯坦Kazakhstan
吉尔吉斯斯坦Kyrgyzstan
乌兹别克斯坦Uzbekistan
澳大利亚Australia
新西兰New Zealand
法国France
德国Germany
意大利Italy
荷兰Netherlands
英国United Kingdom
捷克Czech Repoublic
丹麦Denmark
芬兰Finland
波兰Poland
葡萄牙Portugal
西班牙Spain
瑞典Sweden
瑞士Switzerland
奥地利Austria
希腊Greece
匈牙利Hungary
爱尔兰Ireland
列支敦士登Liechtenstein
卢森堡Luxembourg
摩纳哥Monaco
圣马力诺San Marion
保加利亚Bulgaria
罗马尼亚Romania
美国United States
加拿大Canada
墨西哥Mexico
巴西Brazil
阿根廷Argentina
智利Chile
乌拉圭Uruguay
委内瑞拉Venezuela
秘鲁Peru
埃及Egypt
肯尼亚Kenya
南非South Africa
苏丹Sudan
尼日利亚Nigeria
摩洛哥Morocco
加纳Ghana
贝宁Benin
博茨瓦纳Botswana
布基纳法索Burkina Faso
埃塞俄比亚Ethiopia
加蓬Gabon
马里Mali
毛里求斯Mauritius
纳米比亚Namibia
卢旺达Rwanda
坦桑尼亚Tanzania
多哥Togo
突尼斯Tunisia
乌干达Uganda
赞比亚Zambia
津巴布韦Zimbabwe
塞拉利昂Sierra leone
索马里Somalia
安哥拉Angola
布隆迪Burundi
厄立特里亚Eritrea
科特迪瓦COTE D'LVOIRE(IVORY)
莱索托Lesotho
马达加斯加Madagascar
马拉维Malawi
斯威士兰Swaziland
几内亚Guinea
利比里亚Liberia
利比亚Libya
比利时Belgium
哥伦比亚Colombia