
| 接口环境 | 接口地址 |
|---|---|
| 正式环境 | https://apis.speedaf.com/ |
| 测试环境 | https://uat-api.speedaf.com/ |
假设相关参数
appCode:11111111
secretKey:uYMGr8eU
timestamp:1649823785567
注:appCode、secretKey 需要找速达非对接人获取
统一入参json格式
{ "data": { }, "sign": ""}| 参数名称 | 参数说明 | 是否必须 |
|---|---|---|
| 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字符串传入
xxxxxxxxxx{"data":"{\"countryCode\":\"CN\"}","sign":"00742abca6c98f4412f1c1bb42f8e802"}
接口地址:https://uat-api.speedaf.com/open-api/express/order/queryByCodes?appCode=你的appCode×tamp=当前时间戳
请求方式:POST
请求数据类型:application/text
接口描述:
请求参数示例:
xxxxxxxxxx{ "data":{ "codes":["123456"], "customerCode":"CN001", "type":"1" }, "sign":"65ae68b1325ab1597a4411d53ff8a9ac"}请求参数描述:
| 参数名称 | 参数说明 | 是否必须 | 数据类型 | 备注 |
|---|---|---|---|---|
| codes | 单号集合 | true | List | 单号限制20条以内 |
| customerCode | 客户编号 | true | string | 速达非提供 |
| type | 单号类型 | true | int | 1=运单号 |
响应状态:
响应参数示例:
xxxxxxxxxx{ "success": true, "error": null, "data": [{ "customOrderNo": "CUST123456", "billCode": "123456", "customerCode": "CN001", "parcelType": "PT01", "smallCode": "654321", "deliveryType": "DE01", "transportType": "TT01", "shipType": "ST01", "payMethod": "PA02", "isAllowOpen": 0, "acceptName": "Tom", "acceptCompanyName": "happy", "acceptPostCode": "", "acceptMobile": "123456789", "acceptPhone": "123456789", "acceptEmail": "1@gmail.com", "acceptAddress": "an hui sheng", "acceptCountryName": "Nigeria", "acceptCountryCode": "NG", "acceptCitizenId": "", "acceptProvinceName": "Rivers", "acceptProvinceCode": "", "acceptCityName": "Rivers", "acceptCityCode": "", "acceptDistrictName": "Rivers", "acceptDistrictCode": "", "acceptStreetName": "Rivers", "sendName": "Tim", "sendCompanyName": "great", "sendAddress": "Rivers", "sendPostCode": "", "sendMobile": "2345678", "sendPhone": "124657", "sendMail": "2@gmail.com", "sendCountryName": "Nigeria", "sendCountryCode": "NG", "sendProvinceName": "Rivers", "sendProvinceCode": "", "sendCityName": "Rivers", "sendCityCode": "", "sendDistrictName": "an hui sheng", "sendDistrictCode": "", "parcelLength": 100, "parcelWidth": 100, "parcelHigh": 100, "parcelVolume": 0.001, "parcelWeight": 1, "goodsQTY": 11, "shippingFee": 12.1, "codFee": 1, "currencyType": "NGN", "insurePrice": 10, "threeSectionsCode": "LOS-309", "taxMethod": "DDP", "pickupType": 1, "remark": "test", "itemList": [{ "sku": "test", "goodsName": "test", "goodsNameDialect": "好", "hscode": "1234", "goodsQTY": 11, "goodsValue": 1, "currencyType": "USD", "goodsWeight": 1, "goodsType": "IT01", "goodsLength": 10, "goodsWidth": 10, "goodsHigh": 10, "goodsVolume": 0.000001, "blInsure": 0 }] }]}响应参数描述:
| 参数名称 | 参数说明 | 类型 | 长度 | 备注 |
|---|---|---|---|---|
| customOrderNo | 客户单号 | string | 100 | |
| billCode | 速达非运单号 | string | 64 | |
| customerCode | 客户编号 | string | 32 | 速达非提供 |
| parcelType | 快递类型 | string | 50 | 见附件4 |
| smallCode | 国内转运单号 | string | 64 | |
| deliveryType | 派送方式 | string | 8 | 见附件5 |
| transportType | 运输方式 | string | 8 | 见附件3 |
| shipType | 订单发货类型 | string | 8 | 见附件6 |
| payMethod | 支付方式 | string | 8 | 见附件7 |
| isAllowOpen | 是否允许打开包裹 | int | 4 | 0=不允许收件人开包验货(默认) 1=允许收件人开包验货 |
| acceptName | 收件人姓名 | string | 100 | |
| acceptCompanyName | 收件人公司 | string | 100 | |
| acceptPostCode | 收件客户邮编 | string | 100 | |
| acceptMobile | 收件人手机号 | string | 50 | |
| acceptPhone | 收件人座机 | string | 50 | |
| acceptEmail | 收件人邮箱 | string | 100 | |
| acceptAddress | 收件人详细地址 | string | 500 | |
| acceptCountryName | 收件人国家 | string | 64 | |
| acceptCountryCode | 收件人国家二字码 | string | 8 | 见附件2 |
| acceptCitizenId | 收件人身份ID | string | 64 | |
| acceptProvinceName | 收件人省 | string | 256 | |
| acceptProvinceCode | 收件人省编码 | string | 64 | |
| acceptCityName | 收件人市 | string | 256 | |
| acceptCityCode | 收件人市编码 | string | 64 | |
| acceptDistrictName | 收件人区 | string | 256 | |
| acceptDistrictCode | 收件人区编码 | string | 64 | |
| sendName | 寄件人姓名 | string | 100 | |
| sendCompanyName | 寄件人公司 | string | 100 | |
| sendAddress | 寄件人地址 | string | 500 | |
| sendPostCode | 寄件客户邮编 | string | 100 | |
| sendMobile | 寄件人手机号 | string | 50 | |
| sendPhone | 寄件人座机 | string | 50 | |
| sendMail | 寄件人邮箱 | string | 100 | |
| sendCountryName | 寄件人国家 | string | 64 | |
| sendCountryCode | 寄件人国家二字码 | string | 8 | 见附件2 |
| sendProvinceName | 寄件人省份 | string | 256 | |
| sendProvinceCode | 寄件人省编码 | string | 64 | |
| sendCityName | 寄件人市 | string | 256 | |
| sendCityCode | 寄件人市编码 | string | 64 | |
| sendDistrictName | 寄件人区 | string | 256 | |
| sendDistrictCode | 寄件人区编码 | string | 64 | |
| parcelLength | 包裹长度 | Long | 10 | 单位mm |
| parcelWidth | 包裹宽度 | Long | 10 | 单位mm |
| parcelHigh | 包裹高度 | Long | 10 | 单位mm |
| parcelVolume | 包裹体积 | decimal | 10,2 | 单位m² |
| parcelWeight | 包裹重量 | decimal | 10,3 | 单位KG,整个包裹重量,用于入库差异对比称重 |
| piece | 包裹件数 | Long | 10 | 默认:1 |
| goodsQTY | 商品总数 | Long | 10 | itemList中的goodsQTY合计 |
| shippingFee | 运费 | decimal | 15,2 | |
| codFee | 代收货款 | decimal | 15,2 | |
| currencyType | 货币类型 | string | 32 | 代收货款币种,仅支持收件国本地币,各国币种类型取国际币种三字码(大写) |
| insurePrice | 保价金额 | decimal | 15,2 | |
| threeSectionsCode | 三段码 | string | 50 | |
| taxMethod | 税费方式 | string | 8 | |
| pickupType | 揽收类型 | int | 8 | 0=否(默认) 1=预约揽件 2=客户自送 |
| remark | 备注 | string | 255 | |
| itemList | 商品列表 | List |
其中itemList参数描述:
| 参数 | 参数说明 | 类型 | 长度 | 备注 |
|---|---|---|---|---|
| sku | sku | string | 64 | |
| goodsName | 商品名称 | string | 300 | 英文(国际业务必传) |
| goodsNameDialect | 商品名称(本地语言) | string | 300 | 中文(国际业务必传) |
| hscode | 海关商品编码 | string | 50 | |
| goodsQTY | 商品数量 | Long | 10 | |
| goodsValue | 货值/申报价值 | decimal | 15,2 | |
| currencyType | 货币类型 | string | 10 | 传USD,用于关务,仅支持美金,摩洛哥支持MAD |
| goodsWeight | 商品重量 | decimal | 15,4 | 单位KG |
| goodsType | 商品类型 | string | 32 | 见附件1,如:“IT01” |
| goodsLength | 商品长度 | Long | 10 | 单位mm |
| goodsWidth | 商品宽度 | Long | 10 | 单位mm |
| goodsHigh | 商品高度 | Long | 10 | 单位mm |
| goodsVolume | 商品体积 | decimal | 10,3 | 单位㎡ |
| blInsure | 是否保价 | Long | 2 | 0=否1=是(默认 0,无保价业务) |
注:和金额有关的参数 单位均默认收件国家的本地货币
失败响应参数示例:
xxxxxxxxxx{ "success": false, "error": { "code": "500", "message": "" }, "data": null}1,goodsType:
| Code | 描述 |
|---|---|
| IT01 | 普通物品 |
| IT02 | 文件 |
| IT03 | 贵重物品 |
| IT04 | 带电物品 |
| IT05 | 不带电物品 |
| IT06 | 纯电 |
| IT07 | 敏感物品 |
2,countryCode:
| Code | 描述 |
|---|---|
| CN | China |
| GH | Ghana |
| UG | Uganda |
| KE | Kenya |
| NG | Nigeria |
| MA | Morocco |
| EG | Egypt |
| BD | Bangladesh |
| PK | Pakistan |
| SA | Saudi Arabia |
| AE | Arab Emirates |
| TR | Turkey |
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 | 月结 |