WooCommerce integration

Shipment settings

The shipment PDF document configuration page is located at

WP Admin > WooCommerce > Oxilayer PDF Invoice > Shipment

Shipment also can be used for packing slip or packing label pdf.

General Settings

  • Is Active - enables or disables all functionality related to shipment PDF. If this option is disabled, all other options below on the configuration page will also be disabled
  • Next Shipment ID - Shipment Increment ID. This allows you to have a separate shipment ID from the order and invoice. It's important to keep them separate if you need a sequential shipment ID with a +1 increment. In WooCommerce, order IDs are created for every order, but not all orders may be paid, and some paid orders may not be shipped. Therefore, the only way to maintain the sequence of shipment numbers is to separate them. Shipment increment IDs are generated after the shipment document is created, confirming that the goods have been shipped."

    Here, you can set the next shipment ID and format. Your next shipment will use this current shipment ID and automatically increase by +1 for the next shipment. All digits must be at the end. Here are some examples: SS-0000001, SHIP40001.

PDF Template Settings

PDF Template - Here, you can choose a template for the shipment PDF document. Only templates of the 'shipment' type are listed here. If the list is empty, you will need to create a new invoice PDF template at:

WP Admin > WooCommerce > Oxilayer PDF Invoice > PDF Templates > Create New Template

Our extension allows you to use different templates according to payment or shipping methods. We recommend setting a general template for all payment and shipping methods initially and then configuring specific templates if needed.

Order Tracking Settings

Our extension allows you to add multiple order tracking codes and print them in the shipment PDF document. In this configuration section, you can add your carriers and tracking links.

  • ID / Code - carrier identification. Only lowercase letters (a-z), numbers (0-9), and hyphens (-) are allowed, without spaces. For example: dhl, fedex
  • Carrier Name - the name of the carrier, which will be visible in the shipment PDF. For example: DHL, FedEx, FedEx Express
  • Tracking Link - The link to the carrier's tracking page. Available variables: {tracking_code}. For example: https://www.dhl.com/us-en/home/tracking.html?tracking-id={tracking_code}&submit=1

File Settings

  • Shipment PDF Name - This is the PDF file name for the shipment document. You can use the following variables in the file name: {date}, {id}, {increment_id}. The name must include a file extension. The default value is: shipment_{id}.pdf.
  • Shipment List PDF name - This is the PDF file name for the shipment collection, which is used in bulk actions when multiple shipment PDFs are merged into a single document. Available variable: {date}. The default value is: shipments_{date}.pdf.

Email Attachment Settings

Here, you can choose the email templates to which the shipment PDF document should be attached. The list is dynamic and depends on the available email templates.

Frontend UI Settings

  • Display Print Icon in Frontend Order List - enable/disable the print shipment PDF function on the customer's order list page
  • Display Print Button in Frontend Order View Page - enable/disable the print shipment PDF function on the customer's order view page.

Admin UI Settings

  • Display Print Icon in Order List - enable/disable the print shipment PDF icon in the admin orders list 'Documents' column.
  • Display Print Button in Order View Page - enable/disable the 'Print Shipment' button in the admin order view page.