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

接口

1. 接口定义

1.1. 销售退服务

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

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

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

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

Path

front_rtn_id
必填

销售退平台id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

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

string

Query

platform_id
必填

平台ID

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

200

successful operation

RtnReq
1.1.1.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/front/string?platform_id=string
1.1.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"
        },
        "expected_logistics_type" : "crowdsourcing",
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "suggest_station" : {
        "id" : "string",
        "name" : "string"
      },
      "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station" : {
        "id" : "string",
        "name" : "string"
      },
      "waybill_id" : "123"
    } ],
    "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
    } ],
    "gift" : true,
    "combined" : 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" : [ {
          "type" : "normal（普通）,expDate（效期）",
          "barcode" : "123",
          "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.1.2. 提交销售退

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

提交销售退

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

rtn_req
必填

销售退

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

200

successful operation

RtnReqSubmitResponse
1.1.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"
        },
        "expected_logistics_type" : "crowdsourcing",
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "suggest_station" : {
        "id" : "string",
        "name" : "string"
      },
      "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station" : {
        "id" : "string",
        "name" : "string"
      },
      "waybill_id" : "123"
    } ],
    "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
    } ],
    "gift" : true,
    "combined" : 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" : [ {
          "type" : "normal（普通）,expDate（效期）",
          "barcode" : "123",
          "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.1.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "id" : "string"
}

1.1.3. 取指定销售退

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

取指定销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

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

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

200

successful operation

RtnReq
1.1.3.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreq/string
1.1.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "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"
        },
        "expected_logistics_type" : "crowdsourcing",
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "suggest_station" : {
        "id" : "string",
        "name" : "string"
      },
      "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
      "virtual_station" : {
        "id" : "string",
        "name" : "string"
      },
      "waybill_id" : "123"
    } ],
    "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
    } ],
    "gift" : true,
    "combined" : 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" : [ {
          "type" : "normal（普通）,expDate（效期）",
          "barcode" : "123",
          "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.1.4. 审核销售退

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

审核销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退单审核请求

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

200

successful operation

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

1.1.5. 取消销售退

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

取消销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

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

1.1.6. 确认退货状态

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

确认退货状态

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

Path

id
必填

退货单ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退货请求对象

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

200

successful operation

ActionResult
1.1.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"
      },
      "expected_logistics_type" : "crowdsourcing",
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
    "suggest_station" : {
      "id" : "string",
      "name" : "string"
    },
    "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
    "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
    "virtual_station" : {
      "id" : "string",
      "name" : "string"
    },
    "waybill_id" : "123"
  } ],
  "return_state" : "none"
}
1.1.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.7. 修改销售退

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

修改销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

ActionResult
1.1.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
    } ],
    "gift" : true,
    "combined" : 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"
      },
      "expected_logistics_type" : "crowdsourcing",
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
    "suggest_station" : {
      "id" : "string",
      "name" : "string"
    },
    "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
    "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
    "virtual_station" : {
      "id" : "string",
      "name" : "string"
    },
    "waybill_id" : "123"
  } ],
  "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" : [ {
        "type" : "normal（普通）,expDate（效期）",
        "barcode" : "123",
        "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.1.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.8. 确认退款

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

确认退款

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

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

1.1.9. 拒绝销售退

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

拒绝销售退

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

Path

id
必填

销售退id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退单拒绝审核请求

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

200

successful operation

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

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

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

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

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

200

successful operation

RtnReqPaging
1.1.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.1.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"
          },
          "expected_logistics_type" : "crowdsourcing",
          "deliveryman_mobile" : "18859658865",
          "exception_reason" : "异常原因",
          "delivery_id" : "8548418",
          "delivery_name" : "8548418"
        },
        "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "suggest_station" : {
          "id" : "string",
          "name" : "string"
        },
        "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station" : {
          "id" : "string",
          "name" : "string"
        },
        "waybill_id" : "123"
      } ],
      "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
      } ],
      "gift" : true,
      "combined" : 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" : [ {
            "type" : "normal（普通）,expDate（效期）",
            "barcode" : "123",
            "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.1.11. 查询销售退（ES查询）

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

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

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

200

successful operation

RtnReqPaging
1.1.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.1.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"
          },
          "expected_logistics_type" : "crowdsourcing",
          "deliveryman_mobile" : "18859658865",
          "exception_reason" : "异常原因",
          "delivery_id" : "8548418",
          "delivery_name" : "8548418"
        },
        "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "suggest_station" : {
          "id" : "string",
          "name" : "string"
        },
        "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station" : {
          "id" : "string",
          "name" : "string"
        },
        "waybill_id" : "123"
      } ],
      "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
      } ],
      "gift" : true,
      "combined" : 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" : [ {
            "type" : "normal（普通）,expDate（效期）",
            "barcode" : "123",
            "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.1.12. 查指定销售订单的退货单

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

查指定销售订单的退货单

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

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

销售订单ID

string

Query

parts
可选

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

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

200

successful operation

