Bläddra i källkod

更新接口文档

gmw 6 år sedan
förälder
incheckning
cf8619db83
1 ändrade filer med 115 tillägg och 39 borttagningar
  1. 115 39
      README.md

+ 115 - 39
README.md

@@ -236,44 +236,120 @@
 ```
 其中OrderEntity结构如下:
 OrderEntity {
-    batchNumber (string): 批次号:创建订单可不填,确认批次必填
-    orderNumber (String): 订单号 必填 ,
-    wmsLocation (String): 集货位:可不填 ,
-    startAddress (String): 起始地:可不填 ,
-    endAddress (String): 目的地:可不填 ,
-    consigneeAddress (string): 收货人地址:必填 ,
-    consigneeCity (string): 收货人所在城市:必填 ,
-    consigneeDistrict (string): 收货人所在地区:可不填 ,
-    consigneeName (string): 收货人姓名:必填 ,
-    consigneePhone (string): 收货人电话:必填 ,
-    consigneeProvince (string): 收货人所在省份:可不填 ,
-    consignerAddress (string): 发货人地址:必填 ,
-    consignerCity (string): 发货人所在城市:必填 ,
-    consignerDistrict (string): 发货人所在地区:可不填 ,
-    consignerName (string): 发货人姓名:必填 ,
-    consignerPhone (string): 发货人电话:可不填 ,
-    consignerProvince (string): 发货人所在省份:可不填 ,
-    shipperPayType (int): 上游运费支付方式:可不填, 1:现付,2到付,3回付,4周结,5月结,6货款扣,7季度结
-    shipperPay (double): 上游运费:可不填 ,
-    driverPayType (int): 司机运费支付方式:可不填, 1:现付,2到付,3回付,4周结,5月结,6货款扣,7季度结
-    driverPay (double): 司机运费:可不填 ,
-    customerOrderNumber (string): 客户单号:可不填 ,
-    deliveryTime (integer): 提货时间:时间戳格式,必填 ,
-    appointArriveTime (integer): 预约送达时间:时间戳格式,可不填 ,
-    receiptCount (integer): 回单数量,默认1,可不填 ,
-    note (string): 订单备注:可不填,
-    freightCollect (double): 代收运费金额:可不填 ,
-    paymentCollect (double): 代收货款金额:可不填 ,
-    extraFields (map): 扩展字端:可不填 ,
-    organizationPath (string): 组织机构:可不填 ,
-    warehouseCode (string): 第三方参数:调度单号,可不填 ,
-    ownerCode (string): 第三方参数:调度单号,可不填 ,
-    scheduleOrderCode (string): 第三方参数:调度单号,可不填 ,
-    orderType (string): 第三方参数:业务类型,可不填 ,
-    deliveryArea (string): 第三方参数:配送区域 可不填 ,
-    preDeliveryTime (string): 第三方参数:预约送货时间 可不填 ,
-    payMode (string): 第三方参数:付款方式,可不填 ,
-    cargoList (List<CargoRequest>):货物列表:可不填
+        private String batchNumber;//批次号:创建订单可不填,确认批次必填
+
+        private String orderNumber;//订单号:两边订单唯一依据(必填)
+
+        private String wmsLocation; //集货位
+
+        private Integer deliveryTime; //提货时间:时间戳格式(必填)
+
+        private Integer deliveryType; //提送类型:选填, 1自提,2送货
+
+        private Integer appointArriveTime; //预约送到时间:时间戳格式,选填
+
+        private String customerOrderNumber; // 客户单号
+
+        private String startAddress; // 起始地
+
+        private String endAddress; // 目的地
+
+        private String consignerName;//发货人姓名(必填)
+
+        private String consignerPhone;//发货人电话
+
+        private String consignerAddress;//发货人地址(必填)
+
+        private String consignerProvince; // 发货人所在省份
+
+        private String consignerCity;//发货人所在城市(必填)
+
+        private String consignerDistrict;//发货人所在地区
+
+        private String consigneeName;//收货人姓名
+
+        private String consigneePhone;//收货人电话
+
+        private String consigneeAddress;//收货人地址
+
+        private String consigneeProvince; // 收货人所在省份
+
+        private String consigneeCity;//收货人所在城市
+
+        private String consigneeDistrict;//收货人所在地区
+
+        private Double shipperPay;//上游运费
+
+        private Integer shipperPayType; //上游运费支付方式:可不填, 1:现付,2到付,3回付,4周结,5月结,6货款扣,7季度结
+
+        private Double driverPay; //司机运费
+
+        private Integer driverPayType; //司机运费支付方式:可不填, 1:现付,2到付,3回付,4周结,5月结,6货款扣,7季度结
+
+        private Integer receiptCount; //回单数量
+
+        private Double freightCollect; //代收运费:可不填
+
+        private Double paymentCollect; //代收货款:可不填
+
+        private String warehouseCode;//第三方参数:仓库编码
+
+        private String ownerCode; //第三方参数:货主编码
+
+        private String scheduleOrderCode; //第三方参数:调度单号
+
+        private String orderType; //第三方参数:业务类型
+
+        private String deliveryArea; //第三方参数:配送区域
+
+        private String omsNumber; //第三方参数:oms订单号
+
+        private Integer preDeliveryTime; //第三方参数:预约送货时间
+
+        private String payMode; //第三方参数:付款方式
+
+        private String note; //备注:可不填
+
+        private Map<String, Object> extraFields; //扩展字端:可不填
+
+        private String organizationPath; // 所属组织路径, 可不填
+
+        private Double lng; //发货人经度
+
+        private Double lat; //发货人纬度
+
+        //货物列表
+        private List<CargoRequest> cargoList{
+                private String orderNumber;//订单号
+
+                private String cargoNumber;//货物号
+
+                private String weight;//重量
+
+                private String volume;//体积
+
+                private String quantity;//件数
+
+                private String value;//货值
+
+                private String status;//货物状态
+
+                private String name;//货物名称
+
+                private String productModel;// 货物备注
+
+                private String note1; // 自定义备注1
+
+                private String note2; // 自定义备注2
+
+                private String note3; // 自定义备注3
+
+                private String note4; // 自定义备注4
+
+                private String note5; // 自定义备注5
+
+                private String note6; // 自定义备注6
+        }
 }
 ```
 
@@ -619,7 +695,7 @@ OrderEntity {
 | `driverPhone` | 否 | `string` | 司机电话 |
 
 ```
-String driverPhone; //接单司机,支持批量,多个司机之间用逗号隔开
+driverPhone; //接单司机,支持批量,多个司机之间用逗号隔开
 orderList{
         private String batchNumber;//批次号:创建订单可不填,确认批次必填