版权所有©，上海海鼎信息工程股份有限公司，2016-2025，保留所有权利。

接口

1. 接口定义

1.1. 销售单服务

1.1.1. 提交销售单

POST /{tenant_id}/soms/saleorderservice/saleorder
1.1.1.1. 说明

提交销售单

1.1.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order
必填

销售单

SaleOrder
1.1.1.3. 响应
HTTP代码 说明 类型

200

successful operation

SaleOrderSubmitResponse
1.1.1.4. HTTP请求示例
请求 path
/string/soms/saleorderservice/saleorder?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "88822222222",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "state" : "状态",
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:01",
    "modified" : "2016-03-02 12:00:01",
    "state" : "已付款",
    "logs" : "[]",
    "order_id" : "1223654",
    "third_order_id" : "1223654",
    "main_order_id" : "1223432",
    "station_id" : "254145",
    "station_name" : "254145",
    "station_order_no" : "1",
    "order_type" : "string",
    "wrh" : {
      "id" : "string",
      "name" : "string"
    },
    "logistic" : {
      "id" : "string",
      "name" : "string"
    },
    "extend_props" : "string"
  },
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "distributionInfo" : {
    "distributor" : {
      "id" : "string",
      "name" : "string"
    },
    "tcOrderId" : "1223432"
  },
  "exceptions" : [ {
    "code" : "sku",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "weight" : 500.0,
  "invoice" : {
    "required" : false,
    "result" : "开票成功",
    "details" : [ {
      "type" : "plain",
      "kind" : "paper",
      "title" : "XX公司",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "account" : "0023415445",
      "telephone" : "12344545111",
      "bank" : "中国银行XXX",
      "address" : "福建厦门XX",
      "remark" : "plain",
      "email" : "chw@qq.com",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622",
      "serial_no" : "454557884564545"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  },
  "payment" : {
    "type" : "online",
    "state" : "paid",
    "payee" : {
      "id" : "string",
      "name" : "string"
    },
    "amount" : 14.02,
    "freight" : 14.02,
    "details" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "type" : "5",
      "amount" : 12.33,
      "cashier" : true,
      "score" : 100.0,
      "flowno" : "3223232323",
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "pay_time" : "2019-03-02 12:00:01",
    "pay_bill_id" : "0122333333",
    "cod_amount" : 0.0,
    "earnest_amount" : 0.0,
    "package_total" : 14.02,
    "other_fee" : 0.0
  },
  "delivery" : {
    "type" : "deliver",
    "state" : "none",
    "receiver" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "waybills" : [ {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "expected_logistics_type" : "crowdsourcing",
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "suggest_station" : {
        "id" : "string",
        "name" : "string"
      },
      "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station" : {
        "id" : "string",
        "name" : "string"
      },
      "waybill_id" : "123"
    } ],
    "remark" : "定时达",
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "ship_mode" : "wrhShip",
    "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
    "pre_start_delivery_time" : "2016-03-02 12:00:01",
    "pre_end_delivery_time" : "2016-03-02 14:00:01",
    "pickup_code" : "123456",
    "city_token" : "123456",
    "selftake_code" : "123456",
    "pre_selftake_time" : "03月05日 晚上",
    "operation_state" : "none"
  },
  "items" : [ {
    "uuid" : "string",
    "itemNo" : "1",
    "itemId" : "1",
    "skuId" : "00321",
    "productId" : "2123",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "price" : 122.34,
    "front" : {
      "goods" : {
        "id" : "string",
        "code" : "string",
        "name" : "string"
      },
      "spec" : {
        "id" : "string",
        "code" : "string",
        "name" : "string"
      },
      "spec2" : "500g",
      "barcode" : "121231313",
      "oid" : "string",
      "status" : "string",
      "wrh" : {
        "id" : "string",
        "name" : "string"
      },
      "sku_id" : "052700601",
      "goods_class" : "类型",
      "goods_unit" : "单位",
      "refund_id" : "string",
      "refund_status" : "string",
      "tc_order_id" : "string",
      "tc_payment" : "string",
      "extend_props" : "string",
      "virtual_wrh" : {
        "id" : "string",
        "name" : "string"
      }
    },
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "child_type" : "string",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]",
        "extra_info" : "{\"thirdType\": \"42\"}"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "details" : [ {
      "id" : "detailSkuId123",
      "title" : "detailSkuName123",
      "quantity" : 0.0,
      "ratio" : 0.0,
      "upc" : "upc123"
    } ],
    "state" : "子订单状态",
    "saleOrderId" : "string",
    "gift" : true,
    "combined" : true,
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "pay_amount" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_total" : 205.44,
    "cost_price" : 122.34,
    "lock_detail" : {
      "state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
      "stock_type" : "占货类型： third（外部库存）、purchase(采购库存)、wrh（仓库库存）、store（门店库存）"
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "order_state" : "string",
    "order_id" : "681795759987",
    "salesman_type" : "author",
    "salesman_id" : "123",
    "salesman_name" : "榕榕",
    "orig_sku_id" : "skuId123",
    "orig_item_title" : "skuName123",
    "orig_barcode" : "skuBarcode123",
    "orig_weight" : 1.0,
    "orig_image_url" : "string",
    "orig_extra_info" : {
      "spec" : "1*1",
      "unit" : "个"
    },
    "orig_qty" : 1.0,
    "orig_price" : 1.0,
    "settle_total" : 1.2,
    "settle_price" : 1.2,
    "shop_total" : 1.2,
    "shop_price" : 1.2,
    "settle_discount_amount" : 1.2,
    "extra_info" : "1.20",
    "image_url" : "http://aaa/bbb.png",
    "weight" : 1.0,
    "package_qty" : 125.0
  } ],
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "child_type" : "string",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]",
      "extra_info" : "{\"thirdType\": \"42\"}"
    } ]
  },
  "source_system" : "string",
  "lock_state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
  "customer_note" : "note",
  "seller_note" : "note",
  "seller_append_note" : "note",
  "salesman" : {
    "id" : "string",
    "name" : "string",
    "type" : "saleman",
    "org" : {
      "id" : "string",
      "name" : "string"
    },
    "org_type" : "门店",
    "inviter_mobile" : "18859226552",
    "inviter_name" : "王x",
    "inviter_wid" : "7567645",
    "personal_guider_name" : "王x",
    "personal_guider_no" : "3242323",
    "personal_guider_wid" : "3242323",
    "trade_guider_name" : "王x",
    "trade_guider_no" : "65756",
    "trade_guider_wid" : "45345",
    "weike_mobile" : "18859226552",
    "weike_name" : "张三",
    "weike_wid" : "765765756"
  },
  "cancel_reason" : "我不想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "商品不存在",
  "orig_total" : 120.01,
  "settle_commission" : 120.01,
  "cancel_type" : "customerCancel",
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "suspend_info" : {
    "suspended" : true,
    "code" : "string",
    "caption" : "string",
    "time" : "2017-12-26 16:40:19"
  },
  "member_info" : {
    "member_id" : "12253",
    "card_no" : "22323",
    "member_gid" : "12253",
    "outer_member_id" : "12253",
    "mobile" : "12253",
    "member_extra" : "{\"namespace\":\"wexinApp\",\"member_channel_type\":\"type\",\"member_channel_id\":\"123\",\"member_ident_type\":\"ident\"}"
  },
  "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0,
      "balance" : 100.0
    }
  },
  "settle_info" : {
    "settlable" : true,
    "discounts" : "[{}]",
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string"
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "shop_amount" : 0.0,
  "settle_amount" : 0.0,
  "settle_freight" : 0.0,
  "real_total" : 0.0
}
1.1.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "sale_order_id" : "string"
}

1.1.2. 取指定平台销售单

GET /{tenant_id}/soms/saleorderservice/saleorder/front/{front_order_id}
1.1.2.1. 说明

取指定平台销售单

1.1.2.2. 参数
类型 名称 说明 类型

Path

front_order_id
必填

平台销售单id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用,隔开。

string

Query

platform_id
必填

平台id

string
1.1.2.3. 响应
HTTP代码 说明 类型

200

successful operation

