# WordPress Integration – Guide

### &#x20;     [Plugin Download](https://wordpress.org/plugins/transdirect-shipping/)

### &#x20;     [Github](https://github.com/Transdirect/woocommerce)

## **Application Description**

Transdirect Shipping Plugin for Woocommerce gives you access to Australia’s largest courier and freight companies, and allows your clients a seamless checkout process.

## **Main Features**

* Free to use
* Simple configuration
* Great shipping rates from Fastway, Couriers Please, Toll Priority, Northline and more
* Seamless checkout process for your clients
* Box Sizing
* Order Sync Functionality

## **Requirements** <a href="#requirements" id="requirements"></a>

* PHP version off at least 5.6
* WordPress 4.x
* WordPress WooCommerce Plugin
* An active Transdirect Member account. You can sign up for an account at [www.Transdirect.com.au](http://www.Transdirect.com.au)

## **Installation**  <a href="#installation" id="installation"></a>

1. Download the latest version of the plugin from here. Then simply log in to your WordPress Admin Panel and under Plugins select “Add New” and search for “Transdirect” and then click install.
2. Remember, you must have installed Woocomerce before using this plugin, for more information on installing Woocomerce please see: <http://docs.woothemes.com/document/installing-uninstalling-woocommerce>​
3. Once installed, please make sure you have activated the plugin in the plugins list

![](https://lh4.googleusercontent.com/aK3t0OJtUapts7IMZR71V2nWTNJ-K9ZVldVPVK_aJ-lMzHT0ZeI4Rp-gZ0rbFK1_lcUBZKzxtgpdpOitJeSG21eZ3quclu2XZUGYkrM1JYB0WFSJNQWzcHNAyIgCeKUx23111IQ_)

4\. Login to Transdirect using your Member Account, then click the API Modules link on the left side menu’s list.

5\. On the dropdown, select wordpress and click “ADD NEW”

![](https://lh3.googleusercontent.com/VTthFLYC5qQcZ6KyIHPt7PNzHwH914Uu_1wad9zIDvyGg0RbBoj8oA0uSZE1EmI2N2eWqPrwUSNvuqaSV1s3zfUH34o5HGOzeb8TnnMxuqJ_22JFL0J-onwO5mi8bzBSD-KYXL5l)

&#x20; 6\. Enter your site domain or name then click “ADD”.<br>

![](https://lh5.googleusercontent.com/iXAgvlPxwgTmMHgeTKFlxKf2anbBJzSyDeMNOrArUcrm0-_jgTtChQXg8XRBvB3ssjC48lHsb0LsKWxI7LLuGLa-YTzATqmmiPsNajHxWzT9e608iEoCP2dlDdNePWV8IN4laMRD)

&#x20;7\. You will be redirected to the module page, copy the API Key generated.<br>

![](https://lh3.googleusercontent.com/j3ALh4uSfTfluBCCPRVMKFCyzBd3LR7ZHuE_tg9CsxSdZfAoLvdrztOYuUnPTfuYt0C0ymnzuwnwyEr6ZlAseLgl6pntNC7lC42Ibq8frgGe9WlSHiizABbjH3KdB0m2JHx9X4Fn)

&#x20;    8.Login to your wordpress store site as admin.

&#x20;    9\. Go to Woocommerce -> Settings -> Shipping -> Transdirect Shipping.

&#x20;    10\. Enter the API Key and click Save.

&#x20;    11\. You can also test the API through the “Test API” button, which will alert you if your API is valid or not.<br>

![](https://lh5.googleusercontent.com/3ISwuQKcnGDIuD4HcZmvxRpbGuDSUDMYMcuQBaYX4J2HGeppjK29MLdbe4oRUSCs1dBm_YwNN-xD92mtR8JbtuHnVeN28zvKFFPxllH8X5UQMurQJMdBjOJ7yvWfKQBaEyzvuNBQ)

## **Module Setup**

### **Rules Section**

Rules enable you to add conditions to quotes based on the Rule type selected such as Postcode, State, Weight, Cost, or Product SKU;&#x20;

![](https://lh5.googleusercontent.com/OuXfl0vSk0RasaVJjoXrkmwK5u-0IFbXMj8s8tf11avy-Oqqh4rbCZsqUKdQMJ1VQlPcaOyjwssvmz2ikR_qQahz4roT7dMmlesYSCw_74SpEw7Kbio_MbAJPhZu6P1YMudNNoFm)

![](https://lh3.googleusercontent.com/fCCPjOWtldceqz26_iraqmHFfVLckaSgmVn_legzopH5pStn9jzq-oANPl-AJejK2NbCVPbCZn6VoJGdEh0tR10lVwKOsr7rKJrrWU4DRXuGOsCcj2RlH_rdJjkpmlQbi2wTbhfh)

#### **Rule Types**

* &#x20;**Postcode**

&#x20;         A List or a Range of postcodes can be set on Postcode Rule;

* **State**

&#x20;         Set the State rule by selecting from the drop down list(ACT, NSW, NT, QLD, SA, TAS, VIC, or WA);

* **Weight**

&#x20;        A weight rule can be added by selecting a condition from the Action drop down list: Equals, Less than, Greater than, Less than or equals, Greater than or equals to the Total Weight set on the text box;

* **Cost**&#x20;

&#x20;       A fixed amount, free shipping, or an additional fee can be added or deducted to a quote as you set the condition for the Total Cost on the cost rule;

* **Product SKU**&#x20;

&#x20;      A rule can also be set on a specific product by entering the Product SKU and the action to be applied;

* **Quantity**&#x20;

&#x20;      By selecting Quantity Rule, you can set the number of items on text box and select its corresponding condition whether it is Equals, Less than, Greater than, Less than or equals, Greater than or equals to the item quantity;

In **Couriers** column, you can manage couriers by  ticking or selecting specific couriers where rules will be applied. If no couriers are selected the rule will be apply to all couriers.

**Priority**  column is being used in cases where multiple rules were created on the same Rule Type and Triggers. Our system will execute the rule which was created first. The priority sequence can  be arranged through the up and down (arrow) buttons.

### Click the **Question mark** icon ![](https://lh3.googleusercontent.com/8HLGc79tW6RR4qMpkLz6yk3QLBvria87PnEQ9BuZ_YvT80H-DnSupJi6m18rm089Zb6nzq4F_1RPv7jqV-loO8mcxpQlp4lP7HCRZPqhSEsetD3RuGO0bBwpzng_GOzEChZJmXfj) to read instructions on how to add/create a rul&#x65;**.**

**There are three sections you will need to fill out to create a rule:**

* **Rule Type**&#x20;
  * Single rule application
  * Multiple rules application
* **Trigger**
* **Action**

**Single Rule Type Application**

* Start with selecting a rule type by ticking the box on the left side.
* Set the Trigger conditions.
* Create an action.
* Click "Create Rule".

**Multiple Rule Type Application**

* Start with selecting one rule type, set the trigger for it.
* Tick another rule type and set the trigger after (multiple rule type and trigger).
* When you are done selecting rule types and its specific trigger, you can now set the action for the multiple selections created.
* Click "Create Rule".

### **Import Bulk Rules**

Import bulk rules by selecting ‘*Upload your rules in bulk using import*’ link.

Download CSV template and read bulk Import Rule from here:

![](https://3853472624-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LgPalAXjXJGxXN00u5c%2F-MUs6ABcW2yBiBzWc-RG%2F-MUs7arc3yJSpNKiAUNR%2Fpasted-image-0.png?alt=media\&token=8cf9cfae-474c-40dc-acd6-316fce59b126)

### **Show on Cart**

![](https://lh6.googleusercontent.com/d8zKInZrewqCmjxe1C9fR0ZhmuZccYA8EUhaNy8KFJe9hWu0m4RFDcLNSdaSLVTTJFtjwZcHOEOY3bkV5I3beqdHLhF720-W9C7k0WD4Zu3kxp6AeyjXmhxC7DErCKjp7i-eEEIx)

You can customize the Shipping Calculator Title and set the default delivery address type (Residential or Commercial) to be displayed on cart.

### **Default Item Size**

![](https://lh6.googleusercontent.com/mF0u99ouhr4qep0SZX8-ioFQRVHecco_7umaKBe3ED9q7p0wh1VFL9cFc_88CpbWhav1SZAggnBYKJVmQ2OuynzF1bZId7qGFCM5xfU2fNAON2wPkUyiVZPStxWvQO_bJOceO0pl)

Enter in default package dimensions. Default package dimensions will be used if you do not input custom package dimension for a specific product.

### **Insurance**

![](https://lh5.googleusercontent.com/YIvNAawmkO-w0GlHQ2NzS2XiW6UhS1zLQ6PzS48fje8tjQHsZ12TLLNnBB95akWuN06S61IzuD0SRZa5fvhkD40LQcdfMV6Byk2Lp94IVbW8mkqKQmbfj3hGo3Umq4R1-wNEoO6H)

**If enabled, the Transdirect plugin will add insurance value in quotes calculations.**

### **Order Sync Setup**

![](https://lh3.googleusercontent.com/g4ux1irbr4ZmA3Pwu1PM7l52l_ciwa6hkbxil6onh4QKIgtyzi0TFitXJFGZSRCfIlxq31y1o6f7MPoT7JZEMTVZot5a6Cfw0GHzYUU-thGd1iBA7gnK_JgVhWLfPSEOv-KM9DbU)

If enabled, the Transdirect plugin will upload order information to your transdirect members area as your customers checkout, allowing for easy booking of your orders.

If the first checkbox is selected then only orders with Transdirect as shipping method are synced and if the second checkbox is checked, then all orders will be synced.

### **Module Display Mode**

![](https://lh6.googleusercontent.com/n27P0lP4sZO1sp5QJPU889K2CT6-BcCfZmeBGSo9J5DE5gnoswlgDo8ILHt27HKhC_GQJIpU_xVGYdmeSxGbWplIjHk_OXxMk2Pavmj_5JPYasUV6b3EZD2YaNV5wq5tDOVvRpGv)

* If Full Calculator Mode is selected then the calculator will appear on your checkout page.
* If Simplified Mode is selected then the calculator will be hidden and the quotes will automatically be generated depending on the buyers address.
* If No Display Mode is selected then no quotes will be generated but your orders will still be synced to your Transdirect account.

### **Quote Display**

![](https://lh6.googleusercontent.com/GiyL2aUA1h-tzfRk2VPp2XZkazWqLtKvT7CjcpeSCZqvu939sLCGiWOqkAU8UH1AeWdUpdqayk0eXOrdFCSO6x3fKYf1brWBbJHfHMLpS-_69JNaZAFwjz_MfnFUu8K8kzyZ-ACz)

Select type of Quote to display, These options will control what quotes are displayed to your clients:

* Display All Quotes – This will display all quotes sorted by cheapest to most expensive;
* Display Cheapest – This will only show a single quote which is the cheapest;
* Display Cheapest & Fastest – This will display two quotes, the cheapest quote, and the fastest quote;

  Note: Please keep in mind that all of these options are applied after more advanced options available below are applied.

### **Tailift**

Items that exceed 25kgs must be securely packaged on a forklift able Skid, Pallet or Crate.Select checkbox if Tail lift is required at the **Pickup** location or at the **Delivery** location. A surcharge will be included in the quote.<br>

### **Apply General Surcharge**<br>

![](https://lh6.googleusercontent.com/gZh5HzUETKIhb47aOJGWPHJvW4HgsRTU7arTAfautaoQCYq8WmCFXA6EKJFNwv6AO41sFIQ0RePVPEpY6ZgV-z8pzekoLoAjcV6iQWZE1GIwGg9fKM9vzi6eZs6G9ewKuRUKs6re)

This adds a fixed $ amount or a % into the final quotes that displayed, this can be used to cover handling expenses.

### **Disabling Couriers**

![](https://lh3.googleusercontent.com/nETlbsZhTG-_QryI5FbgBimB2J4piOXb7fQHcQZWsQIoJye6QLqE9U_zhjnpqkEftuhq09WJY3NxCuGYJAsGlLvRClcXfH3iQbiVlKuyXKn0YIC0jQ5fvJB54Qvqhe8F9QxnAu-y)

If you would like to disable quotes from a particular courier service, then you can uncheck the box on the left of the row, if not selecte&#x64;**,** quotes for this courier will not be calculated.

### **Rename / Group Couriers**

![](https://lh6.googleusercontent.com/y95LwZNINJY0803keu_WKMNFOtxhIjO6Z26DwkuuhNHHqVtlFdkZyICpmd0gvX_1LtLM4NNL2dFY5pAurMVq6YbNKvqFVN6_I69nH92G6xtSM-SnjMWmNuPib5Bk2gbLBEygGv0A)

The rename feature allows for you to hide the name of the courier, and allow something more user friendly to be displayed in the front end, eg. “Air Express” or “Road Courier”

You can also use this option to Group couriers, if you call multiple services by the same name, then only the cheapest option will be used and displayed. For example, you could call all the same day services “Same Day” and all road services “Road Express”, and your client would get presented with only 2 options during the checkout process.

### **Surcharge/Fixed Price on a courier**

![](https://lh4.googleusercontent.com/ejhgZx46Q-sEXploWFp99JfuQBLjVOcGjI9ZBk_r_kfzsQq54ZiDf8kaX-whyIlghMPg9KbbP1o9SRMbuJCN8yJ3oIUCQg3RMZ7rMmB3_1lKhoDeH00uA6y-a4VK1FFXFVOYYdRI)

You can add a $ amount or a % surcharge on a particular courier. Or you can set a fixed price on every enabled courier on the list.

### Multipickup Options

Multipickup Tiers allows bookings to be booked via batches.

Each batch is picked up from a given location and you can have distinct batches to be picked up from distinct locations.

Each batch will also be booked on a given date and you will able to complete the booking once you have assigned the minimums shipments amounts for each batch.

Multipickup bookings gives you access to cheaper Courier rates since this process reduces the operational costs for Couriers, which will be able to pickup multiple shipments from a given location on a given day.

![](https://3853472624-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LgPalAXjXJGxXN00u5c%2F-LikTDW13Ofx440Enn5i%2F-LikWXNdzHOBKazGO8Xh%2Fimage.png?alt=media\&token=a6ad7f98-bd94-4ff5-b1f1-b3c0ca5b06e0)

#### Set Up

* You can setup in the Module Setting to always return the Multipickup Tier price instead of the Everday Price.
* When you enable a Tier Price option, the quotes returned by the API will always be from Tier prices.

Please note that currently, only Couriers Please and Fastway offer Multipickup.

### **Order Boxing**

You can add up to 5 boxes to be used for packing your items -The system will calculate the most efficient and cheapest boxes for the items

This feature is intended for customers who might have a large number of small items to be boxed before dispatching and want to achieve better rates.

Multiple packages will be consolidated in boxes and computed based on the total dimension and volumetric weight. Afterwards, these items will be placed in the smallest box size capable of supporting the amount of items.

Note: This is an advanced functionality - do not enable this if you do not fully understand the implications that this will have on quoting.

![](https://lh5.googleusercontent.com/deD8zOJF2LUJotANQ_7MxqPpSoXv4l-J-jXdkdHEX0XMRa0zFTXrR2PeivYNOYUsHtdXR8kAwMwzgszES9arUozLRNAgo1I9h7FAetn3OMsKkg1Jst4miSgHftsjb-br2gHXuFyv)

* **Minimum fill**: allows you to individually quote items outside boxes if they don’t fill a given last box (if multiple boxes in a shipment) by a certain percentage;
* **Box dimension fields**: You may input a maximum of 5 boxes that can be used. Order Boxing functions will select the best combination of boxes to fit your items;&#x20;

  Note: This request is generated as part of a Quote request.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://transdirect-1.gitbook.io/transdirect/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
