API ฉลากคืนสินค้า สำหรับระบบ production
สร้าง return labels จาก structured backend data โดยไม่ใช้ browser. gPdf ทำ PDF rendering และระบบของคุณดูแล business rules.
/api/v1/pdf/render สร้าง return labels เป็น PDF ที่ทำซ้ำได้จาก structured data. gPdf render document ส่วน data semantics และ workflow state อยู่ในระบบของคุณ.
ควรใช้ API นี้เมื่อใด
- Backend มีข้อมูล return labels อยู่แล้วและต้องการ PDF response ที่เสถียร.
- ต้องการหลีกเลี่ยง Chromium หรือ HTML-to-PDF สำหรับ operational document.
- ต้องการ output ที่ repeat ได้สำหรับ reprint, audit หรือ batch.
สิ่งที่ไม่ได้ทดแทน
- gPdf ไม่ซื้อค่าส่ง ไม่ยื่นภาษี ไม่สร้าง order ภายนอก และไม่ใช่ fiscal system.
- ไม่แทนที่ data validation, business rules หรือ marketplace integrations.
ควรเรียก endpoint ใด
/api/v1/pdf/render
JSON Render คือ path หลักสำหรับ workflow นี้.
/api/v1/template-render
ใช้เมื่อ workflow ต้องการ API path ที่เกี่ยวข้อง template contract หรือ capabilities lookup.
Minimal request
/api/v1/pdf/render - return labels
{
"pages": [
{
"size": "label_4_6_in",
"elements": [
{
"type": "text",
"x": 5,
"y": 8,
"content": "RETURN TO",
"style": { "font_size": 9, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 5,
"y": 18,
"content": "Acme Returns\n500 Dock Door 4\nColumbus OH 43215",
"style": { "font_size": 11, "font_family": "NotoSans-Regular" }
},
{
"type": "barcode",
"format": "code128",
"content": "RMA-2026-77881",
"x": 5,
"y": 70,
"width": 88,
"height": 20,
"barcode_text": { "enabled": true, "position": "bottom" }
}
]
}
]
}
gPdf จัดการอะไร
- PDF rendering ของ return labels จาก structured request.
- Text, tables, lines, barcodes, pages, metadata และ output options ตาม request.
- Deterministic output สำหรับ retry, reprint และ audit.
ระบบของคุณรับผิดชอบอะไร
- ข้อมูล return labels ที่ถูกต้อง, business rules และ operation state.
- Authentication, storage, external workflows และ receiver validation.
Production checklist
- ทดสอบด้วย real data และ systems ที่จะ consume PDF.
- เก็บ request IDs และ validation evidence สำหรับ support, audit และ reprint.
- เปลี่ยน approved layout เป็น template เมื่อหลาย systems ต้อง reuse.
ขอบเขตของ claim
- gPdf render label PDF แต่ไม่ซื้อ postage ไม่สร้าง shipment และไม่ certify carrier.
- Payload, printer, label stock, routing และ scan testing อยู่ในระบบของคุณ.
API shape
API ฉลากคืนสินค้า คือ production workflow บน public gPdf APIs. Request ระบุ data, layout, settings และ PDF parts ที่ต้อง render. gPdf สร้าง PDF ส่วนความหมายของ business event อยู่ในระบบของคุณ.
Endpoint choice
Default endpoint ของ workflow นี้คือ /api/v1/pdf/render. ใช้ Template Render เมื่อ layout approve แล้วและ reuse หลายระบบ. ใช้ E-Invoice Render เฉพาะเมื่อจำเป็นต้องมี Factur-X / ZUGFeRD PDF/A-3b packaging พร้อม EN 16931 CII XML embedded.
Validation ก่อน production
Validate return labels ด้วย real data และ downstream systems. เก็บ request IDs, rendered output และ validation evidence สำหรับ support, audit และ reprint.
FAQ
- นี่คือ endpoint แยกหรือไม่
- API ฉลากคืนสินค้า map workflow ไปยัง public gPdf API path. หน้านี้บอก path ที่ต้อง call และสิ่งที่ request ต้องรับผิดชอบ.
- ใช้ templates ได้ไหม
- ได้. ใช้ JSON Render เมื่อ layout ยังเปลี่ยนอยู่ และใช้ Template Render เมื่อ layout approve แล้วและ callers ส่งเฉพาะ business data.
- ก่อน production ต้อง validate อะไร
- Validate ด้วย real data และ printer, scanner, validator, accounting system หรือ marketplace receiver ตาม workflow.