1. Templates
  2. Template Overview

Templates

Template Overview

Templates let you define labels for items, assets, shipments, and parcels. You can create reusable templates for consistent labeling across your organization, or generate custom PDFs with raw element definitions for maximum flexibility.

Endpoints

Endpoint Method Description Scope Required
/v1/templates POST Create a new template templates:write
/v1/templates GET List all templates templates:read
/v1/templates/:template_id GET Retrieve a specific template templates:read
/v1/templates/:template_id POST Update a template templates:write
/v1/templates/:template_id DELETE Delete a template templates:write
/v1/templates/pdf/generate POST Generate a custom PDF with raw elements templates:write

Template Types

Templates are organized by the type of resource they label:

Type Description
shipment__shipping_label_pdf Shipping labels with tracking info
item__item_label_pdf Inventory item labels with SKU/barcode
asset__asset_label_pdf Asset tags with serial numbers
parcel__parcel_label_pdf Parcel labels for packages

PDF Generation

The /v1/templates/pdf/generate endpoint allows you to create custom PDFs with precise control over element positioning. This is ideal for:

  • Custom shipping labels - With specific branding and layouts
  • Asset tags - With barcodes and serial numbers
  • Inventory bin labels - For warehouse organization
  • Product labels - With QR codes linking to product info

Supported Elements

Element Description
text Text with font families (Inter, Fira Mono) and weights
code128 Linear barcodes for tracking numbers and SKUs
qr QR codes for URLs, text, or data encoding
matrix DataMatrix codes for compact 2D encoding
line Horizontal or angled line separators

Supported Page Sizes

Size Dimensions Common Use Case
A4 595 x 842 points Standard documents
letter 612 x 792 points US Letter documents
4x6 288 x 432 points Shipping labels
a6 298 x 420 points Small labels
custom User-defined Any custom dimensions

See the PDF Generate page for detailed documentation with examples.

Limits

  • Maximum 25 templates per type per location (or globally per organization)
  • Maximum 500 elements per PDF generation request
Previous <- Retrieve Manifest
Next Template Models ->