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

接口

1. 接口定义

1.1. 退单服务

1.1.1. 提交退单

POST /{tenant_id}/soms/returnservice/rtn
1.1.1.1. 说明

提交退单，只支持新增退单，不支持修改退单，新增状态：confirmed，仅退款：type=refund，退款退货：type=refundAndRtn，默认type=refundAndRtn

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

rtn
必填

退单

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

200

successful operation

IdWrapper
1.1.1.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "delivery" : {
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "state" : "none",
    "returner" : {
      "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" : "脱敏地址**"
      }
    },
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "station_type" : "string",
    "carrier_note" : "note",
    "wrh_rtn_id" : "XXXXXXXXX",
    "waybill_id" : "XXXXXXXXX",
    "return_mobile" : "18856556655"
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:02",
    "modified" : "2016-03-02 12:00:02",
    "state" : "已退货",
    "stationName" : "254145",
    "creator" : "254145",
    "source" : "平台生成：platform、商家发起:shop",
    "rtn_id" : "123456",
    "return_state" : "string",
    "station_id" : "254145",
    "order_finished" : "2020-06-17 10:00:00"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "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
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_spec" : "122.22",
    "orig_unit" : "122.22",
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "orig_mas_sku_id" : "string",
    "is_gift" : true
  } ],
  "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\"}"
    } ]
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "member_info" : {
    "card_no" : "22323"
  },
  "apply_id" : "0002",
  "apply_system" : "shop(商家)、customer（消费者）",
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "exception_time" : "2020-11-11 12:11:21",
  "seller_info" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "voucher_urls" : [ "string" ],
  "sku_quantity" : 1.0,
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0,
      "balance" : 100.0
    }
  },
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "settle_info" : {
    "settlable" : true,
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "rtn_req_id" : "string",
  "req_id" : "string",
  "address_change_fee" : 120.01,
  "settle_unit" : {
    "type" : "store",
    "code" : "0001",
    "name" : "门店1"
  }
}
1.1.1.5. HTTP响应示例
响应 200
{
  "id" : "string"
}

1.1.2. 根据平台退单号取单个有效退单

GET /{tenant_id}/soms/returnservice/rtn/front/{rtn_id}

operation.deprecated
1.1.2.1. 说明

不建议使用，根据平台退单号取单个有效退单，建议使用：根据平台退单号取多个退单

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

Path

rtn_id
必填

前端退单号

string

Path

tenant_id
必填

租户ID

string

Query

parts
必填

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

string

Query

platform_id
必填

平台ID

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

200

successful operation

Rtn
1.1.2.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/front/string?parts=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" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "delivery" : {
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "state" : "none",
    "returner" : {
      "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" : "脱敏地址**"
      }
    },
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "station_type" : "string",
    "carrier_note" : "note",
    "wrh_rtn_id" : "XXXXXXXXX",
    "waybill_id" : "XXXXXXXXX",
    "return_mobile" : "18856556655"
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:02",
    "modified" : "2016-03-02 12:00:02",
    "state" : "已退货",
    "stationName" : "254145",
    "creator" : "254145",
    "source" : "平台生成：platform、商家发起:shop",
    "rtn_id" : "123456",
    "return_state" : "string",
    "station_id" : "254145",
    "order_finished" : "2020-06-17 10:00:00"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "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
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_spec" : "122.22",
    "orig_unit" : "122.22",
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "orig_mas_sku_id" : "string",
    "is_gift" : true
  } ],
  "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\"}"
    } ]
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "member_info" : {
    "card_no" : "22323"
  },
  "apply_id" : "0002",
  "apply_system" : "shop(商家)、customer（消费者）",
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "exception_time" : "2020-11-11 12:11:21",
  "seller_info" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "voucher_urls" : [ "string" ],
  "sku_quantity" : 1.0,
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0,
      "balance" : 100.0
    }
  },
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "settle_info" : {
    "settlable" : true,
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "rtn_req_id" : "string",
  "req_id" : "string",
  "address_change_fee" : 120.01,
  "settle_unit" : {
    "type" : "store",
    "code" : "0001",
    "name" : "门店1"
  }
}

1.1.3. 提交退单(新版)

POST /{tenant_id}/soms/returnservice/rtn/submit
1.1.3.1. 说明

新旧提交退单接口，只有返回结果格式差异，其它逻辑一致

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

rtn
必填

退单

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

200

successful operation

RtnSubmitResponse
1.1.3.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/submit?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "delivery" : {
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "state" : "none",
    "returner" : {
      "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" : "脱敏地址**"
      }
    },
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "station_type" : "string",
    "carrier_note" : "note",
    "wrh_rtn_id" : "XXXXXXXXX",
    "waybill_id" : "XXXXXXXXX",
    "return_mobile" : "18856556655"
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:02",
    "modified" : "2016-03-02 12:00:02",
    "state" : "已退货",
    "stationName" : "254145",
    "creator" : "254145",
    "source" : "平台生成：platform、商家发起:shop",
    "rtn_id" : "123456",
    "return_state" : "string",
    "station_id" : "254145",
    "order_finished" : "2020-06-17 10:00:00"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "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
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_spec" : "122.22",
    "orig_unit" : "122.22",
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "orig_mas_sku_id" : "string",
    "is_gift" : true
  } ],
  "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\"}"
    } ]
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "member_info" : {
    "card_no" : "22323"
  },
  "apply_id" : "0002",
  "apply_system" : "shop(商家)、customer（消费者）",
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "exception_time" : "2020-11-11 12:11:21",
  "seller_info" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "voucher_urls" : [ "string" ],
  "sku_quantity" : 1.0,
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0,
      "balance" : 100.0
    }
  },
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "settle_info" : {
    "settlable" : true,
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "rtn_req_id" : "string",
  "req_id" : "string",
  "address_change_fee" : 120.01,
  "settle_unit" : {
    "type" : "store",
    "code" : "0001",
    "name" : "门店1"
  }
}
1.1.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "rtn_id" : "string"
}

1.1.4. 取指定退单

GET /{tenant_id}/soms/returnservice/rtn/{id}
1.1.4.1. 说明

取指定退单

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

Path

id
必填

退单id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)、crm（营销信息）、prom（促销详情）、item.traceCodes（溯源码）

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

200

successful operation

Rtn
1.1.4.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string
1.1.4.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "delivery" : {
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "state" : "none",
    "returner" : {
      "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" : "脱敏地址**"
      }
    },
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "station_type" : "string",
    "carrier_note" : "note",
    "wrh_rtn_id" : "XXXXXXXXX",
    "waybill_id" : "XXXXXXXXX",
    "return_mobile" : "18856556655"
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:02",
    "modified" : "2016-03-02 12:00:02",
    "state" : "已退货",
    "stationName" : "254145",
    "creator" : "254145",
    "source" : "平台生成：platform、商家发起:shop",
    "rtn_id" : "123456",
    "return_state" : "string",
    "station_id" : "254145",
    "order_finished" : "2020-06-17 10:00:00"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "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
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_spec" : "122.22",
    "orig_unit" : "122.22",
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "orig_mas_sku_id" : "string",
    "is_gift" : true
  } ],
  "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\"}"
    } ]
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "member_info" : {
    "card_no" : "22323"
  },
  "apply_id" : "0002",
  "apply_system" : "shop(商家)、customer（消费者）",
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "exception_time" : "2020-11-11 12:11:21",
  "seller_info" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "voucher_urls" : [ "string" ],
  "sku_quantity" : 1.0,
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0,
      "balance" : 100.0
    }
  },
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "settle_info" : {
    "settlable" : true,
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "rtn_req_id" : "string",
  "req_id" : "string",
  "address_change_fee" : 120.01,
  "settle_unit" : {
    "type" : "store",
    "code" : "0001",
    "name" : "门店1"
  }
}

1.1.5. 审核退单

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/approve
1.1.5.1. 说明

审核退单，审核通过：approve_state=serviceApproved，审核不通过：approve_state=serviceRefuse

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

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退单审核请求

RtnApproveRequest
1.1.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.5.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/approve?operator=string
请求 body
{
  "reason" : "已发货，不能退",
  "approve_state" : "serviceApproved",
  "operator_role" : "platform",
  "turn_to_type" : "refundAndRtn",
  "item_infos" : [ {
    "item_id" : "string",
    "order_item_id" : "string",
    "item_no" : "string",
    "sku_id" : "string",
    "real_quantity" : 0.0,
    "detail_infos" : [ {
      "real_quantity" : 0.0,
      "sku_id" : "string"
    } ]
  } ]
}
1.1.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.6. 取消退单

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/cancel
1.1.6.1. 说明

取消退单

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

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

ActionResult
1.1.6.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/cancel?operator=string
请求 body
{
  "sellerInfo" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "reason" : "我不想要了",
  "operator_role" : "string",
  "approve_state" : "none"
}
1.1.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.7. 修改退单的退回门店

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/changestation
1.1.7.1. 说明

修改退单的退回门店

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

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

ChangeRtnStationRequest
1.1.7.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.7.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/changestation?operator=string
请求 body
{
  "new_station_id" : "12435453"
}
1.1.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.8. 确认退货状态

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/deliver
1.1.8.1. 说明

确认退货状态,更新消费者退货发货return_state=customerShipped，更新商家退货收货return_state=received

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

Path

id
必填

退单ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退货请求对象

ReturnRequest
1.1.8.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.8.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/deliver?operator=string
请求 body
{
  "carrier" : {
    "state" : "initial",
    "type" : "self",
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "merchant" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman_mobile" : "18859658865",
    "exception_reason" : "异常原因",
    "delivery_id" : "8548418",
    "delivery_name" : "8548418"
  },
  "return_state" : "none",
  "waybill_id" : "1243566215",
  "carrier_note" : "note",
  "operator_role" : "platform"
}
1.1.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.9. 修改退单

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/modify
1.1.9.1. 说明

修改退单

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

Path

id
必填

退单id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnModificationRequest
1.1.9.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.9.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/modify?operator=string
请求 body
{
  "rtnId" : "4356465768",
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "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
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_spec" : "122.22",
    "orig_unit" : "122.22",
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "orig_mas_sku_id" : "string",
    "is_gift" : true
  } ],
  "freight" : 12.03,
  "modify_item_detail" : false,
  "apply_reason" : "不想要了",
  "customer_note" : "haha",
  "voucher_urls" : [ "string" ],
  "settle_amount" : 12.03,
  "settle_commission" : 12.03,
  "refund_extra" : [ {
    "id" : "distance_freight",
    "name" : "远距离运费",
    "value" : "0.01"
  } ],
  "package_total" : 12.03,
  "address_change_fee" : 10.01,
  "carrier_type" : "self"
}
1.1.9.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.10. 通知仓库

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/notifywrh
1.1.10.1. 说明

通知仓库

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

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnNotifyWrhRequest
1.1.10.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.10.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/notifywrh?operator=string
请求 body
1.1.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.11. 确认退款

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/refund
1.1.11.1. 说明

确认退款

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

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

ConfirmRefundRequest
1.1.11.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.11.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/refund?operator=string
请求 body
{
  "refundState" : "refunded",
  "payments" : [ {
    "code" : "支付方式代码",
    "name" : "支付宝",
    "amount" : 12.33,
    "score" : 100.0,
    "account_no" : "002002",
    "account_name" : "工行",
    "discount_amount" : 100.0,
    "pay_id" : "3223232323",
    "out_pay_id" : "3223232323",
    "extra_info" : "{\"session\", \"123\"}"
  } ],
  "operator_role" : "platform"
}
1.1.11.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.12. 修改退单权益接口

POST /{tenant_id}/soms/returnservice/rtn/{id}/mod/crminfo
1.1.12.1. 说明

修改退单权益接口

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

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

权益请求

CRMInfoModificationRequest
1.1.12.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.12.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/mod/crminfo?operator=string
请求 body
{
  "score" : 0.0
}
1.1.12.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.13. 修改退单的退款信息

POST /{tenant_id}/soms/returnservice/rtn/{id}/refund/update
1.1.13.1. 说明

修改退单的退款信息

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

Path

id
必填

退单id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnRefundUpdateRequest
1.1.13.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.13.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/refund/update?operator=string
请求 body
{
  "payments" : [ {
    "code" : "支付方式代码",
    "name" : "支付宝",
    "amount" : 12.33,
    "score" : 100.0,
    "account_no" : "002002",
    "account_name" : "工行",
    "discount_amount" : 100.0,
    "pay_id" : "3223232323",
    "out_pay_id" : "3223232323",
    "extra_info" : "{\"session\", \"123\"}"
  } ]
}
1.1.13.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.14. 修改退单的结算信息

POST /{tenant_id}/soms/returnservice/rtn/{id}/settleinfo/update
1.1.14.1. 说明

修改退单的结算信息

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

Path

id
必填

退单id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnSettleInfoUpdateRequest
1.1.14.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.14.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/settleinfo/update?operator=string
请求 body
{
  "settlable" : true,
  "settle_date" : "2020-06-17 10:00:00"
}
1.1.14.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.15. 修改退回物流信息

POST /{tenant_id}/soms/returnservice/rtn/{id}/updatertndelivery
1.1.15.1. 说明

修改退回物流信息

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

Path

id
必填

退单id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnUpdateDeliveryRequest
1.1.15.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.15.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/updatertndelivery?operator=string
请求 body
{
  "state" : "received",
  "carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "mobile" : "18859540085",
  "waybill_id" : "43444444444232323"
}
1.1.15.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.16. 根据销售退申请单号取退单

GET /{tenant_id}/soms/returnservice/rtn/{rtn_req_id}/getsByRtnReq
1.1.16.1. 说明

根据销售退申请单号取退单

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

Path

rtn_req_id
必填

销售退申请单号

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，取值范围:items(商品详情)

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

200

successful operation

RtnList
1.1.16.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/getsByRtnReq
1.1.16.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "stationName" : "254145",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "return_state" : "string",
      "station_id" : "254145",
      "order_finished" : "2020-06-17 10:00:00"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_spec" : "122.22",
      "orig_unit" : "122.22",
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "orig_mas_sku_id" : "string",
      "is_gift" : true
    } ],
    "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\"}"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop(商家)、customer（消费者）",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0,
        "balance" : 100.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string",
    "req_id" : "string",
    "address_change_fee" : 120.01,
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    }
  } ]
}

1.1.17. 批量取退单

GET /{tenant_id}/soms/returnservice/rtns
1.1.17.1. 说明

批量取退单

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

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

string

Query

rtnIds
必填

退单订单号集合，最多100个

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

200

successful operation

RtnList
1.1.17.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns?rtnIds=string
1.1.17.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "stationName" : "254145",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "return_state" : "string",
      "station_id" : "254145",
      "order_finished" : "2020-06-17 10:00:00"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_spec" : "122.22",
      "orig_unit" : "122.22",
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "orig_mas_sku_id" : "string",
      "is_gift" : true
    } ],
    "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\"}"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop(商家)、customer（消费者）",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0,
        "balance" : 100.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string",
    "req_id" : "string",
    "address_change_fee" : 120.01,
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    }
  } ]
}

1.1.18. 根据平台退单号取多个退单

GET /{tenant_id}/soms/returnservice/rtns/front/{front_rtn_id}
1.1.18.1. 说明

根据平台退单号取多个退单

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

Path

front_rtn_id
必填

前端退单号

string

Path

tenant_id
必填

租户ID

string

Query

parts
必填

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

string

Query

platform_id
必填

平台ID

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

200

successful operation

RtnList
1.1.18.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/front/string?parts=string&platform_id=string
1.1.18.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "stationName" : "254145",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "return_state" : "string",
      "station_id" : "254145",
      "order_finished" : "2020-06-17 10:00:00"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_spec" : "122.22",
      "orig_unit" : "122.22",
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "orig_mas_sku_id" : "string",
      "is_gift" : true
    } ],
    "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\"}"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop(商家)、customer（消费者）",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0,
        "balance" : 100.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string",
    "req_id" : "string",
    "address_change_fee" : 120.01,
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    }
  } ]
}

1.1.19. 查指定平台订单的退单

GET /{tenant_id}/soms/returnservice/rtns/frontorder
1.1.19.1. 说明

查指定平台订单的退单

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

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

订单ID

string

Query

platform_id
必填

平台ID

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

200

successful operation

RtnList
1.1.19.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/frontorder?order_id=string&platform_id=string
1.1.19.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "stationName" : "254145",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "return_state" : "string",
      "station_id" : "254145",
      "order_finished" : "2020-06-17 10:00:00"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_spec" : "122.22",
      "orig_unit" : "122.22",
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "orig_mas_sku_id" : "string",
      "is_gift" : true
    } ],
    "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\"}"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop(商家)、customer（消费者）",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0,
        "balance" : 100.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string",
    "req_id" : "string",
    "address_change_fee" : 120.01,
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    }
  } ]
}

1.1.20. 查指定订单的退单

GET /{tenant_id}/soms/returnservice/rtns/order
1.1.20.1. 说明

查指定订单的退单，默认不返回退单商品明细等关联信息，需要取关联信息，传parts

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

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

订单ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

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

200

successful operation

RtnList
1.1.20.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/order?order_id=string
1.1.20.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "stationName" : "254145",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "return_state" : "string",
      "station_id" : "254145",
      "order_finished" : "2020-06-17 10:00:00"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_spec" : "122.22",
      "orig_unit" : "122.22",
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "orig_mas_sku_id" : "string",
      "is_gift" : true
    } ],
    "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\"}"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop(商家)、customer（消费者）",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0,
        "balance" : 100.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string",
    "req_id" : "string",
    "address_change_fee" : 120.01,
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    }
  } ]
}

1.1.21. 查指定订单的退单

POST /{tenant_id}/soms/returnservice/rtns/orders
1.1.21.1. 说明

查指定订单的退单

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

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

string

Body

order_id
必填

订单ID

< string > array
1.1.21.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnList
1.1.21.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/orders
请求 body
[ "string" ]
1.1.21.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "stationName" : "254145",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "return_state" : "string",
      "station_id" : "254145",
      "order_finished" : "2020-06-17 10:00:00"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_spec" : "122.22",
      "orig_unit" : "122.22",
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "orig_mas_sku_id" : "string",
      "is_gift" : true
    } ],
    "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\"}"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop(商家)、customer（消费者）",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0,
        "balance" : 100.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string",
    "req_id" : "string",
    "address_change_fee" : 120.01,
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    }
  } ]
}

1.1.22. 批量获取退单打印(JPOS打印方)

GET /{tenant_id}/soms/returnservice/rtns/printbills

operation.deprecated
1.1.22.1. 说明

批量获取退单打印(JPOS打印方)

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

Path

tenant_id
必填

租户ID

string

Query

ids
必填

退单号集合

< string > array(multi)

Query

name
可选

打印联的名称，为空则打印全部联。取值有：外卖退单

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

200

successful operation

RtnPrintDataList
1.1.22.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/printbills?ids=string
1.1.22.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "time" : "2016-03-02 12:00:01",
    "rtn_id" : "20160122000006",
    "front_rtn_id" : "20160122000006"
  } ]
}

1.1.23. 查询退单（ES查询）

POST /{tenant_id}/soms/returnservice/rtns/query
1.1.23.1. 说明

查询退单（ES查询，推荐使用），注意避免深度分页

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

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小

integer (int32)

Query

sort_key
可选

排序字段 created、modified、front_created

string

Body

filter
必填

查询条件

RtnFilter
1.1.23.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnPaging
1.1.23.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/query?desc=true&page=0&page_size=0
请求 body
{
  "appeal" : false,
  "platform_id" : "jdo2o",
  "platform_ids" : "jdo2o",
  "order_id" : "123456",
  "order_id_in" : "123456",
  "rtn_Id" : "123456",
  "shop_id" : "12348522",
  "station_id" : "12345",
  "front_order_id" : "323434",
  "front_rtn_id" : "3232434",
  "customer_Name" : "张三",
  "customer_Mobile" : "18587887789",
  "customer_mobile_like" : "7789",
  "types" : [ "refund" ],
  "states" : [ "confirmed" ],
  "carrier_states" : [ "initial" ],
  "carrier_types" : [ "self" ],
  "approve_states" : [ "none" ],
  "return_states" : [ "none" ],
  "refund_states" : [ "none" ],
  "station_ids" : [ "string" ],
  "product_contains" : "sku2323",
  "front_created_start" : "2016-03-02 12:00:02",
  "front_created_end" : "2016-03-02 12:00:02",
  "created_start" : "2016-03-02 12:00:02",
  "created_end" : "2016-03-02 12:00:02",
  "deliver_rtn_start" : "2016-03-02 12:00:02",
  "deliver_rtn_end" : "2016-03-02 12:00:02",
  "waybill_id" : "32323434",
  "index_modified_start" : "2016-03-02 12:00:02",
  "index_modified_end" : "2016-03-02 12:00:02",
  "pre_page" : 1,
  "has_exception" : false,
  "front_sku_id" : "3234",
  "rtn_ids" : [ "string" ],
  "sku_id" : "232323",
  "has_billing" : false,
  "bill_id_like" : "3454545",
  "bill_id_eq" : "32323434",
  "app_id_eq" : "3232323",
  "front_station_order_no_eq" : "3232323",
  "pick_info_operator_id_eq" : "string",
  "pick_info_operator_id_in" : [ "string" ],
  "pick_info_operator_name_like" : "string",
  "vendor_code_eq" : "3232323",
  "vendor_code_start_with" : "3232323",
  "vendor_code_in" : "3232323",
  "wrh_id_start_with" : "3232323",
  "wrh_id_in" : "3232323",
  "station_type" : "wrh",
  "refund_phase" : "aftersale",
  "fake_refund_date" : "2016-03-02"
}
1.1.23.5. HTTP响应示例
响应 200
{
  "total" : 0,
  "page" : 0,
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "stationName" : "254145",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "return_state" : "string",
      "station_id" : "254145",
      "order_finished" : "2020-06-17 10:00:00"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_spec" : "122.22",
      "orig_unit" : "122.22",
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "orig_mas_sku_id" : "string",
      "is_gift" : true
    } ],
    "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\"}"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop(商家)、customer（消费者）",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0,
        "balance" : 100.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string",
    "req_id" : "string",
    "address_change_fee" : 120.01,
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    }
  } ],
  "page_count" : 0,
  "page_size" : 0
}

1.2. 统计服务

1.2.1. 提交count

POST /{tenant_id}/soms/countservice/count
1.2.1.1. 说明

提交count

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

count
必填

统计

Count
1.2.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.2.1.4. HTTP请求示例
请求 path
/string/soms/countservice/count?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "type" : "order",
  "action" : "decrypt",
  "value" : "10",
  "business_key" : "123",
  "action_name" : "解密"
}
1.2.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.2.2. 查询统计

POST /{tenant_id}/soms/countservice/count/query
1.2.2.1. 说明

查询统计

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

Path

tenant_id
必填

租户Id

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小 [1, 1000]

integer (int32)

Query

sort_key
可选

排序字段

string

Body

filter
必填

查询条件

统计服务过滤器
1.2.2.3. 响应
HTTP代码 说明 类型

200

successful operation

soms分页查询结果Count
1.2.2.4. HTTP请求示例
请求 path
/string/soms/countservice/count/query?desc=true&page=0&page_size=0
请求 body
{
  "typeEq" : "order",
  "typeIn" : "[\"order\"]",
  "businessKeyEq" : "123",
  "businessKeyIn" : "[\"123\",\"456\"]",
  "actionEq" : "decrypt",
  "actionIn" : "[\"decrypt\"]",
  "actionNameLike" : "string",
  "modifiedBegin" : "2021-08-23 12:16:20",
  "modifiedEnd" : "2021-08-23 12:16:20"
}
1.2.2.5. HTTP响应示例
响应 200
{
  "page" : 0,
  "pageSize" : 100,
  "pageCount" : 2,
  "total" : "1000L",
  "data" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "type" : "order",
    "action" : "decrypt",
    "value" : "10",
    "business_key" : "123",
    "action_name" : "解密"
  } ]
}

1.2.3. 获取count

GET /{tenant_id}/soms/countservice/count/{business_key}
1.2.3.1. 说明

获取count

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

Path

business_key
必填

业务key

string

Path

tenant_id
必填

租户ID

string

Query

action
必填

操作类型

string

Query

type
必填

类型

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

200

successful operation

Count
1.2.3.4. HTTP请求示例
请求 path
/string/soms/countservice/count/string?action=string&type=string
1.2.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "type" : "order",
  "action" : "decrypt",
  "value" : "10",
  "business_key" : "123",
  "action_name" : "解密"
}

1.2.4. 计数加1

POST /{tenant_id}/soms/countservice/count/{business_key}/add
1.2.4.1. 说明

计数加1

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

Path

business_key
必填

业务key

string

Path

tenant_id
必填

租户Id

string

Query

action
必填

操作类型

string

Query

operator
可选

string

Query

type
必填

类型

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

200

successful operation

ActionResult
1.2.4.4. HTTP请求示例
请求 path
/string/soms/countservice/count/string/add?action=string&type=string
1.2.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.3. 订单调整服务

1.3.1. 取指定调整单

GET /{tenant_id}/soms/orderadjustservice/orderadjust/{id}
1.3.1.1. 说明

取指定调整单

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

Path

adjustId
必填

单据ID

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分

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

200

successful operation

OrderAdjust
1.3.1.4. HTTP请求示例
请求 path
/string/soms/orderadjustservice/orderadjust/{id}
1.3.1.5. HTTP响应示例
响应 200
{
  "id" : "12121212",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "state" : "未提交=initial,已提交 =submitted,审批通过 =approved,审批不通过=rejected;",
  "reason" : "超重补差",
  "remark" : "超重补差",
  "amount" : 0.0,
  "details" : "{}",
  "items" : "{}",
  "payments" : "{}",
  "order_id" : "121212",
  "adjust_phase" : "onsale=售中，aftersale=售后",
  "adjust_version" : 1
}

1.4. 对账管理-公开服务

1.4.1. 上传订单商品明细结算数据

POST /{tenant_id}/soms/ordersettleservice/item/upload
1.4.1.1. 说明

上传订单商品明细结算数据

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

bills
必填

订单商品明细结算数据列表

OrderSettleItemOrderList
1.4.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.4.1.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/item/upload?operator=string
请求 body
{
  "orders" : [ {
    "items" : [ {
      "created" : "2020-06-17 10:00:00",
      "modified" : "2020-06-17 10:00:00",
      "creator" : "string",
      "modifier" : "string",
      "total" : 20.0,
      "amount" : 33.0,
      "item_id" : "212121212",
      "platform_id" : "meituan",
      "shop_id" : "43435",
      "station_id" : "43435",
      "station_name" : "西店",
      "order_id" : "323232323",
      "sku_id" : "43434",
      "item_no" : "1",
      "order_created" : "2018-12-07 14:34:00",
      "front_sku_id" : "3230",
      "front_price" : 12.0,
      "front_discount_radio" : 0.0,
      "front_discount_amount" : 2.0,
      "front_score_amount" : 2.0,
      "quantity" : 12.0,
      "price" : 33.0,
      "unit_price" : 32.0,
      "discount_radio" : 0.0,
      "discount_amount" : 12.0,
      "pay_amount" : 12.0,
      "fav_amount" : 12.0,
      "discounts" : [ {
        "type" : "item",
        "act_id" : "343434",
        "act_name" : "string",
        "front_discount_type_id" : "3234",
        "front_discount_type_name" : "string",
        "front_discount_detail_type_id" : "2222",
        "front_discount_detail_type_name" : "string",
        "front_amount" : 333.0,
        "discount_amount" : 5.0,
        "radio" : 0.0,
        "amount" : 2.0
      } ]
    } ],
    "order_id" : "212121212"
  } ]
}
1.4.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.4.2. 查询指定订单商品明细结算数据

POST /{tenant_id}/soms/ordersettleservice/ordersettles/item/query
1.4.2.1. 说明

查询指定订单商品明细结算数据

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

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码，必须大于等于0

integer (int32)

Query

page_size
必填

分页大小，查询分页大小必须在[0,1000]

integer (int32)

Query

sort_key
可选

排序字段 目前没有可支持的值 不传默认orderId

string

Body

filter
必填

查询过滤器

OrderSettleItemFilter
1.4.2.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSettleItemPaging
1.4.2.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettles/item/query?desc=true&page=0&page_size=0
请求 body
{
  "platform_id_eq" : "meituan",
  "shop_id_eq" : "15154",
  "order_id_eq" : "323243434",
  "item_id_in" : [ "string" ]
}
1.4.2.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "items" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "total" : 20.0,
    "amount" : 33.0,
    "item_id" : "212121212",
    "platform_id" : "meituan",
    "shop_id" : "43435",
    "station_id" : "43435",
    "station_name" : "西店",
    "order_id" : "323232323",
    "sku_id" : "43434",
    "item_no" : "1",
    "order_created" : "2018-12-07 14:34:00",
    "front_sku_id" : "3230",
    "front_price" : 12.0,
    "front_discount_radio" : 0.0,
    "front_discount_amount" : 2.0,
    "front_score_amount" : 2.0,
    "quantity" : 12.0,
    "price" : 33.0,
    "unit_price" : 32.0,
    "discount_radio" : 0.0,
    "discount_amount" : 12.0,
    "pay_amount" : 12.0,
    "fav_amount" : 12.0,
    "discounts" : [ {
      "type" : "item",
      "act_id" : "343434",
      "act_name" : "string",
      "front_discount_type_id" : "3234",
      "front_discount_type_name" : "string",
      "front_discount_detail_type_id" : "2222",
      "front_discount_detail_type_name" : "string",
      "front_amount" : 333.0,
      "discount_amount" : 5.0,
      "radio" : 0.0,
      "amount" : 2.0
    } ]
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.4.3. 查询指定对账数据

