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

接口

1. 接口定义

1.1. 客户退货服务

1.1.1. 退单打印接口v2

POST /{tenant_id}/storedelivery/rtnservice/printRtns
1.1.1.1. 说明

退单打印接口v2

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

Path

tenant_id
必填

租户ID

string

Body

param
必填

参数

退单打印参数
1.1.1.3. 响应
HTTP代码 说明 类型

200

successful operation

退单打印数据v2列表
1.1.1.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/printRtns
请求 body
{
  "rtn_ids" : [ "string" ],
  "tmpl_names" : [ "string" ],
  "printers" : [ "string" ]
}
1.1.1.5. HTTP响应示例
响应 200
{
  "退单打印数据" : [ {
    "rtn_id" : "1233211234567",
    "print_bills" : [ {
      "name" : "外卖订单",
      "content" : "string",
      "created" : "2025-02-14",
      "printer" : "JPOS"
    } ]
  } ]
}

1.1.2. 退单呼叫云打印

POST /{tenant_id}/storedelivery/rtnservice/rtn/call/cloud/print
1.1.2.1. 说明

退单呼叫云打印

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

Path

tenant_id
必填

租户

string

Query

operator
必填

操作人

string

Body

param
必填

参数

退单呼叫云打印参数
1.1.2.3. 响应
HTTP代码 说明 类型

200

successful operation

退单呼叫云打印结果
1.1.2.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/rtn/call/cloud/print?operator=string
请求 body
{
  "printer" : "string",
  "rtn_id" : "string",
  "tpl_names" : [ "string" ]
}
1.1.2.5. HTTP响应示例
响应 200
{
  "message" : "string",
  "success" : true
}

1.1.3. 取指定退货单，支持销售退，和soms接口传参、返回值一模一样

GET /{tenant_id}/storedelivery/rtnservice/sdsoms/rtn/{id}
1.1.3.1. 说明

取指定退货单，支持销售退，和soms接口传参、返回值一模一样

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

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

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

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

200

successful operation

SOMSRtn
1.1.3.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/sdsoms/rtn/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" : "189389928893"
    }
  },
  "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" : "189389928893"
      },
      "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",
    "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" : [ {
        "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"
      } ],
      "input_codes" : [ {
        "type" : "EAN",
        "code" : "232323",
        "qpc" : 0.0,
        "unit" : "string",
        "weight" : 0.0,
        "qpc_str" : "string"
      } ],
      "use_valid_date" : true,
      "shelf_life" : "string",
      "valid_period_over_days" : 0,
      "sale_valid_period_over_hours" : 0
    } ],
    "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" : [ {
      "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"
    } ],
    "orig_mas_sku_id" : "string",
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 0.0,
      "unit" : "string",
      "weight" : 0.0,
      "qpc_str" : "string"
    } ],
    "use_valid_date" : true,
    "shelf_life" : "string",
    "valid_period_over_days" : 0,
    "sale_valid_period_over_hours" : 0,
    "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_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
    }
  },
  "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.4. 审核退换货

POST /{tenant_id}/storedelivery/rtnservice/sdsoms/rtn/{id}/action/approve
1.1.4.1. 说明

审核退换货

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

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退单审核请求

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

200

successful operation

ActionResult
1.1.4.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/sdsoms/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.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.5. 取消退货单

POST /{tenant_id}/storedelivery/rtnservice/sdsoms/rtn/{id}/action/cancel
1.1.5.1. 说明

取消退货单

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

Path

id
必填

退货单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

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

1.1.6. 查询退货单，支持销售退，和soms接口传参、返回值一模一样

POST /{tenant_id}/storedelivery/rtnservice/sdsoms/rtns/query
1.1.6.1. 说明

查询退货单，支持销售退，和soms接口传参、返回值一模一样

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

查询条件

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

200

successful operation

SOMSRtnPaging
1.1.6.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/sdsoms/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.6.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" : "189389928893"
      }
    },
    "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" : "189389928893"
        },
        "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",
      "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" : [ {
          "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"
        } ],
        "input_codes" : [ {
          "type" : "EAN",
          "code" : "232323",
          "qpc" : 0.0,
          "unit" : "string",
          "weight" : 0.0,
          "qpc_str" : "string"
        } ],
        "use_valid_date" : true,
        "shelf_life" : "string",
        "valid_period_over_days" : 0,
        "sale_valid_period_over_hours" : 0
      } ],
      "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" : [ {
        "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"
      } ],
      "orig_mas_sku_id" : "string",
      "input_codes" : [ {
        "type" : "EAN",
        "code" : "232323",
        "qpc" : 0.0,
        "unit" : "string",
        "weight" : 0.0,
        "qpc_str" : "string"
      } ],
      "use_valid_date" : true,
      "shelf_life" : "string",
      "valid_period_over_days" : 0,
      "sale_valid_period_over_hours" : 0,
      "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_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
      }
    },
    "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.1.7. 退货申请

POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/order/{id}/{action}/apply
1.1.7.1. 说明

退货申请

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

Path

action
必填

操作类型,取值有partrefund（部分退款）

string

Path

id
必填

订单号

string

Path

store_id
必填

门店代码

string

Path

tenant_id
必填

租户代码

string

Query

operator_id
必填

操作人

string

Query

operator_name
可选

操作人姓名

string

Body

request
可选

申请内容

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

default

successful operation

无内容
1.1.7.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/order/string/string/apply?operator_id=string
请求 body
{
  "reason" : "不想要了",
  "items" : [ {
    "order_item_no" : "2",
    "item_code" : "32323",
    "item_name" : "苹果",
    "quantity" : 32.0
  } ]
}

1.1.8. 获取退单收货失败原因

GET /{tenant_id}/storedelivery/rtnservice/store/{store_id}/receiverFailReason
1.1.8.1. 说明

获取退单收货失败原因

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

Path

store_id
必填

门店代码

string

Path

tenant_id
必填

