API开放平台

TIP

新增退货订单接口
审批直营退货订单接口
退货订单新增收货单接口
退换货订单自定义字段修改接口
查询直营或分销退货订单
退换货订单查询接口
关闭退货订单接口
查询退货收货单接口

# 新增退货订单接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/dmschangeback/v1/returnOrder/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
    "operate_type": "",
    "order_no": "",
    "type": "",
    "erp_type": "",
    "erp_No": "",
    "rel_order_id": "",
    "cm_id": "",
    "cm_code": "",
    "cm_source_code": "",
    "supply_id": "",
    "supply_code": "",
    "supply_source_code": "",
    "date": "",
    "emp_id": "",
    "emp_code": "",
    "consignment_date": "",
    "receive_name": "",
    "receive_phone": "",
    "receive_tel": "",
    "receive_addr": "",
    "remark": "",
    "reason": "",
    "prods": [
		{
			"id": "",
			"code": "",
			"price": "",
			"num": "",
			"unit": "",
			"unit_name": "",
			"is_gift": "",
			"posnr": "",
			"remark": "",
            "dms_order_detail_id": "",
            "dms_order_detail_posnr": ""
		}
	],
    "exts": [
        {
            "ext_key": "自定义字段1",
            "ext_value": "四星"
        },
        {
            "ext_key": "自定义字段2",
            "ext_value": "SO123123123"
        }
    ]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
operate_type	VARCHAR(32)	否	1：新增退货订单，2：编辑退货订单。默认2
order_no	VARCHAR(100)	否	退换货单号。新增的时候传递作为新的退换货单号（不传系统自动生成），编辑的时候传递作为参数进行编辑退换货订单
type	CHAR(1)	否	订单类型。1：退货订单，2：换入订单，默认1（换入订单不支持编辑）
erp_No	VARCHAR(32)	否	ERP退货订单号
rel_order_id	VARCHAR(32)	否	关联订单ID，关联订单退货时rel_order_id和rel_order_no不能同时为空，如果同时存在，优先级依次降低
rel_order_no	VARCHAR(32)	否	关联订单号，关联订单退货时rel_order_id和rel_order_no不能同时为空，如果同时存在，优先级依次降低
cm_id	VARCHAR(32)	否	客户id，新增并且关联订单为空时cm_id、cm_code、 cm_source_code不能同时为空，如果同时存在，优先级依次降低
cm_code	VARCHAR(100)	否	客户编码，新增并且关联订单为空时cm_id、cm_code、 cm_source_code不能同时为空，如果同时存在，优先级依次降低
cm_source_code	VARCHAR(100)	否	客户第三方系统的唯一标识，新增并且关联订单为空时cm_id、cm_code、 cm_source_code不能同时为空，如果同时存在，优先级依次降低
supply_id	VARCHAR(32)	否	供货商id，新增时，如果关联订单为空并且是分销客户则supply_id、supply_code、 supply_source_code不能同时为空，如果同时存在，优先级依次降低
supply_code	VARCHAR(100)	否	供货商编码，新增时，如果关联订单为空并且是分销客户则supply_id、supply_code、 supply_source_code不能同时为空，如果同时存在，优先级依次降低
supply_source_code	VARCHAR(100)	否	供货商第三方系统的唯一标识，新增时，如果关联订单为空并且是分销客户则supply_id、supply_code、 supply_source_code不能同时为空，如果同时存在，优先级依次降低
date	VARCHAR(32)	否	业务日期。格式：yyyy-MM-dd HH:mm，默认当前时间
emp_id	VARCHAR(32)	否	业务员Id，业务员id和业务员编码都不传，默认取其中一个客户经理的
emp_code	VARCHAR(100)	否	业务员编码，业务员id和业务员编码都不传，默认取其中一个客户经理的
consignment_date	VARCHAR(32)	否	要求交货日期。格式：yyyy-mm-dd，默认取明天
receive_name	VARCHAR(100)	否	收货人名称
receive_phone	VARCHAR(32)	否	收货人手机
receive_tel	VARCHAR(32)	否	收货人电话
receive_addr	VARCHAR(1000)	否	收货地址
remark	text	否	备注
reason	VARCHAR(32)	否	退货原因
prods	List		列表
prods.id	VARCHAR(32)	否	商品id和商品编码必须传一个
prods.code	VARCHAR(100)	否	商品id和商品编码必须传一个
prods.price	numeric(18,8)	否	退货价不传就取客户价格，赠品价格为0。关联订单退货时不传（取订单对应明细行的价格）
prods.num	numeric(18,8)	是	退货数量
prods.unit	VARCHAR(32)	否	退货单位id和退货单位名称传一个即可，不传使用基本单位
prods.unit_name	VARCHAR(32)	否	退货单位id和退货单位名称传一个即可，不传使用基本单位
prods.is_gift	VARCHAR(10)	否	是否是赠品。1：是，0：否。不传默认是非赠品，关联订单退货时不传（取关联订单对应明细行的赠品标识）
prods.posnr	numeric(15)	否	退货明细的行号
prods.remark	text	否	退货明细的备注
prods.dms_order_detail_id	VARCHAR(32)	否	关联订单明细id，只在关联订单退货的时候需要传递，dms_order_detail_id、dms_order_detail_posnr不能同时为空，如果同时存在，优先级依次降低
prods.dms_order_detail_posnr	numeric(15)	否	关联订单明细行号，只在关联订单退货的时候需要传递，dms_order_detail_id、dms_order_detail_posnr不能同时为空，如果同时存在，优先级依次降低
exts	List	否	退货订单主信息扩展字段列表
exts.ext_key	VARCHAR(4000)	否	退货订单主信息扩展字段key值扩展字段需先在我方系统中创建
exts.ext_value	VARCHAR(4000)	否	扩展字段value值对多个选项值，以“,”分隔拼接