POST /{tenant_id}/soms/ordersettleservice/ordersettles/query
1.4.3.1. 说明

查询指定对账数据

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

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码,必须大于等于0

integer (int32)

Query

page_size
必填

查询分页大小必须在[0,1000]

integer (int32)

Query

sort_key
可选

排序字段 id 不传默认orderId

string

Body

filter
必填

查询过滤器

OrderSettleFilter
1.4.3.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSettlePaging
1.4.3.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettles/query?desc=true&page=0&page_size=0
请求 body
{
  "ids" : [ "string" ],
  "platform_id_eq" : "meituan",
  "shop_id_eq" : "323443",
  "order_id_eq" : "323345354",
  "station_id_eq" : "0001",
  "sp_store_id_eq" : "0001",
  "order_id_in" : [ "string" ],
  "created_start" : "2019-08-07 19:49:36",
  "created_end" : "2019-08-07 19:49:36",
  "modified_start" : "2019-08-07 19:49:36",
  "modified_end" : "2019-08-07 19:49:36",
  "id_end_no_equal" : "string",
  "order_ids" : [ "string" ],
  "platform_id_in" : [ "string" ],
  "station_id_in" : [ "string" ],
  "order_start_with" : "string",
  "front_type_name_start_with" : "string",
  "front_type_name_eq" : "string",
  "settle_date_start" : "2019-08-07 19:49:36",
  "settle_date_end" : "2019-08-07 19:49:36"
}
1.4.3.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "items" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "total" : 22.0,
    "discount" : 2.0,
    "amount" : 22.0,
    "freight" : 0.0,
    "discounts" : [ {
      "type" : "item",
      "act_id" : "343434",
      "act_name" : "string",
      "front_discount_type_id" : "3234",
      "front_discount_type_name" : "string",
      "front_discount_detail_type_id" : "2222",
      "front_discount_detail_type_name" : "string",
      "front_amount" : 333.0,
      "discount_amount" : 5.0,
      "radio" : 0.0,
      "amount" : 2.0
    } ],
    "settle_id" : "68785680023933117_1",
    "front_settle_id" : "687856800239331",
    "platform_id" : "meituan",
    "shop_id" : "2123",
    "station_id" : "212123",
    "station_name" : "2323",
    "sp_store_id" : "2323",
    "front_type_id" : "1",
    "front_type_name" : "外卖订单",
    "sub_front_type_id" : "1",
    "sub_front_type_name" : "外卖订单",
    "delivery_type_id" : "string",
    "delivery_type_name" : "string",
    "order_id" : "132344",
    "front_state" : "8",
    "settle_date" : "2019-08-07 00:00:00",
    "order_created" : "2019-08-07 00:00:00",
    "order_finish_time" : "2019-08-07 00:00:00",
    "refund_id" : "323434343",
    "refund_time" : "2019-08-07 00:00:00",
    "package_box" : 2.0,
    "package_fee" : 1.0,
    "shop_package_fee" : 1.0,
    "other_fees" : [ {
      "type" : "delivery_tips",
      "fee" : 21.0
    } ],
    "discount_amount" : 2.0,
    "settle_discount" : 2.0,
    "shop_discount" : 2.0,
    "shop_freight_discount" : 0.0,
    "freight_discount" : 0.0,
    "settle_state" : "已入账",
    "settle_amount" : 2.0,
    "settle" : 22.0,
    "settle_commission" : 2.0,
    "selttle_commission" : 2.0,
    "settle_freight" : 120.01,
    "performance_service_fee" : 2.0,
    "platform_service_fee" : 2.0,
    "platform_service_rate" : 0.02,
    "bottom_service_fee" : 2.0,
    "platform_freight_discount" : 0.0,
    "pay_amount" : 22.0,
    "cod_amount" : 0.0,
    "freight_commission" : 0.0,
    "platform_promotion_settle" : 0.0,
    "platform_subsidy_suspend" : 0.0,
    "invoice_fee" : 0.0
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.4.4. 上传对账数据

POST /{tenant_id}/soms/ordersettleservice/upload
1.4.4.1. 说明

上传对账数据

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

bills
必填

订单结算单列表对象

OrderSettleList
1.4.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.4.4.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/upload?operator=string
请求 body
{
  "items" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "total" : 22.0,
    "discount" : 2.0,
    "amount" : 22.0,
    "freight" : 0.0,
    "discounts" : [ {
      "type" : "item",
      "act_id" : "343434",
      "act_name" : "string",
      "front_discount_type_id" : "3234",
      "front_discount_type_name" : "string",
      "front_discount_detail_type_id" : "2222",
      "front_discount_detail_type_name" : "string",
      "front_amount" : 333.0,
      "discount_amount" : 5.0,
      "radio" : 0.0,
      "amount" : 2.0
    } ],
    "settle_id" : "68785680023933117_1",
    "front_settle_id" : "687856800239331",
    "platform_id" : "meituan",
    "shop_id" : "2123",
    "station_id" : "212123",
    "station_name" : "2323",
    "sp_store_id" : "2323",
    "front_type_id" : "1",
    "front_type_name" : "外卖订单",
    "sub_front_type_id" : "1",
    "sub_front_type_name" : "外卖订单",
    "delivery_type_id" : "string",
    "delivery_type_name" : "string",
    "order_id" : "132344",
    "front_state" : "8",
    "settle_date" : "2019-08-07 00:00:00",
    "order_created" : "2019-08-07 00:00:00",
    "order_finish_time" : "2019-08-07 00:00:00",
    "refund_id" : "323434343",
    "refund_time" : "2019-08-07 00:00:00",
    "package_box" : 2.0,
    "package_fee" : 1.0,
    "shop_package_fee" : 1.0,
    "other_fees" : [ {
      "type" : "delivery_tips",
      "fee" : 21.0
    } ],
    "discount_amount" : 2.0,
    "settle_discount" : 2.0,
    "shop_discount" : 2.0,
    "shop_freight_discount" : 0.0,
    "freight_discount" : 0.0,
    "settle_state" : "已入账",
    "settle_amount" : 2.0,
    "settle" : 22.0,
    "settle_commission" : 2.0,
    "selttle_commission" : 2.0,
    "settle_freight" : 120.01,
    "performance_service_fee" : 2.0,
    "platform_service_fee" : 2.0,
    "platform_service_rate" : 0.02,
    "bottom_service_fee" : 2.0,
    "platform_freight_discount" : 0.0,
    "pay_amount" : 22.0,
    "cod_amount" : 0.0,
    "freight_commission" : 0.0,
    "platform_promotion_settle" : 0.0,
    "platform_subsidy_suspend" : 0.0,
    "invoice_fee" : 0.0
  } ]
}
1.4.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.5. 销售单服务

1.5.1. 提交销售单

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

提交销售单

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order
必填

销售单

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

200

successful operation

SaleOrderSubmitResponse
1.5.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_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"
        },
        "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",
    "combined" : true,
    "gift" : 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.5.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "sale_order_id" : "string"
}

1.5.2. 取指定平台销售单

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

取指定平台销售单

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

Path

front_order_id
必填

平台销售单id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用,隔开。

string

Query

platform_id
必填

平台id

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

200

successful operation

SaleOrder
1.5.2.4. HTTP请求示例
请求 path
/string/soms/saleorderservice/saleorder/front/string?platform_id=string
1.5.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_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"
        },
        "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",
    "combined" : true,
    "gift" : 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.5.3. 取指定销售单

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

取指定销售单

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

Path

sale_order_id
必填

销售单id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用,隔开。

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

200

successful operation

SaleOrder
1.5.3.4. HTTP请求示例
请求 path
/string/soms/saleorderservice/saleorder/{id}
1.5.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_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"
        },
        "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",
    "combined" : true,
    "gift" : 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.5.4. 更新销售订单配送状态

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

更新销售订单配送状态

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

Path

id
必填

销售订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

ActionResult
1.5.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.5.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.5.5. 取指定销售单

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

取指定销售单

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

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用,隔开。

string

Query

sale_order_id
必填

销售单id

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

200

successful operation

SaleOrderList
1.5.5.4. HTTP请求示例
请求 path
/string/soms/saleorderservice/saleorders?sale_order_id=string
1.5.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_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"
          },
          "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",
      "combined" : true,
      "gift" : 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.5.6. 查询销售单

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

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

1.5.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.5.6.3. 响应
HTTP代码 说明 类型

200

successful operation

SaleOrderPaging
1.5.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.5.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_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"
          },
          "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",
      "combined" : true,
      "gift" : 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
}

1.6. 评论服务

1.6.1. 提交订单评价

POST /{tenant_id}/soms/commentservice/comment
1.6.1.1. 说明

提交订单评价

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order_comment
必填

订单评价

OrderComment
1.6.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.6.1.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "202012021621",
  "store" : {
    "id" : "string",
    "name" : "string"
  },
  "time" : "2020-12-02 00:00:00",
  "content" : "很好",
  "labels" : [ "string" ],
  "details" : [ {
    "type" : "string",
    "score" : 0,
    "labels" : [ "string" ]
  } ],
  "order_id" : "202012021621",
  "platform_id" : "jdo2o",
  "shop_id" : "213",
  "image_urls" : [ "string" ],
  "extra_info" : {
    "next_time" : "2020-12-02 00:00:00",
    "next_content" : "很好",
    "delivery_content" : "很好",
    "next_image_urls" : "url"
  },
  "like_skus" : [ "string" ],
  "dislike_skus" : [ "string" ],
  "expire_time" : "2020-06-17 10:00:00",
  "front_comment_id" : "string",
  "reply_state" : "string",
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "process_state" : "string",
  "process_remark" : "string",
  "remark" : "string",
  "tags" : [ "string" ]
}
1.6.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.6.2. 查询评价

POST /{tenant_id}/soms/commentservice/comment/query
1.6.2.1. 说明

查询评价

1.6.2.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
可选

排序字段，取值范围:created(创建时间)、commentTime(评价时间)

string

Body

filter
必填

查询条件

OrderCommentFilter
1.6.2.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderCommentPaging
1.6.2.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/query?desc=true
请求 body
{
  "platformIdEq" : "jdo2o",
  "stationIdEq" : "string",
  "idEq" : "string",
  "orderIdIn" : [ "string" ],
  "processStateEq" : "string",
  "processStateNotIn" : [ "string" ],
  "tagEq" : "string",
  "tagIn" : [ "string" ],
  "tagHas" : [ "string" ],
  "orderIdLike" : "32323232323323",
  "hasReply" : "invalid",
  "satisfieLevel" : "high",
  "hasContent" : false,
  "commentTimeStart" : "2016-03-02 12:00:01",
  "commentTimeEnd" : "2016-03-02 12:00:01",
  "id_in" : [ "string" ]
}
1.6.2.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "comments" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "202012021621",
    "store" : {
      "id" : "string",
      "name" : "string"
    },
    "time" : "2020-12-02 00:00:00",
    "content" : "很好",
    "labels" : [ "string" ],
    "details" : [ {
      "type" : "string",
      "score" : 0,
      "labels" : [ "string" ]
    } ],
    "order_id" : "202012021621",
    "platform_id" : "jdo2o",
    "shop_id" : "213",
    "image_urls" : [ "string" ],
    "extra_info" : {
      "next_time" : "2020-12-02 00:00:00",
      "next_content" : "很好",
      "delivery_content" : "很好",
      "next_image_urls" : "url"
    },
    "like_skus" : [ "string" ],
    "dislike_skus" : [ "string" ],
    "expire_time" : "2020-06-17 10:00:00",
    "front_comment_id" : "string",
    "reply_state" : "string",
    "reply_time" : "2020-06-17 10:00:00",
    "reply_content" : "string",
    "process_state" : "string",
    "process_remark" : "string",
    "remark" : "string",
    "tags" : [ "string" ]
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.6.3. 获取评价

GET /{tenant_id}/soms/commentservice/comment/{id}
1.6.3.1. 说明

获取评价

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

Path

id
必填

评论Id

string

Path

tenant_id
必填

租户ID

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

200

successful operation

OrderComment
1.6.3.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/string
1.6.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "202012021621",
  "store" : {
    "id" : "string",
    "name" : "string"
  },
  "time" : "2020-12-02 00:00:00",
  "content" : "很好",
  "labels" : [ "string" ],
  "details" : [ {
    "type" : "string",
    "score" : 0,
    "labels" : [ "string" ]
  } ],
  "order_id" : "202012021621",
  "platform_id" : "jdo2o",
  "shop_id" : "213",
  "image_urls" : [ "string" ],
  "extra_info" : {
    "next_time" : "2020-12-02 00:00:00",
    "next_content" : "很好",
    "delivery_content" : "很好",
    "next_image_urls" : "url"
  },
  "like_skus" : [ "string" ],
  "dislike_skus" : [ "string" ],
  "expire_time" : "2020-06-17 10:00:00",
  "front_comment_id" : "string",
  "reply_state" : "string",
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "process_state" : "string",
  "process_remark" : "string",
  "remark" : "string",
  "tags" : [ "string" ]
}

1.6.4. 更新评价回复

POST /{tenant_id}/soms/commentservice/comment/{id}/reply
1.6.4.1. 说明

更新评价回复

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

Path

id
必填

评论Id

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

更新评价回复request

UpdateReplyContentRequest
1.6.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.6.4.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/string/reply?operator=string
请求 body
{
  "reply_content" : "string"
}
1.6.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7. 订单服务

1.7.1. 获取催单

GET /{tenant_id}/soms/orderremindservice/orderremind/{id}
1.7.1.1. 说明

获取催单

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

Path

id
必填

催单ID

string

Path

tenant_id
必填

租户Id

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

200

successful operation

OrderRemind
1.7.1.4. HTTP请求示例
请求 path
/string/soms/orderremindservice/orderremind/string
1.7.1.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "store" : {
    "id" : "string",
    "name" : "string"
  },
  "time" : "2020-12-02 00:00:00",
  "count" : 1,
  "remind_id" : "很好",
  "order_id" : "202012021621",
  "platform_id" : "jdo2o",
  "shop_id" : "jdo2o",
  "front_remind_id" : "很好",
  "reply_state" : "string",
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "reply_operator" : "string"
}

1.7.2. 催单回复

POST /{tenant_id}/soms/orderremindservice/remind/{id}/reply
1.7.2.1. 说明

催单回复

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

Path

id
必填

催单ID

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

催单

ReplyRemindRequest
1.7.2.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.2.4. HTTP请求示例
请求 path
/string/soms/orderremindservice/remind/string/reply?operator=string
请求 body
{
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "reply_operator" : "string"
}
1.7.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.3. 查询催单

POST /{tenant_id}/soms/orderremindservice/reminds/query
1.7.3.1. 说明

查询催单

1.7.3.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
可选

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

string

Body

filter
必填

查询条件

OrderRemindFilter
1.7.3.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderRemindPaging
1.7.3.4. HTTP请求示例
请求 path
/string/soms/orderremindservice/reminds/query?desc=true
请求 body
{
  "id_eq" : "123",
  "id_in" : [ "string" ],
  "platform_id_eq" : "meituan",
  "order_id_eq" : "123465",
  "order_id_in" : [ "string" ],
  "store_id_eq" : "0001",
  "reply_state_eq" : "none（未回复）、replied（已回复）、invalid（失效）"
}
1.7.3.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "reminds" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "store" : {
      "id" : "string",
      "name" : "string"
    },
    "time" : "2020-12-02 00:00:00",
    "count" : 1,
    "remind_id" : "很好",
    "order_id" : "202012021621",
    "platform_id" : "jdo2o",
    "shop_id" : "jdo2o",
    "front_remind_id" : "很好",
    "reply_state" : "string",
    "reply_time" : "2020-06-17 10:00:00",
    "reply_content" : "string",
    "reply_operator" : "string"
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.7.4. 提交订单（旧版）

POST /{tenant_id}/soms/orderservice/order
1.7.4.1. 说明

提交订单，只支持新增订单，不支持修改订单，状态：confirmed

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order
必填

订单

Order
1.7.4.3. 响应
HTTP代码 说明 类型

200

successful operation

IdWrapper
1.7.4.4. HTTP请求示例
请求 path
/string/soms/orderservice/order?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"
  },
  "source" : "小程序",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "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" : "脱敏地址**"
      }
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "waybills" : [ {
      "waybill_id" : "123"
    } ],
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "remark" : "定时达",
    "operation_state" : "none",
    "ship_mode" : "wrhShip",
    "ship_delivery_mode" : "wrhShipCarrierDeli",
    "wrh_order_id" : "32323",
    "ship_id" : "23232323",
    "waybill_id" : "123",
    "carrier_proxy_platform" : "string",
    "carrier_proxy_merchant" : "string",
    "carrier_note" : "加快",
    "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日 晚上",
    "selftake_confirmed" : true,
    "waybill_print_info" : {
      "datas" : [ {
        "type" : "string",
        "data" : "string"
      } ]
    }
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:01",
    "modified" : "2016-03-02 12:00:01",
    "state" : "已付款",
    "attribute" : "string",
    "order_id" : "1223654",
    "main_order_id" : "1223432",
    "third_order_id" : "1223432",
    "inner_order_id" : "1223432",
    "dpt_station_time" : "2016-03-02 12:00:01",
    "station_id" : "254145",
    "station_name" : "254145",
    "station_order_no" : "1",
    "finished_time" : "2016-03-02 12:00:01",
    "order_type" : {
      "id" : "string",
      "name" : "string"
    },
    "wrh_id" : "string"
  },
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "front" : {
      "spec" : "蓝色;微甜  少冰/多糖",
      "spec2" : "500g",
      "unit" : "string",
      "attributes" : [ {
        "group" : "口味",
        "values" : [ "string" ],
        "price" : 0.0,
        "qty" : 0.0
      } ],
      "tags" : [ {
        "id" : "string",
        "name" : "string"
      } ],
      "sku_id" : "052700601",
      "spu_id" : "052700601",
      "item_id" : "052700601"
    },
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "front_spec" : "辣",
      "real_quantity" : 0.0,
      "fault_tolerant_info" : "string",
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "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
    },
    "item_no" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "weight" : 1.0,
    "pay_amount" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_qty" : 125.0,
    "package_total" : 205.44,
    "package_info" : {
      "thermosphere" : "string",
      "quantity" : 125.0,
      "total" : 205.44,
      "packageName" : "保温袋"
    },
    "price" : 122.34,
    "cost_price" : 122.34,
    "shop_price" : 122.22,
    "shop_total" : 122.22,
    "settle_price" : 122.2222,
    "settle_total" : 122.22,
    "settle_discountAmount" : 122.22,
    "consume_scores" : 12.2,
    "image_url" : "http://aaa/bbb.png",
    "item_id" : "1",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "relation_sku_id" : "2123",
    "orig_mas_sku_id" : "string",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_weight" : 1.0,
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "weight" : 0.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_extra_info" : {
      "spec" : "1*1",
      "unit" : "个"
    },
    "fault_tolerant_info" : "string",
    "salesman" : {
      "id" : "string",
      "name" : "string"
    },
    "trace_codes" : [ "string" ],
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "extra_info" : "{\"inv_mgr\": false}",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "service_options" : "清洁/杀菌",
    "is_gift" : true
  } ],
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "exceptions" : [ {
    "code" : "sku",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "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\"}"
    } ]
  },
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "approve_state" : "none",
  "wrh_state" : "initial",
  "customer_note" : "note",
  "seller_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_type" : "customerCancel",
  "cancel_reason" : "我不想要了",
  "source_order_id" : "5346567534545645",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "商品不存在",
  "is_private" : true,
  "item_count" : 1,
  "sku_quantity" : 1.0,
  "real_total" : 120.01,
  "orig_total" : 120.01,
  "user_number" : 2,
  "settle_amount" : 120.01,
  "settle_commission" : 120.01,
  "selttle_commission" : 120.01,
  "settle_freight" : 120.01,
  "performance_service_fee" : 120.01,
  "shop_amount" : 120.01,
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "invoice_take_code" : "string",
  "item_change_records" : [ {
    "reason" : "string",
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ],
    "change_items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ]
  } ],
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "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\"}"
  },
  "fault_tolerant_info" : "string",
  "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"
  },
  "settle_unit" : {
    "type" : "store",
    "code" : "0001",
    "name" : "门店1"
  },
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "pick_info" : {
    "time" : "2020-06-17 10:00:00",
    "source" : "string",
    "operator_id" : "string",
    "operator_name" : "string",
    "auto_picked_finish" : true,
    "allow_pick_start_time" : "2020-06-17 10:00:00"
  },
  "item_logistics" : [ {
    "qty" : 0.0,
    "sku_id" : "string",
    "logistics_code" : "string"
  } ],
  "calc_data" : true,
  "wrh_id" : "4184",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string"
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "quotas" : [ {
    "action" : "expect_shipping",
    "time" : "2021-09-26 16:40:19",
    "remark" : "无",
    "action_name" : "期望拣货完成时间"
  } ],
  "reissue_reason" : "string",
  "responsible_party" : "string",
  "mock_info" : {
    "persist" : true
  },
  "adjust_details" : [ {
    "field" : "amount,pay_amount,quantity",
    "before" : "10",
    "after" : "12"
  } ],
  "sale_order_id" : "string",
  "waybill_id" : "32332",
  "address_change_fee" : 0.0,
  "reason" : "黑子",
  "shipping_voucher_urls" : [ "string" ],
  "wish_info" : {
    "wish" : "string",
    "type" : "string"
  }
}
1.7.4.5. HTTP响应示例
响应 200
{
  "id" : "string"
}

1.7.5. 自提检查

POST /{tenant_id}/soms/orderservice/order/action/selftake/check
1.7.5.1. 说明

自提检查

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

OrderSelftakeCheckRequest
1.7.5.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSelftakeCheckResponse
1.7.5.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/action/selftake/check?operator=string
请求 body
{
  "store_id" : "232434",
  "platform_id" : "youzan",
  "selftake_code" : "123456",
  "selftake_qrcode" : "123456",
  "front_order_id" : "5745323545453"
}
1.7.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "5745323545453"
}

1.7.6. 确认自提(新接口)

POST /{tenant_id}/soms/orderservice/order/action/v2/selftake
1.7.6.1. 说明

确认自提(新接口)

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

OrderSelftakeV2Request
1.7.6.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSelftakeV2Response
1.7.6.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/action/v2/selftake?operator=string
请求 body
{
  "store_id" : "454534",
  "selftake_qrcode" : "222222",
  "order_id" : "12345",
  "platform_id" : "be.eleme"
}
1.7.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "5745323545453"
}

1.7.7. 订单检测

POST /{tenant_id}/soms/orderservice/order/check
1.7.7.1. 说明

地址检测：支持检测美团、蜂鸟、顺丰大网，用于检测地址是否在配送范围内；配送检测：用于检测配送平台是否可送；配送计算：用于计算使用哪个配送平台进行配送

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

订单检测

OrderCheckRequest
1.7.7.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderCheckResponse
1.7.7.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/check?operator=string
请求 body
{
  "type" : "deliverycheck",
  "station" : {
    "id" : "string",
    "name" : "string"
  },
  "weight" : 10.0,
  "amount" : 10.0,
  "items" : "[]",
  "platform_id" : "jdo2o",
  "order_id" : "121212",
  "receiver_address" : {
    "country" : "中国",
    "province" : "福建省",
    "city" : "厦门市",
    "district" : "思明区",
    "street" : "前埔",
    "postcode" : "363423",
    "latitude" : "45.3,范围0-90",
    "longtitude" : "121.2,范围0-180",
    "coordinate_type" : "GCJ02",
    "private_street" : "脱敏地址**"
  },
  "receiver_contact" : {
    "name" : "李飞",
    "telephone" : "189389928893",
    "mobile" : "189389928893",
    "email" : "55151@qq.com",
    "fax" : "123123",
    "private_name" : "张*红",
    "private_mobile" : "189****0000"
  },
  "pre_type" : "normal",
  "expect_delivery_time" : "2022-03-02 14:00:01",
  "sku_quantity" : 10.0,
  "carrier_id" : "meituan",
  "ship_mode" : "stationShip"
}
1.7.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "distance" : 1000.0,
  "freight" : 10.0,
  "suggest_carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "pre_delivery_time" : "2022-06-30 12:00:00 或者 2022-06-30",
  "pre_delivery_slots" : [ {
    "pre_date" : "今天（周三）",
    "pre_ends" : "[\"立即送出\",\"12:00\",\"13:00\"]"
  } ],
  "delivery_mins" : 10.0
}

1.7.8. 批量修改订单下单门店

POST /{tenant_id}/soms/orderservice/order/mod/store
1.7.8.1. 说明

批量修改订单下单门店

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

修改内容

OrderStoreModRequest
1.7.8.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderStoreModResponse
1.7.8.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/mod/store?operator=string
请求 body
{
  "mods" : [ {
    "order_id" : "1212",
    "order_store" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}
1.7.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "errors" : [ {
    "id" : "1212",
    "message" : "订单不存在"
  } ]
}

1.7.9. 批量取指定订单

GET /{tenant_id}/soms/orderservice/order/orders
1.7.9.1. 说明

批量取订单，级联信息可以通过parts获取

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

Path

tenant_id
必填

租户ID

string

Query

id
必填

订单号集合，建议20，最多100个

< string > array(multi)

Query

parts
可选

需要返回的部分，取值范围:items(商品详情)、item.details（商品组合详情）,paymentDetails(支付详情)、invoiceDetails(发票详情)、printBills（打印信息）、prom（优惠信息）、exceptions（订单异常信息）、waybill.printinfo（运单打印信息）

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

200

successful operation

OrderList
1.7.9.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/orders?id=string
1.7.9.5. HTTP响应示例
响应 200
{
  "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"
    },
    "source" : "小程序",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "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" : "脱敏地址**"
        }
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "waybills" : [ {
        "waybill_id" : "123"
      } ],
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "remark" : "定时达",
      "operation_state" : "none",
      "ship_mode" : "wrhShip",
      "ship_delivery_mode" : "wrhShipCarrierDeli",
      "wrh_order_id" : "32323",
      "ship_id" : "23232323",
      "waybill_id" : "123",
      "carrier_proxy_platform" : "string",
      "carrier_proxy_merchant" : "string",
      "carrier_note" : "加快",
      "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日 晚上",
      "selftake_confirmed" : true,
      "waybill_print_info" : {
        "datas" : [ {
          "type" : "string",
          "data" : "string"
        } ]
      }
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:01",
      "modified" : "2016-03-02 12:00:01",
      "state" : "已付款",
      "attribute" : "string",
      "order_id" : "1223654",
      "main_order_id" : "1223432",
      "third_order_id" : "1223432",
      "inner_order_id" : "1223432",
      "dpt_station_time" : "2016-03-02 12:00:01",
      "station_id" : "254145",
      "station_name" : "254145",
      "station_order_no" : "1",
      "finished_time" : "2016-03-02 12:00:01",
      "order_type" : {
        "id" : "string",
        "name" : "string"
      },
      "wrh_id" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ],
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "exceptions" : [ {
      "code" : "sku",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "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\"}"
      } ]
    },
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "wrh_state" : "initial",
    "customer_note" : "note",
    "seller_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_type" : "customerCancel",
    "cancel_reason" : "我不想要了",
    "source_order_id" : "5346567534545645",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "商品不存在",
    "is_private" : true,
    "item_count" : 1,
    "sku_quantity" : 1.0,
    "real_total" : 120.01,
    "orig_total" : 120.01,
    "user_number" : 2,
    "settle_amount" : 120.01,
    "settle_commission" : 120.01,
    "selttle_commission" : 120.01,
    "settle_freight" : 120.01,
    "performance_service_fee" : 120.01,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "invoice_take_code" : "string",
    "item_change_records" : [ {
      "reason" : "string",
      "created" : "2020-06-17 10:00:00",
      "modified" : "2020-06-17 10:00:00",
      "creator" : "string",
      "modifier" : "string",
      "items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ],
      "change_items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ]
    } ],
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "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\"}"
    },
    "fault_tolerant_info" : "string",
    "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"
    },
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "pick_info" : {
      "time" : "2020-06-17 10:00:00",
      "source" : "string",
      "operator_id" : "string",
      "operator_name" : "string",
      "auto_picked_finish" : true,
      "allow_pick_start_time" : "2020-06-17 10:00:00"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "quotas" : [ {
      "action" : "expect_shipping",
      "time" : "2021-09-26 16:40:19",
      "remark" : "无",
      "action_name" : "期望拣货完成时间"
    } ],
    "reissue_reason" : "string",
    "responsible_party" : "string",
    "mock_info" : {
      "persist" : true
    },
    "adjust_details" : [ {
      "field" : "amount,pay_amount,quantity",
      "before" : "10",
      "after" : "12"
    } ],
    "sale_order_id" : "string",
    "waybill_id" : "32332",
    "address_change_fee" : 0.0,
    "reason" : "黑子",
    "shipping_voucher_urls" : [ "string" ],
    "wish_info" : {
      "wish" : "string",
      "type" : "string"
    }
  } ],
  "empty" : true
}