租户ID

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

200

successful operation

ReasonList
1.1.8.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/receiverFailReason
1.1.8.5. HTTP响应示例
响应 200
{
  "reasons" : [ {
    "code" : "string",
    "reason" : "string"
  } ]
}

1.1.9. 修改退单的溯源码信息

POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtn/{rtn_id}/tracecode/update
1.1.9.1. 说明

修改退单的溯源码信息

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

Path

rtn_id
必填

退单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

修改退单溯源码的请求
1.1.9.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.9.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtn/string/tracecode/update?operator=string
请求 body
{
  "cover" : true,
  "items" : [ {
    "details" : [ {
      "id" : "string",
      "trace_code_list" : [ {
        "barcode" : "string",
        "type" : "normal（普通）,expDate（效期）",
        "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" : "string",
    "sku_id" : "string",
    "item_id" : "string",
    "trace_code_list" : [ {
      "barcode" : "string",
      "type" : "normal（普通）,expDate（效期）",
      "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"
    } ]
  } ]
}
1.1.9.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.10. 取单个退货订单

GET /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{id}
1.1.10.1. 说明

取单个退货订单

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

Path

id
必填

退换货申请单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

fetch_parts
可选

需要取回的退货订单部件。如果传null表示只取退货订单头部，如果传items表示取订单的详情，refunds表示退款详情，如果传item.details表示取组合商品详情，item.inputCodes（商品输入码）

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

200

successful operation

RtnOrder
1.1.10.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string
1.1.10.5. HTTP响应示例
响应 200
{
  "id" : "23232323",
  "type" : "refund",
  "salechannel" : "jdo2o",
  "status" : "received",
  "total" : 21.25,
  "items" : [ {
    "spec" : "1*1",
    "unit" : "kg",
    "quantity" : 56.0,
    "total" : 59.36,
    "order_item_id" : "string",
    "item_id" : "string",
    "item_no" : "1",
    "item_code" : "0001",
    "item_name" : "香蕉",
    "unit_price" : 12.36,
    "barcode" : "32323",
    "order_quantity" : 56.0,
    "details" : [ {
      "id" : "032345",
      "title" : "矿泉水",
      "quantity" : 12.0,
      "ratio" : 0.65,
      "input_codes" : [ {
        "type" : "EAN",
        "code" : "232323",
        "qpc" : 0.0,
        "unit" : "string",
        "weight" : 0.0,
        "qpc_str" : "string"
      } ],
      "trace_code_details" : [ {
        "barcode" : "string",
        "type" : "normal（普通）,expDate（效期）",
        "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"
      } ],
      "use_valid_date" : true
    } ],
    "orig_item" : {
      "quantity" : 12.0,
      "item_code" : "32323",
      "item_name" : "可乐",
      "qpc" : "1*1",
      "order_quantity" : 12.0,
      "unit" : "份"
    },
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 0.0,
      "unit" : "string",
      "weight" : 0.0,
      "qpc_str" : "string"
    } ],
    "trace_code_details" : [ {
      "barcode" : "string",
      "type" : "normal（普通）,expDate（效期）",
      "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"
    } ],
    "use_valid_date" : true
  } ],
  "refunds" : [ {
    "name" : "支付宝",
    "amount" : 12.03,
    "card_number" : "22121",
    "store_pay" : false,
    "need_cash" : false
  } ],
  "tags" : [ {
    "name" : "首单"
  } ],
  "appeal" : false,
  "sale_order_id" : "32443323",
  "salechannel_name" : "京东到家",
  "sale_payment_type" : "货到付款",
  "sale_ship_location" : "dc",
  "delivery_type" : "上门取件",
  "status_caption" : "待审核",
  "refund_status" : "refunding",
  "refund_status_caption" : "已退款",
  "customer_info" : "aaa",
  "apply_time" : "2018-05-04 14:25:25",
  "apply_reason" : "不想要了",
  "customer_note" : "haha",
  "voucher_urls" : [ "string" ],
  "receive_time" : "2018-05-04 14:25:25",
  "hint_info" : "hello",
  "invoice_info" : "aaa",
  "return_amount" : 25.36,
  "waybill_id" : "1212121212",
  "cancel_reason" : "又想要了",
  "sku_quantity" : 0.0,
  "order_info" : {
    "id" : "1001001",
    "status" : "confirming",
    "deliveryman" : "李三",
    "front_order_id" : "1001001",
    "status_caption" : "已取消",
    "create_time" : "2017-11-27 18:38:42",
    "deliveryman_mobile" : "15655895658",
    "carrier_id" : "self",
    "carrier_name" : "顺丰",
    "waybill_id" : "123456",
    "carrier_type" : "express",
    "carrier_state" : "pickupFailed",
    "station_order_no" : "1",
    "delivery_type" : "送货上门"
  },
  "allow_actions" : [ "string" ]
}

1.1.11. 审核退款

PUT /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{id}/status/approve
1.1.11.1. 说明

审核退款

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

Path

id
必填

退换货申请单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
必填

操作人姓名，长度不超过50

string

Body

detail
必填

退货详情

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

default

successful operation

无内容
1.1.11.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string/status/approve?operator_id=string&operator_name=string
请求 body
{
  "state" : "refuse",
  "reason" : "已和客户联系，不退"
}

1.1.12. 确认收到退货

PUT /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{id}/status/received
1.1.12.1. 说明

确认收到退货

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

Path

id
必填

退换货申请单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
必填

操作人姓名，长度不超过50

string

Body

detail
必填

退货详情

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

default

successful operation

无内容
1.1.12.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string/status/received?operator_id=string&operator_name=string
请求 body
{
  "type" : "all（整单）、part（部分），默认all",
  "items" : [ {
    "item_no" : "1",
    "item_code" : "0001",
    "quantity" : 56.0
  } ],
  "payments" : [ {
    "name" : "支付宝",
    "amount" : 12.03,
    "card_number" : "22121",
    "store_pay" : false,
    "need_cash" : false
  } ]
}

1.1.13. 确认收货失败

POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{id}/status/receivefail
1.1.13.1. 说明

确认收货失败

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

Path

id
必填

退换货申请单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
必填

操作人姓名，长度不超过50

string

Body

fail
必填

失败详情

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

default

successful operation

无内容
1.1.13.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string/status/receivefail?operator_id=string&operator_name=string
请求 body
{
  "reason" : "string",
  "voucher_urls" : [ "string" ]
}

1.1.14. 退货单取消

POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorder/{rtn_id}/cancel
1.1.14.1. 说明

退货单取消

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

Path

rtn_id
必填

退单号

string

Path

store_id
必填

门店代码

string

Path

tenant_id
必填

租户代码

string

Query

operator_id
必填

操作人

string

Query

operator_name
可选

操作人姓名

string

Body

request
可选

申请内容

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

default

successful operation

无内容
1.1.14.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorder/string/cancel?operator_id=string
请求 body
{
  "reason" : "收货失败",
  "operator_role" : "platform",
  "approve_state" : "serviceApproved"
}

1.1.15. 分页查询退货订单

POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorders/query
1.1.15.1. 说明

分页查询退货订单，只返回退货订单头，不返回详情。可查询条件列表conditions有：id.equals(退货申请单号等于)、status.equals(退货单状态等于)、saleOrderId.equals(原始订单等于)、returnerMobileNo.contains(客户手机号等于)、returnerName.contains(客户名字等于)、receiveTime.from(退货时间起始于)、receiveTime.to(退货时间结束于)、approving(退货单状态等于待审核)、returning(退货单状态等于待退货)、received(退货单状态等于已收货)、canceled(退货单状态等于已取消)、type.equals(退货单类型等于refundAndRtn（退款退货）、refund（仅退款）)、refundStatus.equals（退款状态等于refunding（未退款）、refunded（已退款））

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Body

definition
必填

查询条件

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

200

successful operation

RtnOrderPaging
1.1.15.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorders/query
请求 body
{
  "conditions" : [ {
    "name" : "aaa",
    "param" : "2018-05-04 14:25:25"
  } ],
  "orders" : [ {
    "field" : "created",
    "direction" : "asc"
  } ],
  "page" : 0,
  "page_size" : 10,
  "fetch_parts" : "items,invoiceDetails",
  "quick_search_filters" : "0"
}
1.1.15.5. HTTP响应示例
响应 200
{
  "paging" : {
    "page" : 0,
    "page_size" : 20,
    "page_count" : 20,
    "record_count" : 20,
    "has_more" : false
  },
  "records" : [ {
    "id" : "23232323",
    "type" : "refund",
    "salechannel" : "jdo2o",
    "status" : "received",
    "total" : 21.25,
    "items" : [ {
      "spec" : "1*1",
      "unit" : "kg",
      "quantity" : 56.0,
      "total" : 59.36,
      "order_item_id" : "string",
      "item_id" : "string",
      "item_no" : "1",
      "item_code" : "0001",
      "item_name" : "香蕉",
      "unit_price" : 12.36,
      "barcode" : "32323",
      "order_quantity" : 56.0,
      "details" : [ {
        "id" : "032345",
        "title" : "矿泉水",
        "quantity" : 12.0,
        "ratio" : 0.65,
        "input_codes" : [ {
          "type" : "EAN",
          "code" : "232323",
          "qpc" : 0.0,
          "unit" : "string",
          "weight" : 0.0,
          "qpc_str" : "string"
        } ],
        "trace_code_details" : [ {
          "barcode" : "string",
          "type" : "normal（普通）,expDate（效期）",
          "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"
        } ],
        "use_valid_date" : true
      } ],
      "orig_item" : {
        "quantity" : 12.0,
        "item_code" : "32323",
        "item_name" : "可乐",
        "qpc" : "1*1",
        "order_quantity" : 12.0,
        "unit" : "份"
      },
      "input_codes" : [ {
        "type" : "EAN",
        "code" : "232323",
        "qpc" : 0.0,
        "unit" : "string",
        "weight" : 0.0,
        "qpc_str" : "string"
      } ],
      "trace_code_details" : [ {
        "barcode" : "string",
        "type" : "normal（普通）,expDate（效期）",
        "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"
      } ],
      "use_valid_date" : true
    } ],
    "refunds" : [ {
      "name" : "支付宝",
      "amount" : 12.03,
      "card_number" : "22121",
      "store_pay" : false,
      "need_cash" : false
    } ],
    "tags" : [ {
      "name" : "首单"
    } ],
    "appeal" : false,
    "sale_order_id" : "32443323",
    "salechannel_name" : "京东到家",
    "sale_payment_type" : "货到付款",
    "sale_ship_location" : "dc",
    "delivery_type" : "上门取件",
    "status_caption" : "待审核",
    "refund_status" : "refunding",
    "refund_status_caption" : "已退款",
    "customer_info" : "aaa",
    "apply_time" : "2018-05-04 14:25:25",
    "apply_reason" : "不想要了",
    "customer_note" : "haha",
    "voucher_urls" : [ "string" ],
    "receive_time" : "2018-05-04 14:25:25",
    "hint_info" : "hello",
    "invoice_info" : "aaa",
    "return_amount" : 25.36,
    "waybill_id" : "1212121212",
    "cancel_reason" : "又想要了",
    "sku_quantity" : 0.0,
    "order_info" : {
      "id" : "1001001",
      "status" : "confirming",
      "deliveryman" : "李三",
      "front_order_id" : "1001001",
      "status_caption" : "已取消",
      "create_time" : "2017-11-27 18:38:42",
      "deliveryman_mobile" : "15655895658",
      "carrier_id" : "self",
      "carrier_name" : "顺丰",
      "waybill_id" : "123456",
      "carrier_type" : "express",
      "carrier_state" : "pickupFailed",
      "station_order_no" : "1",
      "delivery_type" : "送货上门"
    },
    "allow_actions" : [ "string" ]
  } ]
}

1.1.16. 查询快速搜索条件

POST /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtnorders/quicksearchfilter
1.1.16.1. 说明

查询快速搜索条件

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

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

200

successful operation

RtnOrderQuickSearchResponse
1.1.16.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtnorders/quicksearchfilter
1.1.16.5. HTTP响应示例
响应 200
{
  "quick_filters" : [ "string" ]
}

1.1.17. 批量查询退单打印接口

GET /{tenant_id}/storedelivery/rtnservice/store/{store_id}/rtns/printdatas
1.1.17.1. 说明

批量查询退单打印接口

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

ids
必填

退单号

< string > array(multi)

Query

names
可选

打印模版名称name：外卖退单，长度不超过40，打印多个用英文逗号隔开如：外卖退单。不传表示打印全部

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

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

200

successful operation

RtnOrderPrintDataList
1.1.17.4. HTTP请求示例
请求 path
/string/storedelivery/rtnservice/store/string/rtns/printdatas?ids=string&operator_id=string
1.1.17.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "parts" : [ "string" ],
    "rtn_id" : "21212",
    "time" : "2019-07-03 13:06:46"
  } ]
}

