跳到主要内容

POST 提交备件申请

POST 为服务工单提交备件申请,落「待审批」并发起审批流,批准后分批出库。body 为 JSON:必填 orderId(服务工单ID,工单须可写)、warrantyMode(费用属性,如 保内免费/保外收费/保外免费/待确认/合同覆盖)、lines(明细数组,至少1行,每行必填 productId、productName、qty(>0);可选 productNo、model、unitName、unitPrice(>=0,保外收费时填写)、warehouseId(建议仓库)、remark、sortOrder);可选 warehouseId(来源仓库,可留给出库人员确定)、warehouseName、reason(申请原因)、expectedUseTime、note。

接口编码所需范围后端接口
sales.service-part-request.createsales:writePOST /v1/service-orders/part-request/create(comap-sales)

必填字段

字段依据
orderId参数说明、接口规格
warrantyMode参数说明
lines参数说明、接口规格
lines[].productId参数说明、接口规格
lines[].productName参数说明、接口规格
lines[].qty参数说明、接口规格

条件必填(如「某状态时必填」)不在此表,以上方参数说明为准。 判定规则见必填字段的判定。

请求体字段(body)

字段类型必填说明
orderIdinteger(int64)是服务工单ID
warehouseIdinteger(int64)—兼容旧数据的整单来源仓库ID;新申请使用明细行建议仓库,可为空
warehouseNamestring—来源仓库名称(快照)
warrantyModestring—费用属性:保内免费/保外收费/保外免费
reasonstring—申请原因
expectedUseTimestring(date-time)—预计使用时间
notestring—说明
lines14ServicePartRequestLineDTO[]是备件明细

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

请求示例

curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.service-part-request.create",
"body": {
"orderId": "1961000000000000001",
"lines": []
}
}'

响应 data 字段

字段类型必填说明
idinteger(int64)—申请ID
requestNostring—申请编号
orderIdinteger(int64)—服务工单ID
orderNostring—服务工单号(快照)
warehouseNamestring—来源仓库名称
warrantyModestring—费用属性:保内免费/保外收费/保外免费
totalAmountnumber—申请金额(含税)
statusstring—状态:待审批/已批准/已发货/已驳回/已取消
aggStatusstring—派生聚合状态,见 ServicePartAggStatusEnum
outboundStatusstring—关联出库单状态快照:草稿/已出库/已作废
outboundIdinteger(int64)—关联库存出库单ID
outboundNostring—关联库存出库单号
requestedBystring—申请人
requestedAtstring(date-time)—申请时间
createTimestring(date-time)—创建时间
customerIdinteger(int64)—客户ID
customerNamestring—客户名称
orderTitlestring—服务工单标题
assigneeIdinteger(int64)—执行工程师ID
assigneestring—执行工程师
requestedByIdinteger(int64)—申请人ID
warehouseIdinteger(int64)—来源仓库ID
reasonstring—申请原因
expectedUseTimestring(date-time)—预计使用时间
notestring—说明
flowInstanceCodestring—审批流程实例编码
approverstring—审批人
approvedAtstring(date-time)—审批时间
rejectReasonstring—驳回原因
deliveryMethodstring—物流方式
trackingNostring—物流单号
shippedBystring—发货人
shippedAtstring(date-time)—发货时间
shipNotestring—发货备注
inboundIdinteger(int64)—退库入库单ID
inboundNostring—退库入库单号
returnReasonstring—退库原因
returnedBystring—退库操作人
returnedAtstring(date-time)—退库时间
lines25ServicePartRequestLineVO[]—备件明细
shipments14ServicePartShipmentVO[]—出库批次台账(分批出库/收货)
receipts11ServicePartReceiptVO[]—收货台账(同一出库批次可多次收货)
usages7ServicePartUsageVO[]—使用台账
returns12ServicePartReturnVO[]—退库单台账(退库/验收/撤销)
disposals13ServicePartDisposalVO[]—异常处置台账(申请/审批)
operations6ServiceTimelineVO[]—备件工单操作记录
appliedQtynumber—核定申请总量
shippedQtynumber—累计已发总量
terminatedQtynumber—累计已终止总量
receivedQtynumber—累计已收总量
usedQtynumber—累计已用总量
returnPendingQtynumber—待验收退库总量
returnedQtynumber—累计已退库总量
disposePendingQtynumber—待审批处置总量
disposedQtynumber—累计已处置总量
unreconciledQtynumber—未核销总量
versioninteger(int32)—乐观锁版本,编辑时需原样回传

错误处理​

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

错误码说明可重试
92101访问凭证无效否
92201接口未登记或已停用否
92202超出凭证授权范围——本接口需 sales:write否
92204绑定员工无此接口的功能权限否
92203上游服务调用失败先查询处理结果,禁止盲目重试
92301请求过于频繁是
92205写操作处理超时,结果未知(下游可能仍在执行)否,先查询确认结果
92302有参数相同的写请求正在处理中等待并确认前一次结果,勿重复提交

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

← 返回service-part-request