1.7.10. 补发订单

POST /{tenant_id}/soms/orderservice/order/reissue
1.7.10.1. 说明

补发订单

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

订单补发请求

OrderReissueRequest
1.7.10.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderReissueResponse
1.7.10.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/reissue?operator=string
请求 body
{
  "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" : "脱敏地址**"
    }
  },
  "source_order_id" : "121212",
  "responsible_party" : "carrier",
  "reissue_reason" : "弄丢了",
  "reissue_order_items" : [ {
    "quantity" : 13.0,
    "item_no" : "1",
    "sku_id" : "132323"
  } ],
  "seller_note" : "商家备注"
}
1.7.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "string"
}

1.7.11. 根据销售订单号取订单

GET /{tenant_id}/soms/orderservice/order/saleorder/{sale_order_id}
1.7.11.1. 说明

根据销售订单号取订单

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

Path

sale_order_id
必填

销售订单号

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，取值范围:items(商品详情)、paym entDetails(支付详情)、invoiceDetails(发票详情)

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

200

successful operation

OrderList
1.7.11.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/saleorder/string
1.7.11.5. HTTP响应示例
响应 200
{
  "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"
    },
    "source" : "小程序",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "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" : "脱敏地址**"
        }
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "waybills" : [ {
        "waybill_id" : "123"
      } ],
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "remark" : "定时达",
      "operation_state" : "none",
      "ship_mode" : "wrhShip",
      "ship_delivery_mode" : "wrhShipCarrierDeli",
      "wrh_order_id" : "32323",
      "ship_id" : "23232323",
      "waybill_id" : "123",
      "carrier_proxy_platform" : "string",
      "carrier_proxy_merchant" : "string",
      "carrier_note" : "加快",
      "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日 晚上",
      "selftake_confirmed" : true,
      "waybill_print_info" : {
        "datas" : [ {
          "type" : "string",
          "data" : "string"
        } ]
      }
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:01",
      "modified" : "2016-03-02 12:00:01",
      "state" : "已付款",
      "attribute" : "string",
      "order_id" : "1223654",
      "main_order_id" : "1223432",
      "third_order_id" : "1223432",
      "inner_order_id" : "1223432",
      "dpt_station_time" : "2016-03-02 12:00:01",
      "station_id" : "254145",
      "station_name" : "254145",
      "station_order_no" : "1",
      "finished_time" : "2016-03-02 12:00:01",
      "order_type" : {
        "id" : "string",
        "name" : "string"
      },
      "wrh_id" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ],
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "exceptions" : [ {
      "code" : "sku",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "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\"}"
      } ]
    },
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "wrh_state" : "initial",
    "customer_note" : "note",
    "seller_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_type" : "customerCancel",
    "cancel_reason" : "我不想要了",
    "source_order_id" : "5346567534545645",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "商品不存在",
    "is_private" : true,
    "item_count" : 1,
    "sku_quantity" : 1.0,
    "real_total" : 120.01,
    "orig_total" : 120.01,
    "user_number" : 2,
    "settle_amount" : 120.01,
    "settle_commission" : 120.01,
    "selttle_commission" : 120.01,
    "settle_freight" : 120.01,
    "performance_service_fee" : 120.01,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "invoice_take_code" : "string",
    "item_change_records" : [ {
      "reason" : "string",
      "created" : "2020-06-17 10:00:00",
      "modified" : "2020-06-17 10:00:00",
      "creator" : "string",
      "modifier" : "string",
      "items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ],
      "change_items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ]
    } ],
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "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\"}"
    },
    "fault_tolerant_info" : "string",
    "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"
    },
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "pick_info" : {
      "time" : "2020-06-17 10:00:00",
      "source" : "string",
      "operator_id" : "string",
      "operator_name" : "string",
      "auto_picked_finish" : true,
      "allow_pick_start_time" : "2020-06-17 10:00:00"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "quotas" : [ {
      "action" : "expect_shipping",
      "time" : "2021-09-26 16:40:19",
      "remark" : "无",
      "action_name" : "期望拣货完成时间"
    } ],
    "reissue_reason" : "string",
    "responsible_party" : "string",
    "mock_info" : {
      "persist" : true
    },
    "adjust_details" : [ {
      "field" : "amount,pay_amount,quantity",
      "before" : "10",
      "after" : "12"
    } ],
    "sale_order_id" : "string",
    "waybill_id" : "32332",
    "address_change_fee" : 0.0,
    "reason" : "黑子",
    "shipping_voucher_urls" : [ "string" ],
    "wish_info" : {
      "wish" : "string",
      "type" : "string"
    }
  } ],
  "empty" : true
}

1.7.12. 提交订单（新版）

POST /{tenant_id}/soms/orderservice/order/submit
1.7.12.1. 说明

提交订单，只支持新增订单，不支持修改订单，订单状态：confirmed

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order
必填

订单

Order
1.7.12.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSubmitResponse
1.7.12.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/submit?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"
  },
  "source" : "小程序",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "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" : "脱敏地址**"
      }
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "waybills" : [ {
      "waybill_id" : "123"
    } ],
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "remark" : "定时达",
    "operation_state" : "none",
    "ship_mode" : "wrhShip",
    "ship_delivery_mode" : "wrhShipCarrierDeli",
    "wrh_order_id" : "32323",
    "ship_id" : "23232323",
    "waybill_id" : "123",
    "carrier_proxy_platform" : "string",
    "carrier_proxy_merchant" : "string",
    "carrier_note" : "加快",
    "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日 晚上",
    "selftake_confirmed" : true,
    "waybill_print_info" : {
      "datas" : [ {
        "type" : "string",
        "data" : "string"
      } ]
    }
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:01",
    "modified" : "2016-03-02 12:00:01",
    "state" : "已付款",
    "attribute" : "string",
    "order_id" : "1223654",
    "main_order_id" : "1223432",
    "third_order_id" : "1223432",
    "inner_order_id" : "1223432",
    "dpt_station_time" : "2016-03-02 12:00:01",
    "station_id" : "254145",
    "station_name" : "254145",
    "station_order_no" : "1",
    "finished_time" : "2016-03-02 12:00:01",
    "order_type" : {
      "id" : "string",
      "name" : "string"
    },
    "wrh_id" : "string"
  },
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "front" : {
      "spec" : "蓝色;微甜  少冰/多糖",
      "spec2" : "500g",
      "unit" : "string",
      "attributes" : [ {
        "group" : "口味",
        "values" : [ "string" ],
        "price" : 0.0,
        "qty" : 0.0
      } ],
      "tags" : [ {
        "id" : "string",
        "name" : "string"
      } ],
      "sku_id" : "052700601",
      "spu_id" : "052700601",
      "item_id" : "052700601"
    },
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "front_spec" : "辣",
      "real_quantity" : 0.0,
      "fault_tolerant_info" : "string",
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "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
    },
    "item_no" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "weight" : 1.0,
    "pay_amount" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_qty" : 125.0,
    "package_total" : 205.44,
    "package_info" : {
      "thermosphere" : "string",
      "quantity" : 125.0,
      "total" : 205.44,
      "packageName" : "保温袋"
    },
    "price" : 122.34,
    "cost_price" : 122.34,
    "shop_price" : 122.22,
    "shop_total" : 122.22,
    "settle_price" : 122.2222,
    "settle_total" : 122.22,
    "settle_discountAmount" : 122.22,
    "consume_scores" : 12.2,
    "image_url" : "http://aaa/bbb.png",
    "item_id" : "1",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "relation_sku_id" : "2123",
    "orig_mas_sku_id" : "string",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_weight" : 1.0,
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "weight" : 0.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_extra_info" : {
      "spec" : "1*1",
      "unit" : "个"
    },
    "fault_tolerant_info" : "string",
    "salesman" : {
      "id" : "string",
      "name" : "string"
    },
    "trace_codes" : [ "string" ],
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "extra_info" : "{\"inv_mgr\": false}",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "service_options" : "清洁/杀菌",
    "is_gift" : true
  } ],
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "exceptions" : [ {
    "code" : "sku",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "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\"}"
    } ]
  },
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "approve_state" : "none",
  "wrh_state" : "initial",
  "customer_note" : "note",
  "seller_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_type" : "customerCancel",
  "cancel_reason" : "我不想要了",
  "source_order_id" : "5346567534545645",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "商品不存在",
  "is_private" : true,
  "item_count" : 1,
  "sku_quantity" : 1.0,
  "real_total" : 120.01,
  "orig_total" : 120.01,
  "user_number" : 2,
  "settle_amount" : 120.01,
  "settle_commission" : 120.01,
  "selttle_commission" : 120.01,
  "settle_freight" : 120.01,
  "performance_service_fee" : 120.01,
  "shop_amount" : 120.01,
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "invoice_take_code" : "string",
  "item_change_records" : [ {
    "reason" : "string",
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ],
    "change_items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ]
  } ],
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "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\"}"
  },
  "fault_tolerant_info" : "string",
  "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"
  },
  "settle_unit" : {
    "type" : "store",
    "code" : "0001",
    "name" : "门店1"
  },
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "pick_info" : {
    "time" : "2020-06-17 10:00:00",
    "source" : "string",
    "operator_id" : "string",
    "operator_name" : "string",
    "auto_picked_finish" : true,
    "allow_pick_start_time" : "2020-06-17 10:00:00"
  },
  "item_logistics" : [ {
    "qty" : 0.0,
    "sku_id" : "string",
    "logistics_code" : "string"
  } ],
  "calc_data" : true,
  "wrh_id" : "4184",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string"
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "quotas" : [ {
    "action" : "expect_shipping",
    "time" : "2021-09-26 16:40:19",
    "remark" : "无",
    "action_name" : "期望拣货完成时间"
  } ],
  "reissue_reason" : "string",
  "responsible_party" : "string",
  "mock_info" : {
    "persist" : true
  },
  "adjust_details" : [ {
    "field" : "amount,pay_amount,quantity",
    "before" : "10",
    "after" : "12"
  } ],
  "sale_order_id" : "string",
  "waybill_id" : "32332",
  "address_change_fee" : 0.0,
  "reason" : "黑子",
  "shipping_voucher_urls" : [ "string" ],
  "wish_info" : {
    "wish" : "string",
    "type" : "string"
  }
}
1.7.12.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "string"
}

1.7.13. 批量取指定订单_v2

POST /{tenant_id}/soms/orderservice/order/v2/orders
1.7.13.1. 说明

批量取订单，级联信息可以通过parts获取

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

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，取值范围:items(商品详情)、item.details（商品组合详情）,paymentDetails(支付详情)、invoiceDetails(发票详情)、printBills（打印信息）、prom（优惠信息）、exceptions（订单异常信息）、waybill.printinfo（运单打印信息）

string

Body

ids
必填

订单号集合

IdsWrapper
1.7.13.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderList
1.7.13.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/v2/orders
请求 body
{
  "ids" : [ "string" ]
}
1.7.13.5. HTTP响应示例
响应 200
{
  "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"
    },
    "source" : "小程序",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "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" : "脱敏地址**"
        }
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "waybills" : [ {
        "waybill_id" : "123"
      } ],
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "remark" : "定时达",
      "operation_state" : "none",
      "ship_mode" : "wrhShip",
      "ship_delivery_mode" : "wrhShipCarrierDeli",
      "wrh_order_id" : "32323",
      "ship_id" : "23232323",
      "waybill_id" : "123",
      "carrier_proxy_platform" : "string",
      "carrier_proxy_merchant" : "string",
      "carrier_note" : "加快",
      "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日 晚上",
      "selftake_confirmed" : true,
      "waybill_print_info" : {
        "datas" : [ {
          "type" : "string",
          "data" : "string"
        } ]
      }
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:01",
      "modified" : "2016-03-02 12:00:01",
      "state" : "已付款",
      "attribute" : "string",
      "order_id" : "1223654",
      "main_order_id" : "1223432",
      "third_order_id" : "1223432",
      "inner_order_id" : "1223432",
      "dpt_station_time" : "2016-03-02 12:00:01",
      "station_id" : "254145",
      "station_name" : "254145",
      "station_order_no" : "1",
      "finished_time" : "2016-03-02 12:00:01",
      "order_type" : {
        "id" : "string",
        "name" : "string"
      },
      "wrh_id" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ],
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "exceptions" : [ {
      "code" : "sku",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "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\"}"
      } ]
    },
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "wrh_state" : "initial",
    "customer_note" : "note",
    "seller_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_type" : "customerCancel",
    "cancel_reason" : "我不想要了",
    "source_order_id" : "5346567534545645",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "商品不存在",
    "is_private" : true,
    "item_count" : 1,
    "sku_quantity" : 1.0,
    "real_total" : 120.01,
    "orig_total" : 120.01,
    "user_number" : 2,
    "settle_amount" : 120.01,
    "settle_commission" : 120.01,
    "selttle_commission" : 120.01,
    "settle_freight" : 120.01,
    "performance_service_fee" : 120.01,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "invoice_take_code" : "string",
    "item_change_records" : [ {
      "reason" : "string",
      "created" : "2020-06-17 10:00:00",
      "modified" : "2020-06-17 10:00:00",
      "creator" : "string",
      "modifier" : "string",
      "items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ],
      "change_items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ]
    } ],
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "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\"}"
    },
    "fault_tolerant_info" : "string",
    "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"
    },
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "pick_info" : {
      "time" : "2020-06-17 10:00:00",
      "source" : "string",
      "operator_id" : "string",
      "operator_name" : "string",
      "auto_picked_finish" : true,
      "allow_pick_start_time" : "2020-06-17 10:00:00"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "quotas" : [ {
      "action" : "expect_shipping",
      "time" : "2021-09-26 16:40:19",
      "remark" : "无",
      "action_name" : "期望拣货完成时间"
    } ],
    "reissue_reason" : "string",
    "responsible_party" : "string",
    "mock_info" : {
      "persist" : true
    },
    "adjust_details" : [ {
      "field" : "amount,pay_amount,quantity",
      "before" : "10",
      "after" : "12"
    } ],
    "sale_order_id" : "string",
    "waybill_id" : "32332",
    "address_change_fee" : 0.0,
    "reason" : "黑子",
    "shipping_voucher_urls" : [ "string" ],
    "wish_info" : {
      "wish" : "string",
      "type" : "string"
    }
  } ],
  "empty" : true
}

1.7.14. 取指定订单

GET /{tenant_id}/soms/orderservice/order/{id}
1.7.14.1. 说明

取指定订单，如果需要获取订单商品明细等其他信息，URL需要传parts参数

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

Path

orderId
必填

订单id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用英文,隔开。需要返回的部分,items(商品详情)、item.details（商品组合详情）,、item.details（商品组合详情）、item.change.records（换货记录）、paymentDetails（支付详情）、invoiceDetails（发票详情）、printBills（打印数据）、prom（促销详情）、crm（营销详情）、logs（日志详情）、waybill.printinfo（运单打印信息）

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

200

successful operation

Order
1.7.14.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/{id}
1.7.14.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"
  },
  "source" : "小程序",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "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" : "脱敏地址**"
      }
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "waybills" : [ {
      "waybill_id" : "123"
    } ],
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "remark" : "定时达",
    "operation_state" : "none",
    "ship_mode" : "wrhShip",
    "ship_delivery_mode" : "wrhShipCarrierDeli",
    "wrh_order_id" : "32323",
    "ship_id" : "23232323",
    "waybill_id" : "123",
    "carrier_proxy_platform" : "string",
    "carrier_proxy_merchant" : "string",
    "carrier_note" : "加快",
    "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日 晚上",
    "selftake_confirmed" : true,
    "waybill_print_info" : {
      "datas" : [ {
        "type" : "string",
        "data" : "string"
      } ]
    }
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:01",
    "modified" : "2016-03-02 12:00:01",
    "state" : "已付款",
    "attribute" : "string",
    "order_id" : "1223654",
    "main_order_id" : "1223432",
    "third_order_id" : "1223432",
    "inner_order_id" : "1223432",
    "dpt_station_time" : "2016-03-02 12:00:01",
    "station_id" : "254145",
    "station_name" : "254145",
    "station_order_no" : "1",
    "finished_time" : "2016-03-02 12:00:01",
    "order_type" : {
      "id" : "string",
      "name" : "string"
    },
    "wrh_id" : "string"
  },
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "front" : {
      "spec" : "蓝色;微甜  少冰/多糖",
      "spec2" : "500g",
      "unit" : "string",
      "attributes" : [ {
        "group" : "口味",
        "values" : [ "string" ],
        "price" : 0.0,
        "qty" : 0.0
      } ],
      "tags" : [ {
        "id" : "string",
        "name" : "string"
      } ],
      "sku_id" : "052700601",
      "spu_id" : "052700601",
      "item_id" : "052700601"
    },
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "front_spec" : "辣",
      "real_quantity" : 0.0,
      "fault_tolerant_info" : "string",
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "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
    },
    "item_no" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "weight" : 1.0,
    "pay_amount" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_qty" : 125.0,
    "package_total" : 205.44,
    "package_info" : {
      "thermosphere" : "string",
      "quantity" : 125.0,
      "total" : 205.44,
      "packageName" : "保温袋"
    },
    "price" : 122.34,
    "cost_price" : 122.34,
    "shop_price" : 122.22,
    "shop_total" : 122.22,
    "settle_price" : 122.2222,
    "settle_total" : 122.22,
    "settle_discountAmount" : 122.22,
    "consume_scores" : 12.2,
    "image_url" : "http://aaa/bbb.png",
    "item_id" : "1",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "relation_sku_id" : "2123",
    "orig_mas_sku_id" : "string",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_weight" : 1.0,
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "weight" : 0.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_extra_info" : {
      "spec" : "1*1",
      "unit" : "个"
    },
    "fault_tolerant_info" : "string",
    "salesman" : {
      "id" : "string",
      "name" : "string"
    },
    "trace_codes" : [ "string" ],
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "extra_info" : "{\"inv_mgr\": false}",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "service_options" : "清洁/杀菌",
    "is_gift" : true
  } ],
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "exceptions" : [ {
    "code" : "sku",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "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\"}"
    } ]
  },
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "approve_state" : "none",
  "wrh_state" : "initial",
  "customer_note" : "note",
  "seller_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_type" : "customerCancel",
  "cancel_reason" : "我不想要了",
  "source_order_id" : "5346567534545645",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "商品不存在",
  "is_private" : true,
  "item_count" : 1,
  "sku_quantity" : 1.0,
  "real_total" : 120.01,
  "orig_total" : 120.01,
  "user_number" : 2,
  "settle_amount" : 120.01,
  "settle_commission" : 120.01,
  "selttle_commission" : 120.01,
  "settle_freight" : 120.01,
  "performance_service_fee" : 120.01,
  "shop_amount" : 120.01,
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "invoice_take_code" : "string",
  "item_change_records" : [ {
    "reason" : "string",
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ],
    "change_items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ]
  } ],
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "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\"}"
  },
  "fault_tolerant_info" : "string",
  "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"
  },
  "settle_unit" : {
    "type" : "store",
    "code" : "0001",
    "name" : "门店1"
  },
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "pick_info" : {
    "time" : "2020-06-17 10:00:00",
    "source" : "string",
    "operator_id" : "string",
    "operator_name" : "string",
    "auto_picked_finish" : true,
    "allow_pick_start_time" : "2020-06-17 10:00:00"
  },
  "item_logistics" : [ {
    "qty" : 0.0,
    "sku_id" : "string",
    "logistics_code" : "string"
  } ],
  "calc_data" : true,
  "wrh_id" : "4184",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string"
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "quotas" : [ {
    "action" : "expect_shipping",
    "time" : "2021-09-26 16:40:19",
    "remark" : "无",
    "action_name" : "期望拣货完成时间"
  } ],
  "reissue_reason" : "string",
  "responsible_party" : "string",
  "mock_info" : {
    "persist" : true
  },
  "adjust_details" : [ {
    "field" : "amount,pay_amount,quantity",
    "before" : "10",
    "after" : "12"
  } ],
  "sale_order_id" : "string",
  "waybill_id" : "32332",
  "address_change_fee" : 0.0,
  "reason" : "黑子",
  "shipping_voucher_urls" : [ "string" ],
  "wish_info" : {
    "wish" : "string",
    "type" : "string"
  }
}

1.7.15. 取消订单

POST /{tenant_id}/soms/orderservice/order/{id}/action/cancel
1.7.15.1. 说明

发货前，用户申请取消订单会直接取消订单；发货后用户申请取消订单会自动生成退货订单，退货订单收货后，订单变成客户拒收。

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

取消订单请求对象

CancelOrderRequest
1.7.15.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.15.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/cancel?operator=string
请求 body
{
  "type" : "customerCancel",
  "reason" : "不想要了",
  "frontRtnId" : "599565656"
}
1.7.15.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.16. 更新订单承运信息

POST /{tenant_id}/soms/orderservice/order/{id}/action/carrier
1.7.16.1. 说明

更新订单承运信息

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

CarrierRequest
1.7.16.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.16.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/carrier?operator=string
请求 body
{
  "carrier" : {
    "state" : "initial",
    "type" : "self",
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "merchant" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman_mobile" : "18859658865",
    "exception_reason" : "异常原因",
    "delivery_id" : "8548418",
    "delivery_name" : "8548418"
  },
  "operator" : "user",
  "tags" : [ {
    "name" : "首单"
  } ],
  "waybill_id" : "123",
  "delivery_id" : "123",
  "carrier_note" : "加快",
  "exception_remark" : "第三方要求取消",
  "print_info" : {
    "datas" : [ {
      "type" : "string",
      "data" : "string"
    } ]
  },
  "re_calc_carrier" : true,
  "ignore_check_carrier_state" : true,
  "carrier_proxy_platform" : {
    "value" : "string"
  },
  "carrier_proxy_merchant" : {
    "value" : "string"
  },
  "freight" : 1.11,
  "shop_freight" : {
    "value" : 0.0
  }
}
1.7.16.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.17. 更新订单配送状态(发货、签收)

POST /{tenant_id}/soms/orderservice/order/{id}/action/deliver
1.7.17.1. 说明

更新订单配送状态，更新发货：delivery_state=shipped；更新签收：delivery_state=signed

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

DeliverRequest
1.7.17.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.17.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/deliver?operator=string
请求 body
{
  "operator" : "zhangsan",
  "operation" : "shipping",
  "carrier" : {
    "state" : "initial",
    "type" : "self",
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "merchant" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman_mobile" : "18859658865",
    "exception_reason" : "异常原因",
    "delivery_id" : "8548418",
    "delivery_name" : "8548418"
  },
  "print" : true,
  "delivery_state" : "none",
  "operation_state" : "none（空）、accepted（已接单）、shipping（ 已集货/已拣货）、rechecked（已复核）、handover（已交接）",
  "ship_id" : "122323232",
  "waybill_id" : "1243566215",
  "carrier_note" : "已经在发货的路上",
  "selftake_confirmed" : true,
  "front_modified" : "2016-03-02 12:00:01",
  "front_finished_time" : "2016-03-02 12:00:01",
  "ship_time" : "2022-07-18 20:34:00",
  "pick_info" : {
    "time" : "2020-06-17 10:00:00",
    "source" : "string",
    "operator_id" : "string",
    "operator_name" : "string",
    "auto_picked_finish" : true,
    "allow_pick_start_time" : "2020-06-17 10:00:00"
  }
}
1.7.17.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.18. 确认自提

POST /{tenant_id}/soms/orderservice/order/{id}/action/selftake
1.7.18.1. 说明

确认自提

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

OrderSelftakeRequest
1.7.18.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSelftakeV2Response
1.7.18.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/selftake?operator=string
请求 body
{
  "store_id" : "454534",
  "selftake_qrcode" : "222222"
}
1.7.18.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "5745323545453"
}

1.7.19. 更新订单订单门店作业状态

POST /{tenant_id}/soms/orderservice/order/{id}/action/storeoperation
1.7.19.1. 说明

更新订单门店作业状态

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

门店作业请求

StoreOperationRequest
1.7.19.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.19.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/storeoperation?operator=string
请求 body
{
  "operation" : "accept",
  "store_id" : "21213323",
  "operation_state" : "none（空）、accepted（已接单）、shipping（ 已集货/已拣货）、rechecked（已复核）、handover（已交接）",
  "shipping_voucher_urls" : [ "string" ],
  "pick_info" : {
    "time" : "2020-06-17 10:00:00",
    "source" : "string",
    "operator_id" : "string",
    "operator_name" : "string",
    "auto_picked_finish" : true,
    "allow_pick_start_time" : "2020-06-17 10:00:00"
  }
}
1.7.19.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.20. 商家主动发起退款

POST /{tenant_id}/soms/orderservice/order/{id}/applyrtn
1.7.20.1. 说明

商家主动发起退款

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

申请请求对象

OrderApplyRtnRequest
1.7.20.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderApplyRtnResponse
1.7.20.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/applyrtn?operator=string
请求 body
{
  "reason" : "不想要了",
  "type" : "refund",
  "policy" : "取值：orig_sku(原商品)、sku(现商品)",
  "items" : [ {
    "quantity" : 1.0,
    "weight" : 1.0,
    "weights" : "1",
    "item_no" : "1",
    "sku_id" : "2123",
    "real_total_weight" : 1.0,
    "refund_amount" : 12.03
  } ],
  "front_app" : {
    "id" : "string",
    "name" : "string"
  },
  "rtn_id" : "54132321623",
  "apply_type" : "weight_diff",
  "approve_state" : "none"
}
1.7.20.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "apply_id" : "申请幂等ID",
  "apply_ids" : "多个申请幂等ID"
}

1.7.21. 取消承运商配送申请

POST /{tenant_id}/soms/orderservice/order/{id}/cancel/carrier
1.7.21.1. 说明

取消承运商配送申请

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

取消承运商调度请求

CancelCarrierRequest
1.7.21.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.21.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/cancel/carrier?operator=string
请求 body
{
  "reason" : "客户不要了",
  "carrier_id" : "343434343",
  "auto_dispatch" : true
}
1.7.21.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.22. 更新开票结果

POST /{tenant_id}/soms/orderservice/order/{id}/invoice/result
1.7.22.1. 说明

更新开票结果

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

发票结果更新请求对象

OrderInvoiceResultRequest
1.7.22.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.22.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/invoice/result?operator=string
请求 body
{
  "time" : "2019-07-15 16:56:23",
  "url" : "a.jpg",
  "result" : "开票成功",
  "error_reason" : "系统异常",
  "serial_no" : "45546454454",
  "apply_qrcode" : "string"
}
1.7.22.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.23. 更新开票

POST /{tenant_id}/soms/orderservice/order/{id}/invoices
1.7.23.1. 说明

更新开票

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

发票更新请求对象

OrderInvoiceRequest
1.7.23.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.23.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/invoices?operator=string
请求 body
{
  "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"
  }
}
1.7.23.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.24. 获取快递订单物流轨迹信息

GET /{tenant_id}/soms/orderservice/order/{id}/kd/trace
1.7.24.1. 说明

获取快递订单物流轨迹信息,支持快递100

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

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

200

successful operation

OrderKdTrace
1.7.24.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/kd/trace?operator=string
1.7.24.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "state" : "canceled",
  "carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "details" : [ {
    "time" : "2022-04-07 08:39:07",
    "address" : "福建,厦门市",
    "message" : "顺丰速运 已收取快件",
    "status" : "在途"
  } ],
  "waybill_id" : "213232"
}

1.7.25. 更换承运商

POST /{tenant_id}/soms/orderservice/order/{id}/mod/carrier
1.7.25.1. 说明

更换承运商

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

承运商修改请求

CarrierModificationRequest
1.7.25.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.25.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/mod/carrier?operator=string
请求 body
{
  "type" : "self",
  "carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "merchant" : {
    "id" : "string",
    "name" : "string"
  },
  "deliveryman_id" : "32332",
  "deliveryman_name" : "李某",
  "deliveryman_mobile" : "1565586545",
  "carrier_proxy_platform" : {
    "value" : "string"
  },
  "carrier_proxy_merchant" : {
    "value" : "string"
  }
}
1.7.25.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.26. 订单付款

POST /{tenant_id}/soms/orderservice/order/{id}/pay
1.7.26.1. 说明

订单付款

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

支付请求对象

PayRequest
1.7.26.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.26.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/pay?operator=string
请求 body
{
  "payee" : {
    "id" : "string",
    "name" : "string"
  },
  "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\"}"
  } ],
  "pay_state" : "paid",
  "pay_time" : "2019-12-12 12:12:00",
  "pay_bill_id" : "123434354"
}
1.7.26.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.27. 更新订单拣货信息

