运单查询接口

 

接口环境接口地址
正式环境https://apis.speedaf.com/
测试环境https://uat-api.speedaf.com/

假设相关参数

appCode:11111111

secretKey:uYMGr8eU

timestamp:1649823785567

注:appCode、secretKey 需要找速达非对接人获取

统一入参json格式

参数名称参数说明是否必须
data业务参数json格式true
sign签名true

sign:签名

签名使用MD5方式对业务data的内容进行签名,原理:md5 (timestamp+secretKey+data)

详细解释如下:

假设json格式请求参数:{"mailNoList":["47234208672823"]},secretKey:uYMGr8eU,timestamp:1649823785567,

经过md5加密,得出sign为9a032a6baf9a6884b695382eb1d1e79f

Body:设置Body 为row属性,选择Text,将data和sign转成json字符串传入

 

1. 根据单号查询运单信息(限制20票)

接口地址:https://uat-api.speedaf.com/open-api/express/order/queryByCodes?appCode=你的appCode&timestamp=当前时间戳

请求方式:POST

请求数据类型:application/text

接口描述:

请求参数示例:

请求参数描述:

参数名称参数说明是否必须数据类型备注
codes单号集合trueList单号限制20条以内
customerCode客户编号truestring速达非提供
type单号类型trueint1=运单号

响应状态:

响应参数示例:

响应参数描述:

参数名称参数说明类型长度备注
customOrderNo客户单号string100 
billCode速达非运单号string64 
customerCode客户编号string32速达非提供
parcelType快递类型string50见附件4
smallCode国内转运单号string64 
deliveryType派送方式string8见附件5
transportType运输方式string8见附件3
shipType订单发货类型string8见附件6
payMethod支付方式string8见附件7
isAllowOpen是否允许打开包裹int40=不允许收件人开包验货(默认)
1=允许收件人开包验货
acceptName收件人姓名string100 
acceptCompanyName收件人公司string100 
acceptPostCode收件客户邮编string100 
acceptMobile收件人手机号string50 
acceptPhone收件人座机string50 
acceptEmail收件人邮箱string100 
acceptAddress收件人详细地址string500 
acceptCountryName收件人国家string64 
acceptCountryCode收件人国家二字码string8见附件2
acceptCitizenId收件人身份IDstring64 
acceptProvinceName收件人省string256 
acceptProvinceCode收件人省编码string64 
acceptCityName收件人市string256 
acceptCityCode收件人市编码string64 
acceptDistrictName收件人区string256 
acceptDistrictCode收件人区编码string64 
sendName寄件人姓名string100 
sendCompanyName寄件人公司string100 
sendAddress寄件人地址string500 
sendPostCode寄件客户邮编string100 
sendMobile寄件人手机号string50 
sendPhone寄件人座机string50 
sendMail寄件人邮箱string100 
sendCountryName寄件人国家string64 
sendCountryCode寄件人国家二字码string8见附件2
sendProvinceName寄件人省份string256 
sendProvinceCode寄件人省编码string64 
sendCityName寄件人市string256 
sendCityCode寄件人市编码string64 
sendDistrictName寄件人区string256 
sendDistrictCode寄件人区编码string64 
parcelLength包裹长度Long10单位mm
parcelWidth包裹宽度Long10单位mm
parcelHigh包裹高度Long10单位mm
parcelVolume包裹体积decimal10,2单位m²
parcelWeight包裹重量decimal10,3单位KG,整个包裹重量,用于入库差异对比称重
piece包裹件数Long10默认:1
goodsQTY商品总数Long10itemList中的goodsQTY合计
shippingFee运费decimal15,2 
codFee代收货款decimal15,2 
currencyType货币类型string32代收货款币种,仅支持收件国本地币,各国币种类型取国际币种三字码(大写)
insurePrice保价金额decimal15,2 
threeSectionsCode三段码string50 
taxMethod税费方式string8 
pickupType揽收类型int80=否(默认)
1=预约揽件
2=客户自送
remark备注string255 
itemList商品列表List  

其中itemList参数描述:

参数参数说明类型长度备注
skuskustring64 
goodsName商品名称string300英文(国际业务必传)
goodsNameDialect商品名称(本地语言)string300中文(国际业务必传)
hscode海关商品编码string50 
goodsQTY商品数量Long10 
goodsValue货值/申报价值decimal15,2 
currencyType货币类型string10传USD,用于关务,仅支持美金,摩洛哥支持MAD
goodsWeight商品重量decimal15,4单位KG
goodsType商品类型string32见附件1,如:“IT01”
goodsLength商品长度Long10单位mm
goodsWidth商品宽度Long10单位mm
goodsHigh商品高度Long10单位mm
goodsVolume商品体积decimal10,3单位㎡
blInsure是否保价Long20=否1=是(默认 0,无保价业务)

注:和金额有关的参数 单位均默认收件国家的本地货币

失败响应参数示例:

2.附件

1,goodsType:

Code描述
IT01普通物品
IT02文件
IT03贵重物品
IT04带电物品
IT05不带电物品
IT06纯电
IT07敏感物品

2,countryCode:

Code描述
CNChina
GHGhana
UGUganda
KEKenya
NGNigeria
MAMorocco
EGEgypt
BDBangladesh
PKPakistan
SASaudi Arabia
AEArab Emirates
TRTurkey

3,transportType:

Code描述
TT01汽运
TT02空运
TT03海运
TT04空海联运

4,parcelType:

Code描述
PT01快递
PT02快运

5,deliveryType:

Code描述
DE01送货上门
DE02自提

6,shipType:

Code描述
ST01本地快递
ST02电商小包
ST03海外仓仓发小包
ST04国际快递
ST05海外仓头程

7,payMethod:

Code描述
PA01现金
PA02月结