2. 定义

2.1. ActionResult

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.2. ApproveDetail

审核详情

名称 说明 类型

reason
可选

原因
样例 : "已和客户联系，不退"

string

state
可选

审核状态：approved, refuse
样例 : "refuse"

string

2.3. DeliverPaymentDetail

付款方式详情

名称 说明 类型

amount
必填

金额
样例 : 12.03

number

card_number
可选

卡号
样例 : "22121"

string

name
必填

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

string

need_cash
可选

是否需要缴款
默认值 : false
样例 : false

boolean

store_pay
可选

是否门店收款/付款
默认值 : false
样例 : false

boolean

2.4. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.5. InputCode

输入码

名称 说明 类型

code
可选

条码
样例 : "232323"

string

qpc
可选

规格
样例 : 0.0

number

qpc_str
可选

规格说明
样例 : "string"

string

type
可选

输入码类型
样例 : "EAN"

string

unit
可选

单位
样例 : "string"

string

weight
可选

重量
样例 : 0.0

number

2.6. OrderItemTraceCodeDetail

溯源码

名称 说明 类型

barcode
可选

条码
样例 : "string"

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

退货商品详情

名称 说明 类型

item_code
可选

编码
样例 : "32323"

string

item_name
可选

品名
样例 : "苹果"

string

