接口调用地址	/Api/AllTransfer
当前版本	V 1.0.0.0
接口规范	点击查看API接口调用规范说明

接口说明	获取国家列表
接口名称	GetCountry

请求参数

参数名称	参数类型	是否必填	数组	参数说明
AgentState	Int	必填	否	是否开通代理:0不开通,1开通,-1不限
PageCount	Int	必填	否	每页条数
Page	Int	必填	否	当前页数,首页为1
CountryID	Int64	可空	否	国家编号
CountryName	String	可空	否	国家名称
CountryCode	Int	可空	否	国家代号

返回对象

参数名称	参数类型	数组	参数说明
Count	Int	否	总条数
PageCount	Int	否	每页条数
Page	Int	否	当前页数

ListCountryInfo

参数名称 参数类型 数组 参数说明 CountryID Int64 否 国家编号 CurrencyCode String 否 币种简码 CountryName String 否 国家名称 CurrencyID Int64 否 币种编号 CurrencyName String 否 币种名称 Code Int 否 国家代号 ExchangeRate Decimal 否 汇率:对人民币汇率(1人民币兑换多少当前货币) MonetaryUnit String 否 货币名称 Sort Int64 否 排序 RegexPhone String 否 正则手机 RegexTel String 否 正则电话 RegexCardNo String 否 正则身份证 AgentState Int 否 是否开通代理:0不开通,1开通 OpenDF Int 否 是否开通到付:0不开通,1开通 OpenDBHFK Int 否 是否开通打包后付款:0不开通,1开通 DF_Formula String 否 到付手续费公式 M代表金额 SimpleCode String 否 国家简码 EnableState Int 否 当前启用状态:0停用,1启用

接口说明	获取县区列表
接口名称	GetArea

请求参数

参数名称	参数类型	是否必填	数组	参数说明
CountryID	Int64	可空	否	所属国家编号
ProvinceID	Int64	可空	否	所属省份编号
CityID	Int64	可空	否	所属城市编号
AreaID	Int64	可空	否	县区编号
AreaName	String	可空	否	县区名称
PageCount	Int	必填	否	每页条数
Page	Int	必填	否	当前页数

返回对象

参数名称	参数类型	数组	参数说明
Count	Int	否	总条数
PageCount	Int	否	每页条数
Page	Int	否	当前页数

ListAreaInfo

参数名称 参数类型 数组 参数说明 CountryID Int64 否 所属国家编号 CountryName String 否 所属国家名称 ProvinceID Int64 否 所属省份编号 ProvinceName String 否 所属省份名称 CityID Int64 否 所属城市编号 CityName String 否 所属城市名称 AreaID Int64 否 县区编号 AreaName String 否 县区名称 PostCode String 否 县区邮编 Type Int 否 类型:0住宅,1商业 Free Decimal 否 附加费 EnableState Int 否 当前启用状态:0停用,1启用

接口说明	获取城市列表
接口名称	GetCity

请求参数

参数名称	参数类型	是否必填	数组	参数说明
CountryID	Int64	可空	否	所属国家编号
ProvinceID	Int64	可空	否	所属省份编号
CityID	Int64	可空	否	所属城市编号
CityName	String	可空	否	县区名称
PageCount	Int	必填	否	每页条数
Page	Int	必填	否	当前页数

返回对象

参数名称	参数类型	数组	参数说明
Count	Int	否	总条数
PageCount	Int	否	每页条数
Page	Int	否	当前页数

ListCityInfo

参数名称 参数类型 数组 参数说明 CountryID Int64 否 所属国家编号 CountryName String 否 所属国家名称 ProvinceID Int64 否 所属省份编号 ProvinceName String 否 所属省份名称 CityID Int64 否 所属城市编号 CityName String 否 所属城市名称 EnableState Int 否 当前启用状态:0停用,1启用

接口说明	获取省份列表
接口名称	GetProvince

请求参数

参数名称	参数类型	是否必填	数组	参数说明
CountryID	Int64	可空	否	所属国家编号
ProvinceID	Int64	可空	否	所属省份编号
ProvinceName	String	可空	否	省份名称
PageCount	Int	必填	否	每页条数
Page	Int	必填	否	当前页数

返回对象

参数名称	参数类型	数组	参数说明
Count	Int	否	总条数
PageCount	Int	否	每页条数
Page	Int	否	当前页数

ListProvinceInfo

