Skip to content
ShipEdge Core Logo ShipEdge Core Documentation

Custom Templates

Custom Templates lets you create and edit custom packing list templates for each OMS account. With this tool you can completely customize the appearance, layout, and content of packing slips generated for your orders, adapting them to your specific brand and format needs.

This functionality is available when the Custom Templates module is activated in the system configuration. Each OMS account can have its own custom template that will be used when generating packing lists for its orders.

Why use Custom Templates?

Section titled “Why use Custom Templates?”

Brand Customization

Create packing lists that reflect your brand and style, including logos, colors, and custom design for a professional experience.

Full Design Control

Completely control the design, layout, and content of your packing lists using an intuitive visual editor with real-time preview.

Templates per Account

Each OMS account can have its own custom template, allowing different designs for different brands or clients.

Dynamic Variables

Use dynamic variables to automatically insert order information, products, addresses, and more into your templates.

Real-Time Preview

See how your packing list will look before saving it using sample data from real orders to ensure the design is perfect.

PDF Generation

Custom templates are automatically used to generate professional PDF packing lists when you process orders.

Access Custom Templates

Section titled “Access Custom Templates”

  1. Verify Activation

    Make sure the Custom Templates module is activated in the system configuration. If it’s not activated, this option won’t appear in the menu.

  2. Navigate to Billing Menu

    From the main warehouse menu, go to Billing.

  3. Select Custom Templates

    In the Billing dropdown menu, click “Custom Templates”.

  4. View OMS Account List

    The “Oms List” page will open showing a table with all available OMS accounts to edit their templates.

How to use Custom Templates

Section titled “How to use Custom Templates”

  1. View the OMS account list

    The page shows a table with all active OMS accounts. Columns include:

    • Id: OMS account ID
    • Oms: Company name of the OMS account
    • Actions: Button to edit the template

  2. Search for a specific account

    Use the search field in the Oms column to filter accounts by company name. Press Enter or wait for the filter to apply automatically.

  3. Export the list

    Use the export buttons at the top to download the list:

    • CSV: Export to CSV format
    • Excel: Export to Excel format
    • PDF: Export to PDF (landscape orientation, Legal size)

  4. Open the template editor

    Click the “Edit PackingList” button (with pencil icon) in the row of the OMS account you want to edit.

  5. Use the visual editor

    A modal will open with the template editor that includes:

    • Code editor: Main area where you can edit the HTML/CSS/Twig template code
    • Preview: Shows how the packing list will look with sample data
    • Available variables: List of variables you can use in the template
    • Save controls: Buttons to save and cancel changes

  6. Edit the template

    Modify the template code according to your needs:

    • Use HTML for structure
    • Use CSS for styling and design
    • Use Twig variables (e.g., {{ orderId }}, {{ order }}) to insert dynamic data
    • Include logos and images as needed

  7. View preview

    Use the preview function to see how the packing list will look with real data before saving.

  8. Save the template

    Click the save button to save changes. The template will be associated with the selected OMS account and will be used to generate all future packing lists for that account.

  9. Adjust dimensions and DPI

    If necessary, adjust page dimensions and resolution (DPI) to optimize print quality of the generated PDF.

Available Variables in Templates

Section titled “Available Variables in Templates”

Templates use the Twig template system and have access to multiple variables containing order information:

Main Variables

Section titled “Main Variables”
  • orderId: Order ID
  • order: Complete object with all order information
  • detail: List of products/order details
  • shipmentNumber: Shipment number
  • barCode: Barcode in base64 format
  • merchantCompany: Merchant company name
  • orderLogo: Order logo (if available)

Shipping Information

Section titled “Shipping Information”
  • Destination address information
  • Origin address information
  • Shipping method
  • Carrier information

Product Information

Section titled “Product Information”
  • SKU of each product
  • Description
  • Quantity
  • Price
  • Weight and dimensions

Editor Features

Section titled “Editor Features”

Visual Editor

Section titled “Visual Editor”