POST /{tenant_id}/soms/orderservice/order/{id}/pickInfo
1.7.27.1. 说明

更新订单拣货信息

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

拣货信息请求

PickInfoRequest
1.7.27.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.27.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/pickInfo?operator=string
请求 body
{
  "pick_info" : {
    "time" : "2020-06-17 10:00:00",
    "source" : "string",
    "operator_id" : "string",
    "operator_name" : "string",
    "auto_picked_finish" : true,
    "allow_pick_start_time" : "2020-06-17 10:00:00"
  }
}
1.7.27.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.28. 更新订单标签

POST /{tenant_id}/soms/orderservice/order/{id}/tagging
1.7.28.1. 说明

更新订单标签

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

更新订单标签请求

TaggingRequest
1.7.28.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.28.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/tagging?operator=string
请求 body
{
  "add_tags" : [ "string" ],
  "remove_tags" : [ "string" ]
}
1.7.28.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.29. 更新订单客户备注

POST /{tenant_id}/soms/orderservice/order/{id}/updateCustomerNote
1.7.29.1. 说明

更新订单客户备注

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

更新客户备注请求

UpdateCustomerNoteRequest
1.7.29.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.7.29.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/updateCustomerNote?operator=string
请求 body
{
  "customer_note" : "string"
}
1.7.29.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7.30. 查询订单（数据库查询）

POST /{tenant_id}/soms/orderservice/orders/db/query
1.7.30.1. 说明

查询订单（不推荐使用）

1.7.30.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
必填

查询条件

订单数据库查询条件
1.7.30.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderPaging
1.7.30.4. HTTP请求示例
请求 path
/string/soms/orderservice/orders/db/query?desc=true&page=0&page_size=0
请求 body
{
  "station_id_in" : "[\"0001\"]",
  "order_id_or_front_station_order_no_eq" : "01",
  "order_id_eq" : "718597703857",
  "front_created_start" : "2025-03-05 10:20:30",
  "front_created_end" : "2025-03-05 16:28:32",
  "pick_info_operator_id_eq" : "9527",
  "pick_info_operator_id_in" : [ "string" ],
  "operation_state_in" : "[\"accepted\"]",
  "state_in" : "[\"confirmed\"]",
  "created_start" : "2025-03-03 00:00:00",
  "created_end" : "2025-03-03 23:59:59",
  "need_count_total" : true
}
1.7.30.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "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"
    },
    "source" : "小程序",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "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" : "脱敏地址**"
        }
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "waybills" : [ {
        "waybill_id" : "123"
      } ],
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "remark" : "定时达",
      "operation_state" : "none",
      "ship_mode" : "wrhShip",
      "ship_delivery_mode" : "wrhShipCarrierDeli",
      "wrh_order_id" : "32323",
      "ship_id" : "23232323",
      "waybill_id" : "123",
      "carrier_proxy_platform" : "string",
      "carrier_proxy_merchant" : "string",
      "carrier_note" : "加快",
      "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日 晚上",
      "selftake_confirmed" : true,
      "waybill_print_info" : {
        "datas" : [ {
          "type" : "string",
          "data" : "string"
        } ]
      }
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:01",
      "modified" : "2016-03-02 12:00:01",
      "state" : "已付款",
      "attribute" : "string",
      "order_id" : "1223654",
      "main_order_id" : "1223432",
      "third_order_id" : "1223432",
      "inner_order_id" : "1223432",
      "dpt_station_time" : "2016-03-02 12:00:01",
      "station_id" : "254145",
      "station_name" : "254145",
      "station_order_no" : "1",
      "finished_time" : "2016-03-02 12:00:01",
      "order_type" : {
        "id" : "string",
        "name" : "string"
      },
      "wrh_id" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ],
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "exceptions" : [ {
      "code" : "sku",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "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\"}"
      } ]
    },
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "wrh_state" : "initial",
    "customer_note" : "note",
    "seller_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_type" : "customerCancel",
    "cancel_reason" : "我不想要了",
    "source_order_id" : "5346567534545645",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "商品不存在",
    "is_private" : true,
    "item_count" : 1,
    "sku_quantity" : 1.0,
    "real_total" : 120.01,
    "orig_total" : 120.01,
    "user_number" : 2,
    "settle_amount" : 120.01,
    "settle_commission" : 120.01,
    "selttle_commission" : 120.01,
    "settle_freight" : 120.01,
    "performance_service_fee" : 120.01,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "invoice_take_code" : "string",
    "item_change_records" : [ {
      "reason" : "string",
      "created" : "2020-06-17 10:00:00",
      "modified" : "2020-06-17 10:00:00",
      "creator" : "string",
      "modifier" : "string",
      "items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ],
      "change_items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ]
    } ],
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "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\"}"
    },
    "fault_tolerant_info" : "string",
    "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"
    },
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "pick_info" : {
      "time" : "2020-06-17 10:00:00",
      "source" : "string",
      "operator_id" : "string",
      "operator_name" : "string",
      "auto_picked_finish" : true,
      "allow_pick_start_time" : "2020-06-17 10:00:00"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "quotas" : [ {
      "action" : "expect_shipping",
      "time" : "2021-09-26 16:40:19",
      "remark" : "无",
      "action_name" : "期望拣货完成时间"
    } ],
    "reissue_reason" : "string",
    "responsible_party" : "string",
    "mock_info" : {
      "persist" : true
    },
    "adjust_details" : [ {
      "field" : "amount,pay_amount,quantity",
      "before" : "10",
      "after" : "12"
    } ],
    "sale_order_id" : "string",
    "waybill_id" : "32332",
    "address_change_fee" : 0.0,
    "reason" : "黑子",
    "shipping_voucher_urls" : [ "string" ],
    "wish_info" : {
      "wish" : "string",
      "type" : "string"
    }
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.7.31. 查询订单（ES查询）

POST /{tenant_id}/soms/orderservice/orders/query
1.7.31.1. 说明

查询订单（ES查询，推荐使用）

1.7.31.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
必填

查询条件

OrderFilter
1.7.31.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderPaging
1.7.31.4. HTTP请求示例
请求 path
/string/soms/orderservice/orders/query?desc=true&page=0&page_size=0
请求 body
{
  "states" : [ "confirmed" ],
  "suspended" : true,
  "source" : "小程序",
  "prePage" : 0,
  "hasInvoice" : false,
  "invalid" : false,
  "platform_id" : "jdo2o",
  "platform_ids" : [ "string" ],
  "shop_id" : "0002",
  "pre_type" : "normal",
  "station_ids" : [ "string" ],
  "approve_states" : [ "none" ],
  "delivery_states" : [ "none" ],
  "delivery_types" : [ "selftake" ],
  "carrier_states" : [ "initial" ],
  "carrier_types" : [ "self" ],
  "payment_states" : [ "notPay" ],
  "payment_types" : [ "cod" ],
  "payment_out_pay_id" : "string",
  "receiver_mobile" : "18857485554",
  "receiver_mobile_like" : "5554",
  "receiver_mobile_end_with" : "5554",
  "customer_mobile_end_with" : "5554",
  "receiver_name" : "张三",
  "carrier_id" : "0003",
  "waybill_id" : "0003",
  "front_order_id" : "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",
  "created_start" : "2016-03-02 12:00:01",
  "created_end" : "2016-03-02 12:00:01",
  "modified_start" : "2016-03-02 12:00:01",
  "modified_end" : "2016-03-02 12:00:01",
  "cancel_type" : "customerCancel",
  "have_return" : true,
  "refund_state" : "none",
  "operation_state" : "none",
  "operation_states" : "[none,shipping]",
  "operation_shipping_time_start" : "2016-03-02 12:00:01",
  "operation_shipping_time_end" : "2016-03-02 12:00:01",
  "operation_handover_time_start" : "2016-03-02 12:00:01",
  "operation_handover_time_end" : "2016-03-02 12:00:01",
  "order_id" : "1000002111",
  "order_ids" : [ "string" ],
  "customer_name" : "张三",
  "customer_id" : "8568",
  "shipping_operator" : "张三",
  "handover_operator" : "张三",
  "address_contains" : "福建省",
  "delivered_time_start" : "2016-03-02 12:00:01",
  "delivered_time_end" : "2016-03-02 12:00:01",
  "delivering_time_start" : "2016-03-02 12:00:01",
  "delivering_time_end" : "2016-03-02 12:00:01",
  "deliveryman_name" : "张三",
  "delivery_id" : "111",
  "product_contains" : "sku1111",
  "sku_title" : "冰红茶",
  "has_exception" : false,
  "exception_code_contains" : "false",
  "selftake_code" : "123456",
  "index_modified_start" : "2016-03-02 12:00:01",
  "index_modified_end" : "2016-03-02 12:00:01",
  "has_billing" : true,
  "has_customer_note" : true,
  "bill_id_like" : "32323",
  "bill_id_eq" : "3232323",
  "customer_mobile" : "18896551546",
  "custom_order_state" : [ "string" ],
  "salesman_id_eq" : "3232323",
  "app_id_eq" : "3232323",
  "type_eq" : "拼团订单",
  "has_delivery_exception" : true,
  "front_main_order_id_eq" : "1223432",
  "front_main_order_id_start_with" : "1223432",
  "front_main_order_id_in" : "['123'，'456']",
  "front_sku_id" : "string",
  "sku_id" : "string",
  "sku_id_in" : "[\"sku1\", \"sku2\"]",
  "source_order_id_eq" : "213",
  "source_order_id_in" : [ "string" ],
  "wrh_id_start_with" : "3232323",
  "wrh_id_in" : "3232323",
  "vendor_code_eq" : "3232323",
  "vendor_code_start_with" : "3232323",
  "vendor_code_in" : "3232323",
  "ship_mode" : "string",
  "deliver_shipped_operator" : "rs",
  "prom_id" : "string",
  "prom_id_in" : [ "string" ],
  "prom_key" : "string",
  "prom_key_in" : [ "string" ],
  "prom_name_like" : "string",
  "pick_info_source_eq" : "string",
  "pick_info_operator_id_eq" : "string",
  "pick_info_operator_id_in" : [ "string" ],
  "pick_info_operator_name_like" : "string",
  "pick_info_time_start" : "2020-06-17 10:00:00",
  "pick_info_time_end" : "2020-06-17 10:00:00",
  "pick_info_is_auto_picked_finish" : true,
  "front_station_order_no_eq" : "string",
  "order_id_or_front_station_order_no_eq" : "string",
  "receiver_private_mobile_end_with" : "string",
  "pre_start_delivery_time_start" : "2020-06-17 10:00:00",
  "pre_start_delivery_time_end" : "2020-06-17 10:00:00",
  "pre_end_delivery_time_start" : "2020-06-17 10:00:00",
  "pre_end_delivery_time_end" : "2020-06-17 10:00:00",
  "front_station_id_in" : [ "string" ],
  "member_mobile_eq" : "string",
  "member_mobile_or_mobile_eq" : "string",
  "carrier_proxy_platform_eq" : "string",
  "fornt_order_type_id" : "string",
  "allow_pick_start_time_end" : "2020-06-17 10:00:00"
}
1.7.31.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "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"
    },
    "source" : "小程序",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "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" : "脱敏地址**"
        }
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "waybills" : [ {
        "waybill_id" : "123"
      } ],
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "remark" : "定时达",
      "operation_state" : "none",
      "ship_mode" : "wrhShip",
      "ship_delivery_mode" : "wrhShipCarrierDeli",
      "wrh_order_id" : "32323",
      "ship_id" : "23232323",
      "waybill_id" : "123",
      "carrier_proxy_platform" : "string",
      "carrier_proxy_merchant" : "string",
      "carrier_note" : "加快",
      "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日 晚上",
      "selftake_confirmed" : true,
      "waybill_print_info" : {
        "datas" : [ {
          "type" : "string",
          "data" : "string"
        } ]
      }
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:01",
      "modified" : "2016-03-02 12:00:01",
      "state" : "已付款",
      "attribute" : "string",
      "order_id" : "1223654",
      "main_order_id" : "1223432",
      "third_order_id" : "1223432",
      "inner_order_id" : "1223432",
      "dpt_station_time" : "2016-03-02 12:00:01",
      "station_id" : "254145",
      "station_name" : "254145",
      "station_order_no" : "1",
      "finished_time" : "2016-03-02 12:00:01",
      "order_type" : {
        "id" : "string",
        "name" : "string"
      },
      "wrh_id" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "tags" : [ {
          "id" : "string",
          "name" : "string"
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "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
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "service_options" : "清洁/杀菌",
      "is_gift" : true
    } ],
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "exceptions" : [ {
      "code" : "sku",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "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\"}"
      } ]
    },
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "wrh_state" : "initial",
    "customer_note" : "note",
    "seller_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_type" : "customerCancel",
    "cancel_reason" : "我不想要了",
    "source_order_id" : "5346567534545645",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "商品不存在",
    "is_private" : true,
    "item_count" : 1,
    "sku_quantity" : 1.0,
    "real_total" : 120.01,
    "orig_total" : 120.01,
    "user_number" : 2,
    "settle_amount" : 120.01,
    "settle_commission" : 120.01,
    "selttle_commission" : 120.01,
    "settle_freight" : 120.01,
    "performance_service_fee" : 120.01,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "invoice_take_code" : "string",
    "item_change_records" : [ {
      "reason" : "string",
      "created" : "2020-06-17 10:00:00",
      "modified" : "2020-06-17 10:00:00",
      "creator" : "string",
      "modifier" : "string",
      "items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ],
      "change_items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "tags" : [ {
            "id" : "string",
            "name" : "string"
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "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
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "service_options" : "清洁/杀菌",
        "is_gift" : true
      } ]
    } ],
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "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\"}"
    },
    "fault_tolerant_info" : "string",
    "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"
    },
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "pick_info" : {
      "time" : "2020-06-17 10:00:00",
      "source" : "string",
      "operator_id" : "string",
      "operator_name" : "string",
      "auto_picked_finish" : true,
      "allow_pick_start_time" : "2020-06-17 10:00:00"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "quotas" : [ {
      "action" : "expect_shipping",
      "time" : "2021-09-26 16:40:19",
      "remark" : "无",
      "action_name" : "期望拣货完成时间"
    } ],
    "reissue_reason" : "string",
    "responsible_party" : "string",
    "mock_info" : {
      "persist" : true
    },
    "adjust_details" : [ {
      "field" : "amount,pay_amount,quantity",
      "before" : "10",
      "after" : "12"
    } ],
    "sale_order_id" : "string",
    "waybill_id" : "32332",
    "address_change_fee" : 0.0,
    "reason" : "黑子",
    "shipping_voucher_urls" : [ "string" ],
    "wish_info" : {
      "wish" : "string",
      "type" : "string"
    }
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.8. 销售退服务

1.8.1. 根据平台申请单号取指定销售退

GET /{tenant_id}/soms/rtnreqservice/rtnreq/front/{front_rtn_id}
1.8.1.1. 说明

根据平台申请单号取指定销售退

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

Path

front_rtn_id
必填

销售退平台id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、changeItems（换出商品详情）

string

Query

platform_id
必填

平台ID

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

200

successful operation

RtnReq
1.8.1.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/front/string?platform_id=string
1.8.1.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "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" : "已付款",
    "wrh" : {
      "id" : "string",
      "name" : "string"
    },
    "logistic" : {
      "id" : "string",
      "name" : "string"
    },
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "order_id" : "1223654",
    "third_order_id" : "1223654",
    "main_order_id" : "1223432",
    "rtn_id" : "123456",
    "station_order_no" : "1",
    "order_type" : "string",
    "extend_props" : "string"
  },
  "delivery" : {
    "state" : "none",
    "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"
        },
        "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"
    } ],
    "returner" : {
      "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" : "脱敏地址**"
      }
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "station_type" : "string"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "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"
      }
    },
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0
    } ],
    "combined" : true,
    "gift" : true,
    "item_no" : "1",
    "item_id" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_total" : 205.44,
    "image_Url" : "http://1213323.png",
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "front_unit" : "string",
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "origin_sku_id" : "e235346ger545",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "rtn_state" : "string",
    "rtn_id" : "681795759987",
    "station_id" : "string",
    "station_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\"}"
    } ]
  },
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "tags" : [ {
    "name" : "首单"
  } ],
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "seller_node" : "note",
  "change_order_info" : {
    "change_order_id" : "string",
    "change_items" : [ {
      "quantity" : 13.0,
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "item_no" : "1",
      "sku_id" : "132323",
      "front_sku_id" : "1454543",
      "front_item_id" : "1323233"
    } ]
  },
  "voucher_urls" : [ "string" ],
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "station" : {
    "id" : "string",
    "name" : "string"
  }
}

1.8.2. 提交销售退

POST /{tenant_id}/soms/rtnreqservice/rtnreq/submit
1.8.2.1. 说明

提交销售退

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

rtn_req
必填

销售退

RtnReq
1.8.2.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnReqSubmitResponse
1.8.2.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/submit?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "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" : "已付款",
    "wrh" : {
      "id" : "string",
      "name" : "string"
    },
    "logistic" : {
      "id" : "string",
      "name" : "string"
    },
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "order_id" : "1223654",
    "third_order_id" : "1223654",
    "main_order_id" : "1223432",
    "rtn_id" : "123456",
    "station_order_no" : "1",
    "order_type" : "string",
    "extend_props" : "string"
  },
  "delivery" : {
    "state" : "none",
    "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"
        },
        "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"
    } ],
    "returner" : {
      "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" : "脱敏地址**"
      }
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "station_type" : "string"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "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"
      }
    },
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0
    } ],
    "combined" : true,
    "gift" : true,
    "item_no" : "1",
    "item_id" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_total" : 205.44,
    "image_Url" : "http://1213323.png",
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "front_unit" : "string",
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "origin_sku_id" : "e235346ger545",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "rtn_state" : "string",
    "rtn_id" : "681795759987",
    "station_id" : "string",
    "station_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\"}"
    } ]
  },
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "tags" : [ {
    "name" : "首单"
  } ],
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "seller_node" : "note",
  "change_order_info" : {
    "change_order_id" : "string",
    "change_items" : [ {
      "quantity" : 13.0,
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "item_no" : "1",
      "sku_id" : "132323",
      "front_sku_id" : "1454543",
      "front_item_id" : "1323233"
    } ]
  },
  "voucher_urls" : [ "string" ],
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "station" : {
    "id" : "string",
    "name" : "string"
  }
}
1.8.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "id" : "string"
}

1.8.3. 取指定销售退

GET /{tenant_id}/soms/rtnreqservice/rtnreq/{id}
1.8.3.1. 说明

取指定销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、changeItems（换出商品详情）

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

200

successful operation

RtnReq
1.8.3.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/string
1.8.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "张*红",
      "private_mobile" : "189****0000"
    }
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "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" : "已付款",
    "wrh" : {
      "id" : "string",
      "name" : "string"
    },
    "logistic" : {
      "id" : "string",
      "name" : "string"
    },
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "order_id" : "1223654",
    "third_order_id" : "1223654",
    "main_order_id" : "1223432",
    "rtn_id" : "123456",
    "station_order_no" : "1",
    "order_type" : "string",
    "extend_props" : "string"
  },
  "delivery" : {
    "state" : "none",
    "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"
        },
        "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"
    } ],
    "returner" : {
      "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" : "脱敏地址**"
      }
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "station_type" : "string"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "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"
      }
    },
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0
    } ],
    "combined" : true,
    "gift" : true,
    "item_no" : "1",
    "item_id" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_total" : 205.44,
    "image_Url" : "http://1213323.png",
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "front_unit" : "string",
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "origin_sku_id" : "e235346ger545",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "rtn_state" : "string",
    "rtn_id" : "681795759987",
    "station_id" : "string",
    "station_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\"}"
    } ]
  },
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "tags" : [ {
    "name" : "首单"
  } ],
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "seller_node" : "note",
  "change_order_info" : {
    "change_order_id" : "string",
    "change_items" : [ {
      "quantity" : 13.0,
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "item_no" : "1",
      "sku_id" : "132323",
      "front_sku_id" : "1454543",
      "front_item_id" : "1323233"
    } ]
  },
  "voucher_urls" : [ "string" ],
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "station" : {
    "id" : "string",
    "name" : "string"
  }
}

1.8.4. 审核销售退

POST /{tenant_id}/soms/rtnreqservice/rtnreq/{id}/action/approve
1.8.4.1. 说明

审核销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退单审核请求

RtnReqApproveRequest
1.8.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.8.4.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/string/action/approve?operator=string
请求 body
{
  "reason" : "已发货，不能退",
  "approve_state" : "serviceApproved"
}
1.8.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.5. 取消销售退

POST /{tenant_id}/soms/rtnreqservice/rtnreq/{id}/action/cancel
1.8.5.1. 说明

取消销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

CancelRtnReqRequest
1.8.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.8.5.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/string/action/cancel?operator=string
请求 body
{
  "reason" : "我不想要了",
  "approve_state" : "financeRefuse"
}
1.8.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.6. 确认退货状态

POST /{tenant_id}/soms/rtnreqservice/rtnreq/{id}/action/deliver
1.8.6.1. 说明

确认退货状态

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

Path

id
必填

退货单ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退货请求对象

ReqReturnRequest
1.8.6.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.8.6.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/string/action/deliver?operator=string
请求 body
{
  "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"
      },
      "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"
  } ],
  "return_state" : "none"
}
1.8.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.7. 修改销售退

POST /{tenant_id}/soms/rtnreqservice/rtnreq/{id}/action/modify
1.8.7.1. 说明

修改销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnReqModRequest
1.8.7.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.8.7.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/string/action/modify?operator=string
请求 body
{
  "type" : "4356465768",
  "items" : [ {
    "uuid" : "string",
    "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"
      }
    },
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0
    } ],
    "combined" : true,
    "gift" : true,
    "item_no" : "1",
    "item_id" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_total" : 205.44,
    "image_Url" : "http://1213323.png",
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "front_unit" : "string",
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "origin_sku_id" : "e235346ger545",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "rtn_state" : "string",
    "rtn_id" : "681795759987",
    "station_id" : "string",
    "station_name" : "string"
  } ],
  "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"
      },
      "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"
  } ],
  "front" : {
    "state" : "已付款",
    "wrh" : {
      "id" : "string",
      "name" : "string"
    },
    "logistic" : {
      "id" : "string",
      "name" : "string"
    },
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "extend_props" : "string"
  },
  "change_items" : [ {
    "quantity" : 13.0,
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "front_spec" : "辣",
      "real_quantity" : 0.0,
      "fault_tolerant_info" : "string",
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ]
    } ],
    "item_no" : "1",
    "sku_id" : "132323",
    "front_sku_id" : "1454543",
    "front_item_id" : "1323233"
  } ],
  "apply_reason" : "不想要了",
  "customer_note" : "haha",
  "seller_node" : "note",
  "wrh_id" : "string"
}
1.8.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.8. 确认退款

POST /{tenant_id}/soms/rtnreqservice/rtnreq/{id}/action/refund
1.8.8.1. 说明

确认退款

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

ConfirmReqRefundRequest
1.8.8.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.8.8.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/string/action/refund?operator=string
请求 body
{
  "refundState" : "refunded",
  "payments" : [ {
    "code" : "支付方式代码",
    "name" : "支付宝",
    "amount" : 12.33,
    "score" : 100.0,
    "account_no" : "002002",
    "account_name" : "工行",
    "discount_amount" : 100.0,
    "pay_id" : "3223232323",
    "out_pay_id" : "3223232323",
    "extra_info" : "{\"session\", \"123\"}"
  } ]
}
1.8.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.9. 拒绝销售退

POST /{tenant_id}/soms/rtnreqservice/rtnreq/{id}/action/refuse
1.8.9.1. 说明

拒绝销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退单拒绝审核请求

RtnReqRefuseRequest
1.8.9.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.8.9.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/string/action/refuse?operator=string
请求 body
1.8.9.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.10. 查询销售退（数据库查询）

POST /{tenant_id}/soms/rtnreqservice/rtnreqs/query
1.8.10.1. 说明

查询销售退（数据库查询）

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

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小

integer (int32)

Query

sort_key
可选

排序字段 created、modified、front_created

string

Body

filter
必填

查询条件

RtnReqFilter
1.8.10.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnReqPaging
1.8.10.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreqs/query?desc=true&page=0&page_size=0
请求 body
{
  "platform_id" : "jdo2o",
  "order_id" : "123456",
  "order_id_start_with" : "123456",
  "order_id_in" : "123456",
  "rtn_req_id" : "123456",
  "rtn_req_id_start_with" : "123456",
  "shop_id" : "12348522",
  "front_order_id" : "323434",
  "customer_Name" : "张三",
  "customer_Mobile" : "18587887789",
  "customer_mobile_like" : "7789",
  "types" : [ "refund" ],
  "states" : [ "confirmed" ],
  "approve_states" : [ "none" ],
  "front_created_start" : "2016-03-02 12:00:02",
  "front_created_end" : "2016-03-02 12:00:02",
  "created_start" : "2016-03-02 12:00:02",
  "created_end" : "2016-03-02 12:00:02",
  "pre_page" : 1,
  "has_exception" : false,
  "station_ids" : "12345,56789"
}
1.8.10.5. HTTP响应示例
响应 200
{
  "total" : 0,
  "page" : 0,
  "rtnReqs" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "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" : "已付款",
      "wrh" : {
        "id" : "string",
        "name" : "string"
      },
      "logistic" : {
        "id" : "string",
        "name" : "string"
      },
      "logs" : [ {
        "action" : "modify",
        "message" : "修改订单商品明细",
        "time" : "2017-12-26 16:40:19",
        "operator" : "zuhu",
        "tenant_id" : "zuhu",
        "order_id" : "321212222",
        "rtn_id" : "212123333",
        "action_caption" : "修改订单"
      } ],
      "order_id" : "1223654",
      "third_order_id" : "1223654",
      "main_order_id" : "1223432",
      "rtn_id" : "123456",
      "station_order_no" : "1",
      "order_type" : "string",
      "extend_props" : "string"
    },
    "delivery" : {
      "state" : "none",
      "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"
          },
          "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"
      } ],
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "station_type" : "string"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "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"
        }
      },
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0
      } ],
      "combined" : true,
      "gift" : true,
      "item_no" : "1",
      "item_id" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_total" : 205.44,
      "image_Url" : "http://1213323.png",
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "front_unit" : "string",
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "origin_sku_id" : "e235346ger545",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "rtn_state" : "string",
      "rtn_id" : "681795759987",
      "station_id" : "string",
      "station_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\"}"
      } ]
    },
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "tags" : [ {
      "name" : "首单"
    } ],
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "seller_node" : "note",
    "change_order_info" : {
      "change_order_id" : "string",
      "change_items" : [ {
        "quantity" : 13.0,
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "string"
          } ]
        } ],
        "item_no" : "1",
        "sku_id" : "132323",
        "front_sku_id" : "1454543",
        "front_item_id" : "1323233"
      } ]
    },
    "voucher_urls" : [ "string" ],
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "station" : {
      "id" : "string",
      "name" : "string"
    }
  } ],
  "page_count" : 0,
  "page_size" : 0
}

1.8.11. 查询销售退（ES查询）

POST /{tenant_id}/soms/rtnreqservice/rtnreqs/queryEs
1.8.11.1. 说明

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

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

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小

integer (int32)

Query

sort_key
可选

排序字段 created、modified、front_created

string

Body

filter
必填

查询条件

RtnReqEsFilter
1.8.11.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnReqPaging
1.8.11.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreqs/queryEs?desc=true&page=0&page_size=0
请求 body
{
  "platform_id" : "jdo2o",
  "order_id" : "123456",
  "order_id_start_with" : "123456",
  "order_id_in" : "123456",
  "rtn_req_id" : "123456",
  "rtn_req_id_start_with" : "123456",
  "shop_id" : "12348522",
  "front_order_id" : "323434",
  "customer_Name" : "张三",
  "customer_Mobile" : "18587887789",
  "customer_mobile_like" : "7789",
  "types" : [ "refund" ],
  "states" : [ "confirmed" ],
  "approve_states" : [ "none" ],
  "front_created_start" : "2016-03-02 12:00:02",
  "front_created_end" : "2016-03-02 12:00:02",
  "created_start" : "2016-03-02 12:00:02",
  "created_end" : "2016-03-02 12:00:02",
  "pre_page" : 1,
  "has_exception" : false,
  "station_ids" : "12345,56789",
  "station_id" : "12345",
  "platform_ids" : "jdo2o",
  "return_states" : [ "none" ],
  "waybill_id_condition" : "12345",
  "customer_name_like" : "张三"
}
1.8.11.5. HTTP响应示例
响应 200
{
  "total" : 0,
  "page" : 0,
  "rtnReqs" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "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" : "已付款",
      "wrh" : {
        "id" : "string",
        "name" : "string"
      },
      "logistic" : {
        "id" : "string",
        "name" : "string"
      },
      "logs" : [ {
        "action" : "modify",
        "message" : "修改订单商品明细",
        "time" : "2017-12-26 16:40:19",
        "operator" : "zuhu",
        "tenant_id" : "zuhu",
        "order_id" : "321212222",
        "rtn_id" : "212123333",
        "action_caption" : "修改订单"
      } ],
      "order_id" : "1223654",
      "third_order_id" : "1223654",
      "main_order_id" : "1223432",
      "rtn_id" : "123456",
      "station_order_no" : "1",
      "order_type" : "string",
      "extend_props" : "string"
    },
    "delivery" : {
      "state" : "none",
      "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"
          },
          "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"
      } ],
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "station_type" : "string"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "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"
        }
      },
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0
      } ],
      "combined" : true,
      "gift" : true,
      "item_no" : "1",
      "item_id" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_total" : 205.44,
      "image_Url" : "http://1213323.png",
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "front_unit" : "string",
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "origin_sku_id" : "e235346ger545",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "rtn_state" : "string",
      "rtn_id" : "681795759987",
      "station_id" : "string",
      "station_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\"}"
      } ]
    },
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "tags" : [ {
      "name" : "首单"
    } ],
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "seller_node" : "note",
    "change_order_info" : {
      "change_order_id" : "string",
      "change_items" : [ {
        "quantity" : 13.0,
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "string"
          } ]
        } ],
        "item_no" : "1",
        "sku_id" : "132323",
        "front_sku_id" : "1454543",
        "front_item_id" : "1323233"
      } ]
    },
    "voucher_urls" : [ "string" ],
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "station" : {
      "id" : "string",
      "name" : "string"
    }
  } ],
  "page_count" : 0,
  "page_size" : 0
}

