自定义字段
最后更新 2026-10-19
给单据加自己的属性——表头级或明细行级都行。在 Settings → Custom Fields 里定义一次,对应表单自动出现。
每家业务都有标准字段装不下的属性:订单上的销售渠道标记、每条收货明细的质检点、每条订单行的客户参考号。自定义字段让每个租户不用改代码就能加上这些属性。分两级:表头字段(整单一个值)、行字段(每个明细行一个值)。
表头还是行:选哪一级#
- 表头字段:整单一个值(如订单的销售渠道、入库单的月台门)。在表头 entity 上定义,建单表单里填。
- 行字段:每个明细行一个值(如每条订单行的客户参考号、每条收货明细的质检结果)。在行 entity 上定义,明细行编辑表单里填。
- 经验法则:值可能逐行不同 → 行字段;描述整单 → 表头字段。
定义字段#
- 去该单据所属系统的 Settings → Custom Fields(WMS、OMS、YMS、TMS、Purchase、Drayage、RMS、Tickets、Accounting、CRM、LastMile、Assets 的设置菜单里现在都有这个入口)。
- 从下拉里选 entity——表头 entity(如出库单)和行 entity(如出库单行)分开列出。
- 新增字段(名称、类型、是否必填)。立即生效:对应的单据表单(或明细行编辑表单)里出现新的输入框。
行级 entity 一览#
8 种单据支持行级自定义字段——在行 entity 上定义,逐行填写:
- 销售订单行(OMS)
- 出库单行(WMS)
- 入库单行(WMS)
- 采购单行
- RMA 明细行(RMS)
- 包裹明细行(WMS 打包)
- 装车单行——装车单的成员运单(WMS)
- TMS 并单
建单/改单时,值会按启用中的定义校验:新建时未知 key 直接丢弃,非法值会被打回(API 返回 400 并点名是哪个字段)。