接口说明：退货价price不传默认取客户价格，是否是赠品is_gift不传默认为非赠品。如果该商品是赠品，price传0，is_gift传1。未免出错，这二个字段建议必填

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	必填	说明
msg_id	VARCHAR(32)	是	消息ID
return_code	VARCHAR(32)	是	响应编码。0：成功，1：失败
return_msg	VARCHAR(100)	是	响应说明

# 审批直营退货订单接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/dmschangeback/v1/auditOrder/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	否	退货单id[退货单id与退货单号必传其一]
order_no	VARCHAR(100)	否	退货单号[退货单id与退货单号必传其一]
confirm_emp_code	VARCHAR(32)	是	审批人账号
operate_type	VARCHAR(32)	是	1：通过，2：作废

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	必填	说明
msg_id	VARCHAR(32)	是	消息ID
return_code	VARCHAR(32)	是	响应编码。0：成功，1：失败
return_msg	VARCHAR(100)	是	响应说明

# 退货订单新增收货单接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/dmschangeback/v1/newShouHuo/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "no":"",
  "order_no":"",
  "order_id":"",
  "date":"",
  "erp_stock_no":"",
  "prods":[
      {
          "order_detail_id":"",
          "order_detail_posnr":"",
          "product_id":"",
          "product_code":"",
          "num":"",
          "unit":"",
          "unit_name":""
      }
  ]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
no	VARCHAR(100)	否	收货单号，不传自动生成
order_no	VARCHAR(100)	是	退货订单号，退货订单号和退货订单ID必须传一个
order_id	VARCHAR(32)	是	退货订单id，退货订单号和退货订单ID必须传一个
date	VARCHAR(32)	否	ERP入库日期。格式：yyyy-MM-dd HH:mm:ss
erp_stock_no	VARCHAR(100)	是	ERP入库单号
shouhuo_storehouse_id	VARCHAR(32)	否	收货仓库id
shouhuo_storehouse_code	VARCHAR(32)	否	收货仓库编码
shouhuo_storehouse_name	VARCHAR(32)	否	收货仓库名称
prods	List		列表
prods.order_detail_id	VARCHAR(32)	是	对应退货订单明细行ID,明细ID和行号必须传一个
prods.order_detail_posnr	VARCHAR(32)	是	对应退货订单行号,明细ID和行号必须传一个
prods.product_id	VARCHAR(32)	是	商品id和商品编码必须传一个
prods.product_code	VARCHAR(100)	是	商品id和商品编码必须传一个
prods.num	NUMERIC(18,8)	是	入库数量
prods.unit	VARCHAR(32)	否	入库单位和入库单位名称传一个即可，不传使用基本单位
prods.unit_name	VARCHAR(32)	否	入库单位和入库单位名称传一个即可，不传使用基本单位

响应示例：

{
  "msg_id": "X000001",
  "return_code": 0,
  "return_msg": ""
}

参数说明：

参数	类型	必填	说明
msg_id	VARCHAR(32)	是	消息ID
return_code	VARCHAR(32)	是	响应编码。0：成功，1：失败
return_msg	VARCHAR(100)	是	响应说明

# 退换货订单自定义字段修改接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/dmschangeback/v1/modifyUserDefinedVal/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
order_no	VARCHAR(100)	是	退换货订单号
exts	List		列表
exts.ext_key	VARCHAR(32)	是	退换货订单主数据自定义字段名称
exts.ext_value	VARCHAR(32)	是	退换货订单主数据自定义字段数值

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	必填	说明
msg_id	VARCHAR(32)	是	消息ID
return_code	VARCHAR(32)	是	响应编码。0：成功，1：失败
return_msg	VARCHAR(100)	否	响应说明

