GET 销售退货单详情

GET 查询。query 参数：id（退货单ID，必填）。

接口编码	所需范围	后端接口
`sales.return.detail`	`sales:read`	`GET /v1/sales-return/detail`（comap-sales）

请求参数（query）

字段	类型	必填	说明
`id`	integer(int64)	是	—

「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验，标「—」不等于可以不传；租户在主站配置的字段必填不约束本接口。详见必填字段的判定与字段清单与自定义字段。

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
  -H "Authorization: Bearer <访问令牌>" \
  -H "Content-Type: application/json" \
  -d '{
    "apiCode": "sales.return.detail",
    "query": {
      "id": "1961000000000000001"
    }
  }'

响应 data 字段

字段	类型	必填	说明
`id`	integer(int64)	—	ID
`returnNo`	string	—	退货单号
`contractId`	integer(int64)	—	合同ID
`contractNo`	string	—	合同编号
`customerId`	integer(int64)	—	客户ID
`customerName`	string	—	客户名称
`contactName`	string	—	联系人姓名
`contactPhone`	string	—	联系人电话
`returnReasonId`	integer(int64)	—	退货原因ID
`reason`	string	—	原因
`returnType`	string	—	退货类型：RETURN_REFUND=退货退款, REFUND_ONLY=仅退款, RETURN_ONLY=仅退货, EXCHANGE=换货补发
`warehouseId`	integer(int64)	—	仓库ID
`orderId`	integer(int64)	—	订单ID
`orderNo`	string	—	销售订单号
`status`	integer(int32)	—	状态：0=草稿, 1=待到货登记, 5=已退货, 6=已退款, 8=已取消
`bizStatus`	integer(int32)	—	审批状态：0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消
`amount`	number	—	金额
`refundAmount`	number	—	退款金额
`refundDate`	string(date-time)	—	退款日期
`refundMethod`	string	—	退款方式，关联付款方式配置表
`refundMethodId`	integer(int64)	—	退款方式ID
`remark`	string	—	备注
`operatorId`	integer(int64)	—	操作人ID
`operatorName`	string	—	操作人名称
`createTime`	string(date-time)	—	创建时间
`inboundId`	integer(int64)	—	关联退货入库单 id（入库确认后由 SRM 回写，供退款反审核联动反审核入库单） @author Avery
`flowInstanceCode`	string	—	审批流程实例编号（与 t_sales_return.flow_instance_code 一致，供前端查询当前用户待办）
`refundNeeded`	boolean	—	是否需要实际退款（客户未付款时为 false，仅冲销应收即可）
`orderRefundableAmount`	number	—	销售订单应退金额（该订单客户实付总额 - 该订单所有退货已退款合计）
`followed`	boolean	—	当前用户是否已关注
`items`32	ReturnItemVO[]	—	退货明细
`comments`6	ReturnCommentVO[]	—	评论列表
`attachments`8	ReturnAttachmentVO[]	—	附件列表
`progresses`6	ReturnProgressVO[]	—	处理进度
`exchangeShipments`7	ExchangeShipmentVO[]	—	换货补发单列表；一期最多一张，结构预留一对多

错误处理

响应统一信封 { code, message, data }，code == 200 为成功。以下是本接口可能返回的开放平台层错误：

错误码	说明	可重试
92101	访问凭证无效	否
92201	接口未登记或已停用	否
92202	超出凭证授权范围——本接口需 `sales:read`	否
92204	绑定员工无此接口的功能权限	否
92203	上游服务调用失败	是
92301	请求过于频繁	是

除此之外，comap-sales 自身的业务校验失败会原样透传其业务码与提示（如字段校验、状态不允许、数据不存在），这类码不在开放平台的号段内，以响应里的 message 为准。完整的平台层错误码见错误码说明。

← 返回退货单

错误处理​

错误处理