> For the complete documentation index, see [llms.txt](https://shiply-integration-apis.gitbook.io/shiply-integration-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://shiply-integration-apis.gitbook.io/shiply-integration-documentation/integration-plugins-and-apps/woocommerce-plugin.md).
# WooCommerce Plugin
This section provides a detailed overview of the Shiply WooCommerce plugin, designed to seamlessly integrate Shiply’s logistics services into your WooCommerce store.
## Shiply Logistics WooCommerce plugin
### Installation Guide
* Install the plugin using the following file:
{% file src="/files/ZQSnrMDOS0xyHORB2dmT" %}
* Place the folder in the following path in your WooCommerce website:\
`/wp-content/plugins/shiply-logistics-integration`.
* Configure the API Key:
* Retrieve your `Shiply_API_KEY` from Shiply team.
* Open the `wp-config.php` file located in the root directory of your WordPress website.
* Add the following line of code to the file, replacing `YOUR_SHIPLY_API_KEY` with your actual API key: `define( 'SHIPLY_API_KEY', 'YOUR_SHIPLY_API_KEY' );`
* Configure host server:
* Open the `wp-config.php` file located in the root directory of your WordPress website.
* Add the following line of code to the file, replacing `HOST_SERVER` with the actual host server:\
`define( 'URL', 'HOST_SERVER' );`
For Palestine stores:
* For real environment: `https://shiplylogistics.com/api/v1/`
* For development environment: `https://stage.shiplylogistics.com/api/v1/`
For Jordan stores:
* For real environment: `https://jordan.shiplylogistics.com/api/v1/`
* For development environment: `https://stagejordan.shiplylogistics.com/api/v1/`
{% hint style="info" %}
* For websites using **Palestine** as the country, prices will be rounded to remove decimal points to ensure parcels can be successfully created in Shiply.
{% endhint %}
### Usage Guide
This section introduces the features added to your website through the integration with the Shiply system using this plugin.
#### Order details page
* On the admin order details page, the following fields are added to the Order Details card:
* These are the main sections in the plugin:
1. **Info button:** Displays a brief description of the plugin's features, providing an overview of its functionality.
2. **Shiply Shipping Address Section:**
1. **Selected Shiply Address:** Displays the previously selected shipping address associated with the parcel for the current order.
2. **Selected Address Shipping Cost:** Shows the shipping cost of the previously selected shipping address.
3. **Select Shiply Shipping Address:** This section includes two dropdown lists and a cost field:
1. **Select City:** Allows you to choose the city for the shipping address.
2. **Select Shipping Address:** Populates with villages in the selected city. If no city is selected, it displays all villages from all cities.
3. **Shipping Cost:** Displays the shipping cost based on the selected city and village (the currency will be the same as the used website currency, either ILS or JOD).
4. **Include Shiply shipping cost to the total checkbox:** This checkbox indicates if want to add the calculated Shiply shipping cost from the selected address to the order total when creating or updating the parcel (checked means include).
3. **Shiply Parcel Section:**
1. **Parcel Code:** Displays the parcel code if a parcel has been created for the order.
2. **Parcel Description:** Allows you to add or edit a description for the parcel.
3. **Parcel Actions:** Includes four buttons to manage parcel:
1. **Create Parcel:** Creates a new parcel for the order.
2. **Submit & Assign QR:** Submits the parcel and assigns a QR code to it.
3. **Cancel Parcel:** Cancels the created parcel.
4. **Update Parcel:** Updates the parcel's details.
* Parcel actions:
1. **Create Parcel**
1. A parcel cannot be created for an order that already has an existing parcel.
2. A parcel cannot be created if there are missing customer information in the shipping address entered by the customer such as phone number or street.
3. If the user does not provide a description, a default description will be generated and displayed in the description field.
4. When clicking on the **“Create Parcel”** action:
* If a Shiply shipping address is not selected, the system attempts to resolve it using the address details entered by the recipient (address resolver).
* If the address cannot be resolved, the admin must manually map it by selecting the appropriate city and village based on the recipient’s address information.
5. After Parcel Creation:
1. The shipping address, shipping cost, and parcel code are automatically set.
2. Next to the parcel code, the status of the parcel is displayed for quick reference.
2. **Submit & Assign QR**
* Updates the parcel status from "Draft" to "Submitted".
* Assigns a QR code to the parcel.
3. **Cancel Parcel**
* Reverts the parcel status from "Submitted" back to "Draft".
4. **Update Parcel**
* Allows updating either the shipping address or the description of the parcel.
5. **Change Order Price**
* When the order price is updated and a parcel has already been created for the order, the parcel's price is automatically updated to reflect the new order price.
#### Orders listing page
In the orders listing page:
There are 2 sections added to this page which are:
1. **Shiply Status:** A column that shows the Shiply parcel status for each order
2. Bulk actions:
1. **Shiply - Create Parcel:** To create parcels for orders in bulk.
1. After selecting the order(s), choosing this action, and clicking "Apply", the following will appear:
2. It displays a summary of the shipping address and cost for the selected orders.
For some orders, the Shiply shipping address can be resolved automatically by the system, while for others where the address cannot be resolved, the shipping address must be selected manually. Additionally, the user must specify whether the calculated shipping cost should be included in the order’s total price when creating the parcel.
3. When clicking “Continue Bulk Create”, the system will create parcels for the eligible selected orders and, once completed, present a summary of the performed actions.
2. **Shiply - Submit & Assign QR:** To bulk submit "Draft" parcels associated with orders.
1. After selecting the order(s), choosing this action, and clicking "Apply", the following will appear:\
2. It will display a summary of the parcels from the selected orders that are eligible for submission.
3. When clicking "Continue Submission", the system will submit the selected parcels and, upon completion, display a summary of the performed action:
#### Settings page
In the "WooCommerce" tab, a section labeled “Shiply Logistics” can be found at the end of the list:
There is a “Clear cache” button used to refresh cached Shiply data by clearing the existing cache and reloading it directly from Shiply.