order_item_no
可选

行号
样例 : "2"

string

quantity
可选

数量
样例 : 32.0

number

2.8. Paging

分页对象

名称 说明 类型

has_more
可选

是否还有更多数据未被发现
默认值 : false
样例 : false

boolean

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 20

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

record_count
可选

查询结果集总记录数
样例 : 20

integer (int64)

2.9. QueryCondition

查询条件

名称 说明 类型

name
必填

查询条件名
样例 : "aaa"

string

param
可选

查询条件参数，日期类型使用格式：yyyy-MM-dd HH:mm:ss
样例 : "2018-05-04 14:25:25"

string

2.10. QueryDefinition

查询定义对象

名称 说明 类型

conditions
必填

条件列表
样例 : [ "QueryCondition" ]

< QueryCondition > array

fetch_parts
可选

级联返回，订单查询目前支持返回items（明细行）、item.details（原料明细）、logs（订单日志）、invoiceDetails（发票详情），退单查询支持返回order(订单信息)、items(退单明细行)、item.details（退单明细行原料）多个级联返回用,分割
样例 : "items,invoiceDetails"

string

orders
必填

排序列表
样例 : [ "QueryOrder" ]

< QueryOrder > array

page
必填

当前页码，必须大于等于0
样例 : 0

integer (int32)

page_size
必填

分页大小，范围是[0,100]
样例 : 10

integer (int32)

quick_search_filters
可选

快速搜索条件,多个搜索用,分割
样例 : "0"

string

2.11. QueryOrder

排序条件对象

名称 说明 类型

direction
可选

排序条件，取值范围:asc(升序)、desc(降序)
样例 : "asc"

enum (asc, desc)

field
可选

排序字段
样例 : "created"

string

2.12. Reason

名称 说明 类型

code
可选

样例 : "string"

string

reason
可选

样例 : "string"

string

2.13. ReasonList

名称 说明 类型

reasons
可选

样例 : [ "Reason" ]

< Reason > array

2.14. ReceiveDetail

退货成功详情

名称 说明 类型

items
必填

收货商品明细,部分收货时需要传明细
样例 : [ "ReceiveDetailItem" ]

< ReceiveDetailItem > array

payments
必填

退款详情
样例 : [ "DeliverPaymentDetail" ]

< DeliverPaymentDetail > array

type
必填

收货商品明细
样例 : "all（整单）、part（部分），默认all"

string

2.15. ReceiveDetailItem

退货成功详情

名称 说明 类型

item_code
必填

编码
样例 : "0001"

string

item_no
可选

序号
样例 : "1"

string

quantity
必填

数量
样例 : 56.0

number

2.16. ReceiveFail

收货失败信息

名称 说明 类型

reason
可选

失败原因
样例 : "string"

string

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

2.17. RtnActionApplyRequest

退货申请

名称 说明 类型

items
可选

退货商品明细
样例 : [ "OrderPartRefundItem" ]

< OrderPartRefundItem > array

reason
可选

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

string

2.18. RtnActionCancelRequest

退货申请

名称 说明 类型

approve_state
可选

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

string

operator_role
可选

操作角色
样例 : "platform"

string

reason
可选

取消原因
样例 : "收货失败"

string

2.19. RtnItemDetailTraceCodeUpdateObj

退单明细原料溯源码更新对象

名称 说明 类型

id
可选

