接口说明

注册会员

请求方式：POST
接口地址：/crm/open/user/create
调试工具：在线调试

注意

会员注册目前只支持手机号码注册，并且一个手机号码只能注册一个账号。其次 手机号码、真实姓名、身份证 必须一致，系统会做三要素校验，如果校验不通过则会注册失败。

请求参数

报文示例

{
"phoneNumber":"18677777777"
"password":null,
"displayName":null,
"realName":"张三",
"idCardNo":"62050219111111111111"
}

参数说明

参数	参数类型	是否必须	说明
phoneNumber	string	是	手机号码
password	string	否	登录密码
displayName	string	否	昵称
realName	string	是	真实姓名
idCardNo	string	是	身份证号码

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content":
{
"phoneNumber":"18677777777"
}
}

参数说明

参数	参数类型	是否可空	说明
phoneNumber	string	否	注册的手机号码

添加银行卡

请求方式：POST
接口地址：/crm/open/bankcard/user/add
调试工具：在线调试

注意

这里提供的银行卡必须是本人的，也就是说，注册的手机号码、真实姓名、身份证号码、银行卡 必须是一致的，系统会做四要素校验，如果校验不过，则会绑定失败。
其次每个会员最多绑定10个银行卡。

请求参数

报文示例

{
"phoneNumber":"18677777777",
"bankCardNo":"6225887811338850",
"isDefault":true
}

参数说明

参数	参数类型	是否必须	说明
phoneNumber	string	是	已注册的手机号码
bankCardNo	string	是	银行卡号
isDefault	boolean	是	是否设置为默认银行卡

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content":
{
"bankCardNo":"6225887811338850",
"bankName":"中国银行"
}
}

参数说明

参数	参数类型	是否可空	说明
bankCardNo	string	否	添加的银行卡号
bankName	string	否	卡所属的银行名称

设置默认银行卡

请求方式：POST
接口地址：/crm/open/bankcard/user/setdefault
调试工具：在线调试

将指定的银行卡设置为默认，在今后的业务中，如果将银行卡卡号设置为null的时候，则系统自动使用默认银行卡

请求参数

报文示例

{
"phoneNumber":"18677777777",
"bankCardNo":"6225887811338850"
}

参数说明

参数	参数类型	是否必须	说明
phoneNumber	string	是	已注册的手机号码
bankCardNo	string	是	要操作的银行卡卡号

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content":
{
"bankCardNo":"6225887811338850",
"bankName":"中国银行"
}
}

参数说明

参数	参数类型	是否可空	说明
bankCardNo	string	否	操作的银行卡号
bankName	string	否	卡所属的银行名称

获取回收订单结算信息

请求方式：GET
接口地址：/order/open/recycle/settle
调试工具：在线调试

获取订单的结算信息。只有订单的状态在 待用户确认 时候才有效，否则会改接口会返回 ErrorCode=3020(订单状态异常)的错误码

注意

该接口只能获取属于当前商户的结算信息

请求参数

报文示例

https://domain/crm/open/user/create?orderNo=2255522114

参数说明

参数	参数类型	是否必须	说明
orderNo	string	是	回收订单号

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content":
{
"orderNo":"2552211441222",
"totalPrice":16500.00,
"totalWeight":21.000,
"lockPriceType":1,
"products":
[
{
"code":"A123",
"name":"金条",
"weight":10.5,
"quality":9999,
"price":412.50,
"total":2
},
{
"code":"A122",
"name":"首饰",
"weight":10.5,
"quality":9999,
"price":412.50,
"total":2
}
]
}
}

参数说明

参数	参数类型	是否可空	说明
orderNo	string	否	回收订单号
totalPrice	float	否	结算总价
totalWeight	float	否	回收产品的总重
items	array	否	回收单产品集合

items参数说明

参数	参数类型	是否可空	说明
code	string	否	回收产品代码
name	string	否	回收产品名称
weight	float	否	回收产品的单品重量
quality	int	否	回收产品的单品品质
price	float	否	回收产品的结算单价
total	int	否	回收产品的数量

创建回收订单

请求方式：POST
接口地址：/order/open/recycle/create
调试工具：在线调试

请求参数

报文示例

{
"phoneNumber": "18677777777",
"bankCardNo": "6225887811338850",
"storeNo": "58522144",
"lockPriceType":1,
"remark":"备注信息"
"deliveryInfo":
{
"logisticsSendType":2,
"fromAddress":
{
"contract":
{
"name":"张三",
"mobile":"18677777777"
}
"address":
{
"province":"广东省",
"city":"深圳市",
"area":"罗湖区",
"street":"翠竹街道",
"detailed":"水贝二路xxxxxxxxx"
}
}
}
"products":
[
{
"code": "A123",
"weight": 10.250,
"quality": 9999,
"images":["MTExMTExMTE=","c2Rmc2Rmc2RmYQ=="],
"total": 2
},
{
"code": "A122",
"weight": 10.250,
"quality": 9999,
"images":["MTExMTExMTE=","c2Rmc2Rmc2RmYQ=="],
"total": 1
}
]
}