# 查询直营或分销退货订单

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/dmsdatasearch/v1/getDmsBackOrderInfos/{openid}/{timestamp}/{digest}/{msg_id} 在线调试
请求示例：

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
page_number	INT	否	页码默认1，每页默认1000条
page_length	INT	否	每页记录条数，默认最大是1000条，可以根据业务数据的大小自行优化调整
s_status	CHAR(1)	否	记录状态。0：已删除，1：正常
order_no	VARCHAR(32)	否	退货单编码，有效字符详见附录：有效字符说明 (opens new window)
order_type	VARCHAR(32)	否	订单类型。FXGLTH：分销关联退货，FXSPTH：分销商品退货，FXHRHH：分销换入换货，ZYHRHH：直营换入换货，ZYGLTH：直营关联退货，ZYSPTH：直营商品退货
after_create_date	TIMESTAMP	否	创建时间之后。格式：yyyy-MM-dd HH:mm:ss
after_modify_date	TIMESTAMP	否	修改时间之后。格式：yyyy-MM-dd HH:mm:ss
start_create_date	TIMESTAMP	否	创建时间开始。格式：yyyy-MM-dd
end_create_date	TIMESTAMP	否	创建时间结束。格式：yyyy-MM-dd
start_modify_date	TIMESTAMP	否	修改时间开始。格式：yyyy-MM-dd
end_modify_date	TIMESTAMP	否	修改时间结束。格式：yyyy-MM-dd

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
        "confirm_emp_code": "",
        "supply_id": 6975322184779002302,
        "remark": "",
        "confirm_emp_name": "",
        "prods": [{
            "ruzhang_input_unit": -1,
            "product_id": 6692513571119135747,
            "remark": "",
            "ruzhang_input_unit_name": "",
            "product_name": "海之蓝1L",
            "shenqing_amount": "1200.00",
            "confirm_input_unit_name": "",
            "posnr": 1,
            "promotion_id": -1,
            "shenqing_count": "1.0",
            "outstock_input_unit_name": "",
            "shouhuo_base_unit_count": "0.0",
            "promotion_name": "",
            "outstock_input_unit": -1,
            "confirm_base_unit_count": "0.0",
            "shenqing_input_unit_name": "盒",
            "shouhuo_amount": "0.00",
            "shouhuo_input_unit_name": "",
            "is_gift": "N",
            "detail_id": "5019132889885603614",
            "confirm_amount": "0.00",
            "shenqing_price": "1200.00",
            "product_type": "",
            "outstock_count": "0.0",
            "superposition_promotion_id": -1,
            "ruzhang_count": "0.0",
            "base_unit": 1,
            "shouhuo_count": "0.0",
            "superposition_promotion_name": "",
            "base_unit_name": "盒",
            "outstock_base_unit_count": "0.0",
            "confirm_count": "0.0",
            "confirm_input_unit": -1,
            "ruzhang_base_unit_count": "0.0",
            "shenqing_input_unit": 1,
            "product_code": "1010000097",
            "shenqing_base_unit_count": "1.0",
            "shouhuo_input_unit": -1,
            "sent_detail_id": "",
            "return_order_detail_type": ""
        }],
        "exts": [{
            "ext_key": "级别",
            "ext_value": "四星"
        }],
        "under_out_time": "",
        "receive_phone": "15005192711",
        "order_no": "TH20181106000002",
        "cm_tenant_id": -1,
        "cm_source_code": "",
        "change_back_reason_id": 1,
        "modify_source_code": "",
        "order_source": "GJBF",
        "modify_time": "",
        "cm_name": "南京雨花二级门店",
        "status": "1",
        "modifyier_id": "",
        "creator_id": 7087551921713004433,
        "order_status": "DD_DQR",
        "confirm_emp_id": "",
        "under_ruzhang_time": "",
        "sent_no": "",
        "emp_name": "老板",
        "order_business_status": "DD_DQR",
        "create_time": "2018-11-06 10:29",
        "creator_name": "老板",
        "change_back_reason_name": "王伟",
        "cm_linkman_name": "",
        "creator_code": "cclb",
        "confirm_time": "",
        "upper_shouhuo_emp_id": "",
        "modify_code": "",
        "confirm_emp_source_code": "",
        "consignment_date": "2018-11-07 00:00",
        "supply_tenant_id": -1,
        "cm_id": 7532586660376575775,
        "supply_name": "A青岛慧鑫酒水批发部",
        "receive_name": "苏善著",
        "creator_source_code": "cclb",
        "date": "2018-11-06",
        "cm_linkman_id": "",
        "cm_code": "CUS000006",
        "id": "6397039557757017362",
        "sent_id": -1,
        "product_count": 1,
        "under_ruzhang_emp_name": "",
        "receive_tel": "",
        "receive_addr": "江苏南京市浦口区kangyuan",
        "emp_code": "cclb",
        "change_order_id": 9210493545854071060,
        "supply_code": "0008113689",
        "emp_id": 7087551921713004433,
        "confirm_reason": "",
        "upper_shouhuo_emp_name": "",
        "emp_source_code": "cclb",
        "under_out_emp_name": "",
        "modify_name": "",
        "under_ruzhang_emp_id": "",
        "upper_shouhuo_time": "",
        "under_out_emp_id": "",
        "order_type": "FXHRHH",
        "return_order_type": ""
    }
]

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	单据ID
status	VARCHAR(1)	否	0：已删除，1：正常
creator_id	VARCHAR(32)	否	创建人id
creator_code	VARCHAR(100)	否	创建人编码
creator_name	VARCHAR(100)	否	创建人名称
creator_source_code	VARCHAR(32)	否	创建人对应外部数据id
create_time	TIMESTAMP	否	创建日期。格式：yyyy-mm-dd hh24:mi
modifyier_id	VARCHAR(32)	否	修改人id
modify_code	VARCHAR(100)	否	修改人编码
modify_name	VARCHAR(100)	否	修改人名称
modify_source_code	VARCHAR(32)	否	修改人对应外部数据id
modify_time	TIMESTAMP	否	修改日期。格式：yyyy-mm-dd hh24:mi
order_no	VARCHAR(100)	否	退货单编号
date	TIMESTAMP	否	单据业务日期。格式：yyyy-mm-dd
emp_id	VARCHAR(32)	否	业务员id
emp_code	VARCHAR(100)	否	业务员编码
emp_name	VARCHAR(100)	否	业务员名称
emp_source_code	VARCHAR(32)	否	业务员对应外部数据id
emp_dept_id	VARCHAR(32)	否	业务员部门id
emp_dept_name	VARCHAR(100)	否	业务员部门
cm_id	VARCHAR(32)	否	客户id
cm_code	VARCHAR(32)	否	客户编码
cm_name	VARCHAR(100)	否	客户名称
cm_source_code	VARCHAR(32)	否	客户对应外部数据id
cm_linkman_id	VARCHAR(32)	否	门店联系人ID
cm_linkman_name	VARCHAR(100)	否	门店联系人ID名称
sent_id	VARCHAR(32)	否	关联发货单id
sent_no	VARCHAR(100)	否	关联发货单编码
order_status	VARCHAR(32)	否	订单状态。DD_DSH：待收货，DD_YWC：已完成，DD_DQR：待确认，DD_YQX：已取消，DD_YQR：已确认
change_back_reason_id	VARCHAR(32)	否	退换货原因id
change_back_reason_name	VARCHAR(100)	否	退换货原因名称
supply_id	VARCHAR(32)	否	供货商id。默认值是-1,-1就是厂家
supply_code	VARCHAR(200)	否	供货商编码
supply_name	VARCHAR(200)	否	供货商名称
order_type	VARCHAR(32)	否	订单类型，FXGLTH:分销关联退货，FXSPTH:分销商品退货，FXHRHH:分销换入换货，ZYHRHH：直营换入换货，ZYGLTH：直营关联退货，ZYSPTH：直营商品退货
order_source	varchar(100)	否	NBZHSJ：内部账号手机(业代手机)，NBZHWB：内部账号web（业代web），WBZHSJ：外部账号手机（客户手机），WBZHWB：外部账号web（客户web），MDWXXD：客户微信下单，JK：接口，DINGHUO365:(客户手机端)，GJBF：高级拜访(业代高级拜访)
receive_name	VARCHAR(100)	否	收货人名称
receive_phone	VARCHAR(100)	否	收货人手机号码
receive_tel	VARCHAR(100)	否	收货人电话
receive_addr	VARCHAR(1000)	否	收货地址
remark	VARCHAR(4000)	否	备注
confirm_emp_id	VARCHAR(32)	否	确认人id
confirm_emp_code	VARCHAR(100)	否	确认人编码
confirm_emp_name	VARCHAR(100)	否	确认人名称
confirm_emp_source_code	VARCHAR(32)	否	确认人对应外部数据id
confirm_time	TIMESTAMP	否	确认时间。格式：yyyy-mm-dd hh24:mi
confirm_reason	VARCHAR(4000)	否	审批意见
order_business_status	VRACHAR(100)	否	订单业务状态
under_out_time	TIMESTAMP	否	下游出库时间。格式：yyyy-mm-dd hh24:mi
under_out_emp_id	VRACHAR(32)	否	下游出库操作人id
under_out_emp_name	VARCHAR(100)	否	下游出库操作人名称
under_out_time	TIMESTAMP	否	上游收货时间。格式：yyyy-mm-dd hh24:mi
upper_shouhuo_emp_id	VARCHAR(32)	否	上游收货操作人id
upper_shouhuo_emp_name	VARCHAR(100)	否	上游收货操作人名称
under_out_time	TIMESTAMP	否	下游入账时间。格式：yyyy-mm-dd hh24:mi
under_ruzhang_emp_id	VARCHAR(32)	否	下游入账操作人id
under_ruzhang_emp_name	VARCHAR(100)	否	下游入账操作人名称
supply_tenant_id	VARCHAR(32)	否	supply_tenant_id
cm_tenant_id	VARCHAR(32)	否	客户互联企业id
consignment_date	TIMESTAMP	否	交货日期。格式：yyyy-mm-dd hh24:mi
product_count	NUMERIC(15)	否	品种数
change_order_id	VARCHAR(32)	否	换货单id
return_order_type	VARCHAR(32)	否	退货行类型。1：标准，2：签收
prods	List		列表
prods.detail_id	VARCHAR(32)	是	退货子表id
prods.product_id	VARCHAR(32)	否	商品id
prods.product_name	VARCHAR(100)	否	商品名称
prods.product_code	VARCHAR(100)	否	商品编码
prods.sent_detail_id	VARCHAR(32)	否	关联发货单详情id
prods.shenqing_price	NUMERIC(28,8)	否	申请价格
prods.shenqing_count	numeric(28,8)	否	申请数量
prods.shenqing_input_unit	VARCHAR(32)	否	申请单位id
prods.shenqing_input_unit_name	VARCHAR(100)	否	申请单位名称
prods.base_unit	VARCHAR(32)	否	商品的基本单位id
prods.base_unit_name	VARCHAR(100)	否	商品的基本单位名称
prods.shenqing_base_unit_count	NUMERIC(28,8)	否	申请数量转化成基本单位的数量
prods.shenqing_amount	NUMERIC(20,2)	否	申请金额
prods.confirm_count	NUMERIC(28,8)	否	确认数量
prods.confirm_input_unit	VARCHAR(32)	否	确认单位id
prods.confirm_input_unit_name	VARCHAR(100)	否	确认单位名称
prods.confirm_amount	NUMERIC(20,2)	否	确认金额
prods.confirm_base_unit_count	NUMERIC(28,8)	否	确认基本单位数量
prods.outstock_count	NUMERIC(28,8)	否	出库数量
prods.outstock_input_unit	VARCHAR(32)	否	出库单位id
prods.outstock_input_unit_name	VARCHAR(100)	否	出库单位名称
prods.outstock_base_unit_count	NUMERIC(28,8)	否	出库基本单位数量
prods.shouhuo_count	NUMERIC(28,8)	否	收货数量
prods.shouhuo_input_unit	VARCHAR(32)	否	收货单位id
prods.shouhuo_input_unit_name	VARCHAR(100)	否	收货单位名称
prods.shouhuo_base_unit_count	NUMERIC(28,8)	否	收货基本单位数量
prods.shouhuo_amount	NUMERIC(20,2)	否	收货金额
prods.ruzhang_count	NUMERIC(28,8)	否	入账数量
prods.ruzhang_input_unit	VARCHAR(32)	否	入账单位id
prods.ruzhang_input_unit_name	VARCHAR(100)	否	入账单位名称
prods.ruzhang_base_unit_count	NUMERIC(28,8)	否	入账基本单位数量
prods.remark	VARCHAR(4000)	否	备注
prods.posnr	NUMERIC(20)	否	10,20,查询排序时候也可使用
prods.product_type	VARCHAR(32)	否	销售类型。赠(Z)、兑(D)、返(F)
prods.is_gift	VARCHAR(2)	否	是否是赠品。Y：是，N：否
prods.promotion_id	VARCHAR(32)	否	促销组ID。促销组中的商品才会有促销组id，默认-1，表明这不是促销组中的商品信息
prods.promotion_name	VARCHAR(100)	否	促销组名称
prods.superposition_promotion_id	VARCHAR(32)	否	叠加促销ID
prods.superposition_promotion_name	VARCHAR(100)	否	叠加促销名称
prods.return_order_detail_type	VARCHAR(32)	否	退货行类型。0：标准，1：破损，2：丢失
exts.ext_key	varchar(4000)	否	退货单主信息扩展字段key值扩展字段需先在我方系统中创建
exts.ext_value	varchar(4000)	否	扩展字段value值对多个选项值，以“,”分隔拼接

