做产品的经验一二

冰河系统(OMS)订单推送API

2017-05-06  本文已影响167人  higoIT

订单推送,更新API(订单在未生成出库单之前,重复推送,相当于更新订单信息,比如修改地址等可以通过此API实现,生成出库单之后,无法更新,不能重复推送)

OMS-->WMS-->EXPRESS的整体流程:

订单推送流程订单推送流程

测试API URL POST http://test.higo-express.cn/oms/api/v1/order/pushSalesOrder.do
正式API URL POST http://oms.higo-express.cn/oms/api/v1/order/pushSalesOrder.do

API V1.0调用方式:模拟表单提交,json,userKey,userValue参数,其中 json参数的值为标准JSON格式的字符串,注意转义json相关字符,具体字段含义参考字段要求

输入参数

   json:"销售单明细",
   userKey: "账号名称",
   userValue: "账号密码"

json参数示例

{
  "warehouseNO": "A001",
  "sourceOrderNO": "JB80739733295768-1",
  "salesOrderType": "0",
  "createOrderDate": "2015-03-31 17:06:17",
  "shipperName": "我是0",
  "shipperPhone": "13516803009",
  "postcode": "310000",
  "shipperEmail": "",
  "shipperProvince": "浙江省",
  "shipperCity": "杭州市",
  "shipperDistrict": "西湖区",
  "shipperAddress": "阜通东大街望京SOHO望京soho t3 3203",
  "meansOfPayment": "",
  "total": 68,
  "isInvoice": "N",
  "operater": "联想佳沃",
  "operateDate": "2015-10-13 17:36:39",
  "is_CP": "N",
  "distributionType": "community",
  "transport": "黑狗冷链",
  "transport_company": "HG",
  "expressType":"CRD",
  "expected":"2017-05-09",
  "expectedDate":"08:00-13:00",
  "detailSet": [
    {
      "goodsNO": "lxjwgoods_8",
      "unitPrice": 34,
      "qit": 1,
      "amount": 34,
      "purchasePrice":25
    }
  ]
}

json参数字段说明

字段 中文描述 类型 长度 是否必填 示例值
sourceOrderNO 订单来源单号 String 60 Y
salesOrderType 订单类型 int 1 Y 0 正常订单; 1 上门换货; 2 上门退货(暂时不用)
preSalesOrderNO 前订单号 String 60
createOrderDate 下单时间 datetime 2015-07-10 23:10:10
shipperName 收货人姓名 String 20 Y
shipperPhone 收货人电话 String 13 Y
postcode 收货人邮编 String 8
shipperEmail 收货人邮箱 String 40
shipperProvince 收货人省 String 40 Y
shipperCity 收货人城市 String 40 Y
shipperDistrict 收货人区 String 40 Y
shipperAddress 收货人详细地址 String 258 Y
meansOfPayment 支付方式 String 20
total 总金额 BigDeceimal 12,2
returnTotal 应退金额 BigDeceimal 12,2
isInvoice 是否开发票 String 1 Y N
invoiceTitle 发票抬头 String 128
invoiceContent 发票明细 longtext
waybillID 运单号 String 40 运单号系统自动生成,推送订单成功 会将运单号返回给调用方
remarks 备注 longtext
is_CP 是否自提 String 2 Y N
distributionType 配送范围类型 String 40 community (社区) school(校园)
transport 承运公司名称 String 20 Y 参考承运公司代码说明。示例:黑狗速递
transport_company 承运公司代码 String 20 Y 参考承运公司代码说明。示例:HG
transport_start_time 发货时间 datetime
warehouseNO 发货仓库 String Y 测试环境 A001 正式环境A01
expected 用户期望送达日期,如果不填,系统根据业务类型自动匹配期望送达日期 String 20 2017-05-09
expectedDate 用户期望到达时间段示例值:09:00-13:00 String 20 字符串组合。格式必须按照示例要求,24小时制, 低于10点的前面补充0
detailSet 订单明细(子类型)Set<SalesOrderDetail>
reservedfiled1 预留字段1 String 64 调用方可以根据需要使用预留字段
reservedfiled2 预留字段2 String 64 调用方可以根据需要使用预留字段
billing_account_no 结算帐号 String 64 例如:JS000123546
expressType 业务类型 String 20 只能为CRD, DRD, JSD, CCD四者之一。CRD:次日达, DRD:当日达, JSD: 极速达, CCD: 次晨达

销售明细 (details)说明

字段 中文描述 类型 长度 必填 示例值
goodsNO 产品编码 String 60 Y 1000020
unitPrice 销售单价 BigDecimal 12,2 Y 10.00
qit 数量 int Y 2
amount 金额 BigDecimal 12,2 Y 20.00
temperatureType 温区 String 32 Y 常温
remarks 备注信息 String 128 N 冻品请轻拿轻放
purchasePrice 采购单价 BigDecimal 12,2 N 10.00。如果与黑狗配送是按照采购单价费率计费,请传入此值。其它情况可以忽略此值。此值仅用于计算配送费,不会在系统其它任何地方显示

温区类型(temperatureType )字段说明

参照: http://www.jianshu.com/p/e6a2bb0c739c

承运公司。代码说明:transport_company(code, transport),冰河系统支持以下快递公司面单打印,使用字母编号,不允许使用数字

  HG(1, "黑狗速递"),
  SF(2, "顺丰速运"),
  SFDSTH(3, "顺丰电商特惠"),
  SFDSSP(4, "顺丰电商速配"),
  QFKD(5, "全峰快递"),
  RFD(6,"如风达"),
  CITY100(7,"城市100"),//U掌柜使用如风达面单
  YUNDA(8,"韵达快递"),
  DFRFD(9,"代发如风达");

API返回示例

{
  "data": {
    "sourceNO": "HG07132179431883",
    "externalExpressNO": "CK000000894",
    "waybillID": "4000001256",
  },
  "list": [
    
  ],
  "code": "failed",
  "msg": "错误提示信息",
  "fail": true
}

返回结果字段说明

字段 中文描述
data sourceNO:来源单号,externalExpressNO:冰河系统生成的对应销售单号,waybillID:冰河系统生成对应的运单号
list 保留字段,可以忽略
code 成功,失败标志,failed/success
msg 错误说明
fail 标识成功失败
上一篇下一篇

猜你喜欢

热点阅读