1.8.12. 查指定销售订单的退货单

GET /{tenant_id}/soms/rtnreqservice/rtnreqs/saleorder
1.8.12.1. 说明

查指定销售订单的退货单

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

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

销售订单ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

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

200

successful operation

RtnReqList
1.8.12.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreqs/saleorder?order_id=string
1.8.12.5. HTTP响应示例
响应 200
{
  "reqs" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "张*红",
        "private_mobile" : "189****0000"
      }
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "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" : "已付款",
      "wrh" : {
        "id" : "string",
        "name" : "string"
      },
      "logistic" : {
        "id" : "string",
        "name" : "string"
      },
      "logs" : [ {
        "action" : "modify",
        "message" : "修改订单商品明细",
        "time" : "2017-12-26 16:40:19",
        "operator" : "zuhu",
        "tenant_id" : "zuhu",
        "order_id" : "321212222",
        "rtn_id" : "212123333",
        "action_caption" : "修改订单"
      } ],
      "order_id" : "1223654",
      "third_order_id" : "1223654",
      "main_order_id" : "1223432",
      "rtn_id" : "123456",
      "station_order_no" : "1",
      "order_type" : "string",
      "extend_props" : "string"
    },
    "delivery" : {
      "state" : "none",
      "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"
          },
          "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"
      } ],
      "returner" : {
        "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" : "脱敏地址**"
        }
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "station_type" : "string"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "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"
        }
      },
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0
      } ],
      "combined" : true,
      "gift" : true,
      "item_no" : "1",
      "item_id" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_total" : 205.44,
      "image_Url" : "http://1213323.png",
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "front_unit" : "string",
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "origin_sku_id" : "e235346ger545",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "rtn_state" : "string",
      "rtn_id" : "681795759987",
      "station_id" : "string",
      "station_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\"}"
      } ]
    },
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "tags" : [ {
      "name" : "首单"
    } ],
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "seller_node" : "note",
    "change_order_info" : {
      "change_order_id" : "string",
      "change_items" : [ {
        "quantity" : 13.0,
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "string"
          } ]
        } ],
        "item_no" : "1",
        "sku_id" : "132323",
        "front_sku_id" : "1454543",
        "front_item_id" : "1323233"
      } ]
    },
    "voucher_urls" : [ "string" ],
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "station" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

1.9. 门店作业规则服务

1.9.1. 查询门店作业规则服务

POST /{tenant_id}/soms/storeoperationruleservice/rule
1.9.1.1. 说明

查询门店作业规则服务

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

Path

tenant_id
必填

租户Id

string

Query

desc
必填

升序、降序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

每页条数

integer (int32)

Query

sort_key
必填

排序字段

string

Body

store_operation_rule_filter
必填

过滤条件

StoreOperationRuleFilter
1.9.1.3. 响应
HTTP代码 说明 类型

200

successful operation

< StoreOperationRule > array
1.9.1.4. HTTP请求示例
请求 path
/string/soms/storeoperationruleservice/rule?desc=true&page=0&page_size=0&sort_key=string
请求 body
{
  "typeEq" : "string",
  "platformIdEq" : "string",
  "shopIdEq" : "string",
  "storeIdEq" : "string",
  "storeIdIn" : [ "string" ],
  "stateEq" : "string"
}
1.9.1.5. HTTP响应示例
响应 200
[ {
  "type" : "string",
  "platform_id" : "33454",
  "shop_id" : "33454",
  "store_id" : "33454",
  "state" : "applying",
  "def" : {
    "rtn_rule" : {
      "limtRtnApproveTimeRange" : "string",
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    },
    "pick_rule" : {
      "allow_pick_time" : 0.0
    }
  },
  "source" : "string"
} ]

1.9.2. 获取门店作业规则

GET /{tenant_id}/soms/storeoperationruleservice/rule
1.9.2.1. 说明

获取门店作业规则

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

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

商家代码

string

Query

store_id
必填

门店代码

string

Query

type
必填

规则：storeRtnRule（门店退单规则）

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

200

successful operation

StoreOperationRule
1.9.2.4. HTTP请求示例
请求 path
/string/soms/storeoperationruleservice/rule?platform_id=string&shop_id=string&store_id=string&type=string
1.9.2.5. HTTP响应示例
响应 200
{
  "type" : "string",
  "platform_id" : "33454",
  "shop_id" : "33454",
  "store_id" : "33454",
  "state" : "applying",
  "def" : {
    "rtn_rule" : {
      "limtRtnApproveTimeRange" : "string",
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    },
    "pick_rule" : {
      "allow_pick_time" : 0.0
    }
  },
  "source" : "string"
}

1.9.3. 删除门店作业规则

DELETE /{tenant_id}/soms/storeoperationruleservice/rule/delete
1.9.3.1. 说明

删除门店作业规则

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

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

商家代码

string

Query

store_id
必填

门店代码

string

Query

type
必填

规则：storeRtnRule（门店退单规则）

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

default

successful operation

无内容
1.9.3.4. HTTP请求示例
请求 path
/string/soms/storeoperationruleservice/rule/delete?platform_id=string&shop_id=string&store_id=string&type=string

1.9.4. 保存门店作业规则

POST /{tenant_id}/soms/storeoperationruleservice/rule/save
1.9.4.1. 说明

保存门店作业规则

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

store_operation_rule_save
必填

自提规则

StoreOperationRuleSave
1.9.4.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.9.4.4. HTTP请求示例
请求 path
/string/soms/storeoperationruleservice/rule/save?operator=string
请求 body
{
  "platform_id" : "33454",
  "type" : "33454",
  "shop_id" : "storeRtnRule",
  "store_id" : "0001",
  "def" : {
    "rtn_rule" : {
      "limtRtnApproveTimeRange" : "string",
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    },
    "pick_rule" : {
      "allow_pick_time" : 0.0
    }
  }
}

1.10. 自提规则服务

1.10.1. 获取自提规则

GET /{tenant_id}/soms/selftakeruleservice/selftakerule
1.10.1.1. 说明

获取自提规则

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

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

商家ID

string

Query

store_id
可选

门店ID

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

200

successful operation

SelftakeRule
1.10.1.4. HTTP请求示例
请求 path
/string/soms/selftakeruleservice/selftakerule?platform_id=string&shop_id=string
1.10.1.5. HTTP响应示例
响应 200
{
  "state" : "applying",
  "def" : {
    "check_selftake_code" : true
  },
  "source" : "ptm_store",
  "platform_id" : "meituan",
  "shop_id" : "33454",
  "store_id" : "0001"
}

1.11. 属性服务

1.11.1. 保存属性服务

POST /{tenant_id}/soms/optionservice/option
1.11.1.1. 说明

保存属性服务

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

option
必填

属性

Option
1.11.1.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.1.4. HTTP请求示例
请求 path
/string/soms/optionservice/option?operator=string
请求 body
{
  "type" : "comment",
  "caption" : "说明",
  "value" : "欢迎下次光临",
  "extra" : {
    "auto" : true,
    "conditions" : [ {
      "satisfie_level" : "欢迎下次光临"
    } ]
  }
}

1.11.2. 保存属性服务

POST /{tenant_id}/soms/optionservice/option/batchsave
1.11.2.1. 说明

保存属性服务

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

options
必填

属性

< Option > array
1.11.2.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.2.4. HTTP请求示例
请求 path
/string/soms/optionservice/option/batchsave?operator=string
请求 body
[ {
  "type" : "comment",
  "caption" : "说明",
  "value" : "欢迎下次光临",
  "extra" : {
    "auto" : true,
    "conditions" : [ {
      "satisfie_level" : "欢迎下次光临"
    } ]
  }
} ]

1.11.3. 删除属性服务

POST /{tenant_id}/soms/optionservice/option/{type}/delete
1.11.3.1. 说明

删除属性服务

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

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型

string

Query

value
可选

值

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

default

successful operation

无内容
1.11.3.4. HTTP请求示例
请求 path
/string/soms/optionservice/option/string/delete

1.11.4. 获取属性服务

GET /{tenant_id}/soms/optionservice/options/{type}/getall
1.11.4.1. 说明

获取属性服务

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

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型：remind（催单）、comment(评论)

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

200

successful operation

OptionList
1.11.4.4. HTTP请求示例
请求 path
/string/soms/optionservice/options/string/getall
1.11.4.5. HTTP响应示例
响应 200
{
  "options" : [ {
    "type" : "comment",
    "caption" : "说明",
    "value" : "欢迎下次光临",
    "extra" : {
      "auto" : true,
      "conditions" : [ {
        "satisfie_level" : "欢迎下次光临"
      } ]
    }
  } ]
}

1.11.5. 获取属性服务

GET /{tenant_id}/soms/optionservice/options/{type}/getoption
1.11.5.1. 说明

获取属性服务

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

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型：remind（催单）、comment(评论)

string

Query

value
可选

值

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

200

successful operation

Option
1.11.5.4. HTTP请求示例
请求 path
/string/soms/optionservice/options/string/getoption
1.11.5.5. HTTP响应示例
响应 200
{
  "type" : "comment",
  "caption" : "说明",
  "value" : "欢迎下次光临",
  "extra" : {
    "auto" : true,
    "conditions" : [ {
      "satisfie_level" : "欢迎下次光临"
    } ]
  }
}

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. AdjustDetail

名称 说明 类型

after
可选

调整后
样例 : "12"

string

before
可选

调整前
样例 : "10"

string

field
可选

调整字段
样例 : "amount,pay_amount,quantity"

string

2.4. CRMInfo

会员权益信息

名称 说明 类型

coupon_info
可选

券信息
样例 : CouponInfo

CouponInfo

score_info
可选

积分信息
样例 : ScoreInfo

ScoreInfo

2.5. CRMInfoModificationRequest

名称 说明 类型

score
可选

样例 : 0.0

number

2.6. CancelCarrierRequest

取消承运商配送请求对象

名称 说明 类型

auto_dispatch
可选

是否自动调度到下一个承运商，默认为false
默认值 : false
样例 : true

boolean

carrier_id
必填

承运商Id
样例 : "343434343"

string

reason
可选

原因
样例 : "客户不要了"

string

2.7. CancelOrderRequest

取消订单请求

名称 说明 类型

frontRtnId
可选

平台退单号
样例 : "599565656"

string

reason
可选

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

string

type
可选

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

string

2.8. CancelRtnReqRequest

取消退货请求对象

名称 说明 类型

approve_state
可选

审核状态:none（未审核）,serviceApproved（客服已审核）,serviceRefuse（客服已拒绝）,financeApproved（财务已审核）,financeRefuse（财务已拒绝）
样例 : "financeRefuse"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

reason
可选

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

string

2.9. CancelRtnRequest

取消退货请求对象

名称 说明 类型

approve_state
可选

样例 : "none"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

operator_role
可选

样例 : "string"

string

reason
可选

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

string

sellerInfo
可选

收货失败：原因/凭证
样例 : SellerInfo

SellerInfo

2.10. Carrier

承运商

名称 说明 类型

carrier
可选

承运平台
样例 : IdName

IdName

delivery_id
可选

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

string

delivery_name
可选

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

string

deliveryman
可选

送货员
样例 : IdName

IdName

deliveryman_mobile
可选

送货员手机
样例 : "18859658865"

string

exception_reason
可选

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

string

merchant
可选

承运商家
样例 : IdName

IdName

state
可选

承运状态，取值范围:initial(初始状态)、created(已下发)、createdFailed（下发失败）、dispatched(已派单)、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.11. CarrierModificationRequest

承运商修改请求对象

名称 说明 类型

carrier
可选

承运商
样例 : IdName

IdName

carrier_proxy_merchant
可选

承运代理商家
样例 : ModFieldString

ModFieldString

carrier_proxy_platform
可选

承运代理平台
样例 : ModFieldString

ModFieldString

deliveryman_id
可选

配送员Id
样例 : "32332"

string

deliveryman_mobile
可选

配送员电话
样例 : "1565586545"

string

deliveryman_name
可选

配送员名称
样例 : "李某"

string

merchant
可选

承运商家
样例 : IdName

IdName

type
可选

承运类型： self（门店自送）、thirdparty（平台配送）、express（快递配送）
样例 : "self"

enum (self, thirdparty, express)

2.12. CarrierRequest

更新订单承运商物流状态

名称 说明 类型

carrier
必填

承运商
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "加快"

string

carrier_proxy_merchant
可选

承运代理商家
样例 : ModFieldString

ModFieldString

carrier_proxy_platform
可选

承运代理平台
样例 : ModFieldString

ModFieldString

delivery_id
可选

配送ID
样例 : "123"

string

exception_remark
可选

承运异常备注
样例 : "第三方要求取消"

string

freight
可选

运费
样例 : 1.11

number

ignore_check_carrier_state
可选

忽略校验承运状态
默认值 : false
样例 : true

boolean

operator
可选

操作人
样例 : "user"

string

print_info
可选

运单打印信息
样例 : WaybillPrintInfo

WaybillPrintInfo

re_calc_carrier
可选

是否重新计算承运
默认值 : false
样例 : true

boolean

shop_freight
可选

商家付给承运商的运费
样例 : ModFieldBigDecimal

ModFieldBigDecimal

tags
可选

标签，会给订单加上标签，已有的标签不会重复添加
样例 : [ "OrderTag" ]

< OrderTag > array

waybill_id
可选

运单号
样例 : "123"

string

2.13. ChangeItem

来源：换货商品

名称 说明 类型

details
可选

商品原料详情
样例 : [ "OrderItemDetail" ]

< OrderItemDetail > array

front_item_id
可选

前台订单行标识
样例 : "1323233"

string

front_sku_id
可选

平台商品编码
样例 : "1454543"

string

item_no
可选

行号
样例 : "1"

string

quantity
可选

数量
样例 : 13.0

number

sku_id
可选

货号
样例 : "132323"

string

2.14. ChangeOrderInfo

换出信息

名称 说明 类型

change_items
可选

换出商品行
样例 : [ "ChangeItem" ]

< ChangeItem > array

change_order_id
可选

换出订单号
样例 : "string"

string

2.15. ChangeRtnStationRequest

修改门店请求对象

名称 说明 类型

new_station_id
可选

新的门店ID
样例 : "12435453"

string

2.16. CodeName

名称 说明 类型

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.17. ConfirmRefundRequest

确认退款请求对象

名称 说明 类型

operator_role
可选

操作角色：platform（平台）
样例 : "platform"

string

payments
可选

退款支付明细
样例 : [ "RefundPayment" ]

< RefundPayment > array

refundState
必填

退款状态,none（未退款）,refunded（已退款）
样例 : "refunded"

enum (none, refunded)

2.18. ConfirmReqRefundRequest

确认退款请求对象

名称 说明 类型

payments
可选

退款支付明细
样例 : [ "RefundPayment" ]

< RefundPayment > array

refundState
必填

退款状态,none（未退款）,refunded（已退款）
样例 : "refunded"

enum (none, refunded)

2.19. Count

名称 说明 类型

action
可选

action
样例 : "decrypt"

string

action_name
可选

actionName
样例 : "解密"

string

business_key
可选

业务key
样例 : "123"

string

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

type
可选

类型
样例 : "order"

string

value
可选

value
样例 : "10"

string

2.20. 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.21. CouponInfo

券信息

名称 说明 类型

details
可选

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

< CouponDetail > array

use_total
可选

券抵用总金额
样例 : 1.0

number

2.22. Customer

客户

名称 说明 类型

contact
可选

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

联系方式(soms)

id
可选

代码
样例 : "10001"

string

2.23. DeliverRequest

配送情况

名称 说明 类型

carrier
可选

承运商，非空时将更新
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "已经在发货的路上"

string

delivery_state
必填

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

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

front_finished_time
可选

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

string (date-time)

front_modified
可选

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

string (date-time)

operation
可选

门店作业：accept（接单）、shipping（集货）、recheck（复核）、handover（交接）、cancelShipping（取消集货）
样例 : "shipping"

string

operation_state
可选

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

string

operator
可选

执行操作人
样例 : "zhangsan"

string

pick_info
可选

订单拣货信息
样例 : OrderPickInfo

OrderPickInfo

print
可选

是否打印
默认值 : false
样例 : true

boolean

selftake_confirmed
可选

自提确认
默认值 : false
样例 : true

boolean

ship_id
可选

发货码
样例 : "122323232"

string

ship_time
可选

发货时间，传入的话如果本次操作的是发货，则日志的time将记录该时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2022-07-18 20:34:00"

string (date-time)

waybill_id
可选

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

string

2.24. Delivery

配送信息

名称 说明 类型

carrier
可选

承运商信息
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "加快"

string

carrier_proxy_merchant
可选

承运代理商家
样例 : "string"

string

carrier_proxy_platform
可选

承运代理平台
样例 : "string"

string

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

selftake_confirmed
可选

自提确认
默认值 : false
样例 : true

boolean

ship_delivery_mode
可选

发货及配送方式,可选值：wrhShipCarrierDeli（仓库发货，快递配送）、wrhShipStationDeli（仓库发货，门店配送）、stationShipStationDeli（门店发货，门店配送）、stationShipCarrierDeli（门店发货，快递配送）、vendorShipCarrierDeli（供应商发货，快递配送）
样例 : "wrhShipCarrierDeli"

enum (wrhShipCarrierDeli, wrhShipStationDeli, stationShipStationDeli, stationShipCarrierDeli, vendorShipCarrierDeli)

ship_id
可选

发货码
样例 : "23232323"

string

ship_mode
可选

发货方式，wrhShip（仓库发货），stationShip（门店发货），vendorShip（供应商发货）
样例 : "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)

vendor
可选

发货供应商
样例 : CodeName

CodeName

waybill_id
可选

运单号
样例 : "123"

string

waybill_print_info
可选

运单打印信息
样例 : WaybillPrintInfo

WaybillPrintInfo

waybills
可选

样例 : [ "Waybill" ]

< Waybill > array

wrh
可选

发货仓库
样例 : CodeName

CodeName

wrh_order_id
可选

仓库单号
样例 : "32323"

string

2.25. DiscountSettleDetail

优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

role
可选

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

string

2.26. DiscountShareDetail

整合优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

type
可选

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

string

2.27. DistributionInfo

分销信息

名称 说明 类型

distributor
可选

样例 : IdName

IdName

tcOrderId
可选

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

string

2.28. EncryptDetail

加密信息

名称 说明 类型

encrypt_mobile
可选

样例 : "string"

string

encrypt_name
可选

样例 : "string"

string

encrypt_street
可选

样例 : "string"

string

secretKey
可选

样例 : "string"

string

2.29. ExtraField

自定义字段

名称 说明 类型

id
可选

自定义id
样例 : "distance_freight"

string

name
可选

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

string

value
可选

自定义值
样例 : "0.01"

string

2.30. 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.31. 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.32. FavFactorItem

参与优惠商品明细

名称 说明 类型

amount
可选

参与促销金额
样例 : 1.0

number

item_id
可选

行标识
样例 : "1"

string

item_no
必填

行号
样例 : 1

integer (int32)

qty
可选

参与促销数量
样例 : 1.0

number

2.33. FrontItem

平台商品行信息

名称 说明 类型

attributes
可选

属性
样例 : [ "FrontItemAttribute" ]

< FrontItemAttribute > array

item_id
必填

平台订单行ID
样例 : "052700601"

string

sku_id
可选

平台SKU ID
样例 : "052700601"

string

spec
可选

平台商品属性(口味), 多个属性以;或者/分隔显示
样例 : "蓝色;微甜 少冰/多糖"

string

spec2
可选

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

string

spu_id
可选

平台SPU ID
样例 : "052700601"

string

tags
可选

平台标签
样例 : [ "IdName" ]

< IdName > array

unit
可选

单位
样例 : "string"

string

2.34. FrontItemAttribute

平台商品行属性信息

名称 说明 类型

group
可选

属性分组
样例 : "口味"

string

price
可选

属性售价
样例 : 0.0

number

qty
可选

属性数量
样例 : 0.0

number

values
可选

属性值
样例 : [ "string" ]

< string > array

2.35. FrontOrder

平台订单信息

名称 说明 类型

app
可选

平台应用
样例 : IdName

IdName

attribute
可选

属性信息
样例 : "string"

string

created
可选

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

string (date-time)

dpt_station_time
可选

平台调度门店时间，用于存储平台分配门店时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

finished_time
可选

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

string (date-time)

inner_order_id
可选

平台内部单号
样例 : "1223432"

string

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
可选

订单类型,默认为ECOM（普通订单）:ECOM,普通订单;ShareGroup,拼团订单;POINTS_REDEEM,积分换购订单;ENLIST_REDEEM,预约兑换订单;PRESALE,预售订单;COMPENSATION,赔付订单;RELAY,接龙订单
样例 : IdName

IdName

platform
必填

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

IdName

state
可选

状态
样例 : "已付款"

string

station_id
可选

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

string

station_name
可选

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

string

station_order_no
可选

平台门店订单序号，该平台下单门店的第几单，用于骑手到店取件
样例 : "1"

string

third_order_id
可选

第三方订单号
样例 : "1223432"

string

wrh_id
可选

平台发货仓库编码
样例 : "string"

string

2.36. FrontRtn

平台退货信息

名称 说明 类型

app
可选

平台应用id
样例 : IdName

IdName

created
可选

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

string (date-time)

creator
可选

创建人
样例 : "254145"

string

modified
可选

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

string (date-time)

order_finished
可选

订单完成时间，临时字段，不存储
样例 : "2020-06-17 10:00:00"

string (date-time)

platform
必填

平台
样例 : IdName

IdName

return_state
可选

样例 : "string"

string

rtn_id
可选

平台退货单号
样例 : "123456"

string

source
可选

来源
样例 : "平台生成：platform、商家发起:shop"

string

state
可选

平台退换货状态
样例 : "已退货"

string

stationName
可选

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

string

station_id
可选

平台门店代码
样例 : "254145"

string

2.37. ICN

ICN对象

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.38. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.39. IdWrapper

名称 说明 类型

id
可选

样例 : "string"

string

2.40. IdsWrapper

名称 说明 类型

ids
可选

样例 : [ "string" ]

< string > array

2.41. Invoice

发票信息

名称 说明 类型

apply_qrcode
可选

开票二维码
样例 : "string"

string

details
可选

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

< InvoiceDetail > array

error_reason
可选

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

string

required
必填

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

boolean

result
可选

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

string

2.42. 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.43. ItemPromotion

商品行促销信息

名称 说明 类型

apported_discount_amount
可选

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

number

discount_amount
可选

商品优惠金额
样例 : 0.1

number

favs
可选

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

< FavDetail > array

2.44. 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.45. MockInfo

压测

名称 说明 类型

persist
可选

默认值 : false
样例 : true

boolean

2.46. ModFieldBigDecimal

名称 说明 类型

value
可选

样例 : 0.0

number

2.47. ModFieldString

名称 说明 类型

value
可选

样例 : "string"

string

2.48. Option

文案选项

名称 说明 类型

caption
可选

说明
样例 : "说明"

string

extra
可选

扩展信息
样例 : OptionExtra

OptionExtra

type
可选

类型：remind（催单）、comment(评论)、rtn.receivefailreason（退单收货失败原因）、adjustCategory(调整分类)
样例 : "comment"

string

value
可选

回复文案
样例 : "欢迎下次光临"

string

2.49. OptionExtra

扩展条件

名称 说明 类型

auto
可选

是否开启自动回复
默认值 : false
样例 : true

boolean

conditions
可选

自动回复条件
样例 : [ "OptionExtraCondition" ]

< OptionExtraCondition > array

2.50. OptionExtraCondition

评价等级条件

名称 说明 类型

satisfie_level
可选

评价等级（好评：high；中评：medium；差评：low；）
样例 : "欢迎下次光临"

string

2.51. OptionList

文案选项列表

名称 说明 类型

options
可选

文案选项列表
样例 : [ "Option" ]

< Option > array

2.52. Order

订单

名称 说明 类型

address_change_fee
可选

地址变更费
样例 : 0.0

number

adjust_details
可选

调整详情
样例 : [ "AdjustDetail" ]

< AdjustDetail > array

approve_state
可选

审核子状态,取值范围:none(未审核)、serviceApproved(客服已审核)、financeApproved(财务已审核)、warehouseApproved(物流已审核)、carrierApproved(承运商已审核)
样例 : "none"

enum (none, serviceApproved, financeApproved, warehouseApproved, carrierApproved)

calc_data
可选

是否需要反算金额，默认true
默认值 : false
样例 : true

boolean

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
必填

配送信息
样例 : Delivery

Delivery

encrypt_detail
可选

加密详情
样例 : EncryptDetail

EncryptDetail

exception_codes
可选

异常代码，sku（商品异常）、amount（金额异常）、shopAmount（货款金额异常）、carrier（承运异常）
样例 : "sku"

string

exception_remark
可选

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

string

exceptions
可选

异常信息
样例 : [ "OrderException" ]

< OrderException > array

extra_info
可选

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

string

fault_tolerant_info
可选

容错信息,json字符串
样例 : "string"

string

freight_discount
可选

运费优惠金额
样例 : 33.33

number

front
必填

平台订单信息
样例 : FrontOrder

FrontOrder

has_exception
可选

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

boolean

id
可选

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

string

invoice
可选

发票信息
样例 : Invoice

Invoice

invoice_take_code
可选

发票提取码，32位
样例 : "string"

string

is_private
可选

是否是隐私号,true:小票显示的顾客手机号格式为138*8888，false：原手机号显示
默认值 : false
样例* : true

boolean

item_change_records
可选

换货明细
样例 : [ "OrderItemChange" ]

< OrderItemChange > array

item_count
必填

商品明细数
样例 : 1

integer (int32)

item_logistics
可选

样例 : [ "OrderItemLogistics" ]

< OrderItemLogistics > array

items
必填

商品行
样例 : [ "OrderItem" ]

< OrderItem > array

logs
可选

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

< OrderLog > array

member_info
可选

会员积分信息
样例 : MemberInfo

MemberInfo

mock_info
可选

样例 : MockInfo

MockInfo

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

package_info
可选

订单打包信息
样例 : OrderPackageInfo

OrderPackageInfo

payment
必填

支付信息
样例 : Payment

Payment

performance_service_fee
可选

履约服务费
样例 : 120.01

number

pick_info
可选

订单拣货信息
样例 : OrderPickInfo

OrderPickInfo

print_bills
可选

打印单据
样例 : [ "PrintBill" ]

< PrintBill > array

promotion
可选

订单促销
样例 : OrderPromotion

OrderPromotion

quotas
可选

订单指标
样例 : [ "OrderQuota" ]

< OrderQuota > array

real_total
必填

实际销售商品金额(扣除所有优惠)，等于items中pay_amount之和，不包含运费等其他费用，系统会自动重算
样例 : 120.01

number

reason
可选

黑名单原因
样例 : "黑子"

string

reissue_reason
可选

补发原因
样例 : "string"

string

responsible_party
可选

补发责任方
样例 : "string"

string

sale_order_id
可选

销售订单号
样例 : "string"

string

salesman
可选

推销员
样例 : SalesmanInfo

SalesmanInfo

seller_note
可选

商家备注
样例 : "note"

string

selttle_commission
可选

平台佣金 ，弃用，请使用settle_commission
样例 : 120.01

number

settle_amount
可选

平台的结算金额,平台结算金额=客户实付金额+平台优惠补贴， 为空等于amount
样例 : 120.01

number

settle_commission
可选

平台佣金，平台服务费+履约服务费等服务费用
样例 : 120.01

number

settle_freight
可选

平台结算运费
样例 : 120.01

number

settle_info
可选

对账信息
样例 : OrderSettleInfo

OrderSettleInfo