原料id
样例 : "string"

string

trace_code_list
可选

溯源码列表
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

2.20. RtnItemTraceCodeUpdateObj

退单明细溯源码更新对象

名称 说明 类型

details
可选

原料（组合商品才有）
样例 : [ "RtnItemDetailTraceCodeUpdateObj" ]

< RtnItemDetailTraceCodeUpdateObj > array

item_id
可选

行唯一标识
样例 : "string"

string

item_no
可选

行号
样例 : "string"

string

sku_id
可选

货号
样例 : "string"

string

trace_code_list
可选

溯源码列表
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

2.21. RtnOrder

退货订单

名称 说明 类型

allow_actions
可选

允许操作的动作,拒绝申请、同意申请、确认收货、拒绝收货、打印小票
样例 : [ "string" ]

< string > array

appeal
可选

是否申诉
默认值 : false
样例 : false

boolean

apply_reason
可选

申请原因
样例 : "不想要了"

string

apply_time
必填

申请退货时间，格式是：yyyy-MM-dd HH:mm:ss
样例 : "2018-05-04 14:25:25"

string

cancel_reason
可选

取消申请原因
样例 : "又想要了"

string

customer_info
必填

客户信息
样例 : "aaa"

string

customer_note
可选

客户留言
样例 : "haha"

string

delivery_type
必填

退货订单收货方式,取值:上门取件|到店退货
样例 : "上门取件"

string

hint_info
可选

提示信息
样例 : "hello"

string

id
必填

退货订单ID
样例 : "23232323"

string

invoice_info
可选

发票信息
样例 : "aaa"

string

items
必填

退货商品
样例 : [ "RtnOrderItem" ]

< RtnOrderItem > array

order_info
可选

订单信息，需要级联参数order返回
样例 : RtnOrderOrderInfo

RtnOrderOrderInfo

receive_time
可选

退货时间，格式是：yyyy-MM-dd HH:mm:ss
样例 : "2018-05-04 14:25:25"

string

refund_status
必填

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

string

refund_status_caption
必填

退款状态描述
样例 : "已退款"

string

refunds
可选

退款详情
样例 : [ "DeliverPaymentDetail" ]

< DeliverPaymentDetail > array

return_amount
必填

退款金额
样例 : 25.36

number

sale_order_id
必填

对应的订单ID
样例 : "32443323"

string

sale_payment_type
必填

订单支付方式, 取值:货到付款|在线支付
样例 : "货到付款"

string

sale_ship_location
可选

对应订单的发货地，取值范围:dc(库房发货)、store(门店直送)
样例 : "dc"

string

salechannel
可选

订单来源
样例 : "jdo2o"

string

salechannel_name
可选

平台名称
样例 : "京东到家"

string

sku_quantity
可选

样例 : 0.0

number

status
必填

退货状态，取值范围:approving(待审核)、returning(待退货)、received(已退货)、canceled(已取消)
样例 : "received"

string

status_caption
必填

退货状态描述
样例 : "待审核"

string

tags
可选

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

< 订单标签 > array

total
必填

退货金额
样例 : 21.25

number

type
可选

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

string

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

waybill_id
可选

退回物流单号
样例 : "1212121212"

string

2.22. RtnOrderItem

退货商品

名称 说明 类型

barcode
可选

条形码
样例 : "32323"

string

details
可选

商品原料
样例 : [ "RtnOrderItemDetail" ]

< RtnOrderItemDetail > array

input_codes
可选

输入码
样例 : [ "InputCode" ]

< InputCode > array

item_code
必填

编码
样例 : "0001"

string

item_id
可选

行唯一标识
样例 : "string"

string

item_name
必填

品名
样例 : "香蕉"

string

item_no
可选

序号
样例 : "1"

string

order_item_id
可选

订单行唯一标识
样例 : "string"

string

order_quantity
必填

订单数量
样例 : 56.0

number

orig_item
可选

下单商品行明细
样例 : RtnOrderOrigItem

RtnOrderOrigItem

quantity
必填

数量
样例 : 56.0

number

spec
可选

规格
样例 : "1*1"

string

total
必填

金额
样例 : 59.36

number

trace_code_details
可选

溯源码明细
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

unit
可选

计量单位
样例 : "kg"

string

unit_price
必填

单价
样例 : 12.36

number

use_valid_date
可选

是否启用效期
默认值 : false
样例 : true

boolean

2.23. RtnOrderItemDetail

商品原料

名称 说明 类型

id
必填

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

string

input_codes
可选

输入码
样例 : [ "InputCode" ]

< InputCode > array

quantity
必填

原料商品数量
样例 : 12.0

number

ratio
必填

原料商品比率
样例 : 0.65

number

title
必填

名称
样例 : "矿泉水"

string

trace_code_details
可选

溯源码明细
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

use_valid_date
可选

是否启用效期
默认值 : false
样例 : true

boolean

2.24. RtnOrderOrderInfo

退货订单订单信息

名称 说明 类型

carrier_id
可选

承运商代码,取值为self（门店自送）、thirdparty（平台配送）等其他第三方承运商ID
样例 : "self"

string

carrier_name
可选

承运商名称
样例 : "顺丰"

string

carrier_state
可选

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

string

carrier_type
可选

承运商类型,取值为self（门店自送）、thirdparty（平台配送）、express（快递配送）
样例 : "express"

string

create_time
可选

下单时间，格式是：yyyy-MM-dd HH:mm:ss
样例 : "2017-11-27 18:38:42"

string

delivery_type
可选

送货方式，取值:送货上门|到店自提
样例 : "送货上门"

string

deliveryman
可选

配送员
样例 : "李三"

string

deliveryman_mobile
可选

配送员电话
样例 : "15655895658"

string

front_order_id
可选

平台订单号
样例 : "1001001"

string

id
必填

订单号
样例 : "1001001"

string

station_order_no
可选

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

string

status
必填

