Woo Sendle API

A WordPress plugin for WooCommerce that enables shop owners to book packages on Sendle and retrieve packing labels without leaving their WooCommerce website.

Install or download the plugin from the WordPress.org site: https://www.wordpress.org/plugins/woo-sendle-api/

Contents

1. Sendle Configuration
2. WooCommerce Configuration
3. Using Woo Sendle API
4. Known Issues

Sendle Configuration

Generate an API username and key by logging in to your Sendle Dashboard. Follow the steps in this guide under ‘Generating your API Key’: https://support.sendle.com/hc/en-us/articles/210798518-Sendle-API

You will also need to make sure you have an approved payment method saved in Sendle.

WooCommerce Configuration

The Woo Sendle API settings can be found in an extra tab called ‘Sendle API’ within the WooCommerce Settings.

This settings section is used to:

• enable or disable the plugin
• set the connection mode (live or sandbox)
• set the Sendle API user and password
• set the default pickup details

Further to the Sendle API settings being set, the ‘Actions’ toolbar needs to be activated from the ‘Screen Options’ button on WooCommerce Orders page.

1.

2.

You will now see the action buttons as shown below.

Using Woo Sendle API

How IT WORKS

Woo Sendle API sends a request to Sendle to create a booking in your Sendle account. Once the booking has been received, you can then print the packing label from within WooCommerce.

For Sendle to accept a pickup the following information is required:

• pickup location (default details are set in the Woo Sendle API Settings page)
• shipping location (based of the shipping address on the order)
• shipping weight (calculated from the weight of each item in the cart)

Make a Pickup Booking

Click the booking icon (). This will open a modal prefilled with the relevant order and default information. You can review the shipping details including the allocated shipment weight before submitting the booking request to Sendle.

Note: Only WooCommerce orders in a status of Processing will display a booking icon.

Clicking the status icon will retrieve the latest information from Sendle and update the status icon.

GET THE PACKAGING LABEL

From the booking confirmation, or by clicking on the Woo Sendle status icon to bring up the booking modal, you can click the ‘Get Label’ button which will open the label in a new tab.

Cancel A Booking

To cancel a booking, click the Woo Sendle API status icon and hover over the ‘Cancel Booking’ button on the top right for three seconds. This will then let you click the button to cancel the booking. Please note, bookings can only be cancelled before a pickup consignment has been created.

Once a booking is cancelled, you can click on the cancelled icon () to re-book the order.

Amend a Booking

There is no way to amend a booking. If a booking was incorrect you can attempt to cancel then rebook. If you cannot cancel via the cancel button then you will need to contact Sendle to make the amendment.

Status Icon List

The following table explains the meaning of the Woo Sendle status icons.

Icon	Status Name	Description
	Book	Sendle can be booked on this order.
	Booking	Sendle booking is still being created and has not yet been scheduled for delivery.
	Pickup	Booking has been consigned and Courier is scheduled to pick up the parcel.
	Pickup Attempted	An unsuccessful parcel pickup was attempted.
	Transit	Parcel is in transit.
	Delivered	Parcel has been successfully delivered.
	Cancelled	Booking has been cancelled. You can book Sendle again when in this status.
	Unable to Book	A booking which cannot be booked.
	Lost	A booking marked as missing or lost.
	Return to Sender	A booking which is being returned to the sender.

Known Issues

• Only one booking can be made per WooCommerce order. Extra Sendle bookings must be made by logging into the Sendle website.
• The plugin currently does not provide shipping quotes into the cart.
• The plugin currently does not support international shipping.