参数名称 参数类型 数组 参数说明 CountryID Int64 否 所属国家编号 CountryName String 否 所属国家名称 ProvinceID Int64 否 所属省份编号 ProvinceName String 否 所属省份名称 EnableState Int 否 当前启用状态:0停用,1启用

接口说明	获取门市资料
接口名称	GetEshops

请求参数

参数名称	参数类型	是否必填	数组	参数说明
OPMode	Int	必填	否	门店类型:-1 不限,1 7-Eleven,2 全家超商
EshopId	String	可空	否	门店号
EshopName	String	可空	否	门店名称
State	Int	必填	否	开业状态:-1不限,0已关闭,1营业中
FindKey	String	可空	否	关键词:门店号(完全匹配),门店名称(完全匹配),门店地址(模糊匹配)
PageCount	Int	必填	否	每页条数
Page	Int	必填	否	当前页数

返回对象

参数名称	参数类型	数组	参数说明
Count	Int	否	总条数
PageCount	Int	否	每页条数
Page	Int	否	当前页数

ListEshop

参数名称 参数类型 数组 参数说明 EshopId String 否 门店号 OPMode Int 否 门店类型:1 7-Eleven,2 全家超商 OpModeName String 否 门市类型 EshopName String 否 门店名称 EshopAddress String 否 门店地址 EshopIdOld String 否 老版门店号 EshopPhone String 否 门店电话 EshopNo String 否 门店代码 EshopCode String 否 门店标识 UpDateTime String 否 更新时间 IsClose Int 否 是否关闭:0 否,1 是 MdcStareDate String 否 MDC开始时间 MdcEndDate String 否 MDC结束时间 Route String 否 理货线路 -全家 Step String 否 理货路顺 -全家 StoreCloseDate String 否 门店关闭日期 Area String 否 门店区域:01北区,02中区,03南区 EquipmentID String 否 设备代码 Route2 String 否 二配路线 Step2 String 否 二配路顺 AreaName String 否 二配区域 AreaCode String 否 二配区域符

接口说明	获取承运商列表
接口名称	GetCarrier

请求参数

参数名称	参数类型	是否必填	数组	参数说明
IsAgent	Int	必填	否	是否代理:0不是,1是,-1不限
IsFilter	Bool	必填	否	是否过滤没有报价承运商:true过滤
PriceTypeID	Int	可空	否	报价类型编号:1派送价格,2自提价格,3包税价格,4代收货款价格,5保价价格,6送货价格
CountryID	Int64	可空	否	所属国家编号
CarrierID	Int64	可空	否	承运商编号
Weight	Decimal	可空	否	重量
Perimeter	Decimal	可空	否	周长
ShopID	Decimal	可空	否	店铺编号
GroupID	Int64	可空	否	客户分组编号
TransportTypeId	Int64	可空	否	运输方式编号
WareHouseID	Int64	可空	否	仓库编号
GoodsTypeID	Int64	可空	否	货物类型编号
PageCount	Int	必填	否	每页条数
Page	Int	必填	否	当前页数

返回对象

参数名称	参数类型	数组	参数说明
Count	Int	否	总条数
PageCount	Int	否	每页条数
Page	Int	否	当前页数

ListCarrierInfo

参数名称 参数类型 数组 参数说明 CarrierID Int64 否 编号 CarrierName String 否 承运商名 CountryID Int64 否 所属国家编号 CountryName String 否 所属国家名称 TrackName String 否 物流轨迹关键字 ApiName String 否 接口关键字 Rem String 否 备注 SubMode IsEshop Int 否 是否超商:0不是,1是 IsLocal Int 否 取号类型:0联网,1本地,2手工 MaxWeight Decimal 否 单包最大限制重量:0不限重 MaxPerimeter Decimal 否 最大限制周长(三边之和):0不限 AgentFormula Sort Int64 否 排序:从低到高 EnableState Int64 否 当前启用状态:0停用,1启用

接口说明	获取货物类型列表
接口名称	GetGoodsType

请求参数

参数名称	参数类型	是否必填	数组	参数说明
GoodsTypeID	Int64	可空	否	货物类型编号
GoodsTypeName	String	可空	否	货物类型名称
PageCount	Int	必填	否	每页条数
Page	Int	必填	否	当前页数

返回对象

参数名称	参数类型	数组	参数说明
Count	Int	否	总条数
PageCount	Int	否	每页条数
Page	Int	否	当前页数

ListGoodsTypeInfo

