POST 更新退货单(限草稿)
POST 更新。body 为 JSON 对象(含 id)。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.return.update | sales:write | POST /v1/sales-return/update(comap-sales) |
必填字段
| 字段 | 依据 |
|---|---|
customerId | 接口规格 |
returnReasonId | 接口规格 |
items | 接口规格 |
attachments[].fileId | 接口规格 |
id | 接口规格 |
条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。
请求体字段(body)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
returnNo | string | — | 销售退货单号;为空时按编码规则生成 |
contractId | integer(int64) | — | 合同ID |
customerId | integer(int64) | 是 | 客户ID |
orderId | integer(int64) | — | 销售订单ID;仅退款、仅退货、换货补发必填 |
returnType | string | — | 处理方式 |
contactName | string | — | 联系人 |
contactPhone | string | — | 联系电话 |
returnReasonId | integer(int64) | 是 | 退货原因配置ID |
warehouseId | integer(int64) | — | 退回仓库ID |
warehouseName | string | — | 退回仓库名称 |
refundMethod | string | — | 退款方式,关联付款方式配置表 |
refundMethodId | integer(int64) | — | 退款方式ID |
remark | string | — | 备注 |
items27 | ReturnItemDTO[] | 是 | 退货明细 |
attachments1 | ReturnAttachmentDTO[] | — | 附件列表 |
id | integer(int64) | 是 | 退货单ID |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.return.update",
"body": {
"id": "1961000000000000001",
"customerId": "1961000000000000001",
"returnReasonId": "1961000000000000001",
"items": []
}
}'
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 sales:write | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 先查询处理结果,禁止盲目重试 |
| 92301 | 请求过于频繁 | 是 |
| 92205 | 写操作处理超时,结果未知(下游可能仍在执行) | 否,先查询确认结果 |
| 92302 | 有参数相同的写请求正在处理中 | 等待并确认前一次结果,勿重复提交 |
除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回退货单