订单状态,取值范围:confirming(待确认)、shipping(待发货)、storenotsigned(未签收)、storesigned(门店签收)、prepared(已上架)、delivering(已登记)、delivered(已妥投)、refused(客户拒收)、redeliver(未妥投)、canceled(已取消)、stopped(终止配送)
样例 : "confirming"

string

status_caption
必填

订单状态显示名称
样例 : "已取消"

string

waybill_id
可选

运单号
样例 : "123456"

string

2.25. RtnOrderOrigItem

原商品行信息

名称 说明 类型

item_code
必填

货号
样例 : "32323"

string

item_name
可选

品名
样例 : "可乐"

string

order_quantity
必填

订单数量
样例 : 12.0

number

qpc
可选

规格
样例 : "1*1"

string

quantity
必填

数量
样例 : 12.0

number

unit
可选

单位
样例 : "份"

string

2.26. RtnOrderPaging

退货订单分页查询结果

名称 说明 类型

paging
可选

分页对象
样例 : Paging

Paging

records
可选

退货订单记录
样例 : [ "RtnOrder" ]

< RtnOrder > array

2.27. RtnOrderPrintData

退单打印数据

名称 说明 类型

parts
可选

每联的打印数据
样例 : [ "string" ]

< string > array

rtn_id
可选

退单号
样例 : "21212"

string

time
可选

打印数据的生成时间，格式是：yyyy-MM-dd HH:mm:ss
样例 : "2019-07-03 13:06:46"

string

2.28. RtnOrderPrintDataList

退单打印数据列表

名称 说明 类型

rtns
可选

退单打印数据列表
样例 : [ "RtnOrderPrintData" ]

< RtnOrderPrintData > array

2.29. RtnOrderQuickSearchResponse

名称 说明 类型

quick_filters
可选

支持的快速查询条件,条件有:仅退款，退款退货，顾客申诉
样例 : [ "string" ]

< string > array

2.30. SOMSAddress

地址信息

名称 说明 类型

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.31. SOMSCRMInfo

会员权益信息

名称 说明 类型

coupon_info
可选

券信息
样例 : SOMSCouponInfo

SOMSCouponInfo

score_info
可选

积分信息
样例 : SOMSScoreInfo

SOMSScoreInfo

2.32. SOMSCancelRtnRequest

取消退货请求对象

名称 说明 类型

approve_state
可选

样例 : "none"

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

operator_role
可选

样例 : "string"

string

reason
可选

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

string

sellerInfo
可选

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

SOMSSellerInfo

2.33. SOMSCarrier

承运商

名称 说明 类型

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.34. SOMSCodeName

名称 说明 类型

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.35. SOMSCouponDetail

券信息

名称 说明 类型

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.36. SOMSCouponInfo

券信息

名称 说明 类型

details
可选

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

< SOMSCouponDetail > array

use_total
可选

券抵用总金额
样例 : 1.0

number

2.37. SOMSCustomer

客户

名称 说明 类型

contact
可选

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

联系方式(soms)

id
可选

代码
样例 : "10001"

string

2.38. SOMSDiscountSettleDetail

优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

role
可选

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

string

2.39. SOMSDiscountShareDetail

整合优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

type
可选

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

string

2.40. SOMSExtraField

自定义字段

名称 说明 类型

id
可选

自定义id
样例 : "distance_freight"

string

name
可选

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

string

value
可选

自定义值
样例 : "0.01"

string

2.41. SOMSFavDetail

优惠详情

名称 说明 类型

amount
可选

优惠金额
样例 : 10.5

number

batch_act_id
可选

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

string

child_type
可选

优惠子类型
样例 : "string"

string

extra_info
可选

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

string

factor
可选

优惠参与信息
样例 : SOMSFavFactor

SOMSFavFactor

id
可选

优惠ID
样例 : "1111"

string

merchant_act_id
可选

商家活动ID
样例 : "1111"

string

name
可选

活动名称
样例 : "满减"

string

prom_cls
可选

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

string

remark
可选

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

string

settle_details
可选

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

< SOMSDiscountSettleDetail > array

share_details
可选

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

< SOMSDiscountShareDetail > array

sku_act_id
可选

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

string

type
可选

优惠类型
样例 : "string"

string

voucher_code
可选

凭证代码
样例 : "111111111"

string

2.42. SOMSFavFactor

优惠参与信息

名称 说明 类型

qty
可选

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

number

sku_items
可选

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

< SOMSFavFactorItem > array

total
可选

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

number

2.43. SOMSFavFactorItem

参与优惠商品明细

名称 说明 类型

amount
可选

参与促销金额
样例 : 1.0

number

item_id
可选

行标识
样例 : "1"

string

item_no
必填

行号
样例 : 1

integer (int32)

qty
可选

参与促销数量
样例 : 1.0

number

2.44. SOMSFrontRtn

平台退货信息

名称 说明 类型

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

rtn_id
可选

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

string

source
可选

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

string

state
可选

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

string

stationName
可选

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

string

station_id
可选

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

string

2.45. SOMSItemPromotion

商品行促销信息

名称 说明 类型

apported_discount_amount
可选

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

number

discount_amount
可选

商品优惠金额
样例 : 0.1

number

favs
可选

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

< SOMSFavDetail > array

2.46. SOMSOrderItemTraceCodeDetail

溯源码

名称 说明 类型

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.47. SOMSOrderPackageInfo

订单打包信息

名称 说明 类型

details
可选

包装明细
样例 : "[]"

< SOMSPackageDetail > array

package_type
可选

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

string

required
可选

是否需要打包袋
默认值 : false
样例 : false

boolean

type
可选

单据类型
样例 : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)"

string

2.48. SOMSOrderTag

订单

名称 说明 类型

name
可选

标签名称
样例 : "首单"

string

2.49. SOMSPackageDetail

打包商品明细

名称 说明 类型

amount
可选

打包袋金额
样例 : 1.0

number

qty
可选