SaleOrder
1.1.2.4. HTTP请求示例
请求 path
/string/soms/saleorderservice/saleorder/front/string?platform_id=string
1.1.2.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "88822222222",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "state" : "状态",
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:01",
    "modified" : "2016-03-02 12:00:01",
    "state" : "已付款",
    "logs" : "[]",
    "order_id" : "1223654",
    "third_order_id" : "1223654",
    "main_order_id" : "1223432",
    "station_id" : "254145",
    "station_name" : "254145",
    "station_order_no" : "1",
    "order_type" : "string",
    "wrh" : {
      "id" : "string",
      "name" : "string"
    },
    "logistic" : {
      "id" : "string",
      "name" : "string"
    },
    "extend_props" : "string"
  },
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "distributionInfo" : {
    "distributor" : {
      "id" : "string",
      "name" : "string"
    },
    "tcOrderId" : "1223432"
  },
  "exceptions" : [ {
    "code" : "sku",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "weight" : 500.0,
  "invoice" : {
    "required" : false,
    "result" : "开票成功",
    "details" : [ {
      "type" : "plain",
      "kind" : "paper",
      "title" : "XX公司",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "account" : "0023415445",
      "telephone" : "12344545111",
      "bank" : "中国银行XXX",
      "address" : "福建厦门XX",
      "remark" : "plain",
      "email" : "chw@qq.com",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622",
      "serial_no" : "454557884564545"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  },
  "payment" : {
    "type" : "online",
    "state" : "paid",
    "payee" : {
      "id" : "string",
      "name" : "string"
    },
    "amount" : 14.02,
    "freight" : 14.02,
    "details" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "type" : "5",
      "amount" : 12.33,
      "cashier" : true,
      "score" : 100.0,
      "flowno" : "3223232323",
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "pay_time" : "2019-03-02 12:00:01",
    "pay_bill_id" : "0122333333",
    "cod_amount" : 0.0,
    "earnest_amount" : 0.0,
    "package_total" : 14.02,
    "other_fee" : 0.0
  },
  "delivery" : {
    "type" : "deliver",
    "state" : "none",
    "receiver" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "waybills" : [ {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "expected_logistics_type" : "crowdsourcing",
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "suggest_station" : {
        "id" : "string",
        "name" : "string"
      },
      "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station" : {
        "id" : "string",
        "name" : "string"
      },
      "waybill_id" : "123"
    } ],
    "remark" : "定时达",
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "ship_mode" : "wrhShip",
    "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
    "pre_start_delivery_time" : "2016-03-02 12:00:01",
    "pre_end_delivery_time" : "2016-03-02 14:00:01",
    "pickup_code" : "123456",
    "city_token" : "123456",
    "selftake_code" : "123456",
    "pre_selftake_time" : "03月05日 晚上",
    "operation_state" : "none"
  },
  "items" : [ {
    "uuid" : "string",
    "itemNo" : "1",
    "itemId" : "1",
    "skuId" : "00321",
    "productId" : "2123",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "price" : 122.34,
    "front" : {
      "goods" : {
        "id" : "string",
        "code" : "string",
        "name" : "string"
      },
      "spec" : {
        "id" : "string",
        "code" : "string",
        "name" : "string"
      },
      "spec2" : "500g",
      "barcode" : "121231313",
      "oid" : "string",
      "status" : "string",
      "wrh" : {
        "id" : "string",
        "name" : "string"
      },
      "sku_id" : "052700601",
      "goods_class" : "类型",
      "goods_unit" : "单位",
      "refund_id" : "string",
      "refund_status" : "string",
      "tc_order_id" : "string",
      "tc_payment" : "string",
      "extend_props" : "string",
      "virtual_wrh" : {
        "id" : "string",
        "name" : "string"
      }
    },
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "child_type" : "string",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]",
        "extra_info" : "{\"thirdType\": \"42\"}"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "details" : [ {
      "id" : "detailSkuId123",
      "title" : "detailSkuName123",
      "quantity" : 0.0,
      "ratio" : 0.0,
      "upc" : "upc123"
    } ],
    "state" : "子订单状态",
    "saleOrderId" : "string",
    "gift" : true,
    "combined" : true,
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "pay_amount" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_total" : 205.44,
    "cost_price" : 122.34,
    "lock_detail" : {
      "state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
      "stock_type" : "占货类型： third（外部库存）、purchase(采购库存)、wrh（仓库库存）、store（门店库存）"
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "order_state" : "string",
    "order_id" : "681795759987",
    "salesman_type" : "author",
    "salesman_id" : "123",
    "salesman_name" : "榕榕",
    "orig_sku_id" : "skuId123",
    "orig_item_title" : "skuName123",
    "orig_barcode" : "skuBarcode123",
    "orig_weight" : 1.0,
    "orig_image_url" : "string",
    "orig_extra_info" : {
      "spec" : "1*1",
      "unit" : "个"
    },
    "orig_qty" : 1.0,
    "orig_price" : 1.0,
    "settle_total" : 1.2,
    "settle_price" : 1.2,
    "shop_total" : 1.2,
    "shop_price" : 1.2,
    "settle_discount_amount" : 1.2,
    "extra_info" : "1.20",
    "image_url" : "http://aaa/bbb.png",
    "weight" : 1.0,
    "package_qty" : 125.0
  } ],
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "child_type" : "string",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]",
      "extra_info" : "{\"thirdType\": \"42\"}"
    } ]
  },
  "source_system" : "string",
  "lock_state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
  "customer_note" : "note",
  "seller_note" : "note",
  "seller_append_note" : "note",
  "salesman" : {
    "id" : "string",
    "name" : "string",
    "type" : "saleman",
    "org" : {
      "id" : "string",
      "name" : "string"
    },
    "org_type" : "门店",
    "inviter_mobile" : "18859226552",
    "inviter_name" : "王x",
    "inviter_wid" : "7567645",
    "personal_guider_name" : "王x",
    "personal_guider_no" : "3242323",
    "personal_guider_wid" : "3242323",
    "trade_guider_name" : "王x",
    "trade_guider_no" : "65756",
    "trade_guider_wid" : "45345",
    "weike_mobile" : "18859226552",
    "weike_name" : "张三",
    "weike_wid" : "765765756"
  },
  "cancel_reason" : "我不想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "商品不存在",
  "orig_total" : 120.01,
  "settle_commission" : 120.01,
  "cancel_type" : "customerCancel",
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "suspend_info" : {
    "suspended" : true,
    "code" : "string",
    "caption" : "string",
    "time" : "2017-12-26 16:40:19"
  },
  "member_info" : {
    "member_id" : "12253",
    "card_no" : "22323",
    "member_gid" : "12253",
    "outer_member_id" : "12253",
    "mobile" : "12253",
    "member_extra" : "{\"namespace\":\"wexinApp\",\"member_channel_type\":\"type\",\"member_channel_id\":\"123\",\"member_ident_type\":\"ident\"}"
  },
  "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0,
      "balance" : 100.0
    }
  },
  "settle_info" : {
    "settlable" : true,
    "discounts" : "[{}]",
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string"
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "shop_amount" : 0.0,
  "settle_amount" : 0.0,
  "settle_freight" : 0.0,
  "real_total" : 0.0
}

1.1.3. 取指定销售单

GET /{tenant_id}/soms/saleorderservice/saleorder/{id}
1.1.3.1. 说明

取指定销售单

1.1.3.2. 参数
类型 名称 说明 类型

Path

sale_order_id
必填

销售单id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用,隔开。

string
1.1.3.3. 响应
HTTP代码 说明 类型

200

successful operation