# 退换货订单查询接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/dmschangeback/v1/queryOrder/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "rows": 1000,
  "page": 1,
  "supply_id": -1,
  "order_type": "1",
  "id": 5853717908000492197,
  "order_no": "TH20201012000003",
  "cm_code": "CUS010051",
  "after_create_date": "2021-11-23 10:57:24.487",
  "after_modify_date": "2021-11-23 10:57:24.487",
  "start_create_date": "2017-12-09",
  "end_create_date": "2017-12-09",
  "start_modify_date": "2017-12-09",
  "end_modify_date": "2017-12-09",
  "order_status": "DD_DSH",
  "status": "1"
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
after_create_date	TIMESTAMP	否	创建时间之后。格式：yyyy-MM-dd HH:mm:ss
after_modify_date	TIMESTAMP	否	修改时间之后。格式：yyyy-MM-dd HH:mm:ss
start_create_date	TIMESTAMP	否	创建时间开始。格式：yyyy-MM-dd
end_create_date	TIMESTAMP	否	创建时间结束。格式：yyyy-MM-dd
start_modify_date	TIMESTAMP	否	修改时间开始。格式：yyyy-MM-dd
end_modify_date	TIMESTAMP	否	修改时间结束。格式：yyyy-MM-dd
page	INT	否	页码默认1，每页默认1000条
rows	INT	否	每页记录条数，默认最大是1000条，可以根据数据的大小自行优化调整
supply_id	INT	否	供货商id。-1为直营退货订单，其他为分销退货订单
order_type	VARCHAR(32)	否	订单类型。1：退货订单，2：换入订单
id	INT8	否	退货订单ID
order_no	VARCHAR(32)	否	退货订单编号
cm_code	VARCHAR(32)	否	客户编码
order_status	VARCHAR(100)	否	DD_DSH、待收货，DD_YWC：已完成，DD_DQR：待确认，DD_YQX：已取消，DD_YQR：已确认 , 多状态用逗号分隔
status	VARCHAR(32)	否	记录状态。0：已删除，1：正常

