跳到主要内容

GET 销售订单详情

GET 查询。query 参数:id(订单ID,必填)。

接口编码所需范围后端接口
sales.order.detailsales:readGET /v1/sales-order/detail(comap-sales)

请求参数(query)

字段类型必填说明
idinteger(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 字段

字段类型必填说明
idinteger(int64)—ID
versioninteger(int32)—乐观锁版本号
orderNostring—销售订单号
copiedFromIdinteger(int64)—复制来源销售订单 ID
copiedFromOrderNostring—复制来源销售订单编号
copiedOrders2OrderCopyRelationVO[]—由当前订单复制生成且当前用户可见的订单
customerOrderNostring—客户单号
orderNamestring—订单名称
contractIdinteger(int64)—合同ID
contractNostring—合同编号
customerIdinteger(int64)—客户ID
customerNamestring—客户名称
companyBankAccountIdinteger(int64)—公司资金账户ID
companyBankAccountNostring—公司银行账号
companyBankNamestring—公司开户行
projectIdinteger(int64)—项目ID
projectNamestring—项目名称
orderTypestring—订单类型:PTS=按库存销售, PTO=按订单采购, PTM=按单生产
prioritystring—优先级
totalAmountnumber—当前有效订单总额(存在订单优惠时为优惠后金额)
originalTotalAmountnumber—优惠前订单总额
orderDiscountAmountnumber—已生效订单优惠累计金额
finalAmountnumber—优惠后当前有效金额
baseAmountnumber—退换货冲减前的基础销售额(优惠后、退换货前),永久保留只读
returnedAmountnumber—已退货金额(实物退货事实,仅独立展示,不与退款额相加)
refundedAmountnumber—已退款金额(财务退款事实,仅独立展示,不与退货额相加)
returnAdjustmentAmountnumber—退换货销售冲减累计(有符号,冲减为负)
adjustedAmountnumber—退换货调整后净销售额 = 基础销售额 + 退换货冲减;详情主金额口径
returnAdjustmentStatusstring—订单退换货调整状态:NONE-无调整 ADJUSTED-已调整 RESTORED-已恢复
netReceivedAmountnumber—净回款 = 有效收款 - 已完成现金退款,下限 0
invoicedAmountnumber—已开票金额
invoiceWaivedinteger(int32)—是否无需开票:0否,1是
paidAmountnumber—已付金额
submittedPaymentAmountnumber—已提交付款金额
submittedInvoiceAmountnumber—已提交开票金额
deliveredRatenumber—交付率
expectedDatestring(date-time)—预计交付日期
paymentTermstring—付款条件
paymentTermIdinteger(int64)—付款条件ID
paymentTermNamestring—付款条件名称
payTypeIdinteger(int64)—付款方式ID(关联 t_fin_pay_type)
payTypeNamestring—付款方式名称(快照)
startNodestring—起算节点(快照)
calcMethodstring—计算方式(快照)
creditDaysinteger(int32)—账期天数(快照)
reminderEnabledinteger(int32)—是否启用到期提醒(快照):0-否 1-是
reminderDaysinteger(int32)—提前提醒天数(快照)
salesDeptIdinteger(int64)—销售部门ID
salesDeptNamestring—业务部门名称
operatorIdinteger(int64)—操作人ID
operatorNamestring—操作人名称
ownerIdinteger(int64)—负责人ID
ownerNamestring—负责人名称
ownerAvatarstring—负责人头像
ownerPhonestring—负责人手机号
collaborators4OrderCollaboratorVO[]—订单协同销售
contactNamestring—联系人姓名
contactPhonestring—联系人电话
shippingAddressstring—收货地址
warehouseIdinteger(int64)—仓库ID
warehouseNamestring—仓库名称
statusinteger(int32)—状态:0=草稿, 1=待审批, 2=已审批, 3=已驳回, 4=已取消
bizStatusstring—业务状态:DRAFT=草稿, EXECUTING=执行中, PRODUCING=生产中, PENDING_SHIP=待发货, COMPLETED=已完成, CLOSED=已关闭
useCreditinteger(int32)—使用信用
needApprovalinteger(int32)—是否需要审批(0 否 1 是)
remarkstring—备注
specialPriceApplicationIdinteger(int64)—关联特价申请ID
specialPriceApplicationNostring—关联特价申请编号
recommendSupplierIdinteger(int64)—整单建议供应商ID(引用 srm t_supplier.id)
recommendSupplierNamestring—整单建议供应商名称(冗余快照)
createTimestring(date-time)—创建时间
items70OrderItemVO[]—订单明细行
shipments36ShipmentPageVO[]—发货记录
timelines5OrderTimelineVO[]—操作日志
paymentRecords11PaymentRecordVO[]—回款记录
flowInstanceCodestring—审批流实例编号
approvalHistoryInstanceCodestring—审批历史查询实例编号,不代表当前有效审批实例
approvalHistory10ApprovalHistoryVO[]—审批历史
customerChargeUserNamestring—客户销售负责人姓名
customerChargeUserDeptNamestring—客户销售负责人部门
customerChargeUserPhonestring—客户销售负责人手机号
shipmentBuildStatusstring—发货单创建状态(NONE-未建单 PARTIAL-部分建单 FULL-已建单)
hasDirectOutboundboolean—是否已生成销售直接出库业务单
customFieldValuesobject—字段平台自定义字段值

错误处理​

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

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

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

← 返回销售订单