settle_unit
可选

结算单位
样例 : SettleUnit

SettleUnit

shipping_voucher_urls
可选

上传凭证的url
样例 : [ "string" ]

< string > array

shop
必填

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

IdName

shop_amount
可选

商品货款金额=商品原金额-商家商品优惠金额
样例 : 120.01

number

sku_quantity
必填

商品总数
样例 : 1.0

number

source
可选

来源
样例 : "小程序"

string

source_order_id
可选

来源订单号
样例 : "5346567534545645"

string

state
可选

订单状态，新建可不填,默认取值为:confirmed。取值范围:confirmed(已确认)、prepared（已预处理）、approved(已审核)、delivering( 配送中)、delivered(配送完成)、canceled(已取消)
样例 : "confirmed"

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

suspend_info
可选

挂起信息
样例 : SuspendInfo

SuspendInfo

tags
可选

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

< OrderTag > array

user_number
可选

使用人数,餐具数量
样例 : 2

integer (int32)

waybill_id
可选

运单号
样例 : "32332"

string

weight
可选

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

number

wish_info
可选

祝福信息
样例 : WishInfo

WishInfo

wrh_id
可选

发货仓库编号
样例 : "4184"

string

wrh_state
可选

仓库状态
样例 : "initial"

enum (initial, notified, applyKickBack, shipped)

2.53. OrderAdjust

名称 说明 类型

adjust_phase
可选

调整时机
样例 : "onsale=售中，aftersale=售后"

enum (onsale, aftersale)

adjust_version
可选

调整版本
样例 : 1

integer (int64)

amount
可选

样例 : 0.0

number

details
可选

调整详情
样例 : "{}"

< AdjustDetail > array

id
可选

单据ID
样例 : "12121212"

string

items
可选

调整商品详情
样例 : "{}"

< OrderAdjustItem > array

order_id
可选

来源单号
样例 : "121212"

string

payments
可选

调整支付详情
样例 : "{}"

< PaymentDetail > array

reason
可选

调整原因
样例 : "超重补差"

string

remark
可选

调整说明
样例 : "超重补差"

string

shop
可选

商家
样例 : IdName

IdName

state
可选

状态
样例 : "未提交=initial,已提交 =submitted,审批通过 =approved,审批不通过=rejected;"

enum (initial, submitted, approved, rejected)

2.54. OrderAdjustItem

名称 说明 类型

details
可选

调整详情
样例 : "{}"

< AdjustDetail > array

item_no
可选

调整行号
样例 : 1

integer (int32)

item_title
可选

商品名称
样例 : "112121"

string

order_item_no
可选

订单商品行行号
样例 : "1"

string

payAmount
可选

调整后的商品实付金额
样例 : 112121.0

number

quantity
可选

调整后的数量
样例 : 112121.0

number

sku_id
可选

货号
样例 : "112121"

string

total
可选

商品金额
样例 : 112121.0

number

unit_price
可选

商品价格
样例 : 112121.0

number

2.55. OrderApplyRtnRequest

订单申请退款

名称 说明 类型

apply_type
可选

申请类型：weight_diff（缺重退差），stock_none(缺货退款)，amount(按金额退，预留)，part(部分退)，all(整单退)
样例 : "weight_diff"

string

approve_state
必填

审批状态，取值范围:none(未审核),serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝)
样例 : "none"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

front_app
可选

平台应用
样例 : IdName

IdName

items
必填

申请明细
样例 : [ "OrderItemRtnApply" ]

< OrderItemRtnApply > array

policy
必填

策略
样例 : "取值：orig_sku(原商品)、sku(现商品)"

string

reason
可选

原因
样例 : "不想要了"

string

rtn_id
可选

退单号
样例 : "54132321623"

string

type
可选

退货单类型,取值范围：refund(仅退款)、refundAndRtn(退款退货)
样例 : "refund"

enum (refund, refundAndRtn)

2.56. OrderApplyRtnResponse

名称 说明 类型

apply_id
可选

申请ID
样例 : "申请幂等ID"

string

apply_ids
可选

多个申请ID
样例 : "多个申请幂等ID"

< string > array

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.57. OrderCheckItem

订单检查商品行

名称 说明 类型

item_no
可选

订单行号
样例 : "1"

string

item_title
可选

商品标题
样例 : "葡萄"

string

pay_amount
必填

实付金额
样例 : 2.0

number

quantity
必填

数量
样例 : 1.0

number

sku_id
可选

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

string

total
必填

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

number

unit_price
必填

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

number

2.58. OrderCheckRequest

订单检测请求

名称 说明 类型

amount
可选

总金额
样例 : 10.0

number

carrier_id
可选

指定承运商ID
样例 : "meituan"

string

expect_delivery_time
可选

期望送达时间
样例 : "2022-03-02 14:00:01"

string (date-time)

items
可选

商品明细
样例 : "[]"

< OrderCheckItem > array

order_id
可选

订单号
样例 : "121212"

string

platform_id
可选

下单平台ID
样例 : "jdo2o"

string

pre_type
可选

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

string

receiver_address
可选

收货地址
样例 : Address

Address

receiver_contact
可选

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

联系方式(soms)

ship_mode
可选

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

string

sku_quantity
可选

总数量
样例 : 10.0

number

station
可选

配送站点：门店代码、门店名称
样例 : IdName

IdName

type
必填

检测类型：addresscheck(地址检测),deliverycheck(配送检测),deliverycalc(配送计算)
样例 : "deliverycheck"

string

weight
可选

订单商品总重量，单位：克
样例 : 10.0

number

2.59. OrderCheckResponse

名称 说明 类型

code
可选

样例 : "string"

string

delivery_mins
可选

配送时长，单位分钟
样例 : 10.0

number

distance
可选

送货距离，单位米
样例 : 1000.0

number

freight
可选

送货运费，单位元
样例 : 10.0

number

message
可选

样例 : "string"

string

pre_delivery_slots
可选

可选预计送达时间段
样例 : [ "OrderPreSlot" ]

< OrderPreSlot > array

pre_delivery_time
可选

预计送达时间
样例 : "2022-06-30 12:00:00 或者 2022-06-30"

string

success
可选

默认值 : false
样例 : true

boolean

suggest_carrier
可选

建议承运商
样例 : IdName

IdName

2.60. OrderComment

订单评价

名称 说明 类型

content
可选

评价内容
样例 : "很好"

string

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

details
可选

评价积分
样例 : [ "OrderCommentDetail" ]

< OrderCommentDetail > array

dislike_skus
可选

点踩的商品列表
样例 : [ "string" ]

< string > array

expire_time
可选

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

string (date-time)

extra_info
可选

评价自定义字段，不同平台不同内容
样例 : OrderExtraInfo

OrderExtraInfo

front_comment_id
可选

样例 : "string"

string

id
可选

评价ID
样例 : "202012021621"

string

image_urls
可选

评价图片
样例 : [ "string" ]

< string > array

labels
可选

评价标签
样例 : [ "string" ]

< string > array

like_skus
可选

点赞的商品列表
样例 : [ "string" ]

< string > array

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

order_id
可选

订单ID
样例 : "202012021621"

string

platform_id
可选

平台ID
样例 : "jdo2o"

string

process_remark
可选

处理说明
样例 : "string"

string

process_state
可选

处理状态
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

reply_content
可选

回复内容
样例 : "string"

string

reply_state
可选

回复状态
样例 : "string"

string

reply_time
可选

回复时间
样例 : "2020-06-17 10:00:00"

string (date-time)

shop_id
可选

商家ID
样例 : "213"

string

store
可选

门店
样例 : IdName

IdName

tags
可选

标签
样例 : [ "string" ]

< string > array

time
可选

评价时间
样例 : "2020-12-02 00:00:00"

string (date-time)

2.61. OrderCommentDetail

名称 说明 类型

labels
可选

评价标签
样例 : [ "string" ]

< string > array

score
可选

评价得分
样例 : 0

integer (int32)

type
可选

评价类型
样例 : "string"

string

2.62. OrderCommentFilter

名称 说明 类型

commentTimeEnd
可选

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

string (date-time)

commentTimeStart
可选

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

string (date-time)

hasContent
可选

是否有评价内容
默认值 : false
样例 : false

boolean

hasReply
可选

回复状态：none、replied、invalid
样例 : "invalid"

string

idEq
可选

评价ID
样例 : "string"

string

id_in
可选

样例 : [ "string" ]

< string > array

orderIdIn
可选

订单ID集合
样例 : [ "string" ]

< string > array

orderIdLike
可选

订单号模糊搜索
样例 : "32323232323323"

string

platformIdEq
可选

平台ID
样例 : "jdo2o"

string

processStateEq
可选

处理状态：未处理、处理成功、处理失败
样例 : "string"

string

processStateNotIn
可选

状态不存在
样例 : [ "string" ]

< string > array

satisfieLevel
可选

满意程度（low、medium、high）
样例 : "high"

string

stationIdEq
可选

门店ID
样例 : "string"

string

tagEq
可选

标签
样例 : "string"

string

tagHas
可选

标签包含……必须完全包含
样例 : [ "string" ]

< string > array

tagIn
可选

标签在……中，包含一个就行
样例 : [ "string" ]

< string > array

2.63. OrderCommentPaging

订单评价分页对象

名称 说明 类型

comments
可选

订单评价列表
样例 : [ "OrderComment" ]

< OrderComment > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

total
可选

总条数
样例 : 100

integer (int64)

2.64. 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.65. OrderExtraInfo

名称 说明 类型

delivery_content
可选

配送评价内容
样例 : "很好"

string

next_content
可选

追加评价内容
样例 : "很好"

string

next_image_urls
可选

配送评价图片
样例 : "url"

< string > array

next_time
可选

追加评价时间
样例 : "2020-12-02 00:00:00"

string (date-time)

2.66. OrderFee

订单费用

名称 说明 类型

fee
可选

费用
样例 : 21.0

number

type
可选

类型：platform_service_fee（平台服务费），performance_service_fee（履约服务费），delivery_extra_fee（配送费），delivery_tips（配送小费），tips（小费），cold_chain_processing_fee（冷链加工费），carrier_call_fee（众包呼单费），carrier_call_tips（呼单小费）
样例 : "delivery_tips"

string

2.67. OrderFilter

订单过滤器

名称 说明 类型

address_contains
可选

地址包含
样例 : "福建省"

string

allow_pick_start_time_end
可选

允许拣货的开始时间
样例 : "2020-06-17 10:00:00"

string (date-time)

app_id_eq
可选

平台应用代码等于
样例 : "3232323"

string

approve_states
可选

审核状态，取值:none(未审核)、serviceApproved(客服已审核)、financeApproved(财务已审核)、warehouseApproved(物流已审核)、carrierApproved(承运商已审核)
样例 : [ "none" ]

< enum (none, serviceApproved, financeApproved, warehouseApproved, carrierApproved) > array

bill_id_eq
可选

凭证单号等于
样例 : "3232323"

string

bill_id_like
可选

凭证单号类似
样例 : "32323"

string

cancel_type
可选

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

string

carrier_id
可选

承运商号
样例 : "0003"

string

carrier_proxy_platform_eq
可选

承运代理平台等于
样例 : "string"

string

carrier_states
可选

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

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

carrier_types
可选

承运类型,取值范围:self(商家自送)、thirdparty(平台配送)、express(快递配送)
样例 : [ "self" ]

< enum (self, thirdparty, express) > array

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)

custom_order_state
可选

自定义订单状态
样例 : [ "string" ]

< string > array

customer_id
可选

客户代码
样例 : "8568"

string

customer_mobile
可选

客户手机号，模糊查询
样例 : "18896551546"

string

customer_mobile_end_with
可选

顾客手机号码截止于
样例 : "5554"

string

customer_name
可选

客户姓名
样例 : "张三"

string

deliver_shipped_operator
可选

发货人
样例 : "rs"

string

delivered_time_end
可选

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

string (date-time)

delivered_time_start
可选

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

string (date-time)

delivering_time_end
可选

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

string (date-time)

delivering_time_start
可选

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

string (date-time)

delivery_id
可选

配送ID
样例 : "111"

string

delivery_states
可选

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

< enum (none, shipped, signed, refused, redeliver) > array

delivery_types
可选

配送类型，取值:selftake(到店自提)、deliver(送货上门)
样例 : [ "selftake" ]

< enum (selftake, deliver) > array

deliveryman_name
可选

配送人姓名
样例 : "张三"

string

exception_code_contains
可选

异常代码
样例 : "false"

string

fornt_order_type_id
可选

平台订单类型
样例 : "string"

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_main_order_id_eq
可选

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

string

front_main_order_id_in
可选

平台主订单号在……之中
样例 : "['123'，'456']"

< string > array

front_main_order_id_start_with
可选

平台主订单号起始于
样例 : "1223432"

string

front_order_id
可选

平台订单号
样例 : "32323232323323"

string

front_order_id_prefix
可选

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

string

front_order_ids
可选

平台订单号
样例 : "32323232323323"

< string > array

front_sku_id
可选

平台商品编码，查询订单明细时才有用
样例 : "string"

string

front_station_id_in
可选

平台门店ID在…范围内
样例 : [ "string" ]

< string > array

front_station_order_no_eq
可选

平台门店订单序号等于
样例 : "string"

string

handover_operator
可选

交接人
样例 : "张三"

string

hasInvoice
可选

是否拥有发票
默认值 : false
样例 : false

boolean

has_billing
可选

是否有凭证信息,false搜索没有、true搜索有
默认值 : false
样例 : true

boolean

has_customer_note
可选

是否有顾客信息,false搜索没有、true搜索有
默认值 : false
样例 : true

boolean

has_delivery_exception
可选

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

boolean

has_exception
可选

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

boolean

have_return
可选

存在退货但未签收
默认值 : false
样例 : true

boolean

index_modified_end
可选

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

string (date-time)

index_modified_start
可选

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

string (date-time)

invalid
可选

是否无效订单
默认值 : false
样例 : false

boolean

member_mobile_eq
可选

会员电话等于
样例 : "string"

string

member_mobile_or_mobile_eq
可选

会员电话或者收货人手机号等于
样例 : "string"

string

modified_end
可选

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

string (date-time)

modified_start
可选

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

string (date-time)

operation_handover_time_end
可选

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

string (date-time)

operation_handover_time_start
可选

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

string (date-time)

operation_shipping_time_end
可选

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

string (date-time)

operation_shipping_time_start
可选

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

string (date-time)

operation_state
可选

门店作业状态,取值范围：none（空）、shipping（已集货）、handover（已交接）
样例 : "none"

string

operation_states
可选

门店作业状态,取值范围：none（空）、shipping（已集货）、handover（已交接）
样例 : "[none,shipping]"

< string > array

order_id
可选

订单号
样例 : "1000002111"

string

order_id_or_front_station_order_no_eq
可选

订单id或平台门店订单序号等于
样例 : "string"

string

order_ids
可选

订单号
样例 : [ "string" ]

< string > array

payment_out_pay_id
可选

第三方支付流水号(商户订单号)
样例 : "string"

string

payment_states
可选

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

< enum (notPay, earnest, paid) > array

payment_types
可选

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

< enum (cod, online, earnest) > array

pick_info_is_auto_picked_finish
可选

订单拣货信息-是否自动拣货完成
默认值 : false
样例 : true

boolean

pick_info_operator_id_eq
可选

订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单
样例 : "string"

string

pick_info_operator_id_in
可选

订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单
样例 : [ "string" ]

< string > array

pick_info_operator_name_like
可选

订单拣货信息-拣货员名称
样例 : "string"

string

pick_info_source_eq
可选

订单拣货信息-记录来源
样例 : "string"

string

pick_info_time_end
可选

订单拣货信息-拣货时间
样例 : "2020-06-17 10:00:00"

string (date-time)

pick_info_time_start
可选

订单拣货信息-拣货时间
样例 : "2020-06-17 10:00:00"

string (date-time)

platform_id
可选

平台ID
样例 : "jdo2o"

string

platform_ids
可选

平台ID
样例 : [ "string" ]

< string > array

prePage
可选

上一页
样例 : 0

integer (int32)

pre_end_delivery_time_end
可选

预计送达结束时间end,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2020-06-17 10:00:00"

string (date-time)

pre_end_delivery_time_start
可选

预计送达开始时间start,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2020-06-17 10:00:00"

string (date-time)

pre_start_delivery_time_end
可选

预计送达开始时间end,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2020-06-17 10:00:00"

string (date-time)

pre_start_delivery_time_start
可选

预计送达开始时间start,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2020-06-17 10:00:00"

string (date-time)

pre_type
可选

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

string

product_contains
可选

商品包括
样例 : "sku1111"

string

prom_id
可选

优惠ID等于
样例 : "string"

string

prom_id_in
可选

优惠ID在……之中
样例 : [ "string" ]

< string > array

prom_key
可选

优惠Key等于
样例 : "string"

string

prom_key_in
可选

优惠Key在……之中
样例 : [ "string" ]

< string > array

prom_name_like
可选

优惠名称类似于
样例 : "string"

string

receiver_mobile
可选

收货人手机号码，起始于
样例 : "18857485554"

string

receiver_mobile_end_with
可选

收货人手机号码截止于
样例 : "5554"

string

receiver_mobile_like
可选

收货人手机号码模糊搜索
样例 : "5554"

string

receiver_name
可选

收货人
样例 : "张三"

string

receiver_private_mobile_end_with
可选

收货人隐私号结束于
样例 : "string"

string

refund_state
可选

退款状态，取值范围:none(未退款)、refunded(已退款)
样例 : "none"

string

salesman_id_eq
可选

分销员代码等于
样例 : "3232323"

string

selftake_code
可选

提货码
样例 : "123456"

string

ship_mode
可选

发货方式，wrhShip（仓库发货），stationShip（门店发货），vendorShip（供应商发货）
样例 : "string"

string

shipping_operator
可选

集货人
样例 : "张三"

string

shop_id
可选

商家ID
样例 : "0002"

string

sku_id
可选

商品编码
样例 : "string"

string

sku_id_in
可选

订单明细货号在……之中，最多指定100个货号
样例 : "[\"sku1\", \"sku2\"]"

< string > array

sku_title
可选

商品标题
样例 : "冰红茶"

string

source
可选

订单来源
样例 : "小程序"

string

source_order_id_eq
可选

源订单号等于
样例 : "213"

string

source_order_id_in
可选

源订单号集合
样例 : [ "string" ]

< string > array

states
可选

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

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

station_ids
可选

门店ID
样例 : [ "string" ]

< string > array

suspended
可选

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

boolean

type_eq
可选

订单类型
样例 : "拼团订单"

string

vendor_code_eq
可选

供应商代码等于
样例 : "3232323"

string

vendor_code_in
可选

供应商代码集合
样例 : "3232323"

< string > array

vendor_code_start_with
可选

供应商代码起始于
样例 : "3232323"

string

waybill_id
可选

运单号
样例 : "0003"

string

wrh_id_in
可选

发货仓库ID集合
样例 : "3232323"

< string > array

wrh_id_start_with
可选

发货仓库ID起始于
样例 : "3232323"

string

2.68. OrderInvoiceRequest

发票更新请求对象

名称 说明 类型

invoice
可选

发票信息
样例 : Invoice

Invoice

2.69. OrderInvoiceResultRequest

发票结果更新请求对象

名称 说明 类型

apply_qrcode
可选

开票二维码
样例 : "string"

string

error_reason
可选

开票失败原因
样例 : "系统异常"

string

result
必填

开票结果：开票成功、开票失败
样例 : "开票成功"

string

serial_no
可选

流水号
样例 : "45546454454"

string

time
可选

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

string (date-time)

url
可选

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

string

2.70. OrderItem

商品行

名称 说明 类型

apported_discount_amount
必填

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

number

barcode
可选

商品条码
样例 : "123456"

string

consume_scores
可选

消费积分
样例 : 12.2

number

cost_price
可选

成本价
样例 : 122.34

number

details
可选

原料商品明细
样例 : [ "OrderItemDetail" ]

< OrderItemDetail > array

discount_amount
必填

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

number

extra_info
可选

扩展信息,json格式。美团拼好饭加价金额(singleIncreasePrice)、如果存在 inv_mgr = false 的话，表示该商品为非库存管理商品
样例 : "{\"inv_mgr\": false}"

string

fault_tolerant_info
可选

容错信息,json字符串
样例 : "string"

string

front
可选

前端商品信息
样例 : FrontItem

FrontItem

image_url
可选

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

string

is_collocation
可选

是否搭配商品(加料)，如奶茶+珍珠，珍珠是奶茶的加料商品
默认值 : false
样例 : false

boolean

is_gift
可选

默认值 : false
样例 : true

boolean

item_id
可选

订单商品行唯一标识
样例 : "1"

string

item_no
可选

订单行号
样例 : "1"

string

item_title
可选

商品标题
样例 : "葡萄"

string

orig_barcode
可选

转换前商品条码
样例 : "1212"

string

orig_extra_info
可选

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

OrigExtraInfo

orig_image_url
可选

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

string

orig_item
可选

定制：订单原商品信息，用于多规格、组合商品场景，记录用户下单时的商品信息
样例 : OrderOrigItem

OrderOrigItem

orig_item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

orig_mas_sku_id
可选

样例 : "string"

string

orig_price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 122.22

number

orig_qty
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 2.0

number

orig_sku_id
可选

转换前的货号：用于多规格转换场景
样例 : "121212"

string

orig_weight
可选

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

number

package_info
可选

商品打包信息
样例 : PackageInfo

PackageInfo

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

product_id
可选

商品代码
样例 : "2123"

string

promotion
可选

商品促销
样例 : ItemPromotion

ItemPromotion

purchase_price
可选

采购价
样例 : 2.0

number

quantity
必填

数量
样例 : 1.0

number

real_quantity
可选

实际拣货商品数量
样例 : 0.0

number

real_weight
可选

实际称重，明细总重量，单位g
样例 : 0.0

number

relation_item_id
可选

关联商品行号，如奶茶+珍珠，记录关联的奶茶的item_id
样例 : "2123"

string

relation_sku_id
可选

关联商品货号，如奶茶+珍珠，记录关联的奶茶的sku_id
样例 : "2123"

string

salesman
可选

推销员
样例 : IdName

IdName

service_options
可选

服务项目, 多个项目以/分隔显示
样例 : "清洁/杀菌"

string

settle_discountAmount
可选

平台优惠金额
样例 : 122.22

number

settle_price
可选

平台结算价格，为空等于售价
样例 : 122.2222

number

settle_total
可选

平台结算金额
样例 : 122.22

number

shop_price
可选

商家货款价格
样例 : 122.22

number

shop_total
可选

商家货款金额=商品原金额-商家商品优惠
样例 : 122.22

number

sku_id
必填

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

string

spec
可选

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

string

tags
可选

标签
样例 : "标签"

< OrderItemTag > array

total
必填

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

number

trace_code_details
可选

溯源码明细，与traceCodes（溯源码）字段相比，二者不能同时使用，优先使用traceCodeDetails，traceCodeDetails无值，在使用traceCodes
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

trace_codes
可选

溯源码
样例 : [ "string" ]

< string > array

unit
可选

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

string

unit_price
必填

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

number

uuid
可选

样例 : "string"

string

weight
必填

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

number

2.71. OrderItemChange

换货明细

名称 说明 类型

change_items
可选

目标商品行
样例 : [ "OrderItem" ]

< OrderItem > array

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

items
可选

来源商品行
样例 : [ "OrderItem" ]

< OrderItem > array

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

reason
可选

原因
样例 : "string"

string

2.72. OrderItemDetail

原料商品信息

名称 说明 类型

fault_tolerant_info
可选

容错信息,json字符串
样例 : "string"

string

front_spec
可选

平台属性
样例 : "辣"

string

id
必填

原料商品货号
样例 : "121212"

string

package_info
可选

包装信息
样例 : PackageInfo

PackageInfo

quantity
必填

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

number

ratio
必填

原料商品基数,C=2A+3B，A：2，B：3
样例 : 3.0

number

real_quantity
可选

实际拣货商品数量
样例 : 0.0

number

title
必填

名称
样例 : "矿泉水"

string

trace_code_details
可选

溯源码明细，与traceCodes（溯源码）字段相比，二者不能同时使用，优先使用traceCodeDetails，traceCodeDetails无值，在使用traceCodes
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

trace_codes
可选

溯源码
样例 : [ "string" ]

< string > array

2.73. OrderItemLogistics

订单明细物流信息

名称 说明 类型

logistics_code
可选

样例 : "string"

string

qty
可选

样例 : 0.0

number

sku_id
可选

样例 : "string"

string

2.74. OrderItemRtnApply

退款申请明细对象

名称 说明 类型

item_no
可选

订单行号
样例 : "1"

string

quantity
可选

数量
样例 : 1.0

number

real_total_weight
可选

实拣总重量,单位g
样例 : 1.0

number

refund_amount
可选

退款金额
样例 : 12.03

number

sku_id
必填

商品标识
样例 : "2123"

string

weight
可选

缺重重量,单位g
样例 : 1.0

number

weights
可选

缺重重量详情,多个数量不同缺重时使用,单位g
样例 : "1"

< number > array

2.75. OrderItemTag

订单明细标签

名称 说明 类型

name
可选

标签名称
样例 : "盲盒"

string

2.76. OrderItemTraceCodeDetail

溯源码

名称 说明 类型

batch_no
可选

批号
样例 : "string"

string

code
可选

溯源码
样例 : "string"

string

production_date
可选

生产日期
样例 : "2020-06-17 10:00:00"

string (date-time)

qpc_str
可选

规格
样例 : "string"

string

qty
可选

数量
样例 : 0.0

number

valid_date
可选

有效期
样例 : "2020-06-17 10:00:00"

string (date-time)

2.77. OrderKdTrace

订单快递跟踪

名称 说明 类型

carrier
可选

承运商
样例 : IdName

IdName

code
可选

样例 : "string"

string

details
可选

订单快递跟踪详情
样例 : [ "OrderKdTraceDetail" ]

< OrderKdTraceDetail > array

message
可选

样例 : "string"

string

state
可选

承运状态：initial（初始状态）、created（已下单）、 dispatched（已派单）、createdFailed（下单失败）、pickup（已揽件）、pickupFailed（揽件失败）、 delivering（配送中）、delivered（配送完成）、canceled（已取消）
样例 : "canceled"

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

success
可选

默认值 : false
样例 : true

boolean

waybill_id
可选

快递单号
样例 : "213232"

string

2.78. OrderKdTraceDetail

订单快递跟踪详情

名称 说明 类型

address
可选

地点
样例 : "福建,厦门市"

string

message
可选

内容
样例 : "顺丰速运 已收取快件"

string

status
可选

状态
样例 : "在途"

string

time
可选

时间
样例 : "2022-04-07 08:39:07"

string (date-time)

2.79. OrderList

订单集合对象

名称 说明 类型

empty
可选

默认值 : false
样例 : true

boolean

orders
可选

订单列表
样例 : [ "Order" ]

< Order > array

2.80. OrderLog

订单日志

名称 说明 类型

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.81. OrderOrigItem

原商品行信息

名称 说明 类型

barcode
可选

转换前条码
样例 : "121221"

string

combined_id
可选

如果是组合商品，需要传组合标识ID，可以用组合商品ID作为标识
样例 : "121221"

string

image_url
可选

转换前图片地址
样例 : "string"

string

item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 33.22

number

quantity
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 3.0

number

sku_id
可选

转换前的货号：用于多规格、组合商品转换标品场景
样例 : "121221"

string

type
可选

类型，多规格multi、组合combined
样例 : "multi"

string

weight
可选

重量
样例 : 0.0

number

2.82. OrderPackageInfo

订单打包信息

名称 说明 类型

details
可选

包装明细
样例 : "[]"

< PackageDetail > array

package_type
可选

指定打包袋类型：保温袋、纸袋、PLA环保袋
样例 : "保温袋"

string

required
可选

是否需要打包袋
默认值 : false
样例 : false

boolean

type
可选

单据类型
样例 : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)"

string

2.83. OrderPaging

订单分页对象

名称 说明 类型

orders
可选

订单列表
样例 : [ "Order" ]

< Order > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

total
可选

总条数
样例 : 100

integer (int64)

2.84. OrderPickInfo

名称 说明 类型

allow_pick_start_time
可选

允许拣货的开始时间
样例 : "2020-06-17 10:00:00"

string (date-time)

auto_picked_finish
可选

自动拣货完成
默认值 : false
样例 : true

boolean

operator_id
可选

拣货员ID
样例 : "string"

string

operator_name
可选

拣货员名称
样例 : "string"

string

source
可选

记录来源
样例 : "string"

string

time
可选

拣货时间
样例 : "2020-06-17 10:00:00"

string (date-time)

2.85. OrderPreSlot

订单预计送达信息

名称 说明 类型

pre_date
可选

预计送达日期
样例 : "今天（周三）"

string

pre_ends
可选

预计送达时间
样例 : "[\"立即送出\",\"12:00\",\"13:00\"]"

< string > array

2.86. OrderPromotion

订单优惠

名称 说明 类型

favs
可选

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

< FavDetail > array

