GET 销售发货单详情

GET 查询。query 参数：id（发货单ID，必填）。

接口编码	所需范围	后端接口
`sales.shipment.detail`	`sales:read`	`GET /v1/sales-shipment/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.shipment.detail",
    "query": {
      "id": "1961000000000000001"
    }
  }'

响应 data 字段

字段	类型	必填	说明
`id`	integer(int64)	—	ID
`shipmentNo`	string	—	发货单号
`bizType`	string	—	业务类型：SALES=销售, EXCHANGE=换货补发, GOODWILL=Goodwill
`salesReturnId`	integer(int64)	—	销售退货ID
`salesReturnNo`	string	—	销售退货编号
`goodwillOrderId`	integer(int64)	—	—
`contractId`	integer(int64)	—	合同ID
`contractNo`	string	—	合同编号
`orderId`	integer(int64)	—	订单ID
`orderNo`	string	—	销售订单号
`customerOrderNo`	string	—	客户单号（多订单逗号分隔）
`customerId`	integer(int64)	—	客户ID
`customerName`	string	—	客户名称
`project`	string	—	项目
`operatorId`	integer(int64)	—	操作人ID
`operatorName`	string	—	操作人名称
`receiver`	string	—	收货人
`receiverPhone`	string	—	收货人电话
`receiverAddress`	string	—	收货地址
`totalQty`	number	—	总数量
`shippedQty`	number	—	已发货数量
`status`	string	—	状态：PENDING=待发货, PARTIAL=部分发货, SHIPPED=已发货, CLOSED=已关闭
`shipDate`	string(date-time)	—	发货日期
`amount`	number	—	金额
`remark`	string	—	备注
`createTime`	string(date-time)	—	创建时间
`customFieldValues`	object	—	销售发货单表单自定义字段值
`items`40	ShipmentItemVO[]	—	发货单物料明细（计划级，按产品维度；扁平，兼容旧前端）
`orderGroups`12	ShipmentOrderGroupVO[]	—	按销售订单分组的明细（多订单合并发货时使用；单订单时也会返回一个分组）. /
`outboundItems`45	OutboundItemVO[]	—	出库明细（全量扁平，兼容旧前端：多张出库单的明细合并） /
`outboundGroups`13	ShipmentOutboundGroupVO[]	—	按出库单分组的明细（推荐）

错误处理

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

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

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

← 返回发货单

错误处理​

错误处理