forked from erp-dev/erp
3.0 KiB
3.0 KiB
SalesItem 修改与删除 API 文档
本文档说明 SalesItem 销售品的修改与软删除接口。
修改接口
接口信息
- URL:
/api/v1/shipment/sales-items/{id}/ - Method:
PATCH - 认证: 需要登录(JWT Token)
说明:
- 该接口仅允许修改部分非关系字段
- 当前允许修改的字段只有:
quantityremarkposition
- 不允许修改
name、unit、shipment、customer_id、printing_job_id等字段 - 成功修改后会自动写入
SalesItemChangeRecord
请求体示例
{
"quantity": "120.50",
"remark": "补充备注",
"position": "A3-02"
}
成功响应示例
{
"id": 15,
"name": "测试销售品",
"quantity": "120.50",
"unit": 1,
"unit_display": "米",
"position": "A3-02",
"remark": "补充备注",
"printing_job_id": 123,
"printing_order_id": 45,
"external_order_id": "EXT-2026-001",
"customer_id": 8,
"customer_name": "客户A",
"shipment_id": null,
"shipment_date": null,
"created_at": "2026-04-06T10:00:00+08:00",
"created_by_id": 3,
"created_by_name": "测试员工",
"product_image_url": null
}
修改审计记录
每次成功修改时,会新增一条 SalesItemChangeRecord,记录:
sales_itemoperatoroperated_atbefore_valuesafter_values
错误响应示例
1. 传入了不允许修改的字段
{
"detail": "销售品仅允许修改以下字段: position, quantity, remark;不支持字段: customer_id, name"
}
2. 数量格式非法
{
"detail": "数量 abc 格式无效: [具体异常信息]"
}
3. 对象不存在或无权访问
{
"detail": "Not found."
}
删除接口
接口信息
- URL:
/api/v1/shipment/sales-items/{id}/ - Method:
DELETE - 认证: 需要登录(JWT Token)
说明:
- 该接口为软删除,不会物理删除数据库记录
- 删除后销售品会从常规查询接口中隐藏
- 删除操作需要独立 Django 权限:
shipment.soft_delete_salesitem
软删除字段
SalesItem 通过以下字段记录删除信息:
delete_at: 删除时间delete_by: 删除人
权限要求
调用方需要具备:
shipment.soft_delete_salesitem
无该权限时返回 403 Forbidden。
请求示例
DELETE /api/v1/shipment/sales-items/15/
Authorization: Bearer <token>
成功响应
{
"detail": "销售品已标记为删除"
}
行为说明
- 软删除后,
SalesItem不再出现在以下常规接口结果中:- 销售品详情
- 按客户查询销售品
- 按生产订单查询销售品
- 未出货销售品客户反查
- 出货单详情 / 列表中的嵌套销售品
- 重复删除当前实现保持幂等;由于对象在常规查询中已隐藏,后续再次调用通常会得到
404
错误响应示例
1. 无权限
{
"detail": "没有权限删除销售品"
}
2. 对象不存在或无权访问
{
"detail": "Not found."
}