2.87. OrderQuota

订单指标

名称 说明 类型

action
可选

操作：expect_shipping
样例 : "expect_shipping"

string

action_name
可选

操作名称：期望拣货完成时间
样例 : "期望拣货完成时间"

string

remark
可选

备注
样例 : "无"

string

time
可选

日期
样例 : "2021-09-26 16:40:19"

string (date-time)

2.88. OrderReissueRequest

订单补发请求

名称 说明 类型

receiver
可选

收货信息
样例 : Receiver

Receiver

reissue_order_items
必填

补发商品明细
样例 : [ "ReissueOrderItem" ]

< ReissueOrderItem > array

reissue_reason
可选

补发原因
样例 : "弄丢了"

string

responsible_party
必填

责任方,carrier代表承运商责任
样例 : "carrier"

string

seller_note
可选

备注说明
样例 : "商家备注"

string

source_order_id
必填

来源订单号
样例 : "121212"

string

2.89. OrderReissueResponse

补发订单响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.90. OrderRemind

名称 说明 类型

count
可选

平台催单次数
样例 : 1

integer (int32)

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

front_remind_id
可选

平台催单Id
样例 : "很好"

string

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

order_id
可选

订单ID
样例 : "202012021621"

string

platform_id
可选

平台ID
样例 : "jdo2o"

string

remind_id
可选

催单Id
样例 : "很好"

string

reply_content
可选

回复内容
样例 : "string"

string

reply_operator
可选

回复人
样例 : "string"

string

reply_state
可选

回复状态，未回复、已回复、已失效
样例 : "string"

string

reply_time
可选

回复时间
样例 : "2020-06-17 10:00:00"

string (date-time)

shop_id
可选

店铺ID
样例 : "jdo2o"

string

store
可选

门店
样例 : IdName

IdName

time
可选

催单时间
样例 : "2020-12-02 00:00:00"

string (date-time)

2.91. OrderRemindFilter

名称 说明 类型

id_eq
可选

id等于
样例 : "123"

string

id_in
可选

idIn
样例 : [ "string" ]

< string > array

order_id_eq
可选

订单Id等于
样例 : "123465"

string

order_id_in
可选

订单IdIn
样例 : [ "string" ]

< string > array

platform_id_eq
可选

平台Id等于
样例 : "meituan"

string

reply_state_eq
可选

回复状态
样例 : "none（未回复）、replied（已回复）、invalid（失效）"

string

store_id_eq
可选

门店Id等于
样例 : "0001"

string

2.92. OrderRemindPaging

催单分页对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

reminds
可选

订单列表
样例 : [ "OrderRemind" ]

< OrderRemind > array

total
可选

总条数
样例 : 100

integer (int64)

2.93. OrderSelftakeCheckRequest

自提检查请求对象

名称 说明 类型

front_order_id
可选

平台订单号
样例 : "5745323545453"

string

platform_id
可选

平台ID
样例 : "youzan"

string

selftake_code
必填

自提码
样例 : "123456"

string

selftake_qrcode
必填

自提二维码
样例 : "123456"

string

store_id
必填

门店ID
样例 : "232434"

string

2.94. OrderSelftakeCheckResponse

自提检查返回结果对象

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

订单号
样例 : "5745323545453"

string

success
可选

默认值 : false
样例 : true

boolean

2.95. OrderSelftakeRequest

自提请求对象

名称 说明 类型

selftake_qrcode
可选

自提二维码（订单号和自提二维码不能同时为空）
样例 : "222222"

string

store_id
可选

门店ID
样例 : "454534"

string

2.96. OrderSelftakeV2Request

自提请求对象

名称 说明 类型

order_id
可选

订单号（订单号和自提二维码不能同时为空）
样例 : "12345"

string

platform_id
可选

平台ID（自提二维码不为空时必填）
样例 : "be.eleme"

string

selftake_qrcode
可选

自提二维码（订单号和自提二维码不能同时为空）
样例 : "222222"

string

store_id
可选

门店ID
样例 : "454534"

string

2.97. OrderSelftakeV2Response

自提请求响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

订单号
样例 : "5745323545453"

string

success
可选

默认值 : false
样例 : true

boolean

2.98. OrderSettle

订单结算单

名称 说明 类型

amount
必填

客户实付金额
样例 : 22.0

number

bottom_service_fee
可选

保底服务费
样例 : 2.0

number

cod_amount
必填

货到付款金额
样例 : 0.0

number

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

delivery_type_id
可选

配送方式id
样例 : "string"

string

delivery_type_name
可选

配送方式名称
样例 : "string"

string

discount
必填

商家优惠金额
样例 : 2.0

number

discount_amount
必填

优惠总金额
样例 : 2.0

number

discounts
可选

订单级优惠详情
样例 : [ "OrderSettleItemDiscount" ]

< OrderSettleItemDiscount > array

freight
必填

原运费
样例 : 0.0

number

freight_commission
可选

运费佣金
样例 : 0.0

number

freight_discount
可选

运费优惠金额
样例 : 0.0

number

front_settle_id
可选

平台对账ID
样例 : "687856800239331"

string

front_state
可选

平台单据状态
样例 : "8"

string

front_type_id
可选

单据类型ID，不同平台ID不同
样例 : "1"

string

front_type_name
可选

单据类型名称，不同平台名称不同
样例 : "外卖订单"

string

invoice_fee
可选

开票金额
样例 : 0.0

number

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

order_created
可选

下单时间
样例 : "2019-08-07 00:00:00"

string (date-time)

order_finish_time
可选

完成时间
样例 : "2019-08-07 00:00:00"

string (date-time)

order_id
必填

订单ID
样例 : "132344"

string

other_fees
可选

其他费用
样例 : [ "OrderFee" ]

< OrderFee > array

package_box
必填

原餐盒费
样例 : 2.0

number

package_fee
必填

原打包费
样例 : 1.0

number

pay_amount
必填

付款金额
样例 : 22.0

number

performance_service_fee
可选

履约服务费
样例 : 2.0

number

platform_freight_discount
可选

平台运费优惠金额
样例 : 0.0

number

platform_id
必填

平台ID
样例 : "meituan"

string

platform_promotion_settle
可选

平台推广结算
样例 : 0.0

number

platform_service_fee
可选

平台服务费
样例 : 2.0

number

platform_service_rate
可选

平台服务费率，记小数，举例：0.02=20%
样例 : 0.02

number

platform_subsidy_suspend
可选

平台补贴暂扣
样例 : 0.0

number

refund_id
可选

平台退款ID
样例 : "323434343"

string

refund_time
可选

退款时间
样例 : "2019-08-07 00:00:00"

string (date-time)

selttle_commission
必填

平台结算佣金，拼写错误，建议使用：settle_commission
样例 : 2.0

number

settle
可选

结算金额
样例 : 22.0

number

settle_amount
必填

平台结算金额（商家应收款）
样例 : 2.0

number

settle_commission
必填

平台结算佣金
样例 : 2.0

number

settle_date
可选

结账日期
样例 : "2019-08-07 00:00:00"

string (date-time)

settle_discount
必填

平台结算优惠金额，平台优惠补贴
样例 : 2.0

number

settle_freight
可选

平台结算运费
样例 : 120.01

number

settle_id
可选

对账ID
样例 : "68785680023933117_1"

string

settle_state
必填

结算状态：已入账|未入账
样例 : "已入账"

string

shop_discount
可选

商家商品优惠金额贴
样例 : 2.0

number

shop_freight_discount
可选

商家运费优惠金额贴
样例 : 0.0

number

shop_id
必填

平台商家ID
样例 : "2123"

string

shop_package_fee
可选

商家打包费
样例 : 1.0

number

sp_store_id
可选

平台门店ID
样例 : "2323"

string

station_id
必填

配送门店ID
样例 : "212123"

string

station_name
可选

配送门店名称
样例 : "2323"

string

sub_front_type_id
可选

单据子类型ID，不同平台ID不同
样例 : "1"

string

sub_front_type_name
可选

单据子类型名称，不同平台名称不同
样例 : "外卖订单"

string

total
必填

原商品金额
样例 : 22.0

number

2.99. OrderSettleDiscount

对账优惠信息

名称 说明 类型

amount
可选

优惠金额
样例 : 1.0

number

details
可选

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

< DiscountSettleDetail > array

scope
可选

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

string

2.100. OrderSettleFilter

查询指定对账数据过滤器

名称 说明 类型

created_end
可选

创建时间结束于
样例 : "2019-08-07 19:49:36"

string (date-time)

created_start
可选

创建时间起始于
样例 : "2019-08-07 19:49:36"

string (date-time)

front_type_name_eq
可选

账单类型等于
样例 : "string"

string

front_type_name_start_with
可选

账单类型起始于
样例 : "string"

string

id_end_no_equal
可选

对账ID小于
样例 : "string"

string

ids
可选

对账id数组
样例 : [ "string" ]

< string > array

modified_end
可选

最后修改时间结束于
样例 : "2019-08-07 19:49:36"

string (date-time)

modified_start
可选

最后修改时间起始于
样例 : "2019-08-07 19:49:36"

string (date-time)

order_id_eq
可选

订单ID等于
样例 : "323345354"

string

order_id_in
可选

订单ID数组
样例 : [ "string" ]

< string > array

order_ids
可选

订单ID数组
样例 : [ "string" ]

< string > array

order_start_with
可选

订单ID起始于
样例 : "string"

string

platform_id_eq
可选

平台ID等于
样例 : "meituan"

string

platform_id_in
可选

平台ID数组
样例 : [ "string" ]

< string > array

settle_date_end
可选

账单日期结束于
样例 : "2019-08-07 19:49:36"

string (date-time)

settle_date_start
可选

账单日期起始于
样例 : "2019-08-07 19:49:36"

string (date-time)

shop_id_eq
可选

平台商家ID等于
样例 : "323443"

string

sp_store_id_eq
可选

平台门店ID等于
样例 : "0001"

string

station_id_eq
可选

门店ID等于
样例 : "0001"

string

station_id_in
可选

门店ID数组
样例 : [ "string" ]

< string > array

2.101. 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.102. OrderSettleItemDiscount

订单级优惠详情

名称 说明 类型

act_id
可选

活动代码
样例 : "343434"

string

act_name
可选

活动名称
样例 : "string"

string

amount
必填

商家承担金额
样例 : 2.0

number

discount_amount
可选

优惠金额
样例 : 5.0

number

front_amount
必填

平台承担金额
样例 : 333.0

number

front_discount_detail_type_id
可选

平台优惠类型详情ID
样例 : "2222"

string

front_discount_detail_type_name
可选

平台优惠类型详情名称
样例 : "string"

string

front_discount_type_id
可选

平台优惠类型ID
样例 : "3234"

string

front_discount_type_name
可选

平台优惠类型名称
样例 : "string"

string

radio
可选

商家承担比例,[0,1]
样例 : 0.0

number

type
可选

类型：order，item
样例 : "item"

string

2.103. OrderSettleItemFilter

查询指定订单明细结算数据过滤器

名称 说明 类型

item_id_in
可选

明细行ID列表
样例 : [ "string" ]

< string > array

order_id_eq
可选

订单ID等于
样例 : "323243434"

string

platform_id_eq
可选

平台ID等于
样例 : "meituan"

string

shop_id_eq
可选

平台商家ID等于
样例 : "15154"

string

2.104. OrderSettleItemOrderList

明细结算数据列表对象

名称 说明 类型

orders
可选

明细结算数据列表
样例 : [ "明细结算数据列表" ]

< 明细结算数据列表 > array

2.105. OrderSettleItemPaging

订单明细结算数据查询对象

名称 说明 类型

items
可选

订单明细结算数据列表
样例 : [ "订单明细结算数据" ]

< 订单明细结算数据 > array

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

2.106. OrderSettleList

订单结算单列表对象

名称 说明 类型

items
可选

订单结算单列表
样例 : [ "OrderSettle" ]

< OrderSettle > array

2.107. OrderSettlePaging

对账数据查询对象

名称 说明 类型

items
可选

订单结算单列表
样例 : [ "OrderSettle" ]

< OrderSettle > array

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

2.108. OrderStoreMod

订单下单门店

名称 说明 类型

order_id
可选

订单号
样例 : "1212"

string

order_store
可选

下单门店
样例 : IdName

IdName

2.109. OrderStoreModError

修改订单下单门店失败明细

名称 说明 类型

id
可选

订单号
样例 : "1212"

string

message
可选

原因
样例 : "订单不存在"

string

2.110. OrderStoreModRequest

修改订单下单门店

名称 说明 类型

mods
可选

订单修改列表，一次修改记录不能超过100
样例 : [ "OrderStoreMod" ]

< OrderStoreMod > array

2.111. OrderStoreModResponse

修改订单下单门店响应

名称 说明 类型

code
可选

样例 : "string"

string

errors
可选

失败明细，如果sucess=false，errors为空表示整体失败，否则errors记录具体失败明细
样例 : [ "OrderStoreModError" ]

< OrderStoreModError > array

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.112. OrderSubmitResponse

订单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.113. OrderTag

订单

名称 说明 类型

name
可选

标签名称
样例 : "首单"

string

2.114. OrigExtraInfo

原商品行扩展信息

名称 说明 类型

spec
可选

规格
样例 : "1*1"

string

unit
可选

规格单位
样例 : "个"

string

2.115. PackageDetail

打包商品明细

名称 说明 类型

amount
可选

打包袋金额
样例 : 1.0

number

qty
可选

打包袋数量
样例 : 1.0

number

sku_id
可选

打包袋ID
样例 : "213323232"

string

sku_name
可选

打包袋名称
样例 : "213323232"

string

2.116. PackageInfo

商品打包信息

名称 说明 类型

packageName
可选

打包袋名称
样例 : "保温袋"

string

quantity
可选

包装盒数量
样例 : 125.0

number

thermosphere
可选

温层
样例 : "string"

string

total
可选

包装费用
样例 : 205.44

number

2.117. PayRequest

支付请求对象

名称 说明 类型

details
可选

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

< PaymentDetail > array

pay_bill_id
可选

支付账单号
样例 : "123434354"

string

pay_state
可选

付款状态：notPay（未付款）、earnest（已付定金）、paid（已付全款）
样例 : "paid"

enum (notPay, earnest, paid)

pay_time
可选

付款时间
样例 : "2019-12-12 12:12:00"

string (date-time)

payee
可选

付款人
样例 : IdName

IdName

2.118. 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.119. 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.120. PickInfoRequest

拣货信息请求

名称 说明 类型

pick_info
可选

订单拣货信息
样例 : OrderPickInfo

OrderPickInfo

2.121. PrintBill

打印单据

名称 说明 类型

content
可选

内容
样例 : "内容"

string

created
可选

单据创建时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2020-06-17 10:00:00"

string (date-time)

deleted
可选

默认值 : false
样例 : true

boolean

deleted_time
可选

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

string (date-time)

name
可选

模板小票名称
样例 : "外卖订单"

string

outerId
可选

外部Id，目前作为yilianyun打印的唯一标识
样例 : "string"

string

printer
可选

打印机类型：JPOS（JPOS打印机），yilianyun（易联云打印机），默认JPOS
样例 : "string"

string

sku_id
可选

样例 : "string"

string

ticket_type
可选

票据类型：小票、杯贴
样例 : "小票"

string

title
可选

显示名称
样例 : "外卖订单"

string

type
可选

样例 : "string"

string

2.122. Receiver

收货人

名称 说明 类型

address
必填

地址
样例 : Address

Address

contact
必填

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

联系方式(soms)

2.123. Refund

退款信息

名称 说明 类型

amount
必填

实际退货金额（包含运费）
样例 : 12.03

number

classification
可选

退款类别，取值范围:normal(正常)、balance(补差)，为空表示正常
样例 : "normal"

enum (normal, balance)

extra
可选

退款其他费用，退货取件费：rtn_pickup_freight
样例 : [ "ExtraField" ]

< ExtraField > array

freight
必填

退运费
样例 : 12.03

number

package_total
可选

包装费用
样例 : 12.03

number

part_refund
可选

是否部分退
默认值 : false
样例 : false

boolean

payments
可选

退款支付明細
样例 : [ "RefundPayment" ]

< RefundPayment > array

refund_phase
可选

退款阶段，取值范围:onsale(售中)、aftersale(售后)
样例 : "aftersale"

enum (onsale, aftersale)

settle_amount
可选

结算金额
样例 : 12.03

number

settle_commission
必填

平台结算佣金
样例 : 2.0

number

settle_fieight
可选

结算运费
样例 : 12.03

number

shop_amount
可选

商家货款金额
样例 : 120.01

number

state
必填

退款状态，取值范围:none(未退款)、refunded(已退款)
样例 : "none"

enum (none, refunded)

2.124. RefundPayment

退款支付明细

名称 说明 类型

account_name
可选

账号名称
样例 : "工行"

string

account_no
可选

账号
样例 : "002002"

string

amount
必填

退款金额
样例 : 12.33

number

code
可选

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

string

discount_amount
可选

退款优惠金额
样例 : 100.0

number

extra_info
可选

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

string

name
必填

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

string

out_pay_id
可选

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

string

pay_id
可选

支付id
样例 : "3223232323"

string

score
可选

积分数量
样例 : 100.0

number

2.125. ReissueOrderItem

补发商品明细

名称 说明 类型

item_no
必填

行号
样例 : "1"

string

quantity
必填

数量
样例 : 13.0

number

sku_id
必填

货号
样例 : "132323"

string

2.126. ReplyRemindRequest

名称 说明 类型

reply_content
可选

回复内容
样例 : "string"

string

reply_operator
可选

回复操作人
样例 : "string"

string

reply_time
可选

回复时间
样例 : "2020-06-17 10:00:00"

string (date-time)

2.127. ReqFrontMod

修改平台信息

名称 说明 类型

extend_props
可选

属性信息
样例 : "string"

string

logistic
可选

物流信息
样例 : IdName

IdName

logs
可选

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

< SaleOrderLog > array

state
可选

状态
样例 : "已付款"

string

wrh
可选

仓库信息
样例 : IdName

IdName

2.128. ReqReturnRequest

退货请求对象

名称 说明 类型

return_state
必填

退货状态，取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货)
样例 : "none"

enum (none, customerShipped, received)

waybills
可选

运单信息
样例 : [ "WaybillInfo" ]

< WaybillInfo > array

2.129. ReturnDelivery

退货信息

名称 说明 类型

carrier
可选

承运商
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "note"

string

return_mobile
可选

退货联系人
样例 : "18856556655"

string

returner
可选

退货人
样例 : Receiver

Receiver

state
可选

退货状态，取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货)
样例 : "none"

enum (none, customerShipped, received)

station
可选

退回门店
样例 : IdName

IdName

station_type
可选

退回站点类型，取值范围:store(门店)、wrh(仓库)、vendor(供应商)
样例 : "string"

string

vendor
可选

退回供应商
样例 : CodeName

CodeName

waybill_id
可选

承运单号
样例 : "XXXXXXXXX"

string

wrh
可选

退回仓库
样例 : CodeName

CodeName

wrh_rtn_id
可选

仓库退货单号
样例 : "XXXXXXXXX"

string

2.130. ReturnRequest

退货请求对象

名称 说明 类型

carrier
可选

承运商
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "note"

string

operator_role
可选

操作角色
样例 : "platform"

string

return_state
必填

退货状态，取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货)
样例 : "none"

enum (none, customerShipped, received)

waybill_id
可选

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

string

2.131. Rtn

退换货单

名称 说明 类型

address_change_fee
可选

地址变更费
样例 : 120.01

number

appeal
可选

是否申诉
默认值 : false
样例 : false

boolean

apply_id
可选

申请ID
样例 : "0002"

string

apply_reason
可选

申请原因
样例 : "不想要了"

string

apply_system
可选

申请方
样例 : "shop(商家)、customer（消费者）"

string

approve_state
必填

审批状态，取值范围:none(未审核),serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝)
样例 : "none"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

cancel_reason
可选

取消申请原因
样例 : "又想要了"

string

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

crm_info
可选

营销信息
样例 : CRMInfo

CRMInfo

customer
可选

客户
样例 : Customer

Customer

customer_note
可选

客户留言
样例 : "haha"

string

delivery
必填

退货信息
样例 : ReturnDelivery

ReturnDelivery

exception_codes
可选

异常代码，sku（商品异常）
样例 : "sku"

string

exception_remark
可选

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

string

exception_time
可选

异常时间
样例 : "2020-11-11 12:11:21"

string (date-time)

front
必填

平台退货信息
样例 : FrontRtn

FrontRtn

has_exception
可选

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

boolean

id
可选

退货订单号，不能重复，为空自动生成
样例 : "0002"

string

items
可选

商品行
样例 : [ "RtnItem" ]

< RtnItem > array

member_info
可选

会员积分信息
样例 : RtnMemberInfo

RtnMemberInfo

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

order_id
必填

原订单号
样例 : "3232320003"

string

package_info
可选

打包信息
样例 : OrderPackageInfo

OrderPackageInfo

print_bills
可选

退单打印数据
样例 : [ "PrintBill" ]

< PrintBill > array

promotion
可选

退单促销
样例 : RtnPromotion

RtnPromotion

refund
必填

退款信息
样例 : Refund

Refund

req_id
可选

申请单ID(废弃字段)
样例 : "string"

string

rtn_req_id
可选

销售退单号
样例 : "string"

string

seller_info
可选

收货失败：原因/凭证
样例 : SellerInfo

SellerInfo

settle_info
可选

对账信息
样例 : RtnSettleInfo

RtnSettleInfo

settle_unit
可选

结算单位
样例 : SettleUnit

SettleUnit

shop
必填

平台商家
样例 : IdName

IdName

sku_quantity
必填

商品总数
样例 : 1.0

number

state
可选

退货单状态,新建可不填，取值范围：confirmed(已生成)、approved(已审核)、finished(已完成)、canceled(已取消),为空时取默认值confirmed
样例 : "confirmed"

enum (confirmed, approved, finished, canceled)

tags
可选

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

< OrderTag > array

type
可选

退货单类型,取值范围：refund(仅退款)、refundAndRtn(退款退货)；为空默认为退款退货
样例 : "refund"

enum (refund, refundAndRtn)

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

wrh_id
可选

发货仓库编号
样例 : "string"

string

wrh_state
可选

仓库状态,取值参考RtnWrhState
样例 : "initial"

string

2.132. RtnApproveRequest

退单审核请求对象

名称 说明 类型

approve_state
必填

审核状态:none（未审核）,serviceApproved（客服已审核）,serviceRefuse（客服已拒绝）
样例 : "serviceApproved"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

item_infos
可选

明细信息
样例 : [ "退单审核请求对象-明细信息" ]

< 退单审核请求对象-明细信息 > array

operator_role
可选

操作角色：platform（平台）
样例 : "platform"

string

reason
可选

原因
样例 : "已发货，不能退"

string

turn_to_type
可选

转换为哪种类型
样例 : "refundAndRtn"

enum (refund, refundAndRtn)

2.133. RtnFilter

退单过滤器

名称 说明 类型

app_id_eq
可选

平台应用代码等于
样例 : "3232323"

string

appeal
可选

是否申诉
默认值 : false
样例 : false

boolean

approve_states
可选

审核状态，取值范围:none(未审核)、serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝)
样例 : [ "none" ]

< enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse) > array

bill_id_eq
可选

凭证单号等于
样例 : "32323434"

string

bill_id_like
可选

凭证单号类似
样例 : "3454545"

string

carrier_states
可选

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

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

carrier_types
可选

承运类型,取值范围:self(商家自送)、thirdparty(平台配送)、express(快递配送)
样例 : [ "self" ]

< enum (self, thirdparty, express) > array

created_end
可选

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

string (date-time)

created_start
可选

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

string (date-time)

customer_Mobile
可选

客户电话
样例 : "18587887789"

string

customer_Name
可选

客户姓名
样例 : "张三"

string

customer_mobile_like
可选

客户电话模糊搜索
样例 : "7789"

string

deliver_rtn_end
可选

退货终止时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

deliver_rtn_start
可选

退货起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

fake_refund_date
可选

退款完成日期，只支持es，是用索引最后修改时间和退款状态=refunded来匹配的,格式为：yyyy-MM-dd
样例 : "2016-03-02"

string (date-time)

front_created_end
可选

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

string (date-time)

front_created_start
可选

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

string (date-time)

front_order_id
可选

平台订单ID
样例 : "323434"

string

front_rtn_id
可选

平台退换货ID
样例 : "3232434"

string

front_sku_id
可选

平台商品编码
样例 : "3234"

string

front_station_order_no_eq
可选

门店订单号
样例 : "3232323"

string

has_billing
可选

是否有凭证信息
默认值 : false
样例 : false

boolean

has_exception
可选

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

boolean

index_modified_end
可选

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

string (date-time)

index_modified_start
可选

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

string (date-time)

order_id
可选

订单号起始于
样例 : "123456"

string

order_id_in
可选

订单号
样例 : "123456"

< string > array

pick_info_operator_id_eq
可选

订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单
样例 : "string"

string

pick_info_operator_id_in
可选

订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单
样例 : [ "string" ]

< string > array

pick_info_operator_name_like
可选

订单拣货信息-拣货员名称
样例 : "string"

string

platform_id
可选

平台ID
样例 : "jdo2o"

string

platform_ids
可选

平台ID集合
样例 : "jdo2o"

< string > array

pre_page
可选

上一次页数
样例 : 1

integer (int32)

product_contains
可选

商品包括
样例 : "sku2323"

string

refund_phase
可选

申请阶段
样例 : "aftersale"

string

refund_states
可选

退款状态，取值范围:none(未审核)、refunded(已退款)
样例 : [ "none" ]

< enum (none, refunded) > array

return_states
可选

退货状态，取值范围:none(未审核)、customerShipped(客户已发货)、received(已收货)
样例 : [ "none" ]

< enum (none, customerShipped, received) > array

rtn_Id
可选

退单号起始于
样例 : "123456"

string

rtn_ids
可选

退单号
样例 : [ "string" ]

< string > array

shop_id
可选

店铺ID
样例 : "12348522"

string

sku_id
可选

商品编码
样例 : "232323"

string

states
可选

退货单状态,取值范围:confirmed(已生成)、approved(已审核)、finished(已完成)、canceled(已取消)
样例 : [ "confirmed" ]

< enum (confirmed, approved, finished, canceled) > array

station_id
可选

门店ID
样例 : "12345"

string

station_ids
可选

门店ID
样例 : [ "string" ]

< string > array

station_type
可选

退回站点
样例 : "wrh"

string

types
可选

退货类型
样例 : [ "refund" ]

< enum (refund, refundAndRtn) > array

vendor_code_eq
可选

供应商代码等于
样例 : "3232323"

string

vendor_code_in
可选

供应商代码集合
样例 : "3232323"

< string > array

vendor_code_start_with
可选

供应商代码起始于
样例 : "3232323"

string

waybill_id
可选

退回物流单号
样例 : "32323434"

string

wrh_id_in
可选

退回仓库code集合
样例 : "3232323"

< string > array

wrh_id_start_with
可选

退回仓库code起始于
样例 : "3232323"

string

2.134. RtnItem

退货商品行

名称 说明 类型

barcode
可选

商品条码
样例 : "123456"

string

details
可选

退款商品行明细
样例 : [ "RtnItemDetail" ]

< RtnItemDetail > array

extra_info
可选

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

string

front_item_id
可选

平台订单行ID
样例 : "052700601"

string

front_sku_id
可选

前台商品标识
样例 : "e235346ger545"

string

front_unit
可选

单位
样例 : "string"

string

image_url
可选

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

string

is_collocation
可选

是否搭配商品(加料)
默认值 : false
样例 : false

boolean

is_gift
可选

默认值 : false
样例 : true

boolean

item_id
可选

行唯一标识
样例 : "22323232323"

string

item_no
可选

行号
样例 : "1"

string

item_title
可选

商品标题
样例 : "冰红茶"

string

order_item_id
可选

订单行标识id
样例 : "1"

string

orig_barcode
可选

转换前商品条码
样例 : "1212"

string

orig_image_url
可选

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

string

orig_item
可选

订单原商品信息，用于多规格、组合商品场景，记录用户下单时的商品信息
样例 : RtnOrigItem

RtnOrigItem

orig_item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

orig_mas_sku_id
可选

样例 : "string"

string

orig_price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 122.22

number

orig_qty
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 2.0

number

orig_sku_id
可选

转换前的货号：用于多规格转换场景
样例 : "121212"

string

orig_spec
可选

转换前的规格：用于多规格、组合商品转换标品场景
样例 : "122.22"

string

orig_unit
可选

转换前的单位：用于多规格、组合商品转换标品场景
样例 : "122.22"

string

origin_sku_id
可选

替换前的商品标识,只有界面使用
样例 : "e235346ger545"

string

product_id
可选

商品代码
样例 : "2123"

string

promotion
可选

商品退促销
样例 : ItemPromotion

ItemPromotion

purchase_price
可选

采购价
样例 : 12.0

number

quantity
必填

退货数量
样例 : 2.0

number

real_qty
可选

实际数量(已废弃)
样例 : 0.0