参数名称 参数类型 数组 参数说明 GoodsTypeID Int64 否 编号 GoodsTypeName String 否 名称 GoodsTypeCode String 否 代码 Rem String 否 备注 Sort Int64 否 排序 EnableState Int 否 当前启用状态:0停用,1启用

接口说明	获取仓库列表
接口名称	GetWareHouse

请求参数

参数名称	参数类型	是否必填	数组	参数说明
WareHouseID	Int64	可空	否	仓库编号
WareHouseName	String	可空	否	仓库名称
CountryID	Int64	可空	否	所属国家编号
ProvinceID	Int64	可空	否	所属城市编号
CityID	Int64	可空	否	所属城市编号
AreaID	Int64	可空	否	所属县区编号
PageCount	Int	必填	否	每页条数
Page	Int	必填	否	当前页数

返回对象

参数名称	参数类型	数组	参数说明
Count	Int	否	总条数
PageCount	Int	否	每页条数
Page	Int	否	当前页数

ListWareHouseInfo

参数名称 参数类型 数组 参数说明 WareHouseID Int64 否 仓库编号 WareHouseName String 否 仓库名称 CountryID Int64 否 所属国家编号 CountryName String 否 所属国家名称 Person String 否 联系人 Phone String 否 联系手机 Tel String 否 联系电话 CarrierIDs String 否 承运商编号 CarrierNames String 否 承运商名称 ProvinceID Int64 否 所属省份编号 ProvinceName String 否 所属省份名称 CityID Int64 否 所属城市编号 CityName String 否 所属城市名称 AreaID Int64 否 所属县区编号 AreaName String 否 所属县区名称 Address String 否 仓库详细地址 PostCode String 否 邮政编码 Rem String 否 说明 EnableState Int 否 当前启用状态:0停用,1启用

接口说明	获取运输方式列表
接口名称	GetTransportType

请求参数

参数名称	参数类型	是否必填	数组	参数说明
TransportTypeID	Int64	可空	否	运输方式编号
TransportTypeName	String	可空	否	运输方式名称
IsFilter	Bool	可空	否	是否过滤没有报价运输方式:true过滤
CountryID	Int64	可空	否	所属国家编号
PriceTypeID	Int	可空	否	报价类型编号:1派送价格,2自提价格,3包税价格,4代收货款价格,5保价价格,6送货价格
ShopID	Int64	可空	否	店铺编号
GroupID	Int64	可空	否	客户分组编号
WareHouseID	Int64	可空	否	仓库编号
GoodsTypeID	Int64	可空	否	货物类型编号
PageCount	Int	必填	否	每页条数
Page	Int	必填	否	当前页数

返回对象

参数名称	参数类型	数组	参数说明
Count	Int	否	总条数
PageCount	Int	否	每页条数
Page	Int	否	当前页数

ListTransportType

参数名称 参数类型 数组 参数说明 TransportTypeID Int64 否 运输方式编号 TransportTypeName String 否 运输方式名称 CountryID Int64 否 国家编号 CountryName String 否 国家名称 Rem String 否 备注 Sort Int64 否 排序:从低到高 EnableState Int 否 当前启用状态:0停用,1启用

接口说明	取消订单
接口名称	CancelOrder

请求参数

参数名称	参数类型	是否必填	数组	参数说明
ClientID	Int64	必填	否	会员编号
ListOrderCode	List<String>	必填	是	订单号列表,传入多个订单号时,订单号和订单编号顺序必须一致

返回对象

参数名称	参数类型	数组	参数说明
AllCount	Int	否	取消订单数量
SuccessCount	Int	否	取消订单成功数量
FailCount	Int	否	取消订单失败数量

ListCancelOrderInfo

参数名称 参数类型 数组 参数说明 CancelOrderState Bool 否 取消订单结果:true成功 OrderCode String 否 订单号 msg String 否 失败原因

接口说明	在线生成面单
接口名称	GetPrintData

请求参数

参数名称	参数类型	是否必填	数组	参数说明
ClientID	Int64	必填	否	会员编号
OrderCodeType	Int	必填	否	单号类型:1快递单号,2承运单号,3订单编号,4订单号
OrderCode	String	必填	否	单号
CarrierName	String	必填	否	承运商名称
GetDataType	Int	必填	否	获取数据类型:1返回字典类型,2生成PDF(返回URL))
GetSingleType	Int	可空	否	获取面单类型:0正式面单(默认),1拣货单(台湾地区订单请传1)
GetSpecialType	Int	可空	否	特殊面单:0(默认),1打印特殊面单

