GET 销售订单详情
GET 查询。query 参数:id(订单ID,必填)。
| 接口编码 | 所需范围 | 后端接口 |
|---|---|---|
sales.order.detail | sales:read | GET /v1/sales-order/detail(comap-sales) |
请求参数(query)
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(int64) | 是 | — |
「必填」仅反映接口规格声明的部分。服务内还有未体现在规格里的校验, 标「—」不等于可以不传;租户在主站配置的字段必填不约束本接口。 详见必填字段的判定与字段清单与自定义字段。
请求示例
curl -X POST https://open.risemap.cn/v1/api/invoke \
-H "Authorization: Bearer <访问令牌>" \
-H "Content-Type: application/json" \
-d '{
"apiCode": "sales.order.detail",
"query": {
"id": "1961000000000000001"
}
}'
响应 data 字段
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
id | integer(int64) | — | ID |
version | integer(int32) | — | 乐观锁版本号 |
orderNo | string | — | 销售订单号 |
copiedFromId | integer(int64) | — | 复制来源销售订单 ID |
copiedFromOrderNo | string | — | 复制来源销售订单编号 |
copiedOrders2 | OrderCopyRelationVO[] | — | 由当前订单复制生成且当前用户可见的订单 |
customerOrderNo | string | — | 客户单号 |
orderName | string | — | 订单名称 |
contractId | integer(int64) | — | 合同ID |
contractNo | string | — | 合同编号 |
customerId | integer(int64) | — | 客户ID |
customerName | string | — | 客户名称 |
companyBankAccountId | integer(int64) | — | 公司资金账户ID |
companyBankAccountNo | string | — | 公司银行账号 |
companyBankName | string | — | 公司开户行 |
projectId | integer(int64) | — | 项目ID |
projectName | string | — | 项目名称 |
orderType | string | — | 订单类型:PTS=按库存销售, PTO=按订单采购, PTM=按单生产 |
priority | string | — | 优先级 |
totalAmount | number | — | 当前有效订单总额(存在订单优惠时为优惠后金额) |
originalTotalAmount | number | — | 优惠前订单总额 |
orderDiscountAmount | number | — | 已生效订单优惠累计金额 |
finalAmount | number | — | 优惠后当前有效金额 |
baseAmount | number | — | 退换货冲减前的基础销售额(优惠后、退换货前),永久保留只读 |
returnedAmount | number | — | 已退货金额(实物退货事实,仅独立展示,不与退款额相加) |
refundedAmount | number | — | 已退款金额(财务退款事实,仅独立展示,不与退货额相加) |
returnAdjustmentAmount | number | — | 退换货销售冲减累计(有符号,冲减为负) |
adjustedAmount | number | — | 退换货调整后净销售额 = 基础销售额 + 退换货冲减;详情主金额口径 |
returnAdjustmentStatus | string | — | 订单退换货调整状态:NONE-无调整 ADJUSTED-已调整 RESTORED-已恢复 |
netReceivedAmount | number | — | 净回款 = 有效收款 - 已完成现金退款,下限 0 |
invoicedAmount | number | — | 已开票金额 |
invoiceWaived | integer(int32) | — | 是否无需开票:0否,1是 |
paidAmount | number | — | 已付金额 |
submittedPaymentAmount | number | — | 已提交付款金额 |
submittedInvoiceAmount | number | — | 已提交开票金额 |
deliveredRate | number | — | 交付率 |
expectedDate | string(date-time) | — | 预计交付日期 |
paymentTerm | string | — | 付款条件 |
paymentTermId | integer(int64) | — | 付款条件ID |
paymentTermName | string | — | 付款条件名称 |
payTypeId | integer(int64) | — | 付款方式ID(关联 t_fin_pay_type) |
payTypeName | string | — | 付款方式名称(快照) |
startNode | string | — | 起算节点(快照) |
calcMethod | string | — | 计算方式(快照) |
creditDays | integer(int32) | — | 账期天数(快照) |
reminderEnabled | integer(int32) | — | 是否启用到期提醒(快照):0-否 1-是 |
reminderDays | integer(int32) | — | 提前提醒天数(快照) |
salesDeptId | integer(int64) | — | 销售部门ID |
salesDeptName | string | — | 业务部门名称 |
operatorId | integer(int64) | — | 操作人ID |
operatorName | string | — | 操作人名称 |
ownerId | integer(int64) | — | 负责人ID |
ownerName | string | — | 负责人名称 |
ownerAvatar | string | — | 负责人头像 |
ownerPhone | string | — | 负责人手机号 |
collaborators4 | OrderCollaboratorVO[] | — | 订单协同销售 |
contactName | string | — | 联系人姓名 |
contactPhone | string | — | 联系人电话 |
shippingAddress | string | — | 收货地址 |
warehouseId | integer(int64) | — | 仓库ID |
warehouseName | string | — | 仓库名称 |
status | integer(int32) | — | 状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消 |
bizStatus | string | — | 业务状态:DRAFT=草稿, EXECUTING=执行中, PRODUCING=生产中, PENDING_SHIP=待发货, COMPLETED=已完成, CLOSED=已关闭 |
useCredit | integer(int32) | — | 使用信用 |
needApproval | integer(int32) | — | 是否需要审批(0 否 1 是) |
remark | string | — | 备注 |
specialPriceApplicationId | integer(int64) | — | 关联特价申请ID |
specialPriceApplicationNo | string | — | 关联特价申请编号 |
recommendSupplierId | integer(int64) | — | 整单建议供应商ID(引用 srm t_supplier.id) |
recommendSupplierName | string | — | 整单建议供应商名称(冗余快照) |
createTime | string(date-time) | — | 创建时间 |
items70 | OrderItemVO[] | — | 订单明细行 |
shipments36 | ShipmentPageVO[] | — | 发货记录 |
timelines5 | OrderTimelineVO[] | — | 操作日志 |
paymentRecords11 | PaymentRecordVO[] | — | 回款记录 |
flowInstanceCode | string | — | 审批流实例编号 |
approvalHistoryInstanceCode | string | — | 审批历史查询实例编号,不代表当前有效审批实例 |
approvalHistory10 | ApprovalHistoryVO[] | — | 审批历史 |
customerChargeUserName | string | — | 客户销售负责人姓名 |
customerChargeUserDeptName | string | — | 客户销售负责人部门 |
customerChargeUserPhone | string | — | 客户销售负责人手机号 |
shipmentBuildStatus | string | — | 发货单创建状态(NONE-未建单 PARTIAL-部分建单 FULL-已建单) |
hasDirectOutbound | boolean | — | 是否已生成销售直接出库业务单 |
customFieldValues | object | — | 字段平台自定义字段值 |
错误处理
响应统一信封 { code, message, data },code == 200 为成功。以下是本接口可能返回的开放平台层错误:
| 错误码 | 说明 | 可重试 |
|---|---|---|
| 92101 | 访问凭证无效 | 否 |
| 92201 | 接口未登记或已停用 | 否 |
| 92202 | 超出凭证授权范围——本接口需 sales:read | 否 |
| 92204 | 绑定员工无此接口的功能权限 | 否 |
| 92203 | 上游服务调用失败 | 是 |
| 92301 | 请求过于频繁 | 是 |
除此之外,comap-sales 自身的业务校验失败会原样透传其业务码与提示
(如字段校验、状态不允许、数据不存在),这类码不在开放平台的号段内,
以响应里的 message 为准。完整的平台层错误码见错误码说明。
← 返回销售订单