Biteship Shipping Connector
by dhzid-group https://github.com/dhzid-group/biteship_shipping/issues/1$ 54.05
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Inventory (stock)
• Sales (sale_management) • eCommerce (website_sale) • Discuss (mail) • Invoicing (account) • Website (website) |
| Lines of code | 3225 |
| Technical Name |
dhzid_biteship_shipping |
| License | OPL-1 |
| Website | https://github.com/dhzid-group/biteship_shipping/issues/1 |
Biteship Shipping Connector by DG
Connect Odoo 19 Community with Biteship to calculate live shipping rates, create shipments, print waybills, and track deliveries from one operational workflow.
Key Highlights
Everything needed to connect checkout, sales, delivery orders, courier rates, shipment tracking, and printable waybills.
Live Shipping Rates
Show Biteship courier rates during website checkout after the customer address is complete.
Courier Service Mapping
Create one Odoo Delivery Method for each synced Biteship courier service you want to offer.
Biteship Shipments
Create Biteship orders from Odoo Delivery Orders and store shipment ID, tracking number, and status.
Webhook Tracking
Receive Biteship webhook updates and keep shipment status synchronized in Odoo.
Address Area Helper
Find Biteship Area ID from partner and checkout address forms, including GPS-assisted input.
Real Cost Option
Display checkout estimates and optionally update the sale delivery line with real shipment cost.
Connect Your Biteship Account
Use your existing Biteship account, open the developer integration page, then enter the generated credentials in the Biteship app inside Odoo.
Login to Biteship
Sign in directly from the Biteship login page.
Open Developer Integration
Get API credentials and webhook settings from the integration section.
Configure Odoo
Enter the API key, sync couriers, and start using live rates.
Available Courier Logos
The module includes courier logo assets for Biteship delivery methods and printable waybills.
Operational Dashboard
The module is installed as an Odoo app named Biteship. It provides menus for shipments, accounts, delivery methods, couriers, and locations so shipping operations can be managed without jumping between Odoo configuration screens.
Checkout Flow
- Customer fills shipping address in website checkout.
- Odoo displays published Biteship Delivery Methods.
- Each selected method calls Biteship Rates API through rate_shipment().
- The checkout shows the available rate to the customer.
- When delivery is validated, Odoo creates the Biteship shipment and stores tracking information.
Biteship Capabilities
Configuration
- Open the Biteship app and create a Biteship account connection.
- Enter API Key, optional Account ID, and Webhook Token.
- Configure the Waybill tab for label size, logo, barcode, order notes, and footer text.
- Click Sync Couriers to import courier services.
- Create Delivery Methods for the courier services you want to show in checkout.
- Configure origin location, package dimensions, COD, insurance, draft order, and real cost options.
- Configure Biteship webhook URL using /biteship/webhook?token=YOUR_TOKEN.
Go Live & API Activation
Biteship requires an activation process before a production API key can be used for live orders. Complete sandbox testing first, then submit the activation request from the Biteship dashboard.
Complete Sandbox Testing
Before activation, complete the required integration testing in the sandbox environment.
Prepare Activation Data
Review the terms, choose the API key and courier access to activate, then prepare the requested information.
Submit API Activation
Open the Integration/API Settings page, fill the activation form, and submit the request.
Webhook
Set your Biteship callback URL to:
https://your-odoo-domain.com/biteship/webhook?token=WEBHOOK_TOKEN
The token can also be sent with the X-Biteship-Webhook-Token header. Empty installation verification requests are accepted with a successful response. Real webhook payloads still require token validation.
Technical Notes
Support
Developed by dhzid-group. Before going live, test courier coverage, checkout rate display, shipment creation, webhook delivery, and tracking synchronization with your Biteship account.
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Inventory (stock)
• Sales (sale_management) • eCommerce (website_sale) • Discuss (mail) • Invoicing (account) • Website (website) |
| Lines of code | 3225 |
| Technical Name |
dhzid_biteship_shipping |
| License | OPL-1 |
| Website | https://github.com/dhzid-group/biteship_shipping/issues/1 |
Biteship Shipping Connector by DG
Overview
Biteship Shipping Connector by DG connects Odoo 19 Community with Biteship for shipping rate calculation, shipment creation, waybill printing, and shipment tracking. The module is designed for Odoo 19 Community installations, including custom deployments on Odoo.sh and on-premise servers.
Main Features
- Live Biteship shipping rates in website checkout.
- Dedicated Biteship app menu for shipments, accounts, delivery methods, couriers, and locations.
- Courier and service synchronization from Biteship.
- One Odoo Delivery Method per selected Biteship courier service.
- Biteship Area ID lookup on partner and website checkout address forms.
- Optional GPS-assisted checkout address input.
- Shipment creation from Odoo Delivery Orders.
- Draft order and direct order flows.
- COD and insurance support based on courier capability.
- Biteship shipment status, tracking number, tracking URL, and internal technical shipment data storage on Delivery Orders.
- Webhook endpoint for Biteship status updates.
- Scheduled tracking synchronization fallback.
- Printable local Biteship waybill in 8 x 10 cm, 10 x 15 cm, and A4 layouts.
- Configurable waybill logo, barcode, footer, displayed data, and recipient privacy masking.
- Real cost option to update the sale delivery line after shipment creation.
Supported Odoo Editions
This module is built for:
- Odoo 19 Community
- Odoo.sh version 19, when installed as a custom third-party module
- On-premise Odoo 19 deployments
Odoo Online does not support installing arbitrary custom Python modules, so this module is not intended for standard Odoo Online databases.
Dependencies
The module depends on standard Odoo apps:
- delivery
- stock
- sale_management
- website_sale
No hidden executable code is downloaded or installed by this module.
Installation
- Copy the dhzid_biteship_shipping folder into an Odoo addons path.
- Restart Odoo.
- Update the apps list.
- Install Biteship Shipping Connector by DG.
- Open the Biteship app and create a Biteship account connection.
Configuration
- Enter the Biteship API Key on the Biteship Account form.
- Optionally fill Account ID and Webhook Token.
- Click Sync Couriers to import Biteship courier services.
- Create one Delivery Method for each courier service you want to show in website checkout.
- Configure the origin location, package dimensions, COD, insurance, draft order mode, and real cost options.
- Configure the Waybill tab to control label size, logo, barcode, footer, note display, and privacy masking.
Webhook
Configure the Biteship callback URL as:
https://your-odoo-domain.com/biteship/webhook?token=WEBHOOK_TOKEN
The token can also be sent through the X-Biteship-Webhook-Token header. Empty webhook verification requests are accepted with a successful response. Real webhook payloads still require token validation.
Checkout Flow
After the customer completes the shipping address, Odoo displays the available published Delivery Methods. For Biteship Delivery Methods, Odoo calls rate_shipment() and the module requests the matching rate from Biteship. If a configured courier service is not available for the destination or order weight, the method fails lightly and will not be selected as a valid shipping rate.
Shipment Flow
When the Delivery Order is validated, the module creates the Biteship shipment or draft order according to the Delivery Method configuration. Biteship order details can be pulled into Odoo and are used as the primary source for local waybill printing.
Support
Before going live, test courier availability, website checkout rates, shipment creation, COD handling, webhook status updates, tracking synchronization, and waybill printing with your own Biteship account.
Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module