跳到主要内容

GET 获取出库单详情

GET 查询详情。query 参数:id。

接口编码所需范围后端接口
inventory.outbound.detailinventory:readGET /v1/outbound-order/detail(comap-srm)

请求参数(query)

字段类型必填说明
idinteger(int64)是—

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

请求示例

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

响应 data 字段

字段类型必填说明
idinteger(int64)—主键ID
nostring—出库单号
categoryinteger(int32)—出库大类:1=销售出库, 2=生产领料, 3=采购退货, 4=其他出库, 5=生产管理出库, 6=销售直接出库
statusinteger(int32)—出库单状态:0=草稿, 1=待出库, 2=已出库, 3=已作废, 4=已签收, 5=审批中, 6=已驳回
outboundDatestring—出库日期
totalQtynumber—总数量
displayQtynumber—列表展示数量
displayUnitNamestring—列表展示单位
primaryQtynumber—主单位总数量
primaryUnitNamestring—主单位名称
mixedUnitboolean—是否混合单位
totalAmountnumber—总金额
remarkstring—备注
creatorNamestring—创建人名称
createTimestring—创建时间
storeIdinteger(int64)—---- 仓库 ----
storeNamestring—仓库名称
locationIdinteger(int64)—库位ID
customerIdinteger(int64)—---- 销售出库 ----
customerNamestring—客户名称快照
salesOrderNostring—销售订单号快照
customerOrderNostring—客户单号(销售出库,多订单逗号分隔)
shipmentNostring—发货单号快照
salesDirectOutboundNostring—销售直接出库业务单号快照(category=6)
contractNostring—合同号快照
salesOrderIdinteger(int64)—销售订单ID
shipmentIdinteger(int64)—发货ID
contractIdinteger(int64)—合同ID
deliveryMethodinteger(int32)—配送方式:1物流 2快递 3自提 4送货
carrierstring—carrier
carrierPhonestring—carrierPhone
carrierContactstring—物流联系人
trackingstring—物流跟踪
deliveryContactNamestring—交付联系人名称
deliveryContactPhonestring—交付联系人phone
productionOrderIdinteger(int64)—---- 生产领料 ----
productionOutboundNostring—生产出库编号
productionOutboundTypeinteger(int32)—生产出库类型:1=组装出库,2=委外出库
productionOutboundTypeNamestring—生产出库type名称
productionRequisitionIdinteger(int64)—生产领料ID
productionRequisitionNostring—生产领料编号
productionRequisitionTypeinteger(int32)—生产出库类型:1=组装出库, 2=委外出库
productionRequisitionTypeNamestring—生产领料type名称
supplierIdinteger(int64)—---- 退供应商 ----
supplierNamestring—供应商名称
purchaseIdinteger(int64)—采购单ID
returnReasonstring—退货原因
retreatIdinteger(int64)—退货单ID
flowInstanceCodestring—流程实例编号:SUPPLIER=供应商, CUSTOMER=客户
outboundTypestring—出库类型
relatedPartyTypestring—关联方类型
relatedPartyNamestring—关联方名称
reasonstring—原因
rrIdinteger(int64)—销售收入确认单 ID
rrNostring—销售收入确认单编号
rrStatusstring—销售收入确认单状态 DRAFT/PENDING/APPROVED/REJECTED/VOID
sourceSystemstring—来源系统:服务备件出库为 SERVICE
serviceOrderIdinteger(int64)—服务工单ID
serviceOrderNostring—服务工单编号快照
servicePartRequestIdinteger(int64)—备件工单ID
servicePartRequestNostring—备件工单编号快照
serviceShipmentBatchIdinteger(int64)—出库批次ID(Sales 分批出库执行批次)
serviceShipmentBatchNostring—出库批次编号快照
items49OutboundOrderItemVO[]—商品行
fileIdsinteger(int64)[]—附件文件ID
contactNamestring—主要联系人姓名
contactPhonestring—主要联系人电话
customerAddressstring—客户地址
retreatNostring—关联退货单号
purchaseNostring—关联采购订单号
timeline6TimelineItem[]—操作时间线
receiptUrlstring—H5 验收签字页链接
receiptFiles5OutboundReceiptFileVO[]—验收文件列表
receiptResultstring—签收到货结果
receiptSignerNamestring—签收人姓名
receiptRemarkstring—签收备注
receiptTimestring—签收时间
receiptSourcestring—签收来源:PC(PC端登录签收)/ H5(H5扫码签收)
receiptSignatureFileIdinteger(int64)—签收人手写签名文件 ID
comments5CommentItem[]—评论列表
rrLinks6RrLinkVO[]—关联的收入确认单列表(按订单维度)
projectIdinteger(int64)—关联项目 ID;关联多个项目时为空
projectNamestring—关联项目名称;多个项目使用顿号分隔
productionOrderNostring—关联生产单号
subcontractIssueIdinteger(int64)—委外出库专有:来源委外发料单 ID,供详情页跳转
subcontractIssueNostring—委外出库专有:来源委外发料单号
subcontractOrderIdinteger(int64)—委外出库专有:委外订单 ID,供详情页跳转
subcontractOrderNostring—委外出库专有:委外订单号
subcontractTargetStoreNamestring—委外出库专有:目标虚拟委外仓名称
productionQtyEditableboolean—生产出库单数量是否可编辑(对应领料单已无活动锁定时为 true;仅生产出库单计算)
productionDepartmentNamestring—生产领用部门名称
recipientNamestring—领用人或接收人名称
recipientPhonestring—领用人或接收人电话
destinationAddressstring—出库去向或退货地址
salesOrders11SalesOrderItem[]—关联销售订单列表
stageProgress5StageProgressItem[]—出库阶段进度
costCarryoverIdinteger(int64)—成本结转单 ID
costCarryoverNostring—成本结转单号
costCarryoverStatusstring—成本结转状态:DRAFT/PENDING/APPROVED/VOID/REVERSED
costCarryoverAmountnumber—已结转成本
grossMarginRatenumber—毛利率(%)
costCarryovers5CostCarryoverItem[]—关联成本结转列表;多订单场景完整返回
attachments6AttachmentItem[]—出库单附件列表

错误处理​

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

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

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

← 返回出库单