参数说明

参数	参数类型	是否必须	说明
phoneNumber	string	是	已注册的手机号码
bankCardNo	string	否	要收款的银行卡号(该卡号必须是通过添加银行卡接口已经添加过的银行卡)，如果不设置该值，则系统会使用添加的默认银行卡来作为收款卡号
storeNo	string	是	回收单店铺的店铺号
lockPriceType	enum	是	定价方式，该字段是一个保留字段，目前只支持1(非实时，也就是收到货之后，验货通过之后，待用户确认的时候定价)的方式
remark	string	否	备注
deliveryInfo	object	是	配送信息
products	array	是	回收单产品集合

deliveryInfo参数说明

参数	参数类型	是否必须	说明
logisticsSendType	enum	是	配送方式
fromAddress	object	否	取件信息，如果logisticsSendType是2(物流配送)，则该项是必填项，如果是1(送货上门)、3(自主寄件)则该值可以不用设置(即使设置了也不会处理)

products参数说明

参数	参数类型	是否必须	说明
code	string	是	产品代码
weight	float	是	单个产品的重量
quality	int	是	单个产品的品质
images	array	否	实物图片，将单个图片的字节数组通过Base64编码后转成字符串的方式传递，最多三张照片
total	int	是	产品数量

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content":
{
"phoneNumber": "18677777777",
"bankCardNo": "6225887811338850",
"storeNo": "58522144",
"orderNo": "2255852121212121",
"toAddress":
{
"contract":
{
"name":"张三",
"mobile":"18677777777"
}
"address":
{
"province":"广东省",
"city":"深圳市",
"area":"罗湖区",
"street":"翠竹街道",
"detailed":"水贝二路xxxxxxxxx"
}
}
}
}

参数说明

参数	参数类型	是否可空	说明
phoneNumber	string	否	注册的用户手机号
bankCardNo	string	否	收款银行账号
storeNo	string	否	回收单店铺店铺号
orderNo	string	否	系统生成的回收订单号
clientOrderNo	string	否	客户端订单号
toAddress	object	否	收件信息，无论订单是物流配送、自主寄件、送货上门，都将实物送至该地址，注意：如果是物流配送系统会自动下单，在无需人工处理

确认回收订单

请求方式：POST
接口地址：/order/open/recycle/confirm
调试工具：在线调试

注意

该接口只能确认属于当前商户的订单

请求参数

报文示例

{
"orderNo":"2552211441222",
}

参数说明

参数	参数类型	是否必须	说明
orderNo	string	是	回收订单号

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content":
{
"orderNo":"2552211441222",
"totalPrice":16500.00,
"totalWeight":21.000,
"lockPriceType":1,
"products":
[
{
"code":"A123",
"name":"金条",
"weight":10.5,
"quality":9999,
"price":412.50,
"total":2
},
{
"code":"A122",
"name":"首饰",
"weight":10.5,
"quality":9999,
"price":412.50,
"total":2
}
]
}
}

参数说明

参数	参数类型	是否可空	说明
orderNo	string	否	回收订单号
totalPrice	float	否	结算总价
totalWeight	float	否	回收产品的总重
lockPriceType	enum	是	定价方式
items	array	否	回收单产品集合

items参数说明

参数	参数类型	是否可空	说明
code	string	否	回收产品代码
name	string	否	回收产品名称
weight	float	否	回收产品的单品重量
quality	int	否	回收产品的单品品质
price	float	否	回收产品的结算单价
total	int	否	回收产品的数量

取消回收订单

请求方式：POST
接口地址：/order/open/recycle/cancel
调试工具：在线调试

注意

该接口只能取消属于当前商户的订单

请求参数

报文示例

{
"orderNo":"2552211441222",
"remark":"不同意回收"
}

参数说明

参数	参数类型	是否必须	说明
orderNo	string	是	回收订单号
remark	string	否	备注

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content": null
}

获取提纯订单结算信息

请求方式：GET
接口地址：/order/open/purify/settle
调试工具：在线调试

获取订单的结算信息。只有订单的状态在 待用户确认 时候才有效，否则会改接口会返回 ErrorCode=3020(订单状态异常)的错误码

注意

该接口只能获取属于当前商户的结算信息

请求参数

报文示例

https://domain/crm/open/user/get?orderNo=2255522114

参数说明

参数	参数类型	是否必须	说明
orderNo	string	是	回收订单号

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content":
{
"orderNo":"2552211441222",
"roughWeight":1000.123,
"netWeight":900.123,
"netQuality":9999,
"serviceCharge":
{
"rate":0.1,
"totalPrice":145.23
}
}
}

