API接口文档

创建订单

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：CreateOrder

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
ParamsJson	string	是	请求的数据	Json格式

ParamsJson示例：

 
{
  "Style": "1",
  "ShipperName": "",
  "ShipperAddress": "",
  "ShipperPhone": "",
  "CsRefNo": "05141029402",
  "ConsigneeName": "zhang san",
  "CountryCode": "202",
  "ShipperService": "18",
  "Zipcode": "79879",
  "State": "TX",
  "City": "TX",
  "Address1": "TX001",
  "Address2": "",
  "Contact": "13467987541",
  "Email": "",
  "Company": "",
  "StockID": "",
  "OrderDetail": [
    {
      "CnName": "杯子",
      "EnName": "cup",
      "SKU": "cup",
      "Quantity": "1",
      "Weight": "1",
      "Length": 35.0,
      "Width": 30.0,
      "High": 20.0
      "Price": "1",
      "HSCode": "",
      "Origin": ""
    }
  ],
  "OrderReceipt": [
    {
      "ExpressName": "",
      "TrackingNo":"",
      "Qty": "",
      "Remark": "20.0"
    }
  ]
}

ParamsJson参数说明：

参数名	类型	是否必填	描述	示例
Style	string	是	订单类型	1仓储/2转运订单
CsRefNo	string	是	参考号/ERP订单号	C00001
ShipperService	string	是	运输方式	可以通过运输方式接口获取(ID/代码都可以)
ShipperName	string	否	发件人姓名	zhangsan
ShipperAddress	string	否	发件人地址	shenzhen
ShipperPhone	string	否	发件人联系方式	10086
ConsigneeName	string	是	收件人姓名	james
CountryCode	string	是	收件人国家	US
State	string	是	收件人州/省	CA
City	string	是	收件人城市	Valley
Zipcode	string	是	收件人邮编	92551
Address1	string	是	收件人地址1	24300 Nandina Ave
Address2	string	否	收件人地址2
Contact	string	是	收件人联系方式	000000000
Email	string	是	收件人邮箱	123@Email.com
Company	string	否	收件人公司
Remark	string	否	备注
DEPT	string	否	DEPT
CODAmount	string	否	COD金额	COD订单必填
CODCurrency	string	否	COD币种	COD订单必填
TrackingNo	string	否	跟踪号	用于自发货,wayfair订单
LabelUrl	string	否	面单URL	用于自发货,wayfair面单
StockID	string	否	仓库ID	1(style=1 仓储订单StockID为必填)
OrderDetail	string	是	申报信息	Json集合
SKU	string	否	SKU	cup
EnName	string	是	英文品名	cup
CnName	string	否	中文品名	杯子
Quantity	string	是	数量	1
Weight	string	是	重量(kg/个)	0.5
Length	string	是	长(cm)	0.5
Width	string	是	宽(cm)	0.5
High	string	是	高(cm)	0.5
Price	string	是	申报价值(USD/个)	8.9
HSCode	string	否	海关编码	80020001
Origin	string	否	原产地	CN
OrderReceipt	string	是	代发包裹,代发业务需要	Json集合
ExpressName	string	是	快递公司	顺丰
TrackingNo	string	是	国内快递单号	SF1293212309876
Qty	string	是	数量	1
Remark	string	是	备注	连衣裙-XL-黑色
OrderBags	string	是	包裹信息,一票多件时用	Json集合
Weight	string	是	重量(kg)	0.5
Length	string	是	长(cm)	0.5
Width	string	是	宽(cm)	0.5
Height	string	是	高(cm)	0.5

返回示例：

 
{
  "code": "1",
  "msg": "",
  "OrderNo": "",
  "CsRefNo": "",
  "TrackingNo": "",
  "LabelUrl": ""
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
OrderNo	订单号
TrackingNo	跟踪号
CsRefNo	参考号
LabelUrl	标签URL

获取标签

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：GetLablesUrl

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
ParamsJson	string	是	请求的数据	Json格式

ParamsJson示例：

 
{
  "OrderNo": "60000053110309"
}

ParamsJson参数说明：

参数名	类型	描述	示例
OrderNo	string	订单号	60000053110309

返回示例：

 
{
  "code": "1",
  "msg": "",
  "OrderNo": "",
  "CsRefNo": "",
  "TrackingNo": "",
  "LabelUrl": ""
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
OrderNo	订单号
TrackingNo	跟踪号
CsRefNo	参考号
LabelUrl	标签URL

获取订单信息

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方法：GetOrderInfo

请求方式：POST

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
OrderNo	string	是	订单号/参考号	80000042425611

返回示例：

 
{
  "code": "0",
  "msg": "获取成功",
  "data": [
    {
      "OrderNo": "80000042425611",
      "TrackingNo": "9261290980907425139596",
      "CsRefNo": "10010084R",
      "LabelUrl": "http://oms.topestexpress.com/log/LabelPDF/9261290980907425139596.pdf",
      "Weight": "0.800",
      "TotalAmount": "56.600",
      "ChannelCode": "Fedex-SP",
      "Status": "已发货",
      "EnName": "US"
    }
  ]
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
OrderNo	订单号
TrackingNo	跟踪号
CsRefNo	参考号
LabelUrl	面单URL
Weight	计费重量
TotalAmount	费用
ChannelCode	运输方式
Status	订单状态(1:草稿,2:确认,3:已打印,4:已发货,5:已删除, 6:拣货中)
EnName	目的地国家二字代码

获取价格表

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方法：GetPriceList

请求方式：POST

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
ParamsJson	string	是	请求的数据	Json格式

ParamsJson请求参数说明：

参数名	类型	是否必填	描述
Country	stirng	是	国家
Zipcode	stirng	是	邮编
Weight	decimal	是	重量
Length	decimal	是	长
Width	decimal	是	宽
High	decimal	是	高
GoodsType	stirng	是	1/文件 2/包裹
StockID	stirng	否	7（查询海外仓价格才会用到）默认0

返回示例：

 
{
  "code": "0",
  "msg": "获取成功",
  "data": [
    {
      "Name": "FedEx",
      "Weight": 90.000,
      "TotalCost": 5.113,
      "BaseFee": 20.710,
      "OrderFee": 0.000,
      "FuelFee": 5.113,
      "HousingFee": 1.440,
      "RemoteFee": 0.000,
      "OtherFee": 0.000,
      "OverweightFee": 0.000,
      "ExtraLongFee": 0.000,
      "CDeclaredFee": 43.200
    }
  ]
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
Name	渠道名称
Weight	重量
TotalCost	总运费
BaseFee	基本运费
OrderFee	订单处理费
FuelFee	燃油附加费
HousingFee	住宅费
RemoteFee	偏远费
OverweightFee	超重费
ExtraLongFee	超长费
CDeclaredFee	超330费

创建产品

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：CreateProduct

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
ParamsJson	string	是	请求的数据	Json格式

请求示例：

 
{
  "Goods": [
    {
      "SKU": "6938116643849",
      "GoodsCode": "6938116643849",
      "CnName": "免洗洗手液",
      "EnName": "Disposable hand sanitizer",
      "Price": "1",
      "Weight": "0.1",
      "Length": "1",
      "Width": "1",
      "High": "1",
      "WarnQuantity": "1",
      "HsCode": "",
      "Origin": "",
      "Speci": "",
      "ValidDate": "",
      "Brand": "",
      "EnBrand": "",
      "Battery": "0",
      "Remark": ""
    }
  ]
}

请求参数说明：

参数名	类型	是否必填	描述
SKU	stirng	是	SKU
GoodsCode	stirng	是	产品条码
CnName	stirng	是	中文描述
EnName	stirng	是	英文描述
Price	decimal	是	申报价值
Weight	decimal	是	重量
Length	decimal	是	长
Width	decimal	是	宽
High	decimal	是	高
WarnQuantity	int	否	预警数量
HsCode	stirng	否	海关编码
Origin	stirng	否	原产地
Speci	stirng	否	规格
ValidDate	stirng	否	有效期
Brand	stirng	否	品牌
EnBrand	stirng	否	英文品牌
Battery	stirng	否	是否带电 0 否 1 是
Remark	stirng	否	备注

返回示例：

成功：{"code":"0","msg":"创建成功!"}

失败：{"code":"1","msg":"数据有误！"}

获取产品列表

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：GetProductList

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
SKU	string	是	SKU	123456789

返回示例：

 
{
  "code": "0",
  "msg": "获取成功",
  "data": [
    {
      "GoodsID": "1123",
      "SKU": "SIMG05040001",
      "GoodsCode": "SIMG05040001",
      "CnName": "洗手液",
      "EnName": "handwashing fluid",
      "Price": "20.89",
      "Weight": "0.55",
      "Length": "10",
      "Width": "10",
      "High": "20",
      "RealWeight": "0.6",
      "RealLength": "10",
      "RealWidth": "10",
      "RealHigh": "20"
    }
  ]
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
GoodsID	产品ID
SKU	SKU
GoodsCode	产品条码
CnName	产品中文描述
EnName	产品英文描述
Price	申报价值
Weight	产品重量
Length	产品长
Width	产品宽
RealHigh	产品高
RealWeight	产品真实重量
RealLength	产品真实长
RealWidth	产品真实宽
RealHigh	产品真实高

获取库存

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：GetInventoryList

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
StockID	string	是	仓库ID	1
SKU	string	是	SKU	123456789

返回示例：

 
{
  "code": "0",
  "msg": "获取成功",
  "data": [
    {
      "SKU": "SIMG05040001",
      "GoodsCode": "SIMG05040001",
      "AvailableQty": 56,
      "StockQty": 56,
      "UsedQty": 0,
      "StockUnitNo": "US-NY-A01-001",
      "StockID": 5
    }
    
  ]
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
SKU	SKU
GoodsCode	产品条码
AvailableQty	可用库存数量
StockQty	库存数量
UsedQty	占用库存数量
StockUnitNo	货架
StockID	仓库ID

创建入库单

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：CreateEntryOrder

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
ParamsJson	string	是	请求的数据	Json格式

请求示例：

 
{
  "TrackingNo": "",
  "DeliveryStyle": "1",
  "StockID": "2167",
  "BoxNumber": 1,
  "ExpectTime": "2017-05-10 16:46:47",
  "Remark": "",
  "Detail": [
    {
      "SKU": "SXFD6603022",
      "Quantity": 1,
      "BoxNo": 1
    }
  ]
}

请求参数说明：

参数名	类型	是否必填	描述
TrackingNo	stirng	是	头程单号/快递单号
DeliveryStyle	stirng	是	运输方式 1：空运 2：海运
StockID	stirng	是	仓库ID
BoxNumber	stirng	是	箱数
ExpectTime	stirng	是	预计到仓时间
Remark	stirng	否	备注
SKU	stirng	是	SKU
Quantity	decimal	是	数量
BoxNo	stirng	是	箱号

返回示例：

成功：{"code":"0","msg":"创建成功!"}

失败：{"code":"1","msg":"数据有误！"}

获取入库单信息

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：GetEntryOrderList

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
EntryNo	string	是	入库单/快递单	RK800002004281044

返回示例：

 
{
  "code": "0",
  "msg": "获取成功",
  "StockCode": "US",
  "EntryNo": "RK800002004281044",
  "TrackingNo": "1233",
  "EntryStatus": "已上架",
  "data": [
    {
      "SKU": "123456789",
      "GoodsCode": "123456789",
      "CnName": "洗手液",
      "EnName": "handwashing fluid",
      "PlanQty": 70,
      "ActualQty": 70,
      "FailQty": 0,
      "ShelvesQty": 70
    }
  ]
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
StockCode	仓库编码
EntryNo	入库单号
TrackingNo	头程单号/快递单号
EntryStatus	状态
SKU	SKU
GoodsCode	产品条码
CnName	中文描述
EnName	英文描述
PlanQty	预约入库数量
ActualQty	合格数量
FailQty	不合格数量
ShelvesQty	上架数量

获取跟踪轨迹

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：GetTrack

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
TrackingNo	string	是	跟踪号	74890983116153698166

返回示例：

 
{
  "code": "0",
  "msg": "获取成功",
  "Status": "",
  "Country": "",
  "TrackingNo": "",
  "data": [
    {
      "OccurTime": "",
      "DetailDesc": "",
      "Location": ""
    }
  ]
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
Status	状态
Country	目的地国家
TrackingNo	跟踪号
OccurTime	时间
DetailDesc	描述
Location	位置

获取国家

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：GetCountry

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734

返回示例：

 
{
  "code": "0",
  "msg": "获取成功",
  "data": [
    {
      "ID": "202",
      "Code": "US",
      "CnName": "美国",
      "EnName": "United States"
    }
  ]
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
ID	国家ID
Code	国家二字代码
CnName	中文名称
EnName	英文名称

获取运输方式

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：GetShipperService

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734

返回示例：

 
{
  "code": "0",
  "msg": "获取成功",
  "data": [
    {
      "ID": "18",
      "Code": "USPS",
      "CnName": "美国邮政小包",
      "EnName": "USPS-POST"
    }
  ]
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
ID	运输方式ID
Code	运输方式代码
CnName	中文名称
EnName	英文名称

获取仓库列表

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：GetStockList

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734

返回示例：

 
{
  "code": "0",
  "msg": "获取成功",
  "data": [
    {
                          
      "StockID": "18",
      "Code": "CA",
      "Name": "CAWH",
  
    }
  ]
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息
StockID	仓库ID
Code	仓库编号
Name	仓库名称

上传Wayfair面单

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：UploadWayfairPDF

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
TrackingNo	string	是	跟踪号	322902674156
LabelBase64	string	是	面单Base64字符串	JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9EZWN...

返回示例：

 
{
  "code": "0",
  "msg": "上传成功"
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息

取消订单

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：CancelOrder

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
OrderNo	string	是	订单号/参考号	6000010191046

返回示例：

 
{
  "code": "0",
  "msg": "取消成功"
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息

删除订单

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：DeleteOrder

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
OrderNo	string	是	订单号/参考号	6000010191046

返回示例：

 
{
  "code": "0",
  "msg": "删除成功"
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息

拦截订单

请求地址：http://oms.topestexpress.com/WebService/PublicService.asmx?wsdl

请求方式：POST

请求方法：CutOffOrder

content-type：text/xml

Body参数说明：

参数名	类型	是否必填	描述	示例
Token	string	是	授权令牌	DFD3CFB726E77896E1DB0D2CA133C734
OrderNo	string	是	订单号/跟踪号	6000010191046

返回示例：

 
{
  "code": "0",
  "msg": "删除成功"
}

返回参数说明：

参数名	描述
code	0:成功,1:失败
msg	错误信息

Postman请求示例

以下是查看请求方法和请求报文

打开地址：http://oms.topestexpress.com/WebService/PublicService.asmx