The editor includes:

  • Syntax highlighting: Code is automatically highlighted for easier reading
  • Autocomplete: Suggestions for available variables and functions
  • Real-time preview: See changes while editing
  • HTML/CSS support: Edit HTML and CSS code directly
  • Twig support: Use Twig syntax for variables and logic

Design Features

Section titled “Design Features”
  • Customizable dimensions: Adjust page size according to your needs
  • Configurable DPI: Control the resolution of the generated PDF
  • Multiple pages: Support for multi-page packing lists
  • Images and logos: Include images, logos, and barcodes
  • Custom styles: Apply any CSS styles you need

Data Export

Section titled “Data Export”

You can export the OMS account list in different formats:

  • CSV: For spreadsheet analysis
  • Excel: For advanced analysis with formulas
  • PDF: For documentation and printing (landscape orientation, Legal size)
Section titled “Pagination and Search”
Section titled “Search”
  • Search by name: Enter text in the search field of the Oms column to filter accounts
  • Instant search: Results filter automatically as you type
  • Clear search: Click the X in the search field to clear the filter

Pagination

Section titled “Pagination”

The table shows paginated records with options for:

  • 10 records per page
  • 20 records per page
  • 50 records per page
  • 100 records per page
  • 150 records per page
  • 200 records per page
  • 500 records per page
  • 1000 records per page

💡 Best Practices

Section titled “💡 Best Practices”

Use Variables Correctly

Familiarize yourself with available variables before creating your template. Use variable documentation to ensure you use the correct names.

Test with Real Data

Use the preview with sample data from real orders to ensure all elements display correctly before saving.

Optimize for Printing

Consider how the packing list will look when printed. Adjust dimensions, margins, and font sizes for optimal printing.

Keep Designs Simple

Although you can create complex designs, simple and clear designs are easier to maintain and work better in different page sizes.

Include Essential Information

Make sure to include all essential information: order number, destination address, product list, and barcode if necessary.

Save Backup Versions

Before making major changes, consider saving a copy of the current template so you can restore it if needed.

Troubleshooting

Section titled “Troubleshooting”

I don’t see the Custom Templates option in the menu

Section titled “I don’t see the Custom Templates option in the menu”
  • Verify activation: The Custom Templates module must be activated in the system configuration (custom_templates = 'Y')
  • Verify permissions: Make sure you have Warehouse Billing permissions
  • User level: Some functions may require administrator level (level 3)
  • Contact administrator: If the module is not activated, contact the system administrator

The editor doesn’t open

Section titled “The editor doesn’t open”
  • Verify JavaScript: Make sure JavaScript is enabled in your browser
  • Content blockers: Disable content blockers that may interfere with the modal
  • Reload page: Try reloading the page and opening the editor again
  • Verify permissions: Make sure you have permissions to edit templates

Changes don’t save

Section titled “Changes don’t save”
  • Verify connection: Make sure you have a stable internet connection
  • Check errors: Verify if there are error messages in the browser console
  • Code format: Make sure the template code has valid format
  • Reload and retry: Reload the page and try saving again

Preview doesn’t show data

Section titled “Preview doesn’t show data”
  • Sample data: The system needs sample order data to show the preview
  • Incorrect variables: Verify that you’re using the correct variable names
  • Twig syntax: Make sure to use correct Twig syntax for variables
  • Reload preview: Try reloading the preview after making changes

Generated PDF doesn’t look good

Section titled “Generated PDF doesn’t look good”
  • Dimensions: Adjust page dimensions in the template configuration
  • DPI: Increase DPI for better print quality
  • Margins: Adjust margins to prevent content from being cut off
  • Font size: Make sure font sizes are readable when printed

I can’t find a specific OMS account

Section titled “I can’t find a specific OMS account”
  • Use search: Use the search field in the Oms column to filter by name
  • Verify filters: Make sure there are no active filters hiding the account
  • Pagination: Navigate between pages if there are many accounts
  • Account status: Verify that the account is active and has active users
Section titled “Related”