WooCommerce Order Data PDF Generator
Order data will be available only if the order exists in the context.
- Can be used in templates that are connected to:
- WooCommerce -> Orders
- WooCommerce -> Products
- WooCommerce -> Variations
Inner Shortcodes #
Order ID #
-
-
Set shortcode to the current Order ID:
- id - is not set.
-
Set shortcode to the pre-defined Order ID:
- id - is set to the Order ID.
-
Set shortcode to the dynamic Order ID:
-
id - is set to dynamic.
- [e2pdf-wc-order key="metakey2" meta="true"] must output Order ID.
- All additional [e2pdf-wc-order] shortcodes inside same field / element must be closed as [e2pdf-wc-order key="ID"][/e2pdf-wc-order]
-
id - is set to dynamic.
-
Set shortcode to the current Order ID:
WC Price #
-
- Global attribute to format number with a currency symbol.
Order Data #
-
- Order ID:
- Order Key:
- Order Number:
- Formatted Order Total:
- Cart Tax:
- Currency:
- Discount Tax:
- Discount to Display:
- Discount Total:
- Shipping Tax:
- Shipping Total:
- Subtotal:
- Subtotal to Display:
- Get Total:
- Total Discount:
- Total Tax:
- Total Refunded:
- Total Tax Refunded:
- Total Shipping Refunded:
- Item Count Refunded:
- Total QTY Refunded:
- Remaining Refund Amount:
- Item Count:
- Shipping Method:
- Shipping to Display:
- Date Created:
- format - Set the Date Format.
- Date Modified:
- format - Set the Date Format.
- Date Completed:
- format - Set the Date Format.
- Date Paid:
- format - Set the Date Format.
- Custom ID:
- User ID:
- Customer IP Address:
- Customer User Agent:
- Created Via:
- Customer Note:
- Billing First Name:
- Billing Last Name:
- Billing Company:
- Billing Address 1:
- Billing Address 2:
- Billing City:
- Billing State:
- Billing Postcode:
- Billing Country:
- Billing Email:
- Billing Phone:
- Shopping First Name:
- Shipping Last Name:
- Shipping Company:
- Shipping Address 1:
- Shipping Address 2:
- Shipping City:
- Shipping State:
- Shipping Postcode:
- Shipping Country:
- Shipping Address Map URL:
- Formatted Billing Full Name:
- Formatted Shipping Full Name:
- Formatted Billing Address:
- Formatted Shipping Address:
- Payment Method:
- Payment Method Title:
- Transaction ID:
- Checkout Payment URL:
- Checkout Order Received URL:
- Cancel Order URL:
- Cancel Order URL (raw):
- Cancel Endpoint:
- View Order URL:
- Edit Order URL:
- Status:
- Get Order Cart. Must be used inside HTML Object:
- image_size - Product Image Size.
- show_products - Include Products Table.
- show_image - Include Product Image.
- show_sku - Include Product SKU.
- show_name - Include Product Names.
- show_quantity - Include Product Quantity.
- show_price - Include Product Price.
- show_subtotal - Include Product Subtotal Price.
- show_meta - Include Product Meta.
- show_totals - Include Order Total.
- show_totals_subtotal - Include Order Subtotal.
- show_totals_discount - Include Order Discount.
- show_totals_payment_method - Include Order Payment Method.
- show_totals_total - Include Order Total.
- show_comment - Include Order Comment.
Post Data #
Order Post Data #
-
- ID:
- Author:
- Author ID:
- Date:
- Date (GMT):
- Get Post Content:
- Get Post Content with frontend "actions" and "filters":
- Get Post Content with backend "actions" and "filters":
- Title:
- Excerpt:
- Status:
- Comment Status:
- Ping Status:
- Password:
- Name:
- To Ping:
- Ping:
- Modified Date:
- Modified Date (GMT):
- Filtered Content:
- Parent ID:
- GUID:
- Menu Order:
- Type:
- Mime Type:
- Comments Count:
- Filter:
- Post Thumbnail:
- Post Thumbnail URL:
- Permalink:
- Post Permalink:
Order Post Meta #
-
- Get Order Meta Value:
- Get Order Meta Value converted from the attachment id to the attachment url:
- Get Order Meta Value converted from the attachment id to the image attachment url:
-
Get Order Meta Value converted from the attachment id to the image attachment url with the specified size:
- Default Image sizes: thumbnail, medium, medium_large, large, full
-
Get single value from the comma separated value:
Value 1, Value 2, Value 3
- 1st value:
- 2nd value:
-
Get comma separated value from the indexed array:
a:2:{i:0;s:7:"Value 1";i:1;s:7:"Value 2";}
-
Get single value from the indexed array:
a:2:{i:0;s:7:"Value 1";i:1;s:7:"Value 2";}
- Will output value from array(0)
- To unserialize the array for the structure it can be used: https://www.unserialize.com/
-
Get single value from the multidimensional array:
a:2:{i:0;a:1:{s:4:"name";s:7:"Value 1";}i:1;a:1:{s:4:"name";s:7:"Value 2";}}
- Will output value from array(0 => name)
- To unserialize the array for the structure it can be used: https://www.unserialize.com/
Order Post Terms #
-
- Get the Terms in a given Taxonomy:
- Get the Terms in a given Taxonomy names:
- Get the Terms in a given Taxonomy names as comma separated value:
- Get the Terms in a given Taxonomy by Order ID:
-
Get the Terms in a given Taxonomy by Dynamic Order ID:
- [e2pdf-wc-order key="metakey2" meta="true"] must output Order ID
- All additional [e2pdf-wc-order] shortcodes inside same field / element must be closed as [e2pdf-wc-order key="ID"][/e2pdf-wc-order]
- Get the Terms in a given Taxonomy converted from the attachment id to the attachment url:
- Get the Terms in a given Taxonomy converted from the attachment id to the image attachment url:
-
Get the Terms in a given Taxonomy converted from the attachment id to the image attachment url with the specified size:
- Default Image sizes: thumbnail, medium, medium_large, large, full
- Convert serialized value a:3:{i:0;s:2:"v1";i:1;s:2:"v2";i:2;s:2:"v3";} to the comma separated value:
-
Output single value from the serialized multidimensional array a:2:{i:0;a:1:{s:4:"name";s:7:"Value 1";}i:1;a:1:{s:4:"name";s:7:"Value 2";}}:
- Will output value from array(0 => name)
Order Item Meta #
-
- Get Order Item Meta Keys:
Product Data #
-
- Get Product Data by Index in the Order:
- index - is the index of the purchased product in the Order.
- https://e2pdf/com/docs/extensions/woocommerce/product
- Get Product Data by Index in the Order:
Additional #
-
-
Dataset:
- Can be used as shortcode attribute: [shortcode id="[e2pdf-dataset]"]
- PDF URL:
-
Dataset:
Inner Helper Shortcodes #
[e2pdf-foreach] #
Shortcode is used to iterate over order data.
-
- Order Products:
- Order Totals:
[e2pdf-user] #
Shortcode is used to get User Data/User Meta Data. The shortcode can be used inside E2Pdf Templates. Read More ››
-
- Get User Data:
[e2pdf-format-number] #
Shortcode is applied to modify the number output of the shortcode or field slug. Read More ››
-
- Format the Number Output:
[e2pdf-format-date] #
Shortcode is applied to is applied to modify the date output of the shortcode or field slug. Read More ››
-
- Format the Date Output:
[e2pdf-format-output] #
Shortcode is applied to modify the output of the shortcode or field slug. Read More ››
-
- Format the Output:
Global Shortcodes #
E2Pdf Template connected to WooCommerce -> Orders can be assigned via Settings. Read More ››
[e2pdf-download] #
Shortcode is applied to generate and output the PDF download link button. Read More ››
[e2pdf-attachment] #
Shortcode is applied to generate PDF and attach it to the email as an attachment. Read More ››
[e2pdf-save] #
Shortcode is applied to save PDF file on the server. Read More ››
[e2pdf-zapier] #
Shortcode is applied to generate and send Zapier request via WebHook. Read More ››