返回对象

参数名称	参数类型	数组	参数说明
Dictionarys	Dictionary<string,string>	是	字典数据
PdfUrl	string	否	PDF面单链接地址

接口说明	批量获取物流轨迹
接口名称	GetTracks

请求参数

参数名称	参数类型	是否必填	数组	参数说明
ClientID	Int64	必填	否	会员编号
ListOrderCode	List<String>	必填	是	承运单号列表

返回对象

参数名称	参数类型	数组	参数说明

ListTrackItem	参数名称 参数类型 数组 参数说明 OrderCode String 否 承运单号
ListTrack	参数名称 参数类型 数组 参数说明 OrderCode String 否 承运单号 TrackTime String 否 时间 TrackState Int 否 状态码:0在途,1揽件,2疑难,3签收,4退签,5派件,6退件,7退货入库,8退货上架,9退货重出,10退货销毁,11待取件,12取消,13异常处理 TrackDescription String 否 状态详细描述

接口说明	获取运单号
接口名称	GetWaybillNo

请求参数

参数名称	参数类型	是否必填	数组	参数说明
ClientID	Int64	必填	否	会员编号
OrderCodeType	Int	必填	否	单号类型:1订单编号,2订单号,3快递单号
OrderCode	String	必填	否	单号

返回对象

参数名称	参数类型	数组	参数说明
WaybillNo	String	否	承运单号
State	Bool	否	获取运单结果:true成功
ErrorMsg	String	否	失败原因

接口说明	批量创建订单
接口名称	AddOrders

请求参数

参数名称	参数类型	是否必填	数组	参数说明
ClientID	long	必填	否	会员编号

ListOrder

参数名称 参数类型 是否必填 数组 参数说明 OrderCode string 必填 否 订单号 GoodsTypeName String 必填 否 货物类型 GoodsName String 必填 否 品名 WareHouseName String 必填 否 仓库名称 TransportTypeName String 必填 否 运输方式 CarrierName String 必填 否 承运商名称 ReceiveName String 必填 否 收件人姓名 ReceiveAddress String 必填 否 收件人地址 ReceivePhoneNo String 必填 否 收件人手机号 ReceiveCardNo String 可空 否 收件人统编 CountryName String 必填 否 目的地国家名称 ProvinceName String 可空 否 省 CityName String 可空 否 市 AreaName String 可空 否 区 OrderWaybillNo String 可空 否 承运单号 OldCodeType Int 可空 否 原始单号类型:0订单号,1运单号,2订单ID,3退货单号 OldOrderCode List<String> 可空 是 原始单号,如["0001","0002"] Rem String 可空 是 备注 ClientRem String 可空 否 会员备注 SKU String 可空 否 SKU ImporterEORINumber String 可空 否 税号 GoodsAccount Int 可空 否 货物数量(整数无小数点) Collection Decimal 可空 否 代收货款(整数无小数点) InsuredAmount Decimal 可空 否 保价金额 IsTax Int 可空 否 包税:1包税,0不包税 CardNo String 可空 否 身份证号码 PostNo String 可空 否 邮政编码(台湾可空) ReceiveTel String 可空 否 收件人电话 ReceiveDoorNo String 可空 否 收件人门牌号 ReceiveEmail String 可空 否 收件人邮箱 HsCode String 可空 否 产品海关编码 Weight Decimal 必填 否 实际重量 Price Decimal 必填 否 订单申报单价 Account Int 必填 否 订单申报物品数量(整数无小数点) GoodsName_En String 可空 否 英文品名 StoreNumber String 可空 否 门店号码(承运商如果为7-11、全家，则必填) StoreName String 可空 否 门店名称

ListGoodsItem

参数名称 参数类型 是否必填 数组 参数说明 CheckSku Bool 可空 否 是否校验SKU BillCode String 可空 否 快递单号 Account Int 可空 否 数量 Price Decimal 可空 否 单价 Money Decimal 可空 否 总价 GoodsName String 可空 否 品名 Rem String 可空 否 备注

返回对象

参数名称	参数类型	数组	参数说明

ListOrderCode

参数名称 参数类型 数组 参数说明 OrderID String 否 订单ID OrderCode String 否 订单号 WaybillNo String 否 承运单号 State Bool 否 创建订单结果:true成功 ErrorMsg String 否 错误信息 Carrier String 否 承运商