响应示例：

{
  "return_code": "0",
  "response_data":"<<DATA>>"
}

数据DATA示例:

[
  {
    "order_no": "DD20210803000030",
    "date": "2021-08-03 14:03",
    "supply_id": -1,
    "emp_name": "系统服务器",
    "remark": "测试直营订单退货接口",
    "products": [
      {
        "shenqing_count": "2.00000000",
        "shenqing_amount": "42.00",
        "shenqing_price": "21.00000000",
        "rel_remark": "测试直营订单退货接口",
        "product_code": "662_MZ_Master_01",
        "confirm_count": "2.00000000",
        "product_name": "662_MZ_Master_01",
        "unit_name": "箱",
        "order_detail_id": "",
        "is_gift": "N",
        "shenqing_input_unit": "4862203401633905967",
        "product_id": "7421053210327994503",
        "confirm_amount": "42.00"
      }
    ],
    "cm_code": "CUS000002",
    "ext_infos": [
      {
        "code": "ext_2112240123",
        "value": ""
      }
    ],
    "supply_name": "",
    "order_status": "DD_DSH",
    "receive_phone": "18569854561",
    "receive_name": "张三",
    "receive_tel": "02578946932",
    "id": 6107524931439186956,
    "order_type": "ZYGLTH",
    "emp_code": "intfadmin",
    "create_time": "2021-08-12 10:26",
    "change_back_reason_id": -1,
    "visit_implement_id": -1,
    "order_out_id": "7210525956051557660",
    "order_out_no": "DD20220407000013",
    "receive_addr": "江苏省南京市康缘智汇港",
    "cm_id": "8078723553496786531",
    "back_reason": "",
    "cm_name": "老杜的直营经销商",
    "consignment_date": "2021-08-12",
    "supply_code": "",
    "order_id": "7948284691295991321",
    "status": "1"
  },
  {
    "order_no": "DD20210803000030",
    "date": "2021-08-03 14:03",
    "supply_id": -1,
    "emp_name": "系统服务器",
    "remark": "测试直营订单退货接口",
    "products": [
      {
        "shenqing_count": "2.00000000",
        "shenqing_amount": "21.00",
        "shenqing_price": "21.00000000",
        "rel_remark": "测试直营订单退货接口",
        "product_code": "662_MZ_Master_01",
        "confirm_count": "2.00000000",
        "product_name": "662_MZ_Master_01",
        "unit_name": "箱",
        "order_detail_id": "",
        "is_gift": "N",
        "shenqing_input_unit": "4862203401633905967",
        "product_id": "7421053210327994503",
        "confirm_amount": "21.00"
      }
    ],
    "cm_code": "CUS000002",
    "ext_infos": [
      {
        "code": "ext_2112240123",
        "value": ""
      }
    ],
    "supply_name": "",
    "order_status": "DD_DSH",
    "receive_phone": "18569854561",
    "receive_name": "张三",
    "receive_tel": "02578946932",
    "id": 5165826807846570430,
    "order_type": "ZYGLTH",
    "emp_code": "intfadmin",
    "create_time": "2021-08-12 10:31",
    "change_back_reason_id": -1,
    "visit_implement_id": -1,
    "order_out_id": "7210525956051557660",
    "order_out_no": "DD20220407000013",
    "receive_addr": "江苏省南京市康缘智汇港",
    "cm_id": "8078723553496786531",
    "back_reason": "",
    "cm_name": "老杜的直营经销商",
    "consignment_date": "2021-08-12",
    "supply_code": "",
    "order_id": "7948284691295991321",
    "status": "1"
  },
  {
    "order_no": "DD20210428000003",
    "date": "2021-04-28 14:21",
    "supply_id": -1,
    "emp_name": "系统服务器",
    "remark": "测试直营订单退货接口",
    "products": [
      {
        "shenqing_count": "1.00000000",
        "shenqing_amount": "3.00",
        "shenqing_price": "3.00000000",
        "rel_remark": "测试直营订单退货接口",
        "product_code": "baiyin_meinianda_026",
        "confirm_count": "1.00000000",
        "product_name": "百事_美年达_葡萄味_2.5L",
        "unit_name": "袋",
        "order_detail_id": "",
        "is_gift": "N",
        "shenqing_input_unit": "6936228840570112101",
        "product_id": "5130759210739014375",
        "confirm_amount": "3.00"
      },
      {
        "shenqing_count": "1.00000000",
        "shenqing_amount": "3.00",
        "shenqing_price": "3.00000000",
        "rel_remark": "测试直营订单退货接口",
        "product_code": "baiyin_meinianda_027",
        "confirm_count": "1.00000000",
        "product_name": "百事_美年达_蜜桃味_2.5L",
        "unit_name": "箱",
        "order_detail_id": "",
        "is_gift": "N",
        "shenqing_input_unit": "6362931419429812568",
        "product_id": "9043401268045478811",
        "confirm_amount": "3.00"
      }
    ],
    "cm_code": "CUS000002",
    "ext_infos": [
      {
        "code": "ext_2112240123",
        "value": ""
      }
    ],
    "supply_name": "",
    "order_status": "DD_DSH",
    "receive_phone": "18569854561",
    "receive_name": "老杜的直营经销商",
    "receive_tel": "02578946932",
    "id": 7102018506706606280,
    "order_type": "ZYGLTH",
    "emp_code": "intfadmin",
    "create_time": "2021-08-12 10:46",
    "change_back_reason_id": -1,
    "visit_implement_id": -1,
    "order_out_id": "7210525956051557660",
    "order_out_no": "DD20220407000013",
    "receive_addr": "江苏省南京市康缘智汇港",
    "cm_id": "8078723553496786531",
    "back_reason": "",
    "cm_name": "老杜的直营经销商",
    "consignment_date": "2021-08-12",
    "supply_code": "",
    "order_id": "5692740992502705111",
    "status": "1"
  }
]

