Odoo is a suite of open source business apps that cover CRM, eCommerce, accounting, inventory, point of sale, project management, etc. You can integrate Starshipit with Odoo to create shipping methods that automatically get rates from specific couriers (such as Australia Post, NZ Post, DHL and others) based on predefined conditions. Rates shown on the Odoo side are controlled via Starshipit Settings > Checkout rates > Courier Configuration tab settings.
This integration is managed by Odoo. If you need help setting up Starshipit in your Odoo account, please contact Odoo support or raise a support tickethere.
Before you begin
In your Starshipit account, you must have the following:
- Pickup address
Set this under Settings > Pickup address. - Couriers
Integrate with couriers under Settings > Couriers. - Checkout rates
Configure this for each courier under Settings > Checkout rates. Any couriers not configured with checkout rates will not appear in Odoo. - Starshipit API key
Find this under Settings > API. - Starshipit Subscription key
Same as above.
Setting up Odoo
To integrate your Starshipit account to the Odoo database:
- Log in to Odoo.
- Install the Starshipit module by going to Odoo's Apps module.
- Search for Starshipit Shipping.
- Click Activate to install it.
- Once installed, go to Inventory > Configuration > Settings.
- Activate the Starshipit Connector option.
- Click the Starshipit Shipping Methods link.
- Click Create.
To configure Starshipit in Odoo, fill out the fields on the Shipping Methods form as follows:
- Shipping Method: Type Starshipit.
- Provider: Select Starshipit from the drop-down menu.
- Delivery Product: Assign or create the delivery product that will appear on the sales order line when the cost of shipping is calculated.
In the Starshipit Configuration tab, fill out the following fields:
- Starshipit API Key
- Starshipit Subscription Key
- Origin Address: The address where products are shipped from
- Default Package Type: Set a default package type to include the weight of the empty package when automatically calculating shipping rates. Set the Default Package to specify default dimensions used when Getting Rates in Odoo.
Manually save the form by clicking the cloud icon next to the Shipping Methods / New breadcrumbs.
To set a default package type, the Packages featuremustbe enabled inInventory>Configuration>Settings.
To load the newly configured shipping products:
- Click the Select a service linked to the Starshipit account link at the bottom of the Starshipit Configuration tab. This will open the Choose Starshipit Shipping Service pop-up window.
- In the Delivery Service field, choose the desired shipping service for deliveries and returns from the drop-down menu.
- Click Confirm.
The chosen delivery service will populate in the Service Name field.
Example
Here's a sample of a Starshipit shipping product configured in Odoo:
- Sendle: Sendle drop off
- Shipping Product: Sendle Delivery
- Starshipit Service Code: STANDARD-DROPOFF
We do not provide test keys when a company tests the sending of a package in Odoo. This means that if a package is created, your account may be charged.Odoo has a built-in layer of protection against unwanted charges when using test environments. Within a test environment, if a shipping method is used to create labels, then those labels are immediately canceled after creation — this occurs automatically. Please note that depending on the shipping provider being used, the account might be charged for printing label, unless the order is cancelled manually on the couriers’s portal.Switch between the test and production environment by clicking the Environment smart button at the top of the shipping method form.
Generate a label
When creating a quotation in Odoo, add the Starshipit shipping method by:
- Clicking the Add shipping button.
- In the Add a shipping method pop-up window, select Starshipit in the Shipping Method field.
- Calculate the shipping rate by clicking Get rate.
- Click Add to include the cost of shipping to the sales order line, labeled as the delivery product.
Then, Validate the delivery. Shipping label documents are automatically generated in the chatter, which includes the following:
- Shipping label(s) depending on the number of packages.
- Tracking number(s) if the selected courier supports it.
- Return label(s) if the Starshipit connector is configured for returns.
Package weight in Odoo is calculated by adding the weights of the products plus the empty package saved in the database. Ensure the correct shipping option is selected, as the package weight is not automatically verified.Verify the destination address, as Starshipit checks it when the order is created.Finally, some couriers may require other information, such as an email address or phone number. Please ensure that all necessary information are set upon sending a shipping order.
Returns
We allow returns with the following couriers:
- Australia Post eParcel
- TNT
- Couriers Please
- Aramex
- StarTrack
- DHL Express
- NZ Post Domestic
This can be done by clicking the Return smart button on the intended delivery order. If the selected courier supports returns, the Print Return Label button will be available.
Cancellations
If a delivery order is cancelled in Odoo, it will be automatically archived in Starshipit. However, the cancellation will not be sent to the courier itself, so make sure to log onto the courier’s platform to handle the cancellation manually.
Troubleshooting
"Error: this delivery method is not available for this order."
This error appears when Odoo asks Starshipit for shipping options, but Starshipit returns no available rates for the order. In most cases, this happens because Checkout Rates aren’t set up or don’t match the order details.
To resolve this, set up or update your Checkout Rates in Starshipit.