参数说明

参数	参数类型	是否可空	说明
orderNo	string	否	回收订单号
roughWeight	float	否	提纯前重量
netWeight	float	否	提纯后重量
netQuality	int	否	提纯后的品质
serviceCharge	object	否	服务费

serviceCharge参数说明

参数	参数类型	是否可空	说明
rate	float	否	费率(每克多少钱)
totalPrice	float	否	服务费总价

创建提纯订单

请求方式：POST
接口地址：/order/open/purify/create
调试工具：在线调试

请求参数

报文示例

{
"storeNo": "58522144",
"remark":"备注",
"materialInfo":
{
"materialType":1,
"weight":1000.123,
"images":["MTExMTExMTE=","c2Rmc2Rmc2RmYQ=="]
},
"deliveryInfo":
{
"logisticsSendType":2,
"fromAddress":
{
"contract":
{
"name":"张三",
"mobile":"18677777777"
}
"address":
{
"province":"广东省",
"city":"深圳市",
"area":"罗湖区",
"street":"翠竹街道",
"detailed":"水贝二路xxxxxxxxx"
}
}
}
}

参数说明

参数	参数类型	是否必须	说明
storeNo	string	是	店铺号
remark	string	否	备注
materialInfo	object	是	要处理的材料信息
deliveryInfo	object	是	配送信息

materialInfo参数说明

参数	参数类型	是否必须	说明
materialType	enum	是	材料类型
weight	float	是	重量
images	array	否	实物图片，将单个图片的字节数组通过Base64编码后转成字符串的方式传递，最多三张照片

deliveryInfo参数说明

参数	参数类型	是否必须	说明
logisticsSendType	enum	是	配送方式
fromAddress	object	否	取件信息，如果logisticsSendType是2(物流配送)，则该项是必填项，如果是1(送货上门)、3(自主寄件)则该值可以不用设置(即使设置了也不会处理)

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content":
{
"storeNo": "58522144",
"orderNo": "2255852121212121",
"toAddress":
{
"contract":
{
"name":"张三",
"mobile":"18677777777"
}
"address":
{
"province":"广东省",
"city":"深圳市",
"area":"罗湖区",
"street":"翠竹街道",
"detailed":"水贝二路xxxxxxxxx"
}
}
}
}

参数说明

参数	参数类型	是否可空	说明
storeNo	string	否	店铺号
orderNo	string	否	系统生成的订单号
clientOrderNo	string	否	客户端订单号
toAddress	object	否	收件信息，无论订单是物流配送、自主寄件、送货上门，都将实物送至该地址，注意：如果是物流配送系统会自动下单，在无需人工处理

确认提纯订单

请求方式：POST
接口地址：/order/open/purify/confirm
调试工具：在线调试

注意

该接口只能确认属于当前商户的订单

请求参数

报文示例

{
"orderNo":"2552211441222"
}

参数说明

参数	参数类型	是否必须	说明
orderNo	string	是	提纯订单号

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content":
{
"orderNo":"2552211441222",
"roughWeight":1000.123,
"netWeight":900.123,
"netQuality":9999,
"serviceCharge":
{
"rate":0.1,
"totalPrice":145.23
}
}
}

参数说明

参数	参数类型	是否可空	说明
orderNo	string	否	回收订单号
roughWeight	float	否	提纯前重量
netWeight	float	否	提纯后重量
netQuality	int	否	提纯后的品质
serviceCharge	object	否	服务费

serviceCharge参数说明

参数	参数类型	是否可空	说明
rate	float	否	费率(每克多少钱)
totalPrice	float	否	服务费总价

取消提纯订单

请求方式：POST
接口地址：/order/open/purify/cancel
调试工具：在线调试

注意

该接口只能取消属于当前商户的订单

请求参数

报文示例

{
"orderNo":"2552211441222",
"remark":"不同意回收"
}

参数说明

参数	参数类型	是否必须	说明
orderNo	string	是	回收订单号
remark	string	否	备注

响应参数

报文示例

{
"errorCode": 2000,
"description": "成功",
"version": "1.0",
"traceId": "1d3ed595-a127-4e0f-a971-e93f02af33c5",
"content": null
}

注册会员#

添加银行卡#

设置默认银行卡#

获取回收订单结算信息#

创建回收订单#

确认回收订单#

取消回收订单#

获取提纯订单结算信息#

创建提纯订单#

确认提纯订单#

取消提纯订单#

注册会员

添加银行卡

设置默认银行卡

获取回收订单结算信息

创建回收订单

确认回收订单

取消回收订单

获取提纯订单结算信息

创建提纯订单

确认提纯订单

取消提纯订单