SaleOrder
1.1.3.4. HTTP请求示例
请求 path
/string/soms/saleorderservice/saleorder/{id}
1.1.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "88822222222",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "state" : "状态",
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:01",
    "modified" : "2016-03-02 12:00:01",
    "state" : "已付款",
    "logs" : "[]",
    "order_id" : "1223654",
    "third_order_id" : "1223654",
    "main_order_id" : "1223432",
    "station_id" : "254145",
    "station_name" : "254145",
    "station_order_no" : "1",
    "order_type" : "string",
    "wrh" : {
      "id" : "string",
      "name" : "string"
    },
    "logistic" : {
      "id" : "string",
      "name" : "string"
    },
    "extend_props" : "string"
  },
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "distributionInfo" : {
    "distributor" : {
      "id" : "string",
      "name" : "string"
    },
    "tcOrderId" : "1223432"
  },
  "exceptions" : [ {
    "code" : "sku",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "weight" : 500.0,
  "invoice" : {
    "required" : false,
    "result" : "开票成功",
    "details" : [ {
      "type" : "plain",
      "kind" : "paper",
      "title" : "XX公司",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "account" : "0023415445",
      "telephone" : "12344545111",
      "bank" : "中国银行XXX",
      "address" : "福建厦门XX",
      "remark" : "plain",
      "email" : "chw@qq.com",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622",
      "serial_no" : "454557884564545"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  },
  "payment" : {
    "type" : "online",
    "state" : "paid",
    "payee" : {
      "id" : "string",
      "name" : "string"
    },
    "amount" : 14.02,
    "freight" : 14.02,
    "details" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "type" : "5",
      "amount" : 12.33,
      "cashier" : true,
      "score" : 100.0,
      "flowno" : "3223232323",
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "pay_time" : "2019-03-02 12:00:01",
    "pay_bill_id" : "0122333333",
    "cod_amount" : 0.0,
    "earnest_amount" : 0.0,
    "package_total" : 14.02,
    "other_fee" : 0.0
  },
  "delivery" : {
    "type" : "deliver",
    "state" : "none",
    "receiver" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "waybills" : [ {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "expected_logistics_type" : "crowdsourcing",
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "suggest_station" : {
        "id" : "string",
        "name" : "string"
      },
      "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station" : {
        "id" : "string",
        "name" : "string"
      },
      "waybill_id" : "123"
    } ],
    "remark" : "定时达",
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "ship_mode" : "wrhShip",
    "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
    "pre_start_delivery_time" : "2016-03-02 12:00:01",
    "pre_end_delivery_time" : "2016-03-02 14:00:01",
    "pickup_code" : "123456",
    "city_token" : "123456",
    "selftake_code" : "123456",
    "pre_selftake_time" : "03月05日 晚上",
    "operation_state" : "none"
  },
  "items" : [ {
    "uuid" : "string",
    "itemNo" : "1",
    "itemId" : "1",
    "skuId" : "00321",
    "productId" : "2123",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "price" : 122.34,
    "front" : {
      "goods" : {
        "id" : "string",
        "code" : "string",
        "name" : "string"
      },
      "spec" : {
        "id" : "string",
        "code" : "string",
        "name" : "string"
      },
      "spec2" : "500g",
      "barcode" : "121231313",
      "oid" : "string",
      "status" : "string",
      "wrh" : {
        "id" : "string",
        "name" : "string"
      },
      "sku_id" : "052700601",
      "goods_class" : "类型",
      "goods_unit" : "单位",
      "refund_id" : "string",
      "refund_status" : "string",
      "tc_order_id" : "string",
      "tc_payment" : "string",
      "extend_props" : "string",
      "virtual_wrh" : {
        "id" : "string",
        "name" : "string"
      }
    },
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "child_type" : "string",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]",
        "extra_info" : "{\"thirdType\": \"42\"}"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "details" : [ {
      "id" : "detailSkuId123",
      "title" : "detailSkuName123",
      "quantity" : 0.0,
      "ratio" : 0.0,
      "upc" : "upc123"
    } ],
    "state" : "子订单状态",
    "saleOrderId" : "string",
    "gift" : true,
    "combined" : true,
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "pay_amount" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_total" : 205.44,
    "cost_price" : 122.34,
    "lock_detail" : {
      "state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
      "stock_type" : "占货类型： third（外部库存）、purchase(采购库存)、wrh（仓库库存）、store（门店库存）"
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "order_state" : "string",
    "order_id" : "681795759987",
    "salesman_type" : "author",
    "salesman_id" : "123",
    "salesman_name" : "榕榕",
    "orig_sku_id" : "skuId123",
    "orig_item_title" : "skuName123",
    "orig_barcode" : "skuBarcode123",
    "orig_weight" : 1.0,
    "orig_image_url" : "string",
    "orig_extra_info" : {
      "spec" : "1*1",
      "unit" : "个"
    },
    "orig_qty" : 1.0,
    "orig_price" : 1.0,
    "settle_total" : 1.2,
    "settle_price" : 1.2,
    "shop_total" : 1.2,
    "shop_price" : 1.2,
    "settle_discount_amount" : 1.2,
    "extra_info" : "1.20",
    "image_url" : "http://aaa/bbb.png",
    "weight" : 1.0,
    "package_qty" : 125.0
  } ],
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "child_type" : "string",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]",
      "extra_info" : "{\"thirdType\": \"42\"}"
    } ]
  },
  "source_system" : "string",
  "lock_state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
  "customer_note" : "note",
  "seller_note" : "note",
  "seller_append_note" : "note",
  "salesman" : {
    "id" : "string",
    "name" : "string",
    "type" : "saleman",
    "org" : {
      "id" : "string",
      "name" : "string"
    },
    "org_type" : "门店",
    "inviter_mobile" : "18859226552",
    "inviter_name" : "王x",
    "inviter_wid" : "7567645",
    "personal_guider_name" : "王x",
    "personal_guider_no" : "3242323",
    "personal_guider_wid" : "3242323",
    "trade_guider_name" : "王x",
    "trade_guider_no" : "65756",
    "trade_guider_wid" : "45345",
    "weike_mobile" : "18859226552",
    "weike_name" : "张三",
    "weike_wid" : "765765756"
  },
  "cancel_reason" : "我不想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "商品不存在",
  "orig_total" : 120.01,
  "settle_commission" : 120.01,
  "cancel_type" : "customerCancel",
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "suspend_info" : {
    "suspended" : true,
    "code" : "string",
    "caption" : "string",
    "time" : "2017-12-26 16:40:19"
  },
  "member_info" : {
    "member_id" : "12253",
    "card_no" : "22323",
    "member_gid" : "12253",
    "outer_member_id" : "12253",
    "mobile" : "12253",
    "member_extra" : "{\"namespace\":\"wexinApp\",\"member_channel_type\":\"type\",\"member_channel_id\":\"123\",\"member_ident_type\":\"ident\"}"
  },
  "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0,
      "balance" : 100.0
    }
  },
  "settle_info" : {
    "settlable" : true,
    "discounts" : "[{}]",
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string"
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "shop_amount" : 0.0,
  "settle_amount" : 0.0,
  "settle_freight" : 0.0,
  "real_total" : 0.0
}

1.1.4. 更新销售订单配送状态

POST /{tenant_id}/soms/saleorderservice/saleorder/{id}/action/deliver
1.1.4.1. 说明

更新销售订单配送状态

1.1.4.2. 参数
类型 名称 说明 类型

Path

id
必填

销售订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

SaleOrderDeliverRequest
1.1.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.4.4. HTTP请求示例
请求 path
/string/soms/saleorderservice/saleorder/string/action/deliver?operator=string
请求 body
{
  "operator" : "zhangsan",
  "waybillId" : "1243566215",
  "delivery_state" : "none",
  "front_modified" : "2016-03-02 12:00:01"
}
1.1.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.5. 取指定销售单

GET /{tenant_id}/soms/saleorderservice/saleorders
1.1.5.1. 说明

取指定销售单

1.1.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用,隔开。

string

Query

sale_order_id
必填

销售单id

< string > array(multi)
1.1.5.3. 响应
HTTP代码 说明 类型

200

successful operation

SaleOrderList
1.1.5.4. HTTP请求示例
请求 path
/string/soms/saleorderservice/saleorders?sale_order_id=string
1.1.5.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "sale_orders" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "88822222222",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "state" : "状态",
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "shop" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:01",
      "modified" : "2016-03-02 12:00:01",
      "state" : "已付款",
      "logs" : "[]",
      "order_id" : "1223654",
      "third_order_id" : "1223654",
      "main_order_id" : "1223432",
      "station_id" : "254145",
      "station_name" : "254145",
      "station_order_no" : "1",
      "order_type" : "string",
      "wrh" : {
        "id" : "string",
        "name" : "string"
      },
      "logistic" : {
        "id" : "string",
        "name" : "string"
      },
      "extend_props" : "string"
    },
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "distributionInfo" : {
      "distributor" : {
        "id" : "string",
        "name" : "string"
      },
      "tcOrderId" : "1223432"
    },
    "exceptions" : [ {
      "code" : "sku",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "weight" : 500.0,
    "invoice" : {
      "required" : false,
      "result" : "开票成功",
      "details" : [ {
        "type" : "plain",
        "kind" : "paper",
        "title" : "XX公司",
        "content" : "上海股份有限公司",
        "amount" : 12.03,
        "tax" : 2.32,
        "account" : "0023415445",
        "telephone" : "12344545111",
        "bank" : "中国银行XXX",
        "address" : "福建厦门XX",
        "remark" : "plain",
        "email" : "chw@qq.com",
        "time" : "2019-07-15 16:56:23",
        "url" : "a.jpg",
        "title_type" : "person",
        "buyer_tax_code" : "1232000046600736XP",
        "taxer_id" : "1212345046600736XP",
        "print_number" : "123456",
        "securaty_code" : "2114445",
        "check_code" : "201622",
        "serial_no" : "454557884564545"
      } ],
      "error_reason" : "string",
      "apply_qrcode" : "string"
    },
    "payment" : {
      "type" : "online",
      "state" : "paid",
      "payee" : {
        "id" : "string",
        "name" : "string"
      },
      "amount" : 14.02,
      "freight" : 14.02,
      "details" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "type" : "5",
        "amount" : 12.33,
        "cashier" : true,
        "score" : 100.0,
        "flowno" : "3223232323",
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "pay_time" : "2019-03-02 12:00:01",
      "pay_bill_id" : "0122333333",
      "cod_amount" : 0.0,
      "earnest_amount" : 0.0,
      "package_total" : 14.02,
      "other_fee" : 0.0
    },
    "delivery" : {
      "type" : "deliver",
      "state" : "none",
      "receiver" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "张*红",
          "private_mobile" : "189****0000"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "waybills" : [ {
        "station" : {
          "id" : "string",
          "name" : "string"
        },
        "carrier" : {
          "state" : "initial",
          "type" : "self",
          "carrier" : {
            "id" : "string",
            "name" : "string"
          },
          "merchant" : {
            "id" : "string",
            "name" : "string"
          },
          "deliveryman" : {
            "id" : "string",
            "name" : "string"
          },
          "expected_logistics_type" : "crowdsourcing",
          "deliveryman_mobile" : "18859658865",
          "exception_reason" : "异常原因",
          "delivery_id" : "8548418",
          "delivery_name" : "8548418"
        },
        "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "suggest_station" : {
          "id" : "string",
          "name" : "string"
        },
        "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station" : {
          "id" : "string",
          "name" : "string"
        },
        "waybill_id" : "123"
      } ],
      "remark" : "定时达",
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "ship_mode" : "wrhShip",
      "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
      "pre_start_delivery_time" : "2016-03-02 12:00:01",
      "pre_end_delivery_time" : "2016-03-02 14:00:01",
      "pickup_code" : "123456",
      "city_token" : "123456",
      "selftake_code" : "123456",
      "pre_selftake_time" : "03月05日 晚上",
      "operation_state" : "none"
    },
    "items" : [ {
      "uuid" : "string",
      "itemNo" : "1",
      "itemId" : "1",
      "skuId" : "00321",
      "productId" : "2123",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "price" : 122.34,
      "front" : {
        "goods" : {
          "id" : "string",
          "code" : "string",
          "name" : "string"
        },
        "spec" : {
          "id" : "string",
          "code" : "string",
          "name" : "string"
        },
        "spec2" : "500g",
        "barcode" : "121231313",
        "oid" : "string",
        "status" : "string",
        "wrh" : {
          "id" : "string",
          "name" : "string"
        },
        "sku_id" : "052700601",
        "goods_class" : "类型",
        "goods_unit" : "单位",
        "refund_id" : "string",
        "refund_status" : "string",
        "tc_order_id" : "string",
        "tc_payment" : "string",
        "extend_props" : "string",
        "virtual_wrh" : {
          "id" : "string",
          "name" : "string"
        }
      },
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "child_type" : "string",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]",
          "extra_info" : "{\"thirdType\": \"42\"}"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "details" : [ {
        "id" : "detailSkuId123",
        "title" : "detailSkuName123",
        "quantity" : 0.0,
        "ratio" : 0.0,
        "upc" : "upc123"
      } ],
      "state" : "子订单状态",
      "saleOrderId" : "string",
      "gift" : true,
      "combined" : true,
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_total" : 205.44,
      "cost_price" : 122.34,
      "lock_detail" : {
        "state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
        "stock_type" : "占货类型： third（外部库存）、purchase(采购库存)、wrh（仓库库存）、store（门店库存）"
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "order_state" : "string",
      "order_id" : "681795759987",
      "salesman_type" : "author",
      "salesman_id" : "123",
      "salesman_name" : "榕榕",
      "orig_sku_id" : "skuId123",
      "orig_item_title" : "skuName123",
      "orig_barcode" : "skuBarcode123",
      "orig_weight" : 1.0,
      "orig_image_url" : "string",
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "orig_qty" : 1.0,
      "orig_price" : 1.0,
      "settle_total" : 1.2,
      "settle_price" : 1.2,
      "shop_total" : 1.2,
      "shop_price" : 1.2,
      "settle_discount_amount" : 1.2,
      "extra_info" : "1.20",
      "image_url" : "http://aaa/bbb.png",
      "weight" : 1.0,
      "package_qty" : 125.0
    } ],
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "child_type" : "string",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]",
        "extra_info" : "{\"thirdType\": \"42\"}"
      } ]
    },
    "source_system" : "string",
    "lock_state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
    "customer_note" : "note",
    "seller_note" : "note",
    "seller_append_note" : "note",
    "salesman" : {
      "id" : "string",
      "name" : "string",
      "type" : "saleman",
      "org" : {
        "id" : "string",
        "name" : "string"
      },
      "org_type" : "门店",
      "inviter_mobile" : "18859226552",
      "inviter_name" : "王x",
      "inviter_wid" : "7567645",
      "personal_guider_name" : "王x",
      "personal_guider_no" : "3242323",
      "personal_guider_wid" : "3242323",
      "trade_guider_name" : "王x",
      "trade_guider_no" : "65756",
      "trade_guider_wid" : "45345",
      "weike_mobile" : "18859226552",
      "weike_name" : "张三",
      "weike_wid" : "765765756"
    },
    "cancel_reason" : "我不想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "商品不存在",
    "orig_total" : 120.01,
    "settle_commission" : 120.01,
    "cancel_type" : "customerCancel",
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "suspend_info" : {
      "suspended" : true,
      "code" : "string",
      "caption" : "string",
      "time" : "2017-12-26 16:40:19"
    },
    "member_info" : {
      "member_id" : "12253",
      "card_no" : "22323",
      "member_gid" : "12253",
      "outer_member_id" : "12253",
      "mobile" : "12253",
      "member_extra" : "{\"namespace\":\"wexinApp\",\"member_channel_type\":\"type\",\"member_channel_id\":\"123\",\"member_ident_type\":\"ident\"}"
    },
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0,
        "balance" : 100.0
      }
    },
    "settle_info" : {
      "settlable" : true,
      "discounts" : "[{}]",
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "shop_amount" : 0.0,
    "settle_amount" : 0.0,
    "settle_freight" : 0.0,
    "real_total" : 0.0
  } ]
}