参数说明：

参数	类型	必填	说明
id	INT8	否	退款单ID
status	VARCHAR(32)	否	0：已删除，1：正常
order_no	VARCHAR(32)	否	退货订单号
cm_code	VARCHAR(32)	否	客户编码
supply_code	VARCHAR(32)	否	供货商编码。直营退货订单供货商为空
supply_id	INT	否	供货商id。-1为直营退货订单，其他为分销退货订单
date	VARCHAR(32)	否	下单时间。格式：yyyy-mm-dd hh:mm
order_type	VARCHAR(32)	否	订单类型。1：退货订单，2：换入订单
order_status	VARCHAR(32)	否	订单状态。DD_DSH、待收货，DD_YWC：已完成，DD_DQR：待确认，DD_YQX：已取消，DD_YQR：已确认
order_id	VARCHAR(32)	否	关联订单ID
emp_code	VARCHAR(32)	否	业务员编码
emp_dept_id	VARCHAR(32)	否	业务员部门id
emp_dept_name	VARCHAR(100)	否	业务员部门
consignment_date	VARCHAR(32)	否	交货日期。格式：yyyy-mm-dd
receive_name	VARCHAR(100)	否	收货人名称
receive_tel	VARCHAR(32)	否	收货人手机
receive_phone	VARCHAR(32)	否	收货人电话
receive_addr	VARCHAR(1000)	否	收货地址
remark	text	否	订单单据头备注
back_reason	VARCHAR(32)	否	退货原因名称
visit_implement_id	INT8	否	拜访ID
order_out_id	VARCHAR(32)	否	关联换出订单ID
order_out_no	VARCHAR(32)	否	关联换出订单号
products.product_id	VARCHAR(32)	否	商品id
products.product_code	VARCHAR(100)	否	商品编码
products.shenqing_price	numeric(18,8)	否	退货单价
products.shenqing_count	numeric(18,8)	否	申请数量
products.confirm_count	numeric(18,8)	否	确认数量
products.shenqing_input_unit	VARCHAR(32)	是	退货单位id
products.unit_name	VARCHAR(32)	否	退货单位名称
products.shenqing_amount	numeric(18,2)	否	退货申请金额
products.confirm_amount	numeric(18,2)	否	退货确认金额
products.is_gift	VARCHAR(10)	否	是否是赠品。1：是，0：否。
products.rel_remark	text	否	订单子表的备注
products.order_detail_id	VARCHAR(32)	否	关联订单退货的订单明细id
products.change_back_order_detail_id	VARCHAR(32)	是	退换货明细行id
ext_infos.code	VARCHAR(4000)	否	退货订单主信息扩展字段key值扩展字段需先在我方系统中创建
ext_infos.value	VARCHAR(4000)	否	扩展字段value值对多个选项值，以“,”分隔拼接
create_time	TIMESTAMP	否	单据提交时间。格式：yyyy-mm-dd hh24:mi:ss.us
modify_time	TIMESTAMP	否	单据最近一次变更时间。格式：yyyy-mm-dd hh24:mi:ss.us

