GET 按退货单ID查询关联出库单列表
GET 查询。参数与返回字段见接口参考。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
inventory.outbound.by-retreat | inventory:read | GET /v1/outbound-order/by-retreat(comap-srm) |
请求参数(query)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
retreatId | integer(int64) | 是 | — |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "inventory.outbound.by-retreat",
"query": {
"retreatId": "1961000000000000001"
}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(int64) | — | 主键ID |
no | string | — | 出库单号 |
category | integer(int32) | — | 出库大类:1=销售出库, 2=生产领料, 3=采购退货, 4=其他出库, 5=生产管理出库, 6=销售直接出库 |
status | integer(int32) | — | 出库单状态:0=草稿, 1=待出库, 2=已出库, 3=已作废, 4=已签收, 5=审批中, 6=已驳回 |
outboundDate | string | — | 出库日期 |
totalQty | number | — | 总数量 |
displayQty | number | — | 列表展示数量 |
displayUnitName | string | — | 列表展示单位 |
primaryQty | number | — | 主单位总数量 |
primaryUnitName | string | — | 主单位名称 |
mixedUnit | boolean | — | 是否混合单位 |
totalAmount | number | — | 总金额 |
remark | string | — | 备注 |
creatorName | string | — | 创建人名称 |
createTime | string | — | 创建时间 |
storeId | integer(int64) | — | ---- 仓库 ---- |
storeName | string | — | 仓库名称 |
locationId | integer(int64) | — | 库位ID |
customerId | integer(int64) | — | ---- 销售出库 ---- |
customerName | string | — | 客户名称快照 |
salesOrderNo | string | — | 销售订单号快照 |
customerOrderNo | string | — | 客户单号(销售出库,多订单逗号分隔) |
shipmentNo | string | — | 发货单号快照 |
salesDirectOutboundNo | string | — | 销售直接出库业务单号快照(category=6) |
contractNo | string | — | 合同号快照 |
salesOrderId | integer(int64) | — | 销售订单ID |
shipmentId | integer(int64) | — | 发货ID |
contractId | integer(int64) | — | 合同ID |
deliveryMethod | integer(int32) | — | 配送方式:1物流 2快递 3自提 4送货 |
carrier | string | — | carrier |
carrierPhone | string | — | carrierPhone |
carrierContact | string | — | 物流联系人 |
tracking | string | — | 物流跟踪 |
deliveryContactName | string | — | 交付联系人名称 |
deliveryContactPhone | string | — | 交付联系人phone |
productionOrderId | integer(int64) | — | ---- 生产领料 ---- |
productionOutboundNo | string | — | 生产出库编号 |
productionOutboundType | integer(int32) | — | 生产出库类型:1=组装出库,2=委外出库 |
productionOutboundTypeName | string | — | 生产出库类型名称,后端算好避免前端各自维护一份映射 |
productionRequisitionId | integer(int64) | — | 生产领料ID |
productionRequisitionNo | string | — | 生产领料编号 |
productionRequisitionType | integer(int32) | — | 生产出库类型:1=组装出库, 2=委外出库 |
productionRequisitionTypeName | string | — | 生产领料type名称 |
supplierId | integer(int64) | — | ---- 退供应商 ---- |
supplierName | string | — | 供应商名称 |
purchaseId | integer(int64) | — | 采购单ID |
returnReason | string | — | 退货原因 |
retreatId | integer(int64) | — | 退货单ID |
flowInstanceCode | string | — | 流程实例编号:SUPPLIER=供应商, CUSTOMER=客户 |
outboundType | string | — | 出库类型 |
relatedPartyType | string | — | 关联方类型 |
relatedPartyName | string | — | 关联方名称 |
reason | string | — | 原因 |
rrId | integer(int64) | — | 销售收入确认单 ID |
rrNo | string | — | 销售收入确认单编号 |
rrStatus | string | — | 销售收入确认单状态 DRAFT/PENDING/APPROVED/REJECTED/VOID |
sourceSystem | string | — | 来源系统:服务备件出库为 SERVICE |
serviceOrderId | integer(int64) | — | 服务工单ID |
serviceOrderNo | string | — | 服务工单编号快照 |
servicePartRequestId | integer(int64) | — | 备件工单ID |
servicePartRequestNo | string | — | 备件工单编号快照 |
serviceShipmentBatchId | integer(int64) | — | 出库批次ID(Sales 分批出库执行批次) |
serviceShipmentBatchNo | string | — | 出库批次编号快照 |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 inventory:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-srm 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回出库单