RtnReqList
1.1.12.4. HTTP请求示例
请求 path
/string/soms/rtnreqservice/rtnreqs/saleorder?order_id=string
1.1.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"
          },
          "expected_logistics_type" : "crowdsourcing",
          "deliveryman_mobile" : "18859658865",
          "exception_reason" : "异常原因",
          "delivery_id" : "8548418",
          "delivery_name" : "8548418"
        },
        "suggest_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "suggest_station" : {
          "id" : "string",
          "name" : "string"
        },
        "station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station_type" : "store（门店）、wrh（仓库）、vendor（供应商）",
        "virtual_station" : {
          "id" : "string",
          "name" : "string"
        },
        "waybill_id" : "123"
      } ],
      "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
      } ],
      "gift" : true,
      "combined" : 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" : [ {
            "type" : "normal（普通）,expDate（效期）",
            "barcode" : "123",
            "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"
    }
  } ]
}

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

取消退货请求对象

名称 说明 类型

approve_state
可选

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

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

reason
可选

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

string

2.4. Carrier

承运商

名称 说明 类型

carrier
可选

承运平台
样例 : IdName

IdName

delivery_id
可选

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

string

delivery_name
可选

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

string

deliveryman
可选

送货员
样例 : IdName

IdName

deliveryman_mobile
可选

送货员手机
样例 : "18859658865"

string

exception_reason
可选

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

string

expected_logistics_type
可选

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

string

merchant
可选

承运商家
样例 : IdName

IdName

state
可选

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

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

type
可选

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

enum (self, thirdparty, express)

2.5. 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.6. ChangeOrderInfo

换出信息

名称 说明 类型

change_items
可选

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

< ChangeItem > array

change_order_id
可选

换出订单号
样例 : "string"

string

2.7. CodeName

名称 说明 类型

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.8. ConfirmReqRefundRequest

确认退款请求对象

名称 说明 类型

payments
可选

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

< RefundPayment > array

refundState
必填

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

enum (none, refunded)

2.9. Customer

客户

名称 说明 类型

contact
可选

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

联系方式(soms)

id
可选

代码
样例 : "10001"

string

2.10. DiscountSettleDetail

优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

role
可选

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

string

2.11. DiscountShareDetail

整合优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

type
可选

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

string

2.12. ExtraField

自定义字段

名称 说明 类型

id
可选

自定义id
样例 : "distance_freight"

string

name
可选

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

string

value
可选

自定义值
样例 : "0.01"

string

2.13. 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.14. 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.15. FavFactorItem

参与优惠商品明细

名称 说明 类型

amount
可选

参与促销金额
样例 : 1.0

number

item_id
可选

行标识
样例 : "1"

string

item_no
必填

行号
样例 : 1

integer (int32)

qty
可选

参与促销数量
样例 : 1.0

number

2.16. ICN

ICN对象

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.17. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.18. 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.19. OrderItemTraceCodeDetail

溯源码

名称 说明 类型

barcode
可选

条码
样例 : "123"

string

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

type
可选

类型，默认是normal
样例 : "normal（普通）,expDate（效期）"

string

valid_date
可选

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

string (date-time)

2.20. OrderTag

订单

名称 说明 类型

name
可选

标签名称
样例 : "首单"

string

2.21. PackageInfo

商品打包信息

名称 说明 类型

packageName
可选

打包袋名称
样例 : "保温袋"

string

quantity
可选

包装盒数量
样例 : 125.0

number

thermosphere
可选

温层
样例 : "string"

string

total
可选

包装费用
样例 : 205.44

number

2.22. Receiver

收货人

名称 说明 类型

address
必填

地址
样例 : Address

Address

contact
必填

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

联系方式(soms)

2.23. 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.24. 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.25. ReqFrontMod

修改平台信息

名称 说明 类型

extend_props
可选

属性信息
样例 : "string"

string

logistic
可选

物流信息
样例 : IdName

IdName

logs
可选

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

< SaleOrderLog > array

state
可选

状态
样例 : "已付款"

string

wrh
可选

仓库信息
样例 : IdName

IdName

2.26. ReqReturnRequest

退货请求对象

名称 说明 类型

return_state
必填

退货状态，取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货)
样例 : "none"

enum (none, customerShipped, received)

waybills
可选

运单信息
样例 : [ "WaybillInfo" ]

< WaybillInfo > array

2.27. RtnPromotion

退单优惠

名称 说明 类型

favs
可选

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

< FavDetail > array

2.28. 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.29. RtnReqApproveRequest

退单审核请求对象

名称 说明 类型

approve_state
必填

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

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

reason
可选

原因
样例 : "已发货，不能退"

string

2.30. 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.31. 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.32. 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.33. 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.34. 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.35. RtnReqItemDetail

退款商品行明细

名称 说明 类型

id
必填

商品货号
样例 : "01123"

string

quantity
必填

商品数量
样例 : 0.01

number

ratio
必填

原料比例，数值3表示，一个组合商品，包含3个原料商品
样例 : 2.0

number

real_quantity
可选

样例 : 0.0

number

title
必填

名称
样例 : "01123"

string

2.36. RtnReqList

退换货单集合

名称 说明 类型

reqs
可选

退换货单列表
样例 : [ "RtnReq" ]

< RtnReq > array

2.37. 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.38. 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.39. RtnReqPaging

退换货申请单分页对象

名称 说明 类型

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

总页数
样例 : 0

integer (int32)

page_size
可选

页大小
样例 : 0

integer (int32)

rtnReqs
可选

退换货申请单列表
样例 : [ "RtnReq" ]

< RtnReq > array

total
可选

总条数
样例 : 0

integer (int64)

2.40. RtnReqRefuseRequest

拒绝申请单请求对象

类型 : object

2.41. RtnReqSubmitResponse

退换货申请单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.42. 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.43. 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.44. 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.45. 联系方式(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