# 关闭退货订单接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/dmschangeback/v1/closeOrder/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
order_id	VARCHAR(32)	否	退货单id[退货单id与退货单号必传其一]
order_no	VARCHAR(100)	否	退货单号[退货单id与退货单号必传其一]

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明：

参数	类型	必填	说明
msg_id	VARCHAR(32)	是	消息ID
return_code	VARCHAR(32)	是	响应编码。0：成功，1：失败
return_msg	VARCHAR(100)	是	响应说明

# 查询退货收货单接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/dmsdatasearch/v1/queryShouHuoOrderInfos/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "rows": 1000,
  "page": 1,
  "back_no": -1,
  "after_create_date": "2021-11-23 10:57:24.487",
  "after_modify_date": "2021-11-23 10:57:24.487",
  "start_create_date": "2017-12-09",
  "end_create_date": "2017-12-09",
  "start_modify_date": "2017-12-09",
  "end_modify_date": "2017-12-09",
  "order_status": "DD_DSH",
  "s_status": "1"
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
after_create_date	TIMESTAMP	否	创建时间之后。格式：yyyy-MM-dd HH:mm:ss
after_modify_date	TIMESTAMP	否	修改时间之后。格式：yyyy-MM-dd HH:mm:ss
start_create_date	TIMESTAMP	否	创建时间开始。格式：yyyy-MM-dd
end_create_date	TIMESTAMP	否	创建时间结束。格式：yyyy-MM-dd
start_modify_date	TIMESTAMP	否	修改时间开始。格式：yyyy-MM-dd
end_modify_date	TIMESTAMP	否	修改时间结束。格式：yyyy-MM-dd
page	INT	否	页码默认1，每页默认1000条
rows	INT	否	每页记录条数，默认最大是1000条，可以根据数据的大小自行优化调整
back_no	VARCHAR(32)	否	退货单编码
s_status	VARCHAR(32)	否	记录状态。0：已删除，1：正常
shouhuo_after_create_date	TIMESTAMP	否	退货收货单创建时间之后。格式：yyyy-MM-dd HH:mm:ss
shouhuo_after_modify_date	TIMESTAMP	否	退货收货单修改时间之后。格式：yyyy-MM-dd HH:mm:ss
shouhuo_start_create_date	TIMESTAMP	否	退货收货单创建时间开始。格式：yyyy-MM-dd
shouhuo_end_create_date	TIMESTAMP	否	退货收货单创建时间结束。格式：yyyy-MM-dd
shouhuo_start_modify_date	TIMESTAMP	否	退货收货单修改时间开始。格式：yyyy-MM-dd
shouhuo_end_modify_date	TIMESTAMP	否	退货收货单修改时间结束。格式：yyyy-MM-dd
shouhuo_no	VARCHAR(32)	否	退货收货单编码

响应示例：

{
  "return_code": "0",
  "response_data":"<<DATA>>"
}

数据DATA示例:

[
  {
    "id": "7210525956051557660",
    "status": "1",
    "shouhuo_no": "SH20201210000001",
    "shouhuo_time": "2020-12-10 19:03",
    "ruzhang_time": "2020-12-10 19:03",
    "shouhuo_all_num": "1",
    "shouhuo_all_amount": "12.3",
    "ruzhang_all_num": "2",
    "creator_id": "8728465767594941902",
    "creator_code": "ming",
    "creator_name": "明明",
    "create_time": "2020-12-10 19:03",
    "modifyier_id": "",
    "modifyier_code": "",
    "modifyier_name": "",
    "modify_time": "",
    "change_back_id": "8008078240475660634",
    "change_back_no": "TH20201210000002",
    "change_back_reason_id": "-1",
	"change_back_reason_name": "",		
	"cm_id": "6936206473592251045",
	"cm_code": "CUS000001",
	"cm_name": "建邺区便利蜂便利店",
	"supply_id": "6505356464360739414",
	"supply_code": "CUS000012",
	"supply_name": "建邺区好吃点饼干",
	"order_type": "FXGLTH",
	"order_source": "NBZHWB",
	"consignment_date": "2020-09-16 00:00",
	"shouhuo_storehouse_id": "8259880973735163348",
	"shouhuo_storehouse_code": "CK0006",
	"shouhuo_storehouse_name": "建邺区好吃点仓库",
	"shouhuo_emp_id": "8800591213328174384",
	"shouhuo_emp_code": "y0002",
	"shouhuo_emp_name": "刘虎明",
	"ruzhang_emp_id": "8800591213328174384",
	"ruzhang_emp_code": "y0002",
	"ruzhang_emp_name": "刘虎明",
    "details": [
         {
            "detail_id": "7901459487233200177",
            "change_back_detail_id": "7694941330840696112",
            "product_id": "9210927534816075955",
            "product_code": "sqbg007",
            "product_name": "闲趣阳光蔬菜味苏打饼干500g",
            "base_unit_id": "6026976558929866366",
            "base_unit_name": "包",
            "shouhuo_price": "80.00",
            "shouhuo_count": "9.0",
            "shouhuo_input_unit": "6798715256765209436",
            "shouhuo_input_unit_name": "箱",
            "shouhuo_base_unit_count": "90.00000000",
            "shouhuo_amount": "720.00000000",
            "ruzhang_count": "9.00000000",
            "ruzhang_input_unit": "6798715256765209436",
            "ruzhang_input_unit_name": "箱",
            "ruzhang_base_unit_count": "90.00000000",
            "remark": "",
            "posnr": "2",
            "product_type": "Z",
            "is_gift": "N",
            "promotion_id": "-1",
            "promotion_name": "",
            "superposition_promotion_id": "-1",
            "superposition_promotion_name": ""
         }
     ]
  }
]

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	否	单据ID
status	VARCHAR(32)	否	状态0：已删除，1：正常
creator_id	VARCHAR(32)	否	创建人id
creator_code	VARCHAR(100)	否	客户人编码
creator_name	VARCHAR(100)	否	创建人名称
create_time	VARCHAR(32)	否	创建日期。格式：yyyy-mm-dd hh:mm
modifyier_id	VARCHAR(32)	否	修改人id
modifyier_code	VARCHAR(100)	否	修改人编码
modifyier_name	VARCHAR(100)	否	修改人名称
modify_time	VARCHAR(32)	否	修改日期。格式：yyyy-mm-dd hh:mm
shouhuo_no	VARCHAR(32)	否	收货单号
change_back_id	VARCHAR(32)	否	退换货订单id
change_back_no	VARCHAR(32)	否	退换货订单编号
shouhuo_storehouse_id	VARCHAR(32)	否	收货仓库id
shouhuo_storehouse_code	VARCHAR(200)	否	收货仓库编码
shouhuo_storehouse_name	VARCHAR(200)	否	收货仓库名称
shouhuo_time	VARCHAR(200)	否	收货时间。格式：yyyy-mm-dd hh:mm
shouhuo_emp_id	VARCHAR(32)	否	收货人id
shouhuo_emp_code	VARCHAR(100)	否	收货人编码
shouhuo_emp_name	VARCHAR(100)	否	收货人名称
ruzhang_time	VARCHAR(32)	否	入账时间。格式：yyyy-mm-dd hh:mm
ruzhang_emp_id	VARCHAR(32)	否	入账人id
ruzhang_emp_code	VARCHAR(100)	否	入账人编码
ruzhang_emp_name	VARCHAR(100)	否	入账人名称
shouhuo_all_num	VARCHAR(32)	否	合计收货数量
shouhuo_all_amount	VARCHAR(32)	否	合计收货金额
ruzhang_all_num	VARCHAR(32)	否	合计入账数量
change_back_reason_id	VARCHAR(32)	否	退换货原因id
change_back_reason_name	VARCHAR(200)	否	退换货原因名称
cm_id	VARCHAR(32)	否	客户id
cm_code	VARCHAR(100)	否	客户编码
cm_name	VARCHAR(100)	否	客户名称
supply_id	VARCHAR(32)	否	供货商id。默认值是-1,-1就是厂家
supply_code	VARCHAR(100)	否	供货商编码
supply_name	VARCHAR(100)	否	供货商名称
order_type	VARCHAR(32)	否	退货订单类型，FXGLTH:分销关联退货，FXSPTH:分销商品退货，FXHRHH:分销换入换货，ZYHRHH:直营换入换货，ZYGLTH：直营关联退货，ZYSPTH：直营商品退货
order_source	VARCHAR(32)	否	订单来源，NBZHSJ：内部账号手机(业代手机)，NBZHWB：内部账号web（业代web），WBZHSJ：外部账号手机（客户手机），WBZHWB：外部账号web（客户web），MDWXXD：客户微信下单，JK：接口，DINGHUO365:(客户手机端)，GJBF：高级拜访(业代高级拜访)
consignment_date	VARCHAR(32)	否	交货日期。格式：yyyy-mm-dd hh:mm
details	LIST	否	子数据
details.detail_id	VARCHAR(32)	是	退货子表id
details.change_back_detail_id	VARCHAR(32)	否	退换货详情数据id
details.product_id	VARCHAR(32)	否	商品id
details.product_code	VARCHAR(100)	否	商品编码
details.product_name	VARCHAR(100)	否	商品名称
details.base_unit_id	VARCHAR(32)	否	商品的基本单位id
details.base_unit_name	VARCHAR(32)	否	商品的基本单位名称
details.shouhuo_price	VARCHAR(32)	否	收货价格
details.shouhuo_count	VARCHAR(32)	否	收货数量
details.shouhuo_input_unit	VARCHAR(32)	否	收货单位id
details.shouhuo_input_unit_name	VARCHAR(32)	否	收货单位名称
details.shouhuo_base_unit_count	VARCHAR(32)	否	收货基本单位数量
details.shouhuo_amount	VARCHAR(32)	否	收货金额
details.ruzhang_count	VARCHAR(32)	否	入账数量
details.ruzhang_input_unit	VARCHAR(32)	否	入账单位id
details.ruzhang_input_unit_name	VARCHAR(32)	否	入账单位名称
details.ruzhang_base_unit_count	VARCHAR(32)	否	入账基本单位数量
details.remark	VARCHAR(500)	否	备注
details.posnr	VARCHAR(32)	否	项目号
details.product_type	VARCHAR(10)	否	销售类型。赠(Z)、兑(D)、返(F)
details.is_gift	VARCHAR(2)	否	是否是赠品。Y：是，N：否
details.promotion_id	VARCHAR(32)	否	促销组ID。促销组中的商品才会有促销组id，默认-1，表明这不是促销组中的商品信息
details.promotion_name	VARCHAR(200)	否	促销组名称
details.superposition_promotion_id	VARCHAR(32)	否	叠加促销ID
details.superposition_promotion_name	VARCHAR(200)	否	叠加促销名称

← 直营订单变更单接口退货单推送 →