打包袋数量
样例 : 1.0

number

sku_id
可选

打包袋ID
样例 : "213323232"

string

sku_name
可选

打包袋名称
样例 : "213323232"

string

2.50. SOMSPrintBill

打印单据

名称 说明 类型

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.51. SOMSReceiver

收货人

名称 说明 类型

address
必填

地址
样例 : SOMSAddress

SOMSAddress

contact
必填

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

联系方式(soms)

2.52. SOMSRefund

退款信息

名称 说明 类型

amount
必填

实际退货金额（包含运费）
样例 : 12.03

number

classification
可选

退款类别，取值范围:normal(正常)、balance(补差)，为空表示正常
样例 : "normal"

enum (normal, balance)

extra
可选

退款其他费用，退货取件费：rtn_pickup_freight
样例 : [ "SOMSExtraField" ]

< SOMSExtraField > array

freight
必填

退运费
样例 : 12.03

number

package_total
可选

包装费用
样例 : 12.03

number

part_refund
可选

是否部分退
默认值 : false
样例 : false

boolean

payments
可选

退款支付明細
样例 : [ "SOMSRefundPayment" ]

< SOMSRefundPayment > 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.53. SOMSRefundPayment

退款支付明细

名称 说明 类型

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.54. SOMSReturnDelivery

退货信息

名称 说明 类型

carrier
可选

承运商
样例 : SOMSCarrier

SOMSCarrier

carrier_note
可选

承运商备注
样例 : "note"

string

return_mobile
可选

退货联系人
样例 : "18856556655"

string

returner
可选

退货人
样例 : SOMSReceiver

SOMSReceiver

state
可选

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

enum (none, customerShipped, received)

station
可选

退回门店
样例 : IdName

IdName

station_type
可选

退回站点类型，取值范围:store(门店)、wrh(仓库)、vendor(供应商)
样例 : "string"

string

vendor
可选

退回供应商
样例 : SOMSCodeName

SOMSCodeName

waybill_id
可选

承运单号
样例 : "XXXXXXXXX"

string

wrh
可选

退回仓库
样例 : SOMSCodeName

SOMSCodeName

wrh_rtn_id
可选

仓库退货单号
样例 : "XXXXXXXXX"

string

2.55. SOMSRtn

退换货单

名称 说明 类型

address_change_fee
可选

地址变更费
样例 : 120.01

number

appeal
可选

是否申诉
默认值 : false
样例 : false

boolean

apply_id
可选

申请ID
样例 : "0002"

string

apply_reason
可选

申请原因
样例 : "不想要了"

string

apply_system
可选

申请方
样例 : "shop"

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

营销信息
样例 : SOMSCRMInfo

SOMSCRMInfo

customer
可选

客户
样例 : SOMSCustomer

SOMSCustomer

customer_note
可选

客户留言
样例 : "haha"

string

delivery
必填

退货信息
样例 : SOMSReturnDelivery

SOMSReturnDelivery

exception_codes
可选

异常代码，sku（商品异常）
样例 : "sku"

string

exception_remark
可选

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

string

exception_time
可选

异常时间
样例 : "2020-11-11 12:11:21"

string (date-time)

front
必填

平台退货信息
样例 : SOMSFrontRtn

SOMSFrontRtn

has_exception
可选

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

boolean

id
可选

退货订单号，不能重复，为空自动生成
样例 : "0002"

string

items
可选

商品行
样例 : [ "SOMSRtnItem" ]

< SOMSRtnItem > array

member_info
可选

会员积分信息
样例 : SOMSRtnMemberInfo

SOMSRtnMemberInfo

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

order_id
必填

原订单号
样例 : "3232320003"

string

package_info
可选

打包信息
样例 : SOMSOrderPackageInfo

SOMSOrderPackageInfo

print_bills
可选

退单打印数据
样例 : [ "SOMSPrintBill" ]

< SOMSPrintBill > array

promotion
可选

退单促销
样例 : SOMSRtnPromotion

SOMSRtnPromotion

refund
必填

退款信息
样例 : SOMSRefund

SOMSRefund

req_id
可选

申请单ID
样例 : "string"

string

rtn_req_id
可选

销售退单号，不存储，记录在关联信息
样例 : "string"

string

seller_info
可选

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

SOMSSellerInfo

settle_info
可选

对账信息
样例 : SOMSRtnSettleInfo

SOMSRtnSettleInfo

settle_unit
可选

结算单位
样例 : SOMSSettleUnit

SOMSSettleUnit

shop
必填

平台商家
样例 : IdName

IdName

sku_quantity
必填

商品总数
样例 : 1.0

number

state
可选

退货单状态,新建可不填，取值范围：confirmed(已生成)、approved(已审核)、finished(已完成)、canceled(已取消),为空时取默认值confirmed
样例 : "confirmed"

enum (confirmed, approved, finished, canceled)

tags
可选

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

< SOMSOrderTag > array

type
可选

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

enum (refund, refundAndRtn)

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

wrh_id
可选

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

string

wrh_state
可选

仓库状态,取值参考RtnWrhState
样例 : "initial"

string

2.56. SOMSRtnApproveRequest

退单审核请求对象

名称 说明 类型

approve_state
必填

审核状态:none（未审核）,serviceApproved（客服已审核）,serviceRefuse（客服已拒绝）,financeApproved（财务已审核）,financeRefuse（财务已拒绝）
样例 : "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.57. SOMSRtnFilter

退单过滤器

名称 说明 类型

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.58. SOMSRtnItem

退货商品行

名称 说明 类型

barcode
可选

商品条码
样例 : "123456"

string

details
可选

退款商品行明细
样例 : [ "SOMSRtnItemDetail" ]

< SOMSRtnItemDetail > 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

input_codes
可选

输入码
样例 : [ "InputCode" ]

< InputCode > array

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

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

SOMSRtnOrigItem

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

商品退促销
样例 : SOMSItemPromotion