number

real_quantity
可选

实际拣货商品数量
样例 : 0.0

number

real_weight
可选

实际称重，明细总重量，单位g
样例 : 0.0

number

refund_amount
必填

退款金额 （订单优惠后的金额）
样例 : 12.03

number

relation_item_id
可选

关联商品行号
样例 : "2123"

string

relation_sku_id
可选

关联的货号
样例 : "2123"

string

settle_price
可选

结算价格
样例 : 12.03

number

settle_total
可选

结算金额
样例 : 12.03

number

shop_price
可选

货款价格
样例 : 11.22

number

shop_total
可选

货款金额
样例 : 11.22

number

sku_id
必填

商品标识
样例 : "123456"

string

spec
可选

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

string

tags
可选

标签
样例 : "标签"

< 退单明细标签 > array

total
必填

退款金额
样例 : 12.03

number

trace_code_details
可选

溯源码明细
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

unit
可选

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

string

unit_price
必填

价格
样例 : 12.03

number

uuid
可选

样例 : "string"

string

2.135. RtnItemDetail

退款商品行明细

名称 说明 类型

id
必填

商品货号
样例 : "01123"

string

quantity
必填

商品数量
样例 : 0.01

number

ratio
必填

原料比例，数值3表示，一个组合商品，包含3个原料商品
样例 : 2.0

number

real_quantity
可选

样例 : 0.0

number

title
必填

名称
样例 : "01123"

string

trace_code_details
可选

溯源码明细
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

2.136. RtnList

退换货单集合

名称 说明 类型

rtns
可选

退换货单列表
样例 : [ "Rtn" ]

< Rtn > array

2.137. RtnMemberInfo

积分信息

名称 说明 类型

card_no
可选

实体卡卡号
样例 : "22323"

string

2.138. RtnModificationRequest

修改退货单请求对象

名称 说明 类型

address_change_fee
可选

地址变更费
样例 : 10.01

number

apply_reason
可选

申请原因
样例 : "不想要了"

string

carrier_type
可选

退单配送状态
样例 : "self"

enum (self, thirdparty, express)

customer_note
可选

客户留言
样例 : "haha"

string

freight
可选

运费
样例 : 12.03

number

items
可选

退换货明细行
样例 : [ "RtnItem" ]

< RtnItem > array

modify_item_detail
可选

是否修改商品原料
默认值 : false
样例 : false

boolean

package_total
可选

包装费
样例 : 12.03

number

refund_extra
可选

退款其他费用，退货取件费：rtn_pickup_freight
样例 : [ "ExtraField" ]

< ExtraField > array

rtnId
可选

退换货单ID
样例 : "4356465768"

string

settle_amount
可选

结算金额
样例 : 12.03

number

settle_commission
可选

本退单退回佣金
样例 : 12.03

number

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

2.139. RtnNotifyWrhRequest

通知仓库请求对象

类型 : object

2.140. RtnOrigItem

原商品行信息

名称 说明 类型

barcode
可选

转换前条码
样例 : "121221"

string

combined_id
可选

如果是组合商品，需要传组合标识ID，可以用组合商品ID作为标识
样例 : "121221"

string

image_url
可选

转换前图片地址
样例 : "string"

string

item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 33.22

number

quantity
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 3.0

number

sku_id
可选

转换前的货号：用于多规格、组合商品转换标品场景
样例 : "121221"

string

type
可选

类型，多规格multi、组合combined
样例 : "multi"

string

2.141. RtnPaging

退单分页对象

名称 说明 类型

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

总页数
样例 : 0

integer (int32)

page_size
可选

页大小
样例 : 0

integer (int32)

rtns
可选

退单列表
样例 : [ "Rtn" ]

< Rtn > array

total
可选

总条数
样例 : 0

integer (int64)

2.142. RtnPrintData

退单打印数据

名称 说明 类型

bills
可选

每联的打印数据
样例 : [ "PrintBill" ]

< PrintBill > array

front_rtn_id
可选

前端平台退单ID
样例 : "20160122000006"

string

rtn_id
可选

退单号
样例 : "20160122000006"

string

time
可选

打印数据的生成时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

2.143. RtnPrintDataList

退单打印数据列表对象

名称 说明 类型

rtns
可选

退单打印数据列表
样例 : [ "RtnPrintData" ]

< RtnPrintData > array

2.144. RtnPromotion

退单优惠

名称 说明 类型

favs
可选

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

< FavDetail > array

2.145. RtnRefundUpdateRequest

修改退款信息

名称 说明 类型

payments
可选

退款支付明細
样例 : [ "RefundPayment" ]

< RefundPayment > array

2.146. RtnReq

退换货申请单

名称 说明 类型

appeal
可选

是否申诉
默认值 : false
样例 : false

boolean

apply_reason
可选

申请原因
样例 : "不想要了"

string

approve_state
必填

审批状态，取值范围:none(未审核),serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝)
样例 : "none"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

cancel_reason
可选

取消申请原因
样例 : "又想要了"

string

change_order_info
可选

换出信息
样例 : ChangeOrderInfo

ChangeOrderInfo

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

customer
可选

客户
样例 : Customer

Customer

customer_note
可选

客户留言
样例 : "haha"

string

delivery
可选

配送信息
样例 : RtnReqDelivery

RtnReqDelivery

exception_codes
可选

异常代码，sku（商品异常）
样例 : "sku"

string

exception_remark
可选

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

string

extra_info
可选

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

string

front
可选

平台退货信息
样例 : RtnReqFront

RtnReqFront

has_exception
可选

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

boolean

id
可选

申请单ID，不能重复，为空自动生成
样例 : "0002"

string

items
可选

商品行
样例 : [ "RtnReqItem" ]

< RtnReqItem > array

logs
可选

退换货申请单日志
样例 : [ "SaleOrderLog" ]

< SaleOrderLog > array

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

order_id
必填

原订单号
样例 : "3232320003"

string

promotion
可选

退单促销
样例 : RtnPromotion

RtnPromotion

refund
可选

退款信息
样例 : Refund

Refund

seller_node
可选

商家备注
样例 : "note"

string

shop
必填

平台商家店铺，非门店
样例 : IdName

IdName

state
可选

退货单状态,新建可不填，取值范围：confirmed(已生成)、prepared(已预处理),approved(审核通过)、rejected(已拒绝)、finished(已完成)、canceled(已取消),为空时取默认值confirmed
样例 : "confirmed"

enum (confirmed, perpared, approved, finished, canceled, rejected)

station
可选

退货站点
样例 : IdName

IdName

tags
可选

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

< OrderTag > array

type
可选

申请类型,取值范围：refund(仅退款申请)、refundAndRtn(退款退货申请)、change(换货申请)
样例 : "refund"

enum (refund, refundAndRtn, change)

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

wrh_id
可选

退回仓库编号
样例 : "string"

string

wrh_state
可选

仓库状态,取值参考RtnWrhState
样例 : "initial"

string

2.147. RtnReqApproveRequest

退单审核请求对象

名称 说明 类型

approve_state
必填

审核状态:none（未审核）,serviceApproved（客服已审核）,serviceRefuse（客服已拒绝）,financeApproved（财务已审核）,financeRefuse（财务已拒绝）
样例 : "serviceApproved"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

reason
可选

原因
样例 : "已发货，不能退"

string

2.148. RtnReqDelivery

配送信息

名称 说明 类型

returner
可选

退货人
样例 : Receiver

Receiver

state
可选

退货状态，取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货)
样例 : "none"

enum (none, customerShipped, received)

station
可选

退回门店
样例 : IdName

IdName

station_type
可选

退回站点类型，取值范围:store(门店)、wrh(仓库)、vendor(供应商)
样例 : "string"

string

waybills
可选

运单信息
样例 : [ "WaybillInfo" ]

< WaybillInfo > array

wrh
可选

仓库
样例 : CodeName

CodeName

2.149. RtnReqEsFilter

退换货申请单ES过滤器

名称 说明 类型

approve_states
可选

审核状态，取值范围:none(未审核)、serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝)
样例 : [ "none" ]

< enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse) > array

created_end
可选

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

string (date-time)

created_start
可选

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

string (date-time)

customer_Mobile
可选

客户电话
样例 : "18587887789"

string

customer_Name
可选

客户姓名
样例 : "张三"

string

customer_mobile_like
可选

客户电话模糊搜索
样例 : "7789"

string

customer_name_like
可选

客户姓名类似于
样例 : "张三"

string

front_created_end
可选

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

string (date-time)

front_created_start
可选

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

string (date-time)

front_order_id
可选

平台订单ID
样例 : "323434"

string

has_exception
可选

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

boolean

order_id
可选

订单号
样例 : "123456"

string

order_id_in
可选

订单号
样例 : "123456"

< string > array

order_id_start_with
可选

订单号起始于
样例 : "123456"

string

platform_id
可选

平台ID
样例 : "jdo2o"

string

platform_ids
可选

平台ID集合，仅支持es
样例 : "jdo2o"

< string > array

pre_page
可选

上一次页数
样例 : 1

integer (int32)

return_states
可选

退货状态，仅支持es，取值范围:none(未审核)、customerShipped(客户已发货)、received(已收货)
样例 : [ "none" ]

< enum (none, customerShipped, received) > array

rtn_req_id
可选

退换货申请单号
样例 : "123456"

string

rtn_req_id_start_with
可选

退换货申请单号起始于
样例 : "123456"

string

shop_id
可选

店铺ID
样例 : "12348522"

string

states
可选

退货单状态,取值范围:confirmed(已生成)、approved(已审核)、finished(已完成)、canceled(已取消)
样例 : [ "confirmed" ]

< enum (confirmed, perpared, approved, finished, canceled, rejected) > array

station_id
可选

门店ID，仅支持es
样例 : "12345"

string

station_ids
可选

门店ID，仅支持es
样例 : "12345,56789"

< string > array

types
可选

退货类型
样例 : [ "refund" ]

< enum (refund, refundAndRtn, change) > array

waybill_id_condition
可选

下属退回运单号中运单号精确包含，仅支持es
样例 : "12345"

string

2.150. RtnReqFilter

退换货申请单过滤器

名称 说明 类型

approve_states
可选

审核状态，取值范围:none(未审核)、serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝)
样例 : [ "none" ]

< enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse) > array

created_end
可选

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

string (date-time)

created_start
可选

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

string (date-time)

customer_Mobile
可选

客户电话
样例 : "18587887789"

string

customer_Name
可选

客户姓名
样例 : "张三"

string

customer_mobile_like
可选

客户电话模糊搜索
样例 : "7789"

string

front_created_end
可选

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

string (date-time)

front_created_start
可选

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

string (date-time)

front_order_id
可选

平台订单ID
样例 : "323434"

string

has_exception
可选

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

boolean

order_id
可选

订单号
样例 : "123456"

string

order_id_in
可选

订单号
样例 : "123456"

< string > array

order_id_start_with
可选

订单号起始于
样例 : "123456"

string

platform_id
可选

平台ID
样例 : "jdo2o"

string

pre_page
可选

上一次页数
样例 : 1

integer (int32)

rtn_req_id
可选

退换货申请单号
样例 : "123456"

string

rtn_req_id_start_with
可选

退换货申请单号起始于
样例 : "123456"

string

shop_id
可选

店铺ID
样例 : "12348522"

string

states
可选

退货单状态,取值范围:confirmed(已生成)、approved(已审核)、finished(已完成)、canceled(已取消)
样例 : [ "confirmed" ]

< enum (confirmed, perpared, approved, finished, canceled, rejected) > array

station_ids
可选

门店ID，仅支持es
样例 : "12345,56789"

< string > array

types
可选

退货类型
样例 : [ "refund" ]

< enum (refund, refundAndRtn, change) > array

2.151. RtnReqFront

平台退换货申请单信息

名称 说明 类型

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" ]

< 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

rtn_id
可选

平台退货单号
样例 : "123456"

string

shop
可选

店铺
样例 : IdName

IdName

state
可选

状态
样例 : "已付款"

string

station_order_no
可选

平台门店订单序号
样例 : "1"

string

third_order_id
必填

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

string

wrh
可选

仓库信息
样例 : IdName

IdName

2.152. RtnReqItem

退货申请单商品行

名称 说明 类型

apported_discount_amount
必填

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

number

barcode
可选

商品条码
样例 : "123456"

string

combined
可选

默认值 : false
样例 : true

boolean

details
可选

样例 : [ "RtnReqItemDetail" ]

< RtnReqItemDetail > array

discount_amount
必填

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

number

front
可选

前端商品信息
样例 : SaleFrontItem

SaleFrontItem

front_item_id
可选

平台订单行ID
样例 : "052700601"

string

front_sku_id
可选

前台商品标识
样例 : "e235346ger545"

string

front_unit
可选

单位
样例 : "string"

string

gift
可选

默认值 : false
样例 : true

boolean

image_Url
可选

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

string

item_id
可选

行唯一标识
样例 : "1"

string

item_no
可选

订单行号
样例 : "1"

string

item_title
可选

商品标题
样例 : "葡萄"

string

orig_barcode
可选

转换前商品条码
样例 : "1212"

string

orig_image_url
可选

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

string

orig_item
可选

订单原商品信息，用于多规格、组合商品场景，记录用户下单时的商品信息
样例 : RtnReqOrigItem

RtnReqOrigItem

orig_item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

orig_price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 122.22

number

orig_qty
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 2.0

number

orig_sku_id
可选

转换前的货号：用于多规格转换场景
样例 : "121212"

string

origin_sku_id
可选

替换前的商品标识,只有界面使用
样例 : "e235346ger545"

string

package_total
可选

包装费用
样例 : 205.44

number

price
可选

售价（促销价）
样例 : 122.34

number

product_id
可选

商品代码
样例 : "2123"

string

purchase_price
可选

采购价
样例 : 2.0

number

quantity
必填

数量
样例 : 1.0

number

refund_amount
必填

退款金额 （订单优惠后的金额）
样例 : 12.03

number

rtn_id
可选

关联退回单号
样例 : "681795759987"

string

rtn_state
可选

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

string

settle_price
可选

结算价格
样例 : 12.03

number

settle_total
可选

结算金额
样例 : 12.03

number

shop_price
可选

货款价格
样例 : 11.22

number

shop_total
可选

货款金额
样例 : 11.22

number

sku_id
必填

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

string

spec
可选

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

string

station_id
可选

样例 : "string"

string

station_name
可选

样例 : "string"

string

total
必填

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

number

unit
可选

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

string

unit_price
必填

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

number

uuid
可选

样例 : "string"

string

2.153. RtnReqItemDetail

退款商品行明细

名称 说明 类型

id
必填

商品货号
样例 : "01123"

string

quantity
必填

商品数量
样例 : 0.01

number

ratio
必填

原料比例，数值3表示，一个组合商品，包含3个原料商品
样例 : 2.0

number

real_quantity
可选

样例 : 0.0

number

title
必填

名称
样例 : "01123"

string

2.154. RtnReqList

退换货单集合

名称 说明 类型

reqs
可选

退换货单列表
样例 : [ "RtnReq" ]

< RtnReq > array

2.155. RtnReqModRequest

修改退货单请求对象

名称 说明 类型

apply_reason
可选

申请原因
样例 : "不想要了"

string

change_items
可选

换货明细行
样例 : [ "ChangeItem" ]

< ChangeItem > array

customer_note
可选

客户留言
样例 : "haha"

string

front
可选

平台信息
样例 : ReqFrontMod

ReqFrontMod

items
可选

退货明细行
样例 : [ "RtnReqItem" ]

< RtnReqItem > array

seller_node
可选

商家备注
样例 : "note"

string

type
可选

申请类型
样例 : "4356465768"

enum (refund, refundAndRtn, change)

waybills
可选

运单信息
样例 : [ "WaybillInfo" ]

< WaybillInfo > array

wrh_id
可选

退回仓库编号
样例 : "string"

string

2.156. RtnReqOrigItem

原商品行信息

名称 说明 类型

barcode
可选

转换前条码
样例 : "121221"

string

combined_id
可选

如果是组合商品，需要传组合标识ID，可以用组合商品ID作为标识
样例 : "121221"

string

image_url
可选

转换前图片地址
样例 : "string"

string

item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 33.22

number

quantity
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 3.0

number

sku_id
可选

转换前的货号：用于多规格、组合商品转换标品场景
样例 : "121221"

string

type
可选

类型，多规格multi、组合combined
样例 : "multi"

string

2.157. RtnReqPaging

退换货申请单分页对象

名称 说明 类型

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

总页数
样例 : 0

integer (int32)

page_size
可选

页大小
样例 : 0

integer (int32)

rtnReqs
可选

退换货申请单列表
样例 : [ "RtnReq" ]

< RtnReq > array

total
可选

总条数
样例 : 0

integer (int64)

2.158. RtnReqRefuseRequest

拒绝申请单请求对象

类型 : object

2.159. RtnReqSubmitResponse

退换货申请单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.160. RtnSettleInfo

对账信息

名称 说明 类型

settlable
可选

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

boolean

settle_date
可选

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

string (date-time)

station_settle_mode
可选

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

string

2.161. RtnSettleInfoUpdateRequest

修改结算信息

名称 说明 类型

settlable
可选

默认值 : false
样例 : true

boolean

settle_date
可选

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

string (date-time)

2.162. RtnSubmitResponse

退单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

rtn_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.163. RtnUpdateDeliveryRequest

修改物流物流退回信息请求对象

名称 说明 类型

carrier
可选

承运商
样例 : IdName

IdName

mobile
可选

手机号
样例 : "18859540085"

string

state
可选

退货状态：none（未退货）、customerShipped（客户已发货）、received（已收货）
样例 : "received"

enum (none, customerShipped, received)

waybill_id
可选

承运单号
样例 : "43444444444232323"

string

2.164. 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.165. 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_order_no
可选

订单序号
样例 : "1"

string

third_order_id
必填

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

string

wrh
可选

仓库
样例 : IdName

IdName

2.166. 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.167. 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.168. 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.169. 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.170. 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.171. SaleOrderItemDetail

销售订单组合明细原料

名称 说明 类型

id
必填

原料货号
样例 : "detailSkuId123"

string

quantity
必填

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

number

ratio
必填

原料商品基数
样例 : 0.0

number

title
必填

原料名称
样例 : "detailSkuName123"

string

upc
可选

国际码
样例 : "upc123"

string

2.172. 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.173. SaleOrderLockDetail

销售订单占货明细

名称 说明 类型

state
可选

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

enum (none, part, all)

stock_type
可选

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

string

2.174. 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.175. SaleOrderPaging

销售单分页对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

saleOrders
可选

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

< SaleOrder > array

total
可选

总条数
样例 : 100

integer (int64)

2.176. SaleOrderSubmitResponse

销售单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

sale_order_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.177. 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.178. ScoreInfo

积分信息

名称 说明 类型

balance
可选

积分余额
样例 : 100.0

number

total
可选

获得积分
样例 : 1.0

number

2.179. SelftakeRule

自提规则

名称 说明 类型

def
可选

规则内容
样例 : SelftakeRuleDef

SelftakeRuleDef

platform_id
必填

平台ID
样例 : "meituan"

string

shop_id
必填

商家ID
样例 : "33454"

string

source
可选

规则来源，取值：ptm_shop（平台商家）、ptm_store（平台门店）
样例 : "ptm_store"

string

state
可选

是否开通：applying（未开通）、opened（已开通）
样例 : "applying"

enum (applying, opened)

store_id
必填

门店ID
样例 : "0001"

string

2.180. SelftakeRuleDef

自提规则定义

名称 说明 类型

check_selftake_code
可选

是否校验自提码
默认值 : false
样例 : true

boolean

2.181. SellerInfo

收货失败：原因/凭证

名称 说明 类型

seller_note
可选

收货失败原因
样例 : "收货失败原因"

string

seller_voucher_urls
可选

卖家收货失败凭证：图片地址
样例 : "卖家收货失败凭证：图片地址"

< string > array

2.182. SettleUnit

结算单位

名称 说明 类型

code
可选

单位代码，取值门店代码
样例 : "0001"

string

name
可选

单位门店，取值门店名称
样例 : "门店1"

string

type
可选

类型：store
样例 : "store"

string

2.183. StoreOperationRequest

门店作业请求

名称 说明 类型

operation
必填

作业动作：accept（接单）、shipping（集货）、recheck（复核）、handover（交接）、cancelShipping（取消集货）
样例 : "accept"

string

operation_state
必填

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

string

pick_info
可选

订单拣货信息
样例 : OrderPickInfo

OrderPickInfo

shipping_voucher_urls
可选

拣货凭证
样例 : [ "string" ]

< string > array

store_id
必填

门店ID
样例 : "21213323"

string

2.184. StoreOperationRtnRule

名称 说明 类型

allow_float
可选

默认值 : false
样例 : true

boolean

allow_part_refund
可选

默认值 : false
样例 : true

boolean

limtRtnApproveTimeRange
可选

样例 : "string"

string

manual_receive
可选

默认值 : false
样例 : true

boolean

2.185. StoreOperationRule

名称 说明 类型

def
可选

规则内容
样例 : StoreOperationRuleDef

StoreOperationRuleDef

platform_id
可选

平台ID
样例 : "33454"

string

shop_id
可选

商家ID
样例 : "33454"

string

source
可选

样例 : "string"

string

state
可选

是否开通：applying（未开通）、opened（已开通）
样例 : "applying"

enum (applying, opened)

store_id
可选

门店ID
样例 : "33454"

string

type
可选

样例 : "string"

string

2.186. StoreOperationRuleDef

名称 说明 类型

pick_rule
可选

样例 : 门店作业拣货规则

门店作业拣货规则

rtn_rule
可选

样例 : StoreOperationRtnRule

StoreOperationRtnRule

2.187. StoreOperationRuleFilter

名称 说明 类型

platformIdEq
可选

样例 : "string"

string

shopIdEq
可选

样例 : "string"

string

stateEq
可选

样例 : "string"

string

storeIdEq
可选

样例 : "string"

string

storeIdIn
可选

样例 : [ "string" ]

< string > array

typeEq
可选

样例 : "string"

string

2.188. StoreOperationRuleSave

名称 说明 类型

def
可选

def
样例 : StoreOperationRuleDef

StoreOperationRuleDef

platform_id
可选

平台ID
样例 : "33454"

string

shop_id
可选

商家代码
样例 : "storeRtnRule"

string

store_id
可选

门店代码
样例 : "0001"

string

type
可选

类型
样例 : "33454"

string

2.189. SuspendInfo

挂起信息

名称 说明 类型

caption
必填

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

string

code
必填

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

string

suspended
可选

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

boolean

time
可选

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

string (date-time)

2.190. TaggingRequest

更新订单标签请求

名称 说明 类型

add_tags
可选

要新增的标签
样例 : [ "string" ]

< string > array

remove_tags
可选

要移除的标签
样例 : [ "string" ]

< string > array

2.191. UpdateCustomerNoteRequest

更新客户备注请求

名称 说明 类型

customer_note
可选

客户备注
样例 : "string"

string

2.192. UpdateReplyContentRequest

名称 说明 类型

reply_content
可选

回复内容
样例 : "string"

string

2.193. Waybill

运单

名称 说明 类型

waybill_id
可选

运单号
样例 : "123"

string

2.194. 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.195. WaybillPrintData

运单打印详情

名称 说明 类型

data
可选

数据
样例 : "string"

string

type
可选

request|response
样例 : "string"

string

2.196. WaybillPrintInfo

运单打印数据

名称 说明 类型

datas
可选

打印数据
样例 : [ "WaybillPrintData" ]

< WaybillPrintData > array

2.197. WishInfo

祝福信息

名称 说明 类型

type
可选

1-含义：用户选择商家代打印贺卡 2-含义：用户选择空白贺卡 3-含义：用户选择不需要贺卡
样例 : "string"

string

wish
可选

祝福语
样例 : "string"

string

2.198. soms分页查询结果Count

名称 说明 类型

data
可选

数据
样例 : [ "Count" ]

< Count > array

page
可选

页码
样例 : 0

integer (int32)

pageCount
可选

页数
样例 : 2

integer (int32)

pageSize
可选

页面大小
样例 : 100

integer (int32)

total
可选

总数
样例 : "1000L"

integer (int64)

2.199. 明细结算数据列表

名称 说明 类型

items
可选

订单明细结算数据
样例 : [ "订单明细结算数据" ]

< 订单明细结算数据 > array

order_id
可选

订单ID
样例 : "212121212"

string

2.200. 统计服务过滤器

名称 说明 类型

actionEq
可选

action
样例 : "decrypt"

string

actionIn
可选

action在……之中
样例 : "[\"decrypt\"]"

< string > array

actionNameLike
可选

actionName
样例 : "string"

string

businessKeyEq
可选

业务key
样例 : "123"

string

businessKeyIn
可选

业务key在……之中
样例 : "[\"123\",\"456\"]"

< string > array

modifiedBegin
可选

最后修改时间起始于
样例 : "2021-08-23 12:16:20"

string (date-time)

modifiedEnd
可选

最后修改时间结束于
样例 : "2021-08-23 12:16:20"

string (date-time)

typeEq
可选

类型
样例 : "order"

string

typeIn
可选

类型在……之中
样例 : "[\"order\"]"

< string > array

2.201. 联系方式(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

2.202. 订单数据库查询条件

名称 说明 类型

created_end
可选

创建时间截止于
样例 : "2025-03-03 23:59:59"

string (date-time)

created_start
可选

创建时间起始于
样例 : "2025-03-03 00:00:00"

string (date-time)

front_created_end
可选

下单时间截止于
样例 : "2025-03-05 16:28:32"

string (date-time)

front_created_start
可选

下单时间起始于
样例 : "2025-03-05 10:20:30"

string (date-time)

need_count_total
可选

是否计算总数
默认值 : false
样例 : true

boolean

operation_state_in
可选

门店作业状态范围
样例 : "[\"accepted\"]"

< string > array

order_id_eq
可选

订单号等于
样例 : "718597703857"

string

order_id_or_front_station_order_no_eq
可选

订单号或门店订单号等于
样例 : "01"

string

pick_info_operator_id_eq
可选

拣货Id人等于
样例 : "9527"

string

pick_info_operator_id_in
可选

订单拣货信息-拣货员ID,若传is null则查询没有这个字段或字段为空的订单
样例 : [ "string" ]

< string > array

state_in
可选

状态范围
样例 : "[\"confirmed\"]"

< string > array

station_id_in
可选

门店代码范围，最多200个
样例 : "[\"0001\"]"

< string > array

2.203. 订单明细结算数据

名称 说明 类型

amount
可选

商品金额
样例 : 33.0

number

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

discount_amount
可选

商家承担金额
样例 : 12.0

number

discount_radio
可选

商家承担比例
样例 : 0.0

number

discounts
可选

订单级优惠列表
样例 : [ "OrderSettleItemDiscount" ]

< OrderSettleItemDiscount > array

fav_amount
可选

优惠总金额
样例 : 12.0

number

front_discount_amount
可选

平台承担金额
样例 : 2.0

number

front_discount_radio
可选

平台承担比例
样例 : 0.0

number

front_price
可选

平台商品价格
样例 : 12.0

number

front_score_amount
可选

平台积分金额
样例 : 2.0

number

front_sku_id
必填

平台商品编码
样例 : "3230"

string

item_id
可选

结算行id
样例 : "212121212"

string

item_no
可选

行号
样例 : "1"

string

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

order_created
可选

下单时间
样例 : "2018-12-07 14:34:00"

string (date-time)

order_id
必填

订单ID
样例 : "323232323"

string

pay_amount
必填

顾客实付金额
样例 : 12.0

number

platform_id
必填

平台ID
样例 : "meituan"

string

price
必填

价格
样例 : 33.0

number

quantity
必填

数量
样例 : 12.0

number

shop_id
必填

店铺ID
样例 : "43435"

string

sku_id
必填

商品平台编码
样例 : "43434"

string

station_id
必填

门店代码
样例 : "43435"

string

station_name
可选

门店名称
样例 : "西店"

string

total
可选

商品原价总金额
样例 : 20.0

number

unit_price
可选

原价
样例 : 32.0

number

2.204. 退单审核请求对象-明细信息

名称 说明 类型

detail_infos
可选

原料信息
样例 : [ "退单审核请求对象-明细原料信息" ]

< 退单审核请求对象-明细原料信息 > array

item_id
可选

行Id
样例 : "string"

string

item_no
可选

行号
样例 : "string"

string

order_item_id
可选

订单行Id
样例 : "string"

string

real_quantity
可选

实际数量
样例 : 0.0

number

sku_id
可选

货号
样例 : "string"

string

2.205. 退单审核请求对象-明细原料信息

名称 说明 类型

real_quantity
可选

实际退回数量
样例 : 0.0

number

sku_id
可选

原料货号
样例 : "string"

string

2.206. 退单明细标签

名称 说明 类型

name
可选

名称
样例 : "盲盒"

string

2.207. 门店作业拣货规则

名称 说明 类型

allow_pick_time
可选

限制拣货时间，允许提前多久分钟开始拣货,单位分钟
样例 : 0.0

number