Logistics and labels
面向面单、装箱单和仓库文档的物流 PDF API
基于 WMS、OMS 和 3PL 数据生成结构化物流 PDF,包括面单、装箱单、运单、清单和仓库文档。
主 API JSON Render
ENDPOINT
/api/v1/pdf/render 适用系统 WMS / OMS / 3PL 后端 / 承运商运营
要解决的问题
基于结构化 WMS、OMS、3PL 和履约数据渲染运营类物流文档,同时把承运商交易、发货路由、仓库状态和业务规则留在调用方系统中。
什么时候用这个 API
- 你需要为面单、装箱单、货运清单、运单或仓库纸质单据生成 PDF。
- 你的物流系统已经知道发货、订单、库存、路由和承运商数据。
- 你需要可确定的重打和高并发 API 渲染。
- 你需要一个覆盖面较广的入口页,把用户导向更具体的标签和仓库流程。
它不替代什么
- 你需要 gPdf 询价、购买邮资或直接调用承运商。
- 你需要 WMS、OMS、TMS 或库存管理功能。
- 你需要 PDF 生成之外的原生 EDI、报关或货代流程。
应该调用哪个 endpoint
/api/v1/pdf/render
JSON Render 是这个场景的默认调用路径。
/api/v1/template-render
当流程需要相关 API、模板契约或能力查询时再使用。
最小请求示例
POST /api/v1/template-render - 基于结构化数据生成复用物流文档。
{
"template_id": "packing_list",
"data": [
{
"order_number": "SO-8421",
"warehouse": "LAX-01",
"ship_to": "Example Retailer, 88 Harbor Rd, Long Beach, CA",
"items": [
{ "sku": "CASE-001", "description": "Widget case", "quantity": 4 },
{ "sku": "CASE-002", "description": "Replacement kit", "quantity": 1 }
]
}
]
}
gPdf 负责什么
- 为结构化物流文档渲染 PDF。
- 处理标签尺寸页面、A4/letter 文档、条码、表格、地址块和元数据。
- 为已批准的仓库和履约文档版式提供 Template Render。
- 为重打和审计记录提供确定性输出。
你的系统负责什么
- 发货状态、承运商服务、路由规则、库存状态和文档生成资格。
- 来自 WMS、OMS、TMS、ERP 或 3PL 系统的业务数据映射。
- 打印机路由、存储、交付、重试逻辑和运营异常处理。
上线前检查
- 决定哪些文档直接使用 JSON Render,哪些使用模板。
- 为每类文档验证条码、地址和表格溢出场景。
- 按重打和审计要求保存源数据或 PDF。
- 把承运商 API 调用和 render API 调用拆成独立集成步骤。
- 链接到更细的快递面单和仓库标签页面,不要重复其内容。
能力边界
- gPdf 生成物流 PDF;它不是承运商、WMS、OMS、TMS 或邮资提供方。
- 运费询价、面单购买、库存状态和承运商运营都在 gPdf 之外。
- 这个宽泛页面应链接到更具体的 solution 页面,以匹配精确工作流意图。
物流文档是一组相关场景
物流 PDF 生成覆盖多种文档类型:快递面单、仓库标签、装箱单、货运清单、运单、拣货单和内部交接单。这个页面是宽入口。具体的标签和重条码工作流应由更窄的页面承接搜索意图。
API 使用模式
大多数物流文档使用 JSON Render 或 Template Render。JSON Render 适合程序生成的版式或特殊文档。Template Render 适合运营团队期望稳定版式和少量数据字段的复用文档。
让运营系统保持权威
你的 WMS、OMS、TMS、3PL 平台、ERP 或承运商集成仍然是发货状态和业务规则的事实来源。gPdf 接收最终文档数据并生成 PDF 输出。
常见问题
- 这个页面和快递面单页面不同吗?
- 不同。这里是宽泛的物流文档页面。快递面单和仓库标签有更窄的页面,提供更具体的标签和条码说明。
- gPdf 会调用承运商吗?
- 不会。你的物流系统负责承运商 API、邮资、运费询价和路由。gPdf 根据收到的数据渲染 PDF。
- 物流文档适合哪个 endpoint?
- 自定义版式使用 JSON Render;已批准的复用文档,例如装箱单或仓库标签,使用 Template Render。
- 物流页面可以包含条码吗?
- 可以。gPdf 在 PDF 中渲染条码元素,但编码 payload 和运营验证由你的系统负责。