SOMSItemPromotion

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

sale_valid_period_over_hours
可选

销售保质期超期提醒小时
样例 : 0

integer (int32)

settle_price
可选

结算价格
样例 : 12.03

number

settle_total
可选

结算金额
样例 : 12.03

number

shelf_life
可选

保质期天数
样例 : "string"

string

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

溯源码明细
样例 : [ "SOMSOrderItemTraceCodeDetail" ]

< SOMSOrderItemTraceCodeDetail > array

unit
可选

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

string

unit_price
必填

价格
样例 : 12.03

number

use_valid_date
可选

是否启用效期
默认值 : false
样例 : true

boolean

uuid
可选

样例 : "string"

string

valid_period_over_days
可选

保质期超期提醒天数
样例 : 0

integer (int32)

2.59. SOMSRtnItemDetail

退款商品行明细

名称 说明 类型

id
必填

商品货号
样例 : "01123"

string

input_codes
可选

输入码
样例 : [ "InputCode" ]

< InputCode > array

quantity
必填

商品数量
样例 : 0.01

number

ratio
必填

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

number

real_quantity
可选

样例 : 0.0

number

sale_valid_period_over_hours
可选

销售保质期超期提醒小时
样例 : 0

integer (int32)

shelf_life
可选

保质期天数
样例 : "string"

string

title
必填

名称
样例 : "01123"

string

trace_code_details
可选

溯源码明细
样例 : [ "SOMSOrderItemTraceCodeDetail" ]

< SOMSOrderItemTraceCodeDetail > array

use_valid_date
可选

是否启用效期
默认值 : false
样例 : true

boolean

valid_period_over_days
可选

保质期超期提醒天数
样例 : 0

integer (int32)

2.60. SOMSRtnMemberInfo

积分信息

名称 说明 类型

card_no
可选

实体卡卡号
样例 : "22323"

string

2.61. SOMSRtnOrigItem

原商品行信息

名称 说明 类型

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.62. SOMSRtnPaging

退单分页对象

名称 说明 类型

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

总页数
样例 : 0

integer (int32)

page_size
可选

页大小
样例 : 0

integer (int32)

rtns
可选

退单列表
样例 : [ "SOMSRtn" ]

< SOMSRtn > array

total
可选

总条数
样例 : 0

integer (int64)

2.63. SOMSRtnPromotion

退单优惠

名称 说明 类型

favs
可选

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

< SOMSFavDetail > array

2.64. SOMSRtnSettleInfo

对账信息

名称 说明 类型

settlable
可选

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

boolean

settle_date
可选

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

string (date-time)

station_settle_mode
可选

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

string

2.65. SOMSScoreInfo

积分信息

名称 说明 类型

total
可选

获得积分
样例 : 1.0

number

2.66. SOMSSellerInfo

收货失败：原因/凭证

名称 说明 类型

seller_note
可选

收货失败原因
样例 : "收货失败原因"

string

seller_voucher_urls
可选

卖家收货失败凭证：图片地址
样例 : "卖家收货失败凭证：图片地址"

< string > array

2.67. SOMSSettleUnit

结算单位

名称 说明 类型

code
可选

单位代码，取值门店代码
样例 : "0001"

string

name
可选

单位门店，取值门店名称
样例 : "门店1"

string

type
可选

类型：store
样例 : "store"

string

2.68. 修改退单溯源码的请求

名称 说明 类型

cover
可选

是否全量覆盖，默认为false，传true会删掉旧溯源码
默认值 : false
样例 : true

boolean

items
可选

退单明细溯源码更新对象列表
样例 : [ "RtnItemTraceCodeUpdateObj" ]

< RtnItemTraceCodeUpdateObj > array

2.69. 打印数据

名称 说明 类型

content
可选

内容
样例 : "string"

string

created
可选

创建时间
样例 : "2025-02-14"

string (date-time)

name
可选

名称
样例 : "外卖订单"

string

printer
可选

打印方
样例 : "JPOS"

string

2.70. 联系方式(soms)

联系方式

名称 说明 类型

email
可选

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

string

fax
可选

传真
样例 : "123123"

string

mobile
可选

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

string

name
可选

姓名
样例 : "李飞"

string

private_mobile
可选

隐私号
样例 : "189389928893"

string

private_name
可选

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

string

telephone
可选

电话
样例 : "189389928893"

string

2.71. 订单标签

名称 说明 类型

name
可选

名称
样例 : "首单"

string

2.72. 退单呼叫云打印参数

名称 说明 类型

printer
必填

打印方
样例 : "string"

string

rtn_id
必填

退单号
样例 : "string"

string

tpl_names
可选

模板名称
样例 : [ "string" ]

< string > array

2.73. 退单呼叫云打印结果

名称 说明 类型

message
可选

信息
样例 : "string"

string

success
可选

是否成功
默认值 : false
样例 : true

boolean

2.74. 退单审核请求对象-明细信息

名称 说明 类型

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.75. 退单审核请求对象-明细原料信息

名称 说明 类型

real_quantity
可选

实际退回数量
样例 : 0.0

number

sku_id
可选

原料货号
样例 : "string"

string

2.76. 退单打印参数

名称 说明 类型

printers
可选

打印方
样例 : [ "string" ]

< string > array

rtn_ids
可选

退单号
样例 : [ "string" ]

< string > array

tmpl_names
可选

模板名称集合，不传视为打应所有模板
样例 : [ "string" ]

< string > array

2.77. 退单打印数据v2

名称 说明 类型

print_bills
可选

打印数据
样例 : [ "打印数据" ]

< 打印数据 > array

rtn_id
可选

退单号
样例 : "1233211234567"

string

2.78. 退单打印数据v2列表

名称 说明 类型

退单打印数据
可选

样例 : [ "退单打印数据v2" ]

< 退单打印数据v2 > array

2.79. 退单明细标签

名称 说明 类型

name
可选

名称
样例 : "盲盒"

string