Zoey Support Center

Welcome to the brand new Zoey Support developer hub. We've completely revamped our Support Center to make it easier to find comprehensive guides and documentation to help you start working with Zoey as quickly as possible.

Guides    

Customize PDFs (Invoice, Packing Slip, Credit Memo)

Overview

PDFs such as Invoices, Packing Slips (Shipments), and Credit Memos can be "Printed" (downloaded) by the Admin and Customer. Zoey has multiple settings for customizing the information on the PDF documents.

Print Order view from the Customer's My Account Section

Settings

All PDF settings can be found by navigating to Orders > PDF Settings

The top section called Settings allows you to specify the following:

Logo for PDFs

A custom Logo for your PDF documents. Recommended size: 200x50px. Use only JPEG, PNG or TIFF file types.

Show Product Images in PDFs

This setting allows you to show/hide product images on the "Items" in all of your PDF documents

Address

The Address prints below the Logo on all PDF documents. We recommend using this field for more than just address information if you need other business info like Tax ID to show on all documents.

Display "Item Quantity" Total in PDFs

This setting will add an "Item Quantity" row to the Totals section of the document, summing up the total quantity of items invoiced, shipped or refunded.

Show Item Tax In PDFs

This setting controls the "Tax" column in the items table on the Invoice and Credit Memo PDF

Individual PDF Settings

Zoey provides the ability to customize each PDF type individually in our sections for:

  • Invoice and Order Settings
  • Shipment Settings (Packing Slip)
  • Credit Memo Settings (Refunds)

Within each section you will find the following settings:

Item Sort

This setting allows you to specify the sort order for the items in the items table on the document. You can specify from several options (see below) including Order Added to Cart, Alphabetical and by Price.

PDF Orientation

This setting allows you to specify Portrait or Landscape for your PDF documents. We recommend using Landscape when adding multiple attributes to the items grid (see Item Attributes To Show setting below)

Header Text, Above Items Text and Ending Message Text

Each Document has WYSIWYG text fields that allow you to add Text (HTML) to the PDF document in each of three locations (Header, Above Items and Ending Message - below the totals).

Text Locations on the Invoice

WYSIWYG Field for Header Text from Example Above

Item Attributes To Show

This section allows you to specify additional columns for the Items table on each document. You can choose which product attribute to display and customize the Column Header (Attribute Label). By default, you will see the SKU column added. You can remove, rename, change, add more and drag & drop sort the order of these columns here (see below)

Show Customer Comments on Admin PDF

When set to Yes, the information entered will also print as a note in the PDF

Show Customer Comments on Customer PDF

When set Enable Order Comments is set to Yes the information entered will also print as a note in the PDF.

Show Order History on Admin PDF

When set to Yes the order history, including comments and status updates, will also print as a note in the PDF.

Show Order History on Customer PDF

When set to Yes the order history, including comments and status updates, will also print as a note in the PDF. Only comments marked visible on frontend will appear.

Barcode Settings

This section allows for the generation and printing of Barcode for Invoices, Shipments and Credit Memos. The Barcode can either represent the Order ID or their respective Document ID.

Enable barcode generation for PDF documents

Yes/No - this enables the generation of Barcodes. You will still need to specify Yes/No and Order ID or Document ID for each document in the settings below.

Barcode Type

This setting allows you to specify the encryption type for the barcode. All standard barcode option types included (see below)

Invoice: Insert barcode to the PDF header

Specify Yes - Order ID, Yes - Document ID or No. The setting No will prevent the Barcode from being printed on this document.

Shipment: Insert barcode to the PDF header

Specify Yes - Order ID, Yes - Document ID or No. The setting No will prevent the Barcode from being printed on this document.

Credit Memo: Insert barcode to the PDF header

Specify Yes - Order ID, Yes - Document ID or No. The setting No will prevent the Barcode from being printed on this document.

Translating PDFs

All text inside a PDF can be translated using the Global Translation Tool
Specific text to translate for PDFs are listed below:

//PDF Translations
  * Order
  * Order # 
  * Invoice
  * Invoice # 
  * Credit Memo
  * Credit Memo # 
  * Packing Slip
  * Packing Slip # 
  * Packing Slip Date: 
  * Date: 
  * Bill To:
  * Not Provided
  * Ship To:
  * Shipped By
  * Tracking Number
  * Shipping:
  * Payment Method:
  * Comments:
  * Admin
  * Item
  * Qty
  * Subtotal
  * Tax
  * Item Quantity
  * Discount
  * Grand Total

📘

TRANSLATION NOTE

Please note that some translations like Order # have a blank space after the # symbol. When Translating, please be sure the original column has the blank space at the end.

Updated 2 years ago

Customize PDFs (Invoice, Packing Slip, Credit Memo)


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.