1.1.6. 查询销售单

POST /{tenant_id}/soms/saleorderservice/saleorders/query
1.1.6.1. 说明

查询销售单（ES查询，推荐使用）

1.1.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
必填

页码，从0开始，必须>=0

integer (int32)

Query

page_size
必填

分页大小，范围是[1,100]

integer (int32)

Query

sort_key
可选

排序字段，取值范围:front_created()、created(创建时间)、modified(最后修改时间)

string

Body

filter
必填

查询条件

SaleOrderFilter
1.1.6.3. 响应
HTTP代码 说明 类型

200

successful operation

SaleOrderPaging
1.1.6.4. HTTP请求示例
请求 path
/string/soms/saleorderservice/saleorders/query?desc=true&page=0&page_size=0
请求 body
{
  "platformIds" : [ "string" ],
  "states" : [ "confirmed" ],
  "exceptionRemark" : "名称",
  "hasException" : true,
  "platform_id" : "jdo2o",
  "shop_id" : "0002",
  "shop_id_in" : "0002",
  "created_start" : "2016-03-02 12:00:01",
  "created_end" : "2016-03-02 12:00:01",
  "order_id" : "1000002111",
  "order_ids" : [ "string" ],
  "lock_stock_type_eq" : "wrh",
  "lock_state_in" : "wrh",
  "waybill_station_type_eq" : "wrh",
  "waybill_station_id_eq" : "1001",
  "pre_type" : "normal",
  "customer_name" : "张三",
  "customer_id" : "8568",
  "customer_mobile" : "8568",
  "front_order_id" : "32323232323323",
  "id_prefix" : "32323232323323",
  "front_order_id_prefix" : "32323232323323",
  "front_order_ids" : "32323232323323",
  "front_created_start" : "2016-03-02 12:00:01",
  "front_created_end" : "2016-03-02 12:00:01",
  "waybill_id_eq" : "32323232323323",
  "tag_eq" : "赔付订单",
  "sku_id_eq" : "AZ3J",
  "sku_title_eq" : "名称",
  "order_store_code_in" : "true"
}
1.1.6.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "saleOrders" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "88822222222",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "state" : "状态",
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "shop" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:01",
      "modified" : "2016-03-02 12:00:01",
      "state" : "已付款",
      "logs" : "[]",
      "order_id" : "1223654",
      "third_order_id" : "1223654",
      "main_order_id" : "1223432",
      "station_id" : "254145",
      "station_name" : "254145",
      "station_order_no" : "1",
      "order_type" : "string",
      "wrh" : {
        "id" : "string",
        "name" : "string"
      },
      "logistic" : {
        "id" : "string",
        "name" : "string"
      },
      "extend_props" : "string"
    },
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "distributionInfo" : {
      "distributor" : {
        "id" : "string",
        "name" : "string"
      },
      "tcOrderId" : "1223432"
    },
    "exceptions" : [ {
      "code" : "sku",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "weight" : 500.0,
    "invoice" : {
      "required" : false,
      "result" : "开票成功",
      "details" : [ {
        "type" : "plain",
        "kind" : "paper",
        "title" : "XX公司",
        "content" : "上海股份有限公司",
        "amount" : 12.03,
        "tax" : 2.32,
        "account" : "0023415445",
        "telephone" : "12344545111",
        "bank" : "中国银行XXX",
        "address" : "福建厦门XX",
        "remark" : "plain",
        "email" : "chw@qq.com",
        "time" : "2019-07-15 16:56:23",
        "url" : "a.jpg",
        "title_type" : "person",
        "buyer_tax_code" : "1232000046600736XP",
        "taxer_id" : "1212345046600736XP",
        "print_number" : "123456",
        "securaty_code" : "2114445",
        "check_code" : "201622",
        "serial_no" : "454557884564545"
      } ],
      "error_reason" : "string",
      "apply_qrcode" : "string"
    },
    "payment" : {
      "type" : "online",
      "state" : "paid",
      "payee" : {
        "id" : "string",
        "name" : "string"
      },
      "amount" : 14.02,
      "freight" : 14.02,
      "details" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "type" : "5",
        "amount" : 12.33,
        "cashier" : true,
        "score" : 100.0,
        "flowno" : "3223232323",
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "pay_time" : "2019-03-02 12:00:01",
      "pay_bill_id" : "0122333333",
      "cod_amount" : 0.0,
      "earnest_amount" : 0.0,
      "package_total" : 14.02,
      "other_fee" : 0.0
    },
    "delivery" : {
      "type" : "deliver",
      "state" : "none",
      "receiver" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "张*红",
          "private_mobile" : "189****0000"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "waybills" : [ {
        "station" : {
          "id" : "string",
          "name" : "string"
        },
        "carrier" : {
          "state" : "initial",
          "type" : "self",
          "carrier" : {
            "id" : "string",
            "name" : "string"
          },
          "merchant" : {
            "id" : "string",
            "name" : "string"
          },
          "deliveryman" : {
            "id" : "string",
            "name" : "string"
          },
          "expected_logistics_type" : "crowdsourcing",
          "deliveryman_mobile" : "18859658865",
          "exception_reason" : "异常原因",
          "delivery_id" : "8548418",
          "delivery_name" : "8548418"
        },
        "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "suggest_station" : {
          "id" : "string",
          "name" : "string"
        },
        "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station" : {
          "id" : "string",
          "name" : "string"
        },
        "waybill_id" : "123"
      } ],
      "remark" : "定时达",
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "ship_mode" : "wrhShip",
      "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
      "pre_start_delivery_time" : "2016-03-02 12:00:01",
      "pre_end_delivery_time" : "2016-03-02 14:00:01",
      "pickup_code" : "123456",
      "city_token" : "123456",
      "selftake_code" : "123456",
      "pre_selftake_time" : "03月05日 晚上",
      "operation_state" : "none"
    },
    "items" : [ {
      "uuid" : "string",
      "itemNo" : "1",
      "itemId" : "1",
      "skuId" : "00321",
      "productId" : "2123",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "price" : 122.34,
      "front" : {
        "goods" : {
          "id" : "string",
          "code" : "string",
          "name" : "string"
        },
        "spec" : {
          "id" : "string",
          "code" : "string",
          "name" : "string"
        },
        "spec2" : "500g",
        "barcode" : "121231313",
        "oid" : "string",
        "status" : "string",
        "wrh" : {
          "id" : "string",
          "name" : "string"
        },
        "sku_id" : "052700601",
        "goods_class" : "类型",
        "goods_unit" : "单位",
        "refund_id" : "string",
        "refund_status" : "string",
        "tc_order_id" : "string",
        "tc_payment" : "string",
        "extend_props" : "string",
        "virtual_wrh" : {
          "id" : "string",
          "name" : "string"
        }
      },
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "child_type" : "string",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]",
          "extra_info" : "{\"thirdType\": \"42\"}"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "details" : [ {
        "id" : "detailSkuId123",
        "title" : "detailSkuName123",
        "quantity" : 0.0,
        "ratio" : 0.0,
        "upc" : "upc123"
      } ],
      "state" : "子订单状态",
      "saleOrderId" : "string",
      "gift" : true,
      "combined" : true,
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_total" : 205.44,
      "cost_price" : 122.34,
      "lock_detail" : {
        "state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
        "stock_type" : "占货类型： third（外部库存）、purchase(采购库存)、wrh（仓库库存）、store（门店库存）"
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "order_state" : "string",
      "order_id" : "681795759987",
      "salesman_type" : "author",
      "salesman_id" : "123",
      "salesman_name" : "榕榕",
      "orig_sku_id" : "skuId123",
      "orig_item_title" : "skuName123",
      "orig_barcode" : "skuBarcode123",
      "orig_weight" : 1.0,
      "orig_image_url" : "string",
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "orig_qty" : 1.0,
      "orig_price" : 1.0,
      "settle_total" : 1.2,
      "settle_price" : 1.2,
      "shop_total" : 1.2,
      "shop_price" : 1.2,
      "settle_discount_amount" : 1.2,
      "extra_info" : "1.20",
      "image_url" : "http://aaa/bbb.png",
      "weight" : 1.0,
      "package_qty" : 125.0
    } ],
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "child_type" : "string",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]",
        "extra_info" : "{\"thirdType\": \"42\"}"
      } ]
    },
    "source_system" : "string",
    "lock_state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
    "customer_note" : "note",
    "seller_note" : "note",
    "seller_append_note" : "note",
    "salesman" : {
      "id" : "string",
      "name" : "string",
      "type" : "saleman",
      "org" : {
        "id" : "string",
        "name" : "string"
      },
      "org_type" : "门店",
      "inviter_mobile" : "18859226552",
      "inviter_name" : "王x",
      "inviter_wid" : "7567645",
      "personal_guider_name" : "王x",
      "personal_guider_no" : "3242323",
      "personal_guider_wid" : "3242323",
      "trade_guider_name" : "王x",
      "trade_guider_no" : "65756",
      "trade_guider_wid" : "45345",
      "weike_mobile" : "18859226552",
      "weike_name" : "张三",
      "weike_wid" : "765765756"
    },
    "cancel_reason" : "我不想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "商品不存在",
    "orig_total" : 120.01,
    "settle_commission" : 120.01,
    "cancel_type" : "customerCancel",
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "suspend_info" : {
      "suspended" : true,
      "code" : "string",
      "caption" : "string",
      "time" : "2017-12-26 16:40:19"
    },
    "member_info" : {
      "member_id" : "12253",
      "card_no" : "22323",
      "member_gid" : "12253",
      "outer_member_id" : "12253",
      "mobile" : "12253",
      "member_extra" : "{\"namespace\":\"wexinApp\",\"member_channel_type\":\"type\",\"member_channel_id\":\"123\",\"member_ident_type\":\"ident\"}"
    },
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0,
        "balance" : 100.0
      }
    },
    "settle_info" : {
      "settlable" : true,
      "discounts" : "[{}]",
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "shop_amount" : 0.0,
    "settle_amount" : 0.0,
    "settle_freight" : 0.0,
    "real_total" : 0.0
  } ],
  "page_count" : 5,
  "page_size" : 20
}

2. 定义

2.1. ActionResult

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.2. Address

地址信息

名称 说明 类型

city
可选

市
样例 : "厦门市"

string

coordinate_type
可选

坐标类型，BD09：百度坐标， GCJ02：火星坐标，WGS84：WGS84坐标
样例 : "GCJ02"

string

country
可选

国家
样例 : "中国"

string

district
可选

区
样例 : "思明区"

string

latitude
可选

纬度
样例 : "45.3,范围0-90"

number

longtitude
可选

经度
样例 : "121.2,范围0-180"

number

postcode
可选

邮编
样例 : "363423"

string

private_street
可选

脱敏地址
样例 : "脱敏地址**"

string

province
可选

省份
样例 : "福建省"

string

street
可选

详细地址
样例 : "前埔"

string

2.3. CRMInfo

会员权益信息

名称 说明 类型

coupon_info
可选

券信息
样例 : CouponInfo

CouponInfo

score_info
可选

积分信息
样例 : ScoreInfo

ScoreInfo

2.4. Carrier

承运商

名称 说明 类型

carrier
可选

承运平台
样例 : IdName

IdName

delivery_id
可选

配送活动标识
样例 : "8548418"

string

delivery_name
可选

配送活动名称
样例 : "8548418"

string

deliveryman
可选

送货员
样例 : IdName

IdName

deliveryman_mobile
可选

送货员手机
样例 : "18859658865"

string

exception_reason
可选

承运异常原因
样例 : "异常原因"

string

expected_logistics_type
可选

期望承运物流类型，取值范围:express(快递)、crowdsourcing(众包)。快递：如圆通，中通等;众包：如美团，蜂鸟，达达等
样例 : "crowdsourcing"

string

merchant
可选

承运商家
样例 : IdName

IdName

state
可选

承运状态，取值范围:initial(初始状态)、created(已下发)、createdFailed（下发失败）、dispatched(已派单)、arrived(骑手已到店)、pickup(已揽件)、pickupFailed(揽件失败)、delivering（配送中）、delivered（配送完成）、canceled（已取消）
样例 : "initial"

enum (initial, created, dispatched, createdFailed, arrived, pickup, pickupFailed, delivering, delivered, canceled)

type
可选

承运商类型，取值范围:self(门店自送)、thirdparty(平台配送)、express（物流配送）
样例 : "self"

enum (self, thirdparty, express)

2.5. CodeName

名称 说明 类型

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.6. CouponDetail

券信息

名称 说明 类型

amount
可选

实际抵用金额
样例 : 10.0

number

code
可选

券号
样例 : "10245678"

string

name
可选

券名称
样例 : "现金券"

string

type
可选

cash（现金券）、discount（折扣券）
样例 : "cash"

string

type_id
可选

券类型代码
样例 : "0001"

string

use_mode
可选

用券形式：pay（支付）、discount(优惠)
样例 : "pay"

string

value
可选

折扣率或者现金面额
样例 : "100，0.1"

number

2.7. CouponInfo

券信息

名称 说明 类型

details
可选

券使用详情
样例 : "[]"

< CouponDetail > array

use_total
可选

券抵用总金额
样例 : 1.0

number

2.8. Customer

客户

名称 说明 类型

contact
可选

联系方式
样例 : 联系方式(soms)

联系方式(soms)

id
可选

代码
样例 : "10001"

string

2.9. DiscountSettleDetail

优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

role
可选

优惠承担方
样例 : "shop（商家）、platform（平台）、agent（代理商）"

string

2.10. DiscountShareDetail

整合优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

type
可选

类型
样例 : "3：整合营销"

string

2.11. DistributionInfo

分销信息

名称 说明 类型

distributor
可选

样例 : IdName

IdName

tcOrderId
可选

分销主订单号
样例 : "1223432"

string

2.12. EncryptDetail

加密信息

名称 说明 类型

encrypt_mobile
可选

样例 : "string"

string

encrypt_name
可选

样例 : "string"

string

encrypt_street
可选

样例 : "string"

string

secretKey
可选

样例 : "string"

string

2.13. ExtraField

自定义字段

名称 说明 类型

id
可选

自定义id
样例 : "distance_freight"

string

name
可选

自定义名称
样例 : "远距离运费"

string

value
可选

自定义值
样例 : "0.01"

string

2.14. FavDetail

优惠详情

名称 说明 类型

amount
可选

优惠金额
样例 : 10.5

number

batch_act_id
可选

批次维度的活动ID
样例 : "1111"

string

child_type
可选

优惠子类型
样例 : "string"

string

extra_info
可选

扩展信息,json格式。
样例 : "{\"thirdType\": \"42\"}"

string

factor
可选

优惠参与信息
样例 : FavFactor

FavFactor

id
可选

优惠ID
样例 : "1111"

string

merchant_act_id
可选

商家活动ID
样例 : "1111"

string

name
可选

活动名称
样例 : "满减"

string

prom_cls
可选

促销来源类型
样例 : "string"

string

remark
可选

优惠说明
样例 : "测试优惠"

string

settle_details
可选

优惠结算分摊详情
样例 : [ "DiscountSettleDetail" ]

< DiscountSettleDetail > array

share_details
可选

多方整合优惠分摊信息
样例 : "[]"

< DiscountShareDetail > array

sku_act_id
可选

商品维度的活动ID
样例 : "1111"

string

type
可选

优惠类型
样例 : "string"

string

voucher_code
可选

凭证代码
样例 : "111111111"

string

2.15. FavFactor

优惠参与信息

名称 说明 类型

qty
可选

本商品参与促销总数量
样例 : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1"

number

sku_items
可选

来源商品参与优惠明细
样例 : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"

< FavFactorItem > array

total
可选

本商品参与促销总金额
样例 : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20"

number

2.16. FavFactorItem

参与优惠商品明细

名称 说明 类型

amount
可选

参与促销金额
样例 : 1.0

number

item_id
可选

行标识
样例 : "1"

string

item_no
必填

行号
样例 : 1

integer (int32)

qty
可选

参与促销数量
样例 : 1.0

number

2.17. ICN

ICN对象

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.18. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.19. Invoice

发票信息

名称 说明 类型

apply_qrcode
可选

开票二维码
样例 : "string"

string

details
可选

发票详情
样例 : [ "InvoiceDetail" ]

< InvoiceDetail > array

error_reason
可选

开票失败原因
样例 : "string"

string

required
必填

是否需要发票
默认值 : false
样例 : false

boolean

result
可选

开票结果：开票成功、开票失败，申请开票时不传
样例 : "开票成功"

string

2.20. InvoiceDetail

发票详情

名称 说明 类型

account
可选

银行编号/账号
样例 : "0023415445"

string

address
可选

地址
样例 : "福建厦门XX"

string

amount
必填

发票金额
样例 : 12.03

number

bank
可选

开户行
样例 : "中国银行XXX"

string

buyer_tax_code
可选

购买方税号，废弃，建议使用taxerId字段
样例 : "1232000046600736XP"

string

check_code
可选

校验码
样例 : "201622"

string

content
可选

发票内容
样例 : "上海股份有限公司"

string

email
可选

发票接收邮箱
样例 : "chw@qq.com"

string

kind
可选

发票种类，取值范围：e-invoice（电子）、paper（纸质）
样例 : "paper"

string

print_number
必填

打印单号
样例 : "123456"

string

remark
可选

发票备注
样例 : "plain"

string

securaty_code
可选

密码
样例 : "2114445"

string

serial_no
可选

流水号
样例 : "454557884564545"

string

tax
可选

税费
样例 : 2.32

number

taxer_id
可选

纳税人识别号（买家填写）
样例 : "1212345046600736XP"

string

telephone
可选

电话
样例 : "12344545111"

string

time
可选

开票日期
样例 : "2019-07-15 16:56:23"

string (date-time)

title
可选

发票抬头
样例 : "XX公司"

string

title_type
可选

抬头类型，取值范围：person（个人）、company（单位）
样例 : "person"

enum (person, company)

type
可选

发票类型，取值范围：plain（普通发票）、VAT（增值税专用发票）
样例 : "plain"

enum (plain, VAT)

url
可选

电子发票图片地址
样例 : "a.jpg"

string

2.21. ItemPromotion

商品行促销信息

名称 说明 类型

apported_discount_amount
可选

整单优惠分摊金额
样例 : 0.1

number

discount_amount
可选

商品优惠金额
样例 : 0.1

number

favs
可选

优惠详情
样例 : [ "FavDetail" ]

< FavDetail > array

2.22. MemberInfo

积分信息

名称 说明 类型

card_no
可选

实体卡卡号,如果存在多个，以英文逗号隔开
样例 : "22323"

string

member_extra
可选

额外参数,json字符串
样例 : "{\"namespace\":\"wexinApp\",\"member_channel_type\":\"type\",\"member_channel_id\":\"123\",\"member_ident_type\":\"ident\"}"

string

member_gid
可选

会员资料内码
样例 : "12253"

string

member_id
可选

会员ID
样例 : "12253"

string

mobile
可选

会员电话
样例 : "12253"

string

outer_member_id
可选

外部会员id
样例 : "12253"

string

2.23. OrderException

名称 说明 类型

caption
可选

异常标题
样例 : "商品异常"

string

code
可选

异常代码
样例 : "sku"

string

operator
可选

操作人
样例 : "zuhu"

string

order_id
可选

订单号
样例 : "123456"

string

remark
可选

异常说明
样例 : "商品异常"

string

time
可选

异常时间
样例 : "2017-12-26 16:40:19"

string (date-time)

2.24. OrderPromotion

订单优惠

名称 说明 类型

favs
可选

优惠详情
样例 : [ "FavDetail" ]

< FavDetail > array

2.25. OrderSettleDiscount

对账优惠信息

名称 说明 类型

amount
可选

优惠金额
样例 : 1.0

number

details
可选

优惠结算详情
样例 : "[]"

< DiscountSettleDetail > array

scope
可选

优惠范围
样例 : "order（订单）、item（商品）、package（包装）、freight(运费)"

string

2.26. OrderSettleInfo

对账信息

名称 说明 类型

discounts
可选

优惠结算明细
样例 : "[{}]"

< OrderSettleDiscount > array

settlable
可选

是否可结算
默认值 : false
样例 : true

boolean

settle_date
可选

账单日期
样例 : "2022-08-25 00:00:00"

string (date-time)

station_settle_mode
可选

门店分账模式：online（线上分账模式）、offline（线下分账模式）
样例 : "online"

string

2.27. OrderTag

订单

名称 说明 类型

name
可选

标签名称
样例 : "首单"

string

2.28. OrigExtraInfo

原商品行扩展信息

名称 说明 类型

spec
可选

规格
样例 : "1*1"

string

unit
可选

规格单位
样例 : "个"

string

2.29. Payment

支付信息

名称 说明 类型

amount
必填

订单应付总金额（包含商品、运费、包装费等）
样例 : 14.02

number

cod_amount
必填

货到付款金额
样例 : 0.0

number

details
可选

支付详情
样例 : [ "PaymentDetail" ]

< PaymentDetail > array

earnest_amount
必填

预售订金金额
样例 : 0.0

number

extra
可选

支付费用扩展信息,京东配送服务费:baseLogisticsServiceFee、美团拼好饭加价金额:singleIncreasePrice
样例 : [ "ExtraField" ]

< ExtraField > array

freight
必填

运费(优惠后)
样例 : 14.02

number

other_fee
可选

其他费用
样例 : 0.0

number

package_total
必填

商家包装费用
样例 : 14.02

number

pay_bill_id
可选

支付账单号
样例 : "0122333333"

string

pay_time
可选

付款时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2019-03-02 12:00:01"

string (date-time)

payee
可选

付款人
样例 : IdName

IdName

state
必填

付款状态，默认取值:notPay。取值范围：notPay(未付款)、earnest(已付定金)、paid(已付全款)
样例 : "paid"

enum (notPay, earnest, paid)

type
必填

付款类型，默认取值:online。取值范围：cod(货到付款)、online(在线支付)、earnest(预付)
样例 : "online"

enum (cod, online, earnest)

2.30. PaymentDetail

支付详情

名称 说明 类型

account_name
可选

账号名称
样例 : "工行"

string

account_no
可选

账号
样例 : "002002"

string

amount
必填

金额
样例 : 12.33

number

cashier
可选

是否缴款 ,此字段用于刻画收款人收的钱是否需要上缴，如收的是现金就需要上缴，刷卡则就不需要上缴
默认值 : false
样例 : true

boolean

code
可选

支付方式代码
样例 : "支付方式代码"

string

discount_amount
可选

支付优惠金额
样例 : 100.0

number

extra_info
可选

扩展信息,json字符串
样例 : "{\"session\", \"123\"}"

string

flowno
可选

业务流水号
样例 : "3223232323"

string

name
必填

支付方式名称
样例 : "支付宝"

string

out_pay_id
可选

第三方支付流水号
样例 : "3223232323"

string

pay_id
可选

支付id
样例 : "3223232323"

string

score
可选

积分数量
样例 : 100.0

number

type
可选

支付方式类型
样例 : "5"

string

2.31. Receiver

收货人

名称 说明 类型

address
必填

地址
样例 : Address

Address

contact
必填

联系方式
样例 : 联系方式(soms)

联系方式(soms)

2.32. SaleFrontItem

平台商品行信息

名称 说明 类型

barcode
可选

条码
样例 : "121231313"

string

extend_props
可选

扩展信息
样例 : "string"

string

goods
可选

商品
样例 : ICN

ICN

goods_class
可选

商品类型
样例 : "类型"

string

goods_unit
可选

商品单位
样例 : "单位"

string

oid
可选

子订单号
样例 : "string"

string

refund_id
可选

退款id
样例 : "string"

string

refund_status
可选

退款状态
样例 : "string"

string

sku_id
可选

平台SKU ID
样例 : "052700601"

string

spec
可选

属性
样例 : ICN

ICN

spec2
可选

平台商品的规格,形如：500g、500ml
样例 : "500g"

string

status
可选

平台状态
样例 : "string"

string

tc_order_id
可选

样例 : "string"

string

tc_payment
可选

样例 : "string"

string

virtual_wrh
可选

虚拟仓库
样例 : IdName

IdName

wrh
可选

仓库信息
样例 : IdName

IdName

2.33. SaleFrontOrder

平台订单信息

名称 说明 类型

app
可选

平台应用
样例 : IdName

IdName

created
可选

下单时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

extend_props
可选

属性信息
样例 : "string"

string

logistic
可选

物流
样例 : IdName

IdName

logs
可选

日志
样例 : "[]"

< SaleOrderLog > array

main_order_id
可选

平台主订单号
样例 : "1223432"

string

modified
可选

最后修改时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

order_id
必填

平台订单号,第三方单号
样例 : "1223654"

string

order_type
可选

订单类型
样例 : "string"

string

platform
必填

平台,其中：自接入平台需要提供约定平台id，申请在鼎力云开通。
样例 : IdName

IdName

shop
可选

店铺
样例 : IdName

IdName

state
可选

状态
样例 : "已付款"

string

station_id
可选

平台侧的门店编码
样例 : "254145"

string

station_name
可选

平台侧的门店名称
样例 : "254145"

string

station_order_no
可选

订单序号
样例 : "1"

string

third_order_id
必填

通道系统订单号,第三方单号
样例 : "1223654"

string

wrh
可选

仓库
样例 : IdName

IdName

2.34. SaleOrder

销售订单

名称 说明 类型

cancel_reason
可选

取消原因
样例 : "我不想要了"

string

cancel_type
可选

取消类型,取值为stationRefuse（门店拒接）、customerCancel（客户取消）
样例 : "customerCancel"

string

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

crm_info
可选

会员权益信息
样例 : CRMInfo

CRMInfo

customer
可选

客户信息
样例 : Customer

Customer

customer_note
可选

客户备注
样例 : "note"

string

delivery
必填

配送信息
样例 : SaleOrderDelivery

SaleOrderDelivery

distributionInfo
可选

分销信息
样例 : DistributionInfo

DistributionInfo

encrypt_detail
可选

加密详情
样例 : EncryptDetail

EncryptDetail

exception_codes
可选

异常代码
样例 : "sku"

string

exception_remark
可选

异常说明
样例 : "商品不存在"

string

exceptions
可选

样例 : [ "OrderException" ]

< OrderException > array

extra_info
可选

扩展信息,json字符串
样例 : "{\"lcUserAccessToken\", \"123\"}"

string

freight_discount
可选

运费优惠金额
样例 : 33.33

number

front
必填

平台订单信息
样例 : SaleFrontOrder

SaleFrontOrder

has_exception
可选

是否异常
默认值 : false
样例 : true

boolean

id
可选

订单Id，由系统自动生成，不需要填写
样例 : "88822222222"

string

invoice
可选

发票信息
样例 : Invoice

Invoice

items
必填

商品行
样例 : [ "SaleOrderItem" ]

< SaleOrderItem > array

lock_state
可选

none
样例 : "占货状态：none（缺货）、part（部分占货）、all（全部占货）"

enum (none, part, all)

logs
可选

订单日志
样例 : [ "SaleOrderLog" ]

< SaleOrderLog > array

member_info
可选

会员积分信息
样例 : MemberInfo

MemberInfo

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

order_store
可选

下单门店
样例 : IdName

IdName

orig_total
可选

订单原金额(优惠之前)
样例 : 120.01

number

package_discount
可选

包装优惠金额
样例 : 33.33

number

payment
必填

支付信息
样例 : Payment

Payment

promotion
可选

订单促销
样例 : OrderPromotion

OrderPromotion

real_total
可选

样例 : 0.0

number

salesman
可选

推销员
样例 : SalesmanInfo

SalesmanInfo

seller_append_note
可选

商家追加备注
样例 : "note"

string

seller_note
可选

商家备注
样例 : "note"

string

settle_amount
可选

结算金额
样例 : 0.0

number

settle_commission
可选

平台佣金
样例 : 120.01

number

settle_freight
可选

结算运费
样例 : 0.0

number

settle_info
可选

对账信息
样例 : OrderSettleInfo

OrderSettleInfo

shop
必填

平台商家(店铺)，平台侧的商家，非门店
样例 : IdName

IdName

shop_amount
可选

货款金额
样例 : 0.0

number

source_system
可选

样例 : "string"

string

state
可选

confirmed
样例 : "状态"

enum (confirmed, prepared, approved, delivering, delivered, canceled)

suspend_info
可选

挂起信息
样例 : SuspendInfo

SuspendInfo

tags
可选

订单标签
样例 : [ "OrderTag" ]

< OrderTag > array

weight
可选

订单重量，单位：g
样例 : 500.0

number

2.35. SaleOrderDeliverRequest

销售单配送情况

名称 说明 类型

delivery_state
必填

配送状态，取值范围:none(未配送)、shipped(已发货)、signed(已妥投)、refused(已拒收)、redeliver(重投)
样例 : "none"

enum (none, shipped, signed, refused, redeliver)

front_modified
可选

平台订单最后修改时间，非空时将更新,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

operator
可选

执行操作人
样例 : "zhangsan"

string

waybillId
可选

承运单号，非空时将更新
样例 : "1243566215"

string

2.36. SaleOrderDelivery

配送信息

名称 说明 类型

city_token
可选

同城令牌
样例 : "123456"

string

operation_state
可选

门店作业状态，none（空），accepted（已接单），shipping（已集货（已拣货）），rechecked（已复核），handover（已交接）
样例 : "none"

string

pickup_code
可选

取件码
样例 : "123456"

string

pre_end_delivery_time
可选

预计送达结束时间
样例 : "2016-03-02 14:00:01"

string (date-time)

pre_selftake_time
可选

预计自提时间
样例 : "03月05日 晚上"

string

pre_start_delivery_time
可选

预计送达开始时间
样例 : "2016-03-02 12:00:01"

string (date-time)

pre_type
可选

订单预约类型
样例 : "normal：正常，dsd：定时达，half_day：半日达"

string

receiver
可选

收货人信息
样例 : Receiver

Receiver

remark
可选

配送说明
样例 : "定时达"

string

selftake_code
可选

自提码
样例 : "123456"

string

ship_mode
可选

发货方式，wrhShip（仓库发货），stationShip（门店发货）
样例 : "wrhShip"

enum (wrhShip, stationShip, vendorShip)

state
可选

配送状态，默认取值为:none。取值范围:none(未配送)、shipped(已发货)、signed(已妥投)、refused(已拒收)、redeliver(重投)
样例 : "none"

enum (none, shipped, signed, refused, redeliver)

station
可选

配送门店
样例 : IdName

IdName

type
可选

交付方式，默认取值:deliver。取值范围:selftake(到店自提)、deliver(送货上门)
样例 : "deliver"

enum (selftake, deliver)

waybills
可选

样例 : [ "WaybillInfo" ]

< WaybillInfo > array

wrh
可选

发货仓库
样例 : CodeName

CodeName

2.37. SaleOrderFilter

销售单过滤器

名称 说明 类型

created_end
可选

创建结束时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

created_start
可选

创建起始时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

customer_id
可选

客户代码
样例 : "8568"

string

customer_mobile
可选

客户代码
样例 : "8568"

string

customer_name
可选

客户姓名
样例 : "张三"

string

exceptionRemark
可选

异常原因类似于
样例 : "名称"

string

front_created_end
可选

下单时间终止时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

front_created_start
可选

下单时间起始时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

front_order_id
可选

平台订单号
样例 : "32323232323323"

string

front_order_id_prefix
可选

平台订单号起始搜索
样例 : "32323232323323"

string

front_order_ids
可选

平台订单号
样例 : "32323232323323"

< string > array

hasException
可选

是否异常
默认值 : false
样例 : true

boolean

id_prefix
可选

销售订单号起始搜索
样例 : "32323232323323"

string

lock_state_in
可选

占货状态：none（缺货）、part（部分占货）、all（全部占货）
样例 : "wrh"

< enum (none, part, all) > array

lock_stock_type_eq
可选

占货类型： purchase(采购)、wrh（仓库）
样例 : "wrh"

string

order_id
可选

销售单号
样例 : "1000002111"

string

order_ids
可选

销售单号
样例 : [ "string" ]

< string > array

order_store_code_in
可选

下单门店编码在……之中
样例 : "true"

< string > array

platformIds
可选

平台ID
样例 : [ "string" ]

< string > array

platform_id
可选

平台ID
样例 : "jdo2o"

string

pre_type
可选

预处理类型：normal：正常，dsd：定时达
样例 : "normal"

string

shop_id
可选

商家ID
样例 : "0002"

string

shop_id_in
可选

商家ID
样例 : "0002"

< string > array

sku_id_eq
可选

商品代码等于
样例 : "AZ3J"

string

sku_title_eq
可选

商品名称等于
样例 : "名称"

string

states
可选

销售单状态，取值:confirmed(已确认)、prepared(已预处理)、approved(已审核)、delivering(配送中)、delivered(配送完成)、canceled(已取消)
样例 : [ "confirmed" ]

< enum (confirmed, prepared, approved, delivering, delivered, canceled) > array

tag_eq
可选

标签等于
样例 : "赔付订单"

string

waybill_id_eq
可选

运单信息ID
样例 : "32323232323323"

string

waybill_station_id_eq
可选

发货站点等于
样例 : "1001"

string

waybill_station_type_eq
可选

发货站点类型等于，store（门店）、wrh（仓库）、vendor（供应商）
样例 : "wrh"

string

2.38. SaleOrderItem

销售订单商品行

名称 说明 类型

apported_discount_amount
必填

整单优惠分摊金额，如：订单满减，整单分摊到明细
样例 : 12.02

number

barcode
可选

商品条码
样例 : "123456"

string

combined
可选

默认值 : false
样例 : true

boolean

cost_price
可选

成本价
样例 : 122.34

number

details
可选

组合明细的原料
样例 : [ "SaleOrderItemDetail" ]

< SaleOrderItemDetail > array

discount_amount
必填

商品优惠金额，如：商品立减优惠
样例 : 12.02

number

extra_info
可选

额外信息
样例 : "1.20"

string

front
可选

前端商品信息
样例 : SaleFrontItem

SaleFrontItem

gift
可选

默认值 : false
样例 : true

boolean

image_url
可选

商品图片信息
样例 : "http://aaa/bbb.png"

string

itemId
可选

行唯一标识
样例 : "1"

string

itemNo
可选

订单行号
样例 : "1"

string

item_title
可选

商品标题
样例 : "葡萄"

string

lock_detail
可选

none
样例 : SaleOrderLockDetail

SaleOrderLockDetail

order_id
可选

关联订单号
样例 : "681795759987"

string

order_state
可选

订单状态，取值范围:confirmed(已确认)、prepared（已预处理）、approved(已审核)、delivering( 配送中)、delivered(配送完成)、canceled(已取消)
样例 : "string"

string

orig_barcode
可选

转换前的商品条码
样例 : "skuBarcode123"

string

orig_extra_info
可选

原商品行扩展信息
样例 : OrigExtraInfo

OrigExtraInfo

orig_image_url
可选

转换前商品图片信息
样例 : "string"

string

orig_item_title
可选

转换前的商品名称
样例 : "skuName123"

string

orig_price
可选

转换前的商品行价格
样例 : 1.0

number

orig_qty
可选

转换前的商品数量
样例 : 1.0

number

orig_sku_id
可选

转换前的货号
样例 : "skuId123"

string

orig_weight
可选

转换前商品重量，单位g
样例 : 1.0

number

package_qty
可选

包装盒数量
样例 : 125.0

number

package_total
可选

包装费用
样例 : 205.44

number

pay_amount
必填

实付金额，等于total - apported_discount_amount - discount_amount
样例 : 2.0

number

price
可选

售价（促销价），为空等于pay_amount/quantity
样例 : 122.34

number

productId
可选

商品代码
样例 : "2123"

string

promotion
可选

商品促销
样例 : ItemPromotion

ItemPromotion

purchase_price
可选

采购价
样例 : 2.0

number

quantity
必填

数量
样例 : 1.0

number

saleOrderId
可选

样例 : "string"

string

salesman_id
可选

售卖员Id
样例 : "123"

string

salesman_name
可选

售卖员名字
样例 : "榕榕"

string

salesman_type
可选

售卖员类型
样例 : "author"

string

settle_discount_amount
可选

平台优惠金额
样例 : 1.2

number

settle_price
可选

结算价格
样例 : 1.2

number

settle_total
可选

结算金额
样例 : 1.2

number

shop_price
可选

货款金额
样例 : 1.2

number

shop_total
可选

货款金额
样例 : 1.2

number

skuId
必填

商品标识（货号）
样例 : "00321"

string

spec
可选

商品规格
样例 : "1*1"

string

state
可选

confirmed
样例 : "子订单状态"

enum (confirmed, prepared, approved, delivering, delivered, canceled)

station
可选

配送门店
样例 : IdName

IdName

total
必填

商品金额，等于unit_price * quantity
样例 : 2.0

number

unit
可选

单位：个、份等
样例 : "瓶"

string

unit_price
必填

商品销售价格（扣除优惠券前的价格）
样例 : 2.0

number

uuid
可选

样例 : "string"

string

weight
必填

单个商品重量，单位g
样例 : 1.0

number

2.39. SaleOrderItemDetail

销售订单组合明细原料

名称 说明 类型

id
必填

原料货号
样例 : "detailSkuId123"

string

quantity
必填

需要原料商品数量,C=2A+3B，原料商品数量=组合商品数量*基数
样例 : 0.0

number

ratio
必填

原料商品基数
样例 : 0.0

number

title
必填

原料名称
样例 : "detailSkuName123"

string

upc
可选

国际码
样例 : "upc123"

string

2.40. SaleOrderList

销售订单

名称 说明 类型

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

sale_orders
可选

销售订单
样例 : [ "SaleOrder" ]

< SaleOrder > array

2.41. SaleOrderLockDetail

销售订单占货明细

名称 说明 类型

state
可选

none
样例 : "占货状态：none（缺货）、part（部分占货）、all（全部占货）"

enum (none, part, all)

stock_type
可选

wrh
样例 : "占货类型： third（外部库存）、purchase(采购库存)、wrh（仓库库存）、store（门店库存）"

string

2.42. SaleOrderLog

订单日志

名称 说明 类型

action
可选

操作
样例 : "modify"

string

action_caption
可选

操作标题
样例 : "修改订单"

string

message
可选

操作说明
样例 : "修改订单商品明细"

string

operator
可选

操作人
样例 : "zuhu"

string

order_id
可选

订单号
样例 : "321212222"

string

rtn_id
可选

退换货单号
样例 : "212123333"

string

tenant_id
可选

租户ID
样例 : "zuhu"

string

time
可选

操作时间
样例 : "2017-12-26 16:40:19"

string (date-time)

2.43. SaleOrderPaging

销售单分页对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

saleOrders
可选

销售单列表
样例 : [ "SaleOrder" ]

< SaleOrder > array

total
可选

总条数
样例 : 100

integer (int64)

2.44. SaleOrderSubmitResponse

销售单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

sale_order_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.45. SalesmanInfo

名称 说明 类型

id
可选

样例 : "string"

string

inviter_mobile
可选

邀请人手机号
样例 : "18859226552"

string

inviter_name
可选

邀请人名称
样例 : "王x"

string

inviter_wid
可选

邀请人wid
样例 : "7567645"

string

name
可选

样例 : "string"

string

org
可选

销售员所属组织
样例 : IdName

IdName

org_type
可选

所属组织类型：门店,总部
样例 : "门店"

string

personal_guider_name
可选

归属导购员名称
样例 : "王x"

string

personal_guider_no
可选

归属导购员编号
样例 : "3242323"

string

personal_guider_wid
可选

归属导购员wid
样例 : "3242323"

string

trade_guider_name
可选

交易导购员名称
样例 : "王x"

string

trade_guider_no
可选

交易导购员编号
样例 : "65756"

string

trade_guider_wid
可选

交易导购员wid
样例 : "45345"

string

type
可选

type：类型
样例 : "saleman"

string

weike_mobile
可选

微客手机号
样例 : "18859226552"

string

weike_name
可选

微客名称
样例 : "张三"

string

weike_wid
可选

微客名称wid
样例 : "765765756"

string

2.46. ScoreInfo

积分信息

名称 说明 类型

balance
可选

积分余额
样例 : 100.0

number

total
可选

获得积分
样例 : 1.0

number

2.47. SuspendInfo

挂起信息

名称 说明 类型

caption
必填

挂起原因标题，显示用
样例 : "string"

string

code
必填

挂起原因代码，每一种挂起原因用代码表示
样例 : "string"

string

suspended
可选

是否挂起
默认值 : false
样例 : true

boolean

time
可选

挂起时间
样例 : "2017-12-26 16:40:19"

string (date-time)

2.48. WaybillInfo

运单

名称 说明 类型

carrier
可选

承运商
样例 : Carrier

Carrier

station
可选

站点
样例 : IdName

IdName

station_type
可选

站点类型
样例 : "store（门店）、wrh（仓库）、vendor（供应商）"

string

suggest_station
可选

建议站点
样例 : IdName

IdName

suggest_station_type
可选

建议站点类型
样例 : "store（门店）、wrh（仓库）、vendor（供应商）"

string

virtual_station
可选

虚拟站点
样例 : IdName

IdName

virtual_station_type
可选

虚拟站点类型
样例 : "store（门店）、wrh（仓库）、vendor（供应商）"

string

waybill_id
可选

运单号
样例 : "123"

string

2.49. 联系方式(soms)

联系方式

名称 说明 类型

email
可选

邮箱
样例 : "55151@qq.com"

string

fax
可选

传真
样例 : "123123"

string

mobile
可选

手机(mobile和telephone建议给值mobile)
样例 : "189389928893"

string

name
可选

姓名
样例 : "李飞"

string

private_mobile
可选

脱敏手机号
样例 : "189****0000"

string

private_name
可选

脱敏名称
样例 : "张*红"

string

telephone
可选

电话
样例 : "189389928893"

string