一、获取Token

接口说明

请求地址

环境请求地址支持方法返回数据格式
生产环境http://www.tofba.com:8887/api/accessTokenGET/POSTJSON
测试环境http://tofba1.f3322.net:8887/api/accessTokenGET/POSTJSON

请求参数说明

请求参数Required描述
usernameYes用户名(九方ERP账户客户编码或者客户登录名)
passwordYes密码

请求样例

JSON响应结果

二、获取渠道

接口说明

请求地址

环境请求地址支持方法返回数据格式
生产环境http://www.tofba.com:8887/api/getProductListGET/POSTJSON
测试环境http://tofba1.f3322.net:8887/api/getProductListGET/POSTJSON

请求参数说明

请求参数Required描述
tokenYes请求令牌,获取令牌参考获取Token
customerCodeYes九方ERP系统为客户生成的唯一客户编码

请求样例

JSON响应结果

三、创建订单

接口地址

请求地址

环境请求地址支持方法返回数据格式
生产环境http://www.tofba.com:8887/api/createOrderPOSTJSON
测试环境http://tofba1.f3322.net:8887/api/createOrderPOSTJSON

请求参数说明

字段Required类型描述
tokenYesString请求令牌,获取令牌参考获取Token
customerCodeYesString九方ERP系统为客户生成的唯一客户编码
returnSignYesString退回标志,N:表示不退回,Y:标表示退回,默认:N
customerInvoiceCodeYesString原单号,客户自己系统中订单号
tradeTypefalseString平台类型平台类型说明
countryCodetrueString收件国家二字码
productIdtrueLong运输方式ID获取渠道接口查询得到
transactionUrlfalseString产品销售链接
currencyCodefalseString申报币种,币种代码。常见币种
consigneeNametrueString收件人姓名
consigneeAddresstrueString收件人地址
consigneeCitytrueString收件人城市
consigneePostCodetrueString收件人邮编
consigneeStatetrueString收件人州/省
consigneeTelephonetrueString收件人电话
consigneeMobilefalseString收件人手机
consigneeEmailfalseString收件人邮箱
consigneeCompanyNamefalseString收件人公司名
shipperNamefalseString发件人姓名
shipperCompanyNamefalseString发件人公司名
shipperAddress1falseString发件人地址1
shipperAddress2falseString发件人地址2
shipperAddress3falseString发件人地址3
shipperCityfalseString发件人城市
shipperStatefalseString发件人省
shipperPostCodefalseString发件人邮编
shipperCountryfalseString发件人国家二字码
shipperTelephonefalseString发件人电话
orderPiecetrueInteger下单件数
weightfalseDouble如果不填则默认为SKU重量之和
collectionAmountfalseDouble代收金额
cargoAmountfalseDouble订单实际金额
customerRemarkfalseString订单备注
insuranceAmountfalseDouble保险金额
orderInvoicestrueListOrderInvoice
orderVolumesfalseListOrderVolume

OrderInvoice

字段Required类型描述
invoiceAmounttrueDouble总申报货值
invoicePcstrueInteger数量
skuNameCntrueString中文品名
skuNameEntrueString英文品名
skuCodetrueStringSKU
hsCodetrueString海关编码
invoicePurposefalseString用途
invoiceWeightfalseDouble单件重量

OrderVolume

字段Required类型描述
lengthfalseDouble
widthfalseDouble
heightfalseDouble
weightfalseDouble

请求样例

JSON响应结果

四、标记发货

接口说明

请求地址

环境请求地址支持方法返回数据格式
生产环境http://www.tofba.com:8887/api/markShipmentGET/POSTJSON
测试环境http://tofba1.f3322.net:8887/api/markShipmentGET/POSTJSON

请求参数说明

请求参数Required描述
tokenYes请求令牌,获取令牌参考获取Token
customerCodeYes九方ERP系统为客户生成的唯一客户编码
customerInvoiceCodeYes九方ERP参考号,即客户所使用ERP系统中订单号

请求样例

JSON响应结果

五、更新重量

接口地址

请求地址

环境请求地址支持方法返回数据格式
生产环境http://www.tofba.com:8887/api/updateOrderWeightGET/POSTJSON
测试环境http://tofba1.f3322.net:8887/api/updateOrderWeightGET/POSTJSON

请求参数说明

请求参数Required描述
tokenYes请求令牌,获取令牌参考获取Token
customerCodeYes九方ERP系统为客户生成的唯一客户编码
customerInvoiceCodeYes九方ERP参考号,即客户所使用ERP系统中订单号
weightYes订单新重量,大于0的正实数

请求样例

JSON响应结果

六、获取追踪号

接口地址

请求地址

环境请求地址支持方法返回数据格式
生产环境http://www.tofba.com:8887/api/getOrderTrackNumberGET/POSTJSON
测试环境http://tofba1.f3322.net:8887/api/getOrderTrackNumberGET/POSTJSON

请求参数说明

请求参数Required描述
tokenYes请求令牌,获取令牌参考获取Token
customerCodeYes九方ERP系统为客户生成的唯一客户编码
customerInvoiceCodeYes参考号,即客户所使用ERP系统中订单号

请求样例

JSON响应结果

七、轨迹查询

接口地址

请求地址

环境请求地址支持方法返回数据格式
生产环境http://www.tofba.com:8887/api/getLogisticsTrackGET/POSTJSON
测试环境http://tofba1.f3322.net:8887/api/getLogisticsTrackGET/POSTJSON

请求参数说明

请求参数Required描述
tokenYes请求令牌,获取令牌参考获取Token
customerCodeYes九方ERP系统为客户生成的唯一客户编码
documentCodeYes追踪号,多个追踪号,分开,一次最多支持20个查询

请求样例

JSON响应结果