开放接口
介绍
世通开放接口的目标是通过提供支持多类业务场景的标准化API,供客户或者第三方软件供应商与世通跨境进行系统对接,从而打通与STTERP、丁仓OMS、DingExpress等系统之间的信息流,形成整体订单、物流、商品、客服、仓库、销售、供应链等全流程管理服务,物流供应链的一体化解决方案,进一步提升客户系统作业效率以及用户体验,实现双赢。
丁仓物流API
丁仓OMS支持的物流商
支持云途、燕文、第四方、三态、义达、17feia、佳成、飞特、UBI
易仓系统物流商
华翰物流、海德嘉、文慧国际、三通物流、安迪物流、快宜邮国际物流、京华达、海拓通、广和物流、鼎晟源、、艾姆勒直邮、柒歌物流、 纬狮、 格兰思迪、亦邦物流、至信达
速递管家系统物流商
全程动力、浩远快递、俄顺和先行者、汇天国际物流、上海义达、义乌思捷货代、乐天速递、伟成物流、顺途国际、德仕国际、EAS跨境物流、QSGJ、邮行天下、瑞安祥和-新、宝来国际、妥投物流、通达全球、发去哪、快驿通、圆通国际、黑猫快运、疯狂小袋、领兵斯通、纵横迅通、宁波合羽国际、一沅国际、义乌友键、捷谱斯、CSE、航投物流、广邮跨境、安徽邮政、沐瑟供应链
K5系统物流商
凯丰、6LS(绿色速递)、义乌腾海货运、深圳泰嘉物流、易世通达、蔷薇国际、琳龙、EPX易方易达、STL中贸英联、速迪利、丰诚达、杭州双翔国际、速邮达、全速通、瑞安祥和、恒捷宇通、沈诺国际-俄运专家、苏州保利通、深圳政豪 、湖南迪比翼国际、百宝航、深圳飞翔达、北北国际、汇翔。广州昌晖、 北俄物流、丰邦、华昇国际、中跃国际、17Post、优顺速递、恒丰、玖铭通国际、嘉迈国际、八方速递、志腾物流、 网商易、安喆AZE、乐翔国际、大周物流、金元跨境、 卢云外贸、易方达、杭州泽邦国际、捷球通、泛美国际、忠恕物流、柠檬树、广州国鹏、华运通、左浩辰、志腾、广东兴远、合溢、顺安隆、亿方电池国际、佰事达、千易物流、佳宏、海翼、欣运优供应链、MYEX闽亚快递、光速(新)、齐璟国际、德华盛、华源达、大地、途士普、跨易达、康瑶国际(英诺国际)、华路、源鹏、恒丰国际、畅飞速递、荣凯国际、 中鸿运通、欧亚兴、汇增、中识国际、艾达速递、今日国际、湘麓达、 汉诺达、广州新道、 华风供应链 。
华磊系统物流商
威速易、EQUICK、安德物流、怀海环球、彧腾国际、金龙天运、永合国际、前雨国际、达毅快递、飞达国际、博速通达、畅湘国际、亚翔国际、柏迅国际、易德国际、福州翔达国际、捷邮国际、高翔物流、国一秒、深圳淼信、埃森国际、创宇国际、星前国际、淼信国际、万邮通国际、联合运通、五和通、湘洲物流、辉晓国际、E+供应链、汉万物流、丝绸网路、中鹏、1DLEXPRESS、恒通速运、铭志国际、时丰国际、南阳启帆国际、凡士达、世纪宏利、快越达、远大物流、七大州、港森国际、运亨、华旗物流、睿振行、恒迅国际、优兰达、启航华硕Express、嘉腾国际、E裕云仓、广州腾顺、优美宇通、平达国际、天汇物流、快易速达、广州天正物流、福鑫、邮毅达、鑫亚国际、深圳天蓝、美亚运通、众齐现代物流、广州天驰、河南西航、飞洋跨境物流、羿德国际货运、乔盛货运代理、运川物流、追丰国际、跨境易、广州天驰、华运亚通、广州易起飞国际物流、雄飞国际新版、JSH嘉盛泓、延锦国际、eTotal、和胜通、义乌市申卯货运代理有限公司、广州天蓝、杭州金麦、妥瞬国际、上海昭临、达达牛、轻风速递、美捷、青赢时代、丰运全球、梓健、河南安瑞奇、晨鸿国际货代、深圳恒捷宇通、东莞金远国际、义乌纵诚、洲道国际、朝昔国际、世海国际、优逊国际、邮驿速、杭州飞约、风帆国际、诺誉、上海盛通、阿世达、万邦物流、广州优速派、义乌申利、上尚供应链、云比特、兴亿国际、义乌卿氏、铠盟国际、快美物流、安途国际、环世货运、广州锦速、天子速递、宏志达、佳邮供应链、亿仓、云邮、臻速、朗腾国际俄罗斯专线、超光速、四季慧宇、浙熊、品速、佰年奕然(新)、八方安运、青石国际(新)、跨时速、天府盛物流、优邮国际、亦邦国际、速刻蜂、恒源国际、斯德克、斯格国际、途帆、嘉洋国际、祥辉、伍点国际、易翔国际、雅顺达物流、凯晟、安易捷、雷翼、伏尔加货运、朋博、昊博、通达、义务俄速、恒易通国际、吉旋国际、环贸仓配、迎运国际物流、易智国际、云速、泉州众驰、广州华亚运通、世宽国际、海丰县佳运达、外代国际、广州华航吉运、电流国际、深圳超时代、富天亿、上海驹隙国际、立德国际物流(广州立德)、志运物流、俄易稳、 华熙、威捷、上海肃河、鑫天运、新联、 华海成国际、尧顺国际、广州优进货运、广州世航、鑫昇供应链、拾诚国际、联航、顺云峰、广和跨境物流(新系统)、上海洪冠、优联达、鑫佳达、伟长鸿、旺通国际、广州光速、广州百思特、 万通物流、跨鲸国际、加禾物流、瑞羽国际、江铃实顺、雄九、景强国际、伍陆捌国际、和星耀、宏海供应链、玖鼎通、青鸟、光驰、斯流、龙辕、 上海锦鸽、寰世达、 佳易启、全酋通、 常昇国际、青云物流、阿玛货运、飞牛国际、 广州色咖 、 黄马褂供应链 、迅安达国际 、 鑫昊国际 、 能通国际 、 夏浦世纪 、 东冠国际物流 、 Cheer Express 、 广州安速、 畅发国际、 世运供应链
丁仓OMS对接优势
拥有一个丁仓接口即可对接“百家”货代公司。
ERP商家:维护一个丁仓接口即可维护多个货代接口,加速erp的开发。
丁仓OMS对接费用
功能 | 单量 | 扩展 | 费用 | 优惠 |
---|---|---|---|---|
丁仓带打包发货、丁仓物流商API对接 | 10000/月 | 单月每增加10000单加收100元;单月最高收费2000元(含680元基础费) | 600/月 | 6000/年 |
丁仓优选-API
获取Key和Secret
1、先注册并登陆系统
2、系统右上角点击“我的资料”
3、在API位置点击按钮 生成AppKey 和 AppSecret
4、通过左边菜单“系统设置”-“渠道价格”页面获取每个渠道的渠道ID
单条创建订单
Host:http://best.dingcang.vip/api/interface.api.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
参数名 | 参数名 | 参数类型 | 是否必填 | 参数说明 |
---|---|---|---|---|
AppKey | string | TRUE | Appkey(系统获取) | |
AppSecret | String | TRUE | AppSecret(系统获取) | |
Channel_id | Int | TRUE | 运输渠道ID(系统获取) | |
ptid | Int | FALSE | 平台代码,传此参数请与我们沟通 | |
orders | ||||
/ | cargo_type | Int | TRUE | 固定值:2 |
/ | OrderID | String | TRUE | 客户订单号 |
/ | ydh1 | String | FALSE | 特殊用途,一般不使用,如需要使用请与技术人员确认 |
/ | ydh2 | String | FALSE | 特殊用途,一般不使用,如需要使用请与技术人员确认 |
/ | Fname | string | TRUE | 发件人姓名 |
/ | Fcompany | string | FALSE | 发件人公司,如不传默认使用发件人姓名 |
/ | Ftel | string | TRUE | 发件人电话 |
/ | Fadd1 | String | TRUE | 发件地址一 |
/ | Fstate | String | TRUE | 发件省/州 |
/ | Fcity | String | TRUE | 发件城市 |
/ | Fpostcode | String | TRUE | 发件邮编 |
/ | Fcountry | String | TRUE | 发件国家 |
/ | Otheraddid | Int | FALSE | 用于特殊渠道需要使用接口地址ID的 |
/ | Sname | String | TRUE | 收件人姓名 |
/ | Scompany | String | TRUE | 收件人公司 |
/ | Sadd1 | String | TRUE | 收件人地址 |
/ | Sadd2 | String | TRUE | 收件人地址 |
/ | Scity | String | TRUE | 收件人城市 |
/ | Sstate | String | TRUE | 收件人省/州 |
/ | Spostcode | String | TRUE | 收件人邮编 |
/ | Stel | String | TRUE | 收件人电话 |
/ | Scountry | String | TRUE | 收件人国家 |
/ | ckid | Int | FALSE | 仓库ID,用于仓库库存发货,系统内获取 |
/ | Parcel_num | Int | TRUE | 包裹数量 |
/ | 总重量(kg)如一票多箱的情况下,这里是所有箱子加起来的总重量 | |||
/ | Note | String | FALSE | 订单备注,显示在label上面 |
parcels | 用于非库存发货 | |||
/ | box | String | TRUE | 箱子编号 |
/ | weight | Float | TRUE | 包裹重量(kg)特别注意:此重量为包裹重量,而非产品重量 |
/ | length | Int | TRUE | 长(cm) |
/ | width | Int | TRUE | 宽(cm) |
/ | height | Int | TRUE | 高(cm) |
/ | sku | String | FALSE | sku |
/ | cnname | String | FALSE | 中文名称 |
/ | enname | String | FALSE | 英文名称 |
/ | price | Float | FALSE | 申报单价 |
/ | num | Int | FALSE | 申报数量 |
/ | material | String | FALSE | 材质 |
/ | use | String | FALSE | 用途 |
/ | cweight | Float | FALSE | 产品单重 |
/ | hscode | String | FALSE | 海关编码 |
/ | battery | String | FALSE | 电池描述 |
請求JSON示例:
{
"AppKey": "xxxxxxx",
"AppSecret": "xxxxxxxxxx",
"Channel_id": "000",
"ptid": 0, (传此参数请与我们沟通)
"orders": [
{
"cargo_type": 2,
"OrderID": "a2020020915",
"Fname": "kimi",
"Ftel": "1234567890",
"Fadd1": "2777 Alton Parkway apt 347",
"Fstate": "CA",
"Fcity": "irvine",
"Fpostcode": "92606",
"Fcountry": "US",
"Sname": "Pam Pierce",
"Scompany": "",
"Sadd1": "27 silver tail rd",
"Scity": "Berwick",
"Sstate": "ME",
"Spostcode": "03901",
"Stel": "9787933920",
"Scountry": "US",
"ckid": "1",
"Parcel_num": 1,
"Weight": 0.25,
"Note": " label reference",
"parcels": [
{
"box": "box1",
"boxnote": "label reference",
"weight": "0.25",
"length": "10",
"width": "5",
"height": "2",
"sku": "1",
"cnname": "asdfasdf",
"enname": "clothes",
"price": "1",
"num": "1",
"material": "1asdfsf",
"use": "1sdf",
"cweight": "0.25",
"hscode": "sadfsadf1",
"battery": "1"
}
]
}
]
}
成功返回:
{
"result": [
{
"code": 200
}
]
}
失敗返回:
{
"result": [
{
"code": 400,
"orderid": "訂單編號",
"msg": “錯誤信息"
}
]
}
批量创建订单(不推荐)
Host:http://best.dingcang.vip/api/multicreateorder.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
参数说明见<单条创建订单>:
請求JSON示例:
{
"AppKey": "xxxxxxx",
"AppSecret": "xxxxxxxxxx",
"Channel_id": "000",
"ptid": 0,(传此参数请与我们沟通)
"orders": [
{
"cargo_type": 2,
"OrderID": "a2020020915",
"Fname": "kimi",
"Ftel": "1234567890",
"Fadd1": "2777 Alton Parkway apt 347",
"Fstate": "CA",
"Fcity": "irvine",
"Fpostcode": "92606",
"Fcountry": "US",
"Fphone":"值", //可不填
"Femail":"值", //可不填
"Sname": "Pam Pierce",
"Scompany": "",
"Sadd1": "27 silver tail rd",
"Scity": "Berwick",
"Sstate": "ME",
"Spostcode": "03901",
"Stel": "9787933920",
"Scountry": "US",
"ckid": "1",
"Parcel_num": 1,
"Weight": 0.25,
"Note": "reference for single box",
"parcels": [
{
"box": "box1",
"boxnote":"reference for multi box"
"weight": "0.25",
"length": "10",
"width": "5",
"height": "2",
"sku": "1",
"cnname": "asdfasdf",
"enname": "clothes",
"price": "1",
"num": "1",
"material": "1asdfsf",
"use": "1sdf",
"cweight": "0.25",
"hscode": "sadfsadf1",
"battery": "1"
}
]
},
{
"cargo_type": 2,
"OrderID": "a20200209156",
"Fname": "kimi",
"Ftel": "1234567890",
"Fadd1": "2777 Alton Parkway apt 347",
"Fstate": "CA",
"Fcity": "irvine",
"Fpostcode": "92606",
"Fcountry": "US",
"Sname": "Pam Pierce",
"Scompany": "",
"Sadd1": "27 silver tail rd",
"Scity": "Berwick",
"Sstate": "ME",
"Spostcode": "03901",
"Stel": "9787933920",
"Scountry": "US",
"ckid": "1",
"Parcel_num": 1,
"Weight": 0.25,
"Note": "reference for single box",
"parcels": [
{
"box": "box1",
"boxnote":"reference for multi box"
"weight": "0.25",
"length": "10",
"width": "5",
"height": "2",
"sku": "1",
"cnname": "asdfasdf",
"enname": "clothes",
"price": "1",
"num": "1",
"material": "1asdfsf",
"use": "1sdf",
"cweight": "0.25",
"hscode": "sadfsadf1",
"battery": "1"
}
]
}
]
}
返回示例:
[
{
"code": 400,
"orderid": "a20208591513",
"msg": "订单号已存在"
},
{
"code": 400,
"orderid": "a202085915168",
"msg": "接口返回:Ship web service is currently unavailable."
},
{
"code": 200,
"orderid": "a202085915169"
},
{
"code": 200,
"orderid": "a202085915160"
},
{
"code": 200,
"orderid": "a202085915161"
}
]
3.1单条创建多内容返回参考:
{
"result": [
{
"code": 200,
"orderid": "MS801662004417319_100",
"nborderid": "898b4b6e436962e81d140e9c",
"source": {
"tracking": "跟踪号",
"waybill": "运单号",
"png_url": "png图片地址",
"pdf_url": "pdf地址",
"base64_type": "base64格式",
"base64": "base64代码"
}
}
]
}
批量获取LABEL及跟踪号
Host:http://best.dingcang.vip/api/multifetchlabels.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求JSON示例:
{
"AppKey":"xxx",
"AppSecret":"xxx",
"orderids":
[
"a007",
"a006"
]
}
返回JSON示例:
[
{
"code": 200,
"orderid": "a007",
"label_url": "http://440.pdf",
"trackingno": "1Z9XV6160327140440",
"post_fee": "39.66",
"gh_fee": "0.00",
"cl_fee": "0.00",
"other_fee": "0.00",
"ranyou_fee": "0.00",
"trackingnolist": [
{
"boxno": "asdfafd1",
"trackingno": "1Z9XV6160327140440",
"pdf": "",
"label_png": "http://40440.png"
},
{
"boxno": "asdfafd2",
"trackingno": "1Z9XV6160334558852",
"pdf": "",
"label_png": "http://4558852.png"
}
]
},
{
"code": 400,
"orderid": "a006",
"msg": "订单不存在或无权限"
}
]
获取LABEL及跟踪号
Host:http://best.dingcang.vip/api/fetchlabel.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求JSON示例:
{
"AppKey": "xxxxx",
"AppSecret": "xxxxx",
"Orderid": "xxxxxx"
}
成功返回JSON示例:
{
"result": [
{
"code": 200,
"orderid": "GG19",
"msg": {
"result": {
"label_url": "http://..xxx.pdf",
"trackingno": "xxx",
"post_fee": "0.00", //邮费
"gh_fee": "0.00", //挂号费
"cl_fee": "0.00", //处理费
"other_fee": "0.00", //其他费
"ranyou_fee": "0.00" //燃油费
}
}
}
]
}
失败返回JSON示例:
{
"result": [
{
"code": 400,
"orderid": "xxx",
"msg": "Error message"
}
]
}
撤消订单
Host:http://best.dingcang.vip/api/cancel.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求JSON示例:
{
"AppKey": "xxx",
"AppSecret": "xxx",
"Orderid": "xxx"
}
返回成功示例:
{
"result": [
{
"code": 200,
"orderid": "xxx",
"msg": "撤消成功!"
}
]
}
{
"result": [
{
"code": 300,
"orderid": "xxx",
"msg": "已申请撤消!"
}
]
}
返回失败示例:
{
"result": [
{
"code": 400,
"orderid": "a202002222",
"msg": "撤消失败!"
}
]
}
获取转运标签
Host:http://best.dingcang.vip/api/transferlabel.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求JSON示例:
{
"AppKey": "xxx",
"AppSecret": "xxx",
"Orderid": "xxx"
}
返回成功示例:
{
"result": [
{
"code": 200,
"orderid": "xxx",
"msg": "转运标签url"
}
]
}
返回失败示例:
{
"result": [
{
"code": 400,
"orderid": "xxx",
"msg": "失败原因"
}
]
}
获取价格
Host:http://best.dingcang.vip/api/getprice.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
請求JSON示例:
{
"AppKey": "xxxxxxx",
"AppSecret": "xxxxxxxxxx",
"Channel_id": "000",
"ptid": 0, //传此参数请与我们沟通
"orders": [
{
"cargo_type": 2,
"OrderID": "a2020020915",
"Fname": "kimi",
"Ftel": "1234567890",
"Fadd1": "2777 Alton Parkway apt 347",
"Fstate": "CA",
"Fcity": "irvine",
"Fpostcode": "92606",
"Fcountry": "US",
"Sname": "Pam Pierce",
"Scompany": "",
"Sadd1": "27 silver tail rd",
"Scity": "Berwick",
"Sstate": "ME",
"Spostcode": "03901",
"Stel": "9787933920",
"Scountry": "US",
"ckid": "1",
"Parcel_num": 1,
"Weight": 0.25,
"Note": " label reference",
"parcels": [
{
"box": "box1",
"boxnote":"label reference",
"weight": "0.25",
"length": "10",
"width": "5",
"height": "2",
"sku": "1",
"cnname": "asdfasdf",
"enname": "clothes",
"price": "1",
"num": "1",
"material": "1asdfsf",
"use": "1sdf",
"cweight": "0.25",
"hscode": "sadfsadf1",
"battery": "1"
}
]
}
]
}
成功返回:
{
"result": [
{
"code": 200,
"orderid": "xxx",
"post_fee": 5.2, //邮费
"gh_fee": 0, //挂号费
"cl_fee": 0, //处理费
"other_fee": 0, //其他费用
"ranyou_fee": 0 //燃油费
}
]
}
获取运输渠道
Host:http://best.dingcang.vip/api/channel.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
{
"AppKey":"20011",
"AppSecret":"xxx"
}
返回示例:
[
{
"channelid": "386",
"channelname": "FEDEX_GROUND"
},
{
"channelid": "405",
"channelname": "测试渠道"
}
]
获取帐户信息
Host:http://best.dingcang.vip/api/getaccoutinfo.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
{
"AppKey":"20011",
"AppSecret":"xxx"
}
返回示例:
{
"code": 200, //200表示成功
"uid": "11", // 用户ID
"yue": "6369.22" //余额
}
获取跟踪信息
Host:http://best.dingcang.vip/api/tracking.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
{
"AppKey": "21033",
"AppSecret": "xxx",
"Trackingno": "xxx"
}
返回示例:
{
"code": 200,
"result": [
{
"Time": "2020-08-21 04:54:46",
"EventDescription": "The goods have been packed and sent from Yiwu to Russia"
},
{
"Time": "2020-08-20 21:54:46",
"EventDescription": "The goods have arrived at the warehouse in Yiwu, and the warehouse has been scanned for collection"
},
{
"Time": "2020-08-20 17:54:46",
"EventDescription": "Order created successfully"
}
]
}
生成SCANFORM
注意:仅部分渠道支持
Host:http://best.dingcang.vip/api/scanform.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请示示例:
{
"AppKey": "20011",
"AppSecret": "xx",
"Qdid": 422, //渠道ID
"AddressID": 93, //发货地址ID,在系统左侧,我的地址可以查看
"TrackingNos": [
"9405500897846053129766",
"9405500897846053129810"
]
}
成功返回:
{
"code": "200",
"sfurl": "https://www.**.com/372b3abfe56c49d0a00bf80070707d12.pdf"
}
失败返回:
{
"code": "400",
"msg": "reason"
}
查看订单撤消状态
Host:http://best.dingcang.vip/api/cancelstatus.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
{
"AppKey": "20011",
"AppSecret": "xxx",
"Orderid": "xxx"
}
成功示例:
{
"code": 200,
"result": "3"
}
状态说明 :0 未申请退款 1 退款中 2 退款完成 3 不能退款
失败示例:
{
"code": 400,
"result": "记录不存在!"
}
小丁物流-API
获取Key和Secret
1、先注册并登陆系统
2、系统右上角点击“我的资料”
3、在API位置点击按钮 生成AppKey 和 AppSecret
4、通过左边菜单“系统设置”-“渠道价格”页面获取每个渠道的渠道ID
单条创建订单
Host:http://oms.dingexpress.cn/api/interface.api.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
参数名 | 参数名 | 参数类型 | 是否必填 | 参数说明 |
---|---|---|---|---|
AppKey | string | TRUE | Appkey(系统获取) | |
AppSecret | String | TRUE | AppSecret(系统获取) | |
Channel_id | Int | TRUE | 运输渠道ID(系统获取) | |
ptid | Int | FALSE | 平台代码,传此参数请与我们沟通 | |
orders | ||||
/ | cargo_type | Int | TRUE | 固定值:2 |
/ | OrderID | String | TRUE | 客户订单号 |
/ | ydh1 | String | FALSE | 特殊用途,一般不使用,如需要使用请与技术人员确认 |
/ | ydh2 | String | FALSE | 特殊用途,一般不使用,如需要使用请与技术人员确认 |
/ | Fname | string | TRUE | 发件人姓名 |
/ | Fcompany | string | FALSE | 发件人公司,如不传默认使用发件人姓名 |
/ | Ftel | string | TRUE | 发件人电话 |
/ | Fadd1 | String | TRUE | 发件地址一 |
/ | Fstate | String | TRUE | 发件省/州 |
/ | Fcity | String | TRUE | 发件城市 |
/ | Fpostcode | String | TRUE | 发件邮编 |
/ | Fcountry | String | TRUE | 发件国家 |
/ | Otheraddid | Int | FALSE | 用于特殊渠道需要使用接口地址ID的 |
/ | Sname | String | TRUE | 收件人姓名 |
/ | Scompany | String | TRUE | 收件人公司 |
/ | Sadd1 | String | TRUE | 收件人地址 |
/ | Sadd2 | String | TRUE | 收件人地址 |
/ | Scity | String | TRUE | 收件人城市 |
/ | Sstate | String | TRUE | 收件人省/州 |
/ | Spostcode | String | TRUE | 收件人邮编 |
/ | Stel | String | TRUE | 收件人电话 |
/ | Scountry | String | TRUE | 收件人国家 |
/ | ckid | Int | FALSE | 仓库ID,用于仓库库存发货,系统内获取 |
/ | Parcel_num | Int | TRUE | 包裹数量 |
/ | 总重量(kg)如一票多箱的情况下,这里是所有箱子加起来的总重量 | |||
/ | Note | String | FALSE | 订单备注,显示在label上面 |
parcels | 用于非库存发货 | |||
/ | box | String | TRUE | 箱子编号 |
/ | weight | Float | TRUE | 包裹重量(kg)特别注意:此重量为包裹重量,而非产品重量 |
/ | length | Int | TRUE | 长(cm) |
/ | width | Int | TRUE | 宽(cm) |
/ | height | Int | TRUE | 高(cm) |
/ | sku | String | FALSE | sku |
/ | cnname | String | FALSE | 中文名称 |
/ | enname | String | FALSE | 英文名称 |
/ | price | Float | FALSE | 申报单价 |
/ | num | Int | FALSE | 申报数量 |
/ | material | String | FALSE | 材质 |
/ | use | String | FALSE | 用途 |
/ | cweight | Float | FALSE | 产品单重 |
/ | hscode | String | FALSE | 海关编码 |
/ | battery | String | FALSE | 电池描述 |
請求JSON示例:
{
"AppKey": "xxxxxxx",
"AppSecret": "xxxxxxxxxx",
"Channel_id": "000",
"ptid": 0, (传此参数请与我们沟通)
"orders": [
{
"cargo_type": 2,
"OrderID": "a2020020915",
"Fname": "kimi",
"Ftel": "1234567890",
"Fadd1": "2777 Alton Parkway apt 347",
"Fstate": "CA",
"Fcity": "irvine",
"Fpostcode": "92606",
"Fcountry": "US",
"Sname": "Pam Pierce",
"Scompany": "",
"Sadd1": "27 silver tail rd",
"Scity": "Berwick",
"Sstate": "ME",
"Spostcode": "03901",
"Stel": "9787933920",
"Scountry": "US",
"ckid": "1",
"Parcel_num": 1,
"Weight": 0.25,
"Note": " label reference",
"parcels": [
{
"box": "box1",
"boxnote": "label reference",
"weight": "0.25",
"length": "10",
"width": "5",
"height": "2",
"sku": "1",
"cnname": "asdfasdf",
"enname": "clothes",
"price": "1",
"num": "1",
"material": "1asdfsf",
"use": "1sdf",
"cweight": "0.25",
"hscode": "sadfsadf1",
"battery": "1"
}
]
}
]
}
成功返回:
{
"result": [
{
"code": 200
}
]
}
失敗返回:
{
"result": [
{
"code": 400,
"orderid": "訂單編號",
"msg": “錯誤信息"
}
]
}
批量创建订单(不推荐)
Host:http://oms.dingexpress.cn/api/multicreateorder.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
参数说明见<单条创建订单>:
請求JSON示例:
{
"AppKey": "xxxxxxx",
"AppSecret": "xxxxxxxxxx",
"Channel_id": "000",
"ptid": 0,(传此参数请与我们沟通)
"orders": [
{
"cargo_type": 2,
"OrderID": "a2020020915",
"Fname": "kimi",
"Ftel": "1234567890",
"Fadd1": "2777 Alton Parkway apt 347",
"Fstate": "CA",
"Fcity": "irvine",
"Fpostcode": "92606",
"Fcountry": "US",
"Fphone":"值", //可不填
"Femail":"值", //可不填
"Sname": "Pam Pierce",
"Scompany": "",
"Sadd1": "27 silver tail rd",
"Scity": "Berwick",
"Sstate": "ME",
"Spostcode": "03901",
"Stel": "9787933920",
"Scountry": "US",
"ckid": "1",
"Parcel_num": 1,
"Weight": 0.25,
"Note": "reference for single box",
"parcels": [
{
"box": "box1",
"boxnote":"reference for multi box"
"weight": "0.25",
"length": "10",
"width": "5",
"height": "2",
"sku": "1",
"cnname": "asdfasdf",
"enname": "clothes",
"price": "1",
"num": "1",
"material": "1asdfsf",
"use": "1sdf",
"cweight": "0.25",
"hscode": "sadfsadf1",
"battery": "1"
}
]
},
{
"cargo_type": 2,
"OrderID": "a20200209156",
"Fname": "kimi",
"Ftel": "1234567890",
"Fadd1": "2777 Alton Parkway apt 347",
"Fstate": "CA",
"Fcity": "irvine",
"Fpostcode": "92606",
"Fcountry": "US",
"Sname": "Pam Pierce",
"Scompany": "",
"Sadd1": "27 silver tail rd",
"Scity": "Berwick",
"Sstate": "ME",
"Spostcode": "03901",
"Stel": "9787933920",
"Scountry": "US",
"ckid": "1",
"Parcel_num": 1,
"Weight": 0.25,
"Note": "reference for single box",
"parcels": [
{
"box": "box1",
"boxnote":"reference for multi box"
"weight": "0.25",
"length": "10",
"width": "5",
"height": "2",
"sku": "1",
"cnname": "asdfasdf",
"enname": "clothes",
"price": "1",
"num": "1",
"material": "1asdfsf",
"use": "1sdf",
"cweight": "0.25",
"hscode": "sadfsadf1",
"battery": "1"
}
]
}
]
}
返回示例:
[
{
"code": 400,
"orderid": "a20208591513",
"msg": "订单号已存在"
},
{
"code": 400,
"orderid": "a202085915168",
"msg": "接口返回:Ship web service is currently unavailable."
},
{
"code": 200,
"orderid": "a202085915169"
},
{
"code": 200,
"orderid": "a202085915160"
},
{
"code": 200,
"orderid": "a202085915161"
}
]
3.1单条创建多内容返回参考:
{
"result": [
{
"code": 200,
"orderid": "MS801662004417319_100",
"nborderid": "898b4b6e436962e81d140e9c",
"source": {
"tracking": "跟踪号",
"waybill": "运单号",
"png_url": "png图片地址",
"pdf_url": "pdf地址",
"base64_type": "base64格式",
"base64": "base64代码"
}
}
]
}
批量获取LABEL及跟踪号
Host:http://oms.dingexpress.cn/api/multifetchlabels.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求JSON示例:
{
"AppKey":"xxx",
"AppSecret":"xxx",
"orderids":
[
"a007",
"a006"
]
}
返回JSON示例:
[
{
"code": 200,
"orderid": "a007",
"label_url": "http://440.pdf",
"trackingno": "1Z9XV6160327140440",
"post_fee": "39.66",
"gh_fee": "0.00",
"cl_fee": "0.00",
"other_fee": "0.00",
"ranyou_fee": "0.00",
"trackingnolist": [
{
"boxno": "asdfafd1",
"trackingno": "1Z9XV6160327140440",
"pdf": "",
"label_png": "http://40440.png"
},
{
"boxno": "asdfafd2",
"trackingno": "1Z9XV6160334558852",
"pdf": "",
"label_png": "http://4558852.png"
}
]
},
{
"code": 400,
"orderid": "a006",
"msg": "订单不存在或无权限"
}
]
获取LABEL及跟踪号
Host:http://oms.dingexpress.cn/api/fetchlabel.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求JSON示例:
{
"AppKey": "xxxxx",
"AppSecret": "xxxxx",
"Orderid": "xxxxxx"
}
成功返回JSON示例:
{
"result": [
{
"code": 200,
"orderid": "GG19",
"msg": {
"result": {
"label_url": "http://..xxx.pdf",
"trackingno": "xxx",
"post_fee": "0.00", //邮费
"gh_fee": "0.00", //挂号费
"cl_fee": "0.00", //处理费
"other_fee": "0.00", //其他费
"ranyou_fee": "0.00" //燃油费
}
}
}
]
}
失败返回JSON示例:
{
"result": [
{
"code": 400,
"orderid": "xxx",
"msg": "Error message"
}
]
}
撤消订单
Host:http://oms.dingexpress.cn/api/cancel.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求JSON示例:
{
"AppKey": "xxx",
"AppSecret": "xxx",
"Orderid": "xxx"
}
返回成功示例:
{
"result": [
{
"code": 200,
"orderid": "xxx",
"msg": "撤消成功!"
}
]
}
{
"result": [
{
"code": 300,
"orderid": "xxx",
"msg": "已申请撤消!"
}
]
}
返回失败示例:
{
"result": [
{
"code": 400,
"orderid": "a202002222",
"msg": "撤消失败!"
}
]
}
获取转运标签
Host:http://oms.dingexpress.cn/api/transferlabel.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求JSON示例:
{
"AppKey": "xxx",
"AppSecret": "xxx",
"Orderid": "xxx"
}
返回成功示例:
{
"result": [
{
"code": 200,
"orderid": "xxx",
"msg": "转运标签url"
}
]
}
返回失败示例:
{
"result": [
{
"code": 400,
"orderid": "xxx",
"msg": "失败原因"
}
]
}
获取价格
Host:http://oms.dingexpress.cn/api/getprice.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
請求JSON示例:
{
"AppKey": "xxxxxxx",
"AppSecret": "xxxxxxxxxx",
"Channel_id": "000",
"ptid": 0, //传此参数请与我们沟通
"orders": [
{
"cargo_type": 2,
"OrderID": "a2020020915",
"Fname": "kimi",
"Ftel": "1234567890",
"Fadd1": "2777 Alton Parkway apt 347",
"Fstate": "CA",
"Fcity": "irvine",
"Fpostcode": "92606",
"Fcountry": "US",
"Sname": "Pam Pierce",
"Scompany": "",
"Sadd1": "27 silver tail rd",
"Scity": "Berwick",
"Sstate": "ME",
"Spostcode": "03901",
"Stel": "9787933920",
"Scountry": "US",
"ckid": "1",
"Parcel_num": 1,
"Weight": 0.25,
"Note": " label reference",
"parcels": [
{
"box": "box1",
"boxnote":"label reference",
"weight": "0.25",
"length": "10",
"width": "5",
"height": "2",
"sku": "1",
"cnname": "asdfasdf",
"enname": "clothes",
"price": "1",
"num": "1",
"material": "1asdfsf",
"use": "1sdf",
"cweight": "0.25",
"hscode": "sadfsadf1",
"battery": "1"
}
]
}
]
}
成功返回:
{
"result": [
{
"code": 200,
"orderid": "xxx",
"post_fee": 5.2, //邮费
"gh_fee": 0, //挂号费
"cl_fee": 0, //处理费
"other_fee": 0, //其他费用
"ranyou_fee": 0 //燃油费
}
]
}
获取运输渠道
Host:http://oms.dingexpress.cn/api/channel.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
{
"AppKey":"20011",
"AppSecret":"xxx"
}
返回示例:
[
{
"channelid": "386",
"channelname": "FEDEX_GROUND"
},
{
"channelid": "405",
"channelname": "测试渠道"
}
]
获取帐户信息
Host:http://oms.dingexpress.cn/api/getaccoutinfo.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
{
"AppKey":"20011",
"AppSecret":"xxx"
}
返回示例:
{
"code": 200, //200表示成功
"uid": "11", // 用户ID
"yue": "6369.22" //余额
}
获取跟踪信息
Host:http://oms.dingexpress.cn/api/tracking.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
{
"AppKey": "21033",
"AppSecret": "xxx",
"Trackingno": "xxx"
}
返回示例:
{
"code": 200,
"result": [
{
"Time": "2020-08-21 04:54:46",
"EventDescription": "The goods have been packed and sent from Yiwu to Russia"
},
{
"Time": "2020-08-20 21:54:46",
"EventDescription": "The goods have arrived at the warehouse in Yiwu, and the warehouse has been scanned for collection"
},
{
"Time": "2020-08-20 17:54:46",
"EventDescription": "Order created successfully"
}
]
}
生成SCANFORM
注意:仅部分渠道支持
Host:http://oms.dingexpress.cn/api/scanform.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请示示例:
{
"AppKey": "20011",
"AppSecret": "xx",
"Qdid": 422, //渠道ID
"AddressID": 93, //发货地址ID,在系统左侧,我的地址可以查看
"TrackingNos": [
"9405500897846053129766",
"9405500897846053129810"
]
}
成功返回:
{
"code": "200",
"sfurl": "https://www.**.com/372b3abfe56c49d0a00bf80070707d12.pdf"
}
失败返回:
{
"code": "400",
"msg": "reason"
}
查看订单撤消状态
Host:http://oms.dingexpress.cn/api/cancelstatus.php
接口请求Content-Type类型为:application/json
请求方式:post
接口返回类型为JSON,同时进行UTF-8编码
请求示例:
{
"AppKey": "20011",
"AppSecret": "xxx",
"Orderid": "xxx"
}
成功示例:
{
"code": 200,
"result": "3"
}
状态说明 :0 未申请退款 1 退款中 2 退款完成 3 不能退款
失败示例:
{
"code": 400,
"result": "记录不存在!"
}