Skip to content

AgileShift/cargo_management

Repository files navigation

ERPNext Cargo Management


  • WIP
    bench export-fixtures --app cargo_management

TODO: WORK HEAVILY ON THE TRANSLATIONS bench generate-pot-file --app cargo_management bench update-po-files --app cargo_management --locale es

TODO: frappe/frappe#36846

Personalize Mobile View: frappe/frappe#36759

URGENT ADD TO API: frappe/frappe#36744

TODO: Migrate Fixtures to Hidden App → Private repo for business-critical data

Update readme con: logistic engine y SLAs


ERPNext Cargo Management is a fully-fledged ERPNext solution designed for freight forwarding companies.

Streamlines logistics processes, including parcel tracking, invoicing and warehouse management, providing a seamless, efficient and user-friendly experience.

Built on Frappe Framework v16 and ERPNext, this solution is designed to meet the unique needs of businesses in the freight forwarding industry.
It leverages core functionalities from ERPNext, such as Accounting, Stock, HR, Assets, Payroll and more.

Key Features

  • Cargo Core: TODO: But will have the new engines :D
  • Parcel Management: Manages the parcels, integrates tracking APIs and handles notifications.
  • Warehouse Management: Handles the receipt of parcels in warehouses.
  • Shipment Management: Manages shipments and receipts, also generates packing lists for each shipment.
  • WIP Refactor Name: Selling Management: Customizes ERPNext modules for invoicing parcels and managing customer import orders.
  • Purchase Management: TODO
  • Support Management: Customizes ERPNext modules for customer support related to parcels and orders.
  • Custom Views:
    • Workspaces, Dashboard Views, Settings
    • Reports: Provides insightful reports for better decision-making and business analysis.
  • External APIs For Tracking Parcels:

Extra Addons

List of Carriers Currently Supported:

Last checked: 8 May 2026

Carrier EasyPost 17Track
Amazon ❌️ ❌️
USPS ✅️ ✅️
UPS ✅️ ✅️
DHL ✅️ ✅️
FedEx ❗️With Account ✅️
OnTrac ❗️With Account ✅️
Cainiao ❌️ Deprecated ✅️
SpeedX ❌️ ✅️
SF Express ❗️With Account ✅️
Yanwen ⁉️ Limited ✅️
YunExpress ❌️ Deprecated ✅️
SunYou ❌️ ✅️
Veho ❗️With Account ✅️
GOFO Pending ✅️

Configuration of API Keys and Webhooks for EasyPost and 17Track

EasyPost Configuration

  1. Get Your EasyPost API Key
  2. Set the API Key: $ bench set-config easypost_api_key API_KEY
  3. Create and set your Webhook Secret(hmac): $ bench set-config easypost_webhook_secret SECRET
  4. Set up your Webhook Secret and the Webhook URL on EasyPost: {HOST}/api/method/cargo_management.parcel_management.doctype.parcel.api.easypost_api.easypost_webhook

17Track Configuration

  1. Get Your 17Track Security Key
  2. Set the API Key: $ bench set-config 17track_api_key API_KEY
  3. Set up the Webhook URL on 17Track: {HOST}/api/method/cargo_management.parcel_management.doctype.parcel.api.17track_api.17track_webhook

TODO: WORKING

https://github.com/frappe/frappe/wiki/Writing-an-IntegrationTestCase-in-Frappe:-A-Step%E2%80%90by%E2%80%90Step-Guide

Parcel Flow → WORKING ON

  1. Parcels are created and can be related to a specific customer
    1. Content of the parcel can be added and its related Item for invoice Purposes.
    2. It can be tracked by the API or not.
  2. As the carrier updates the details, the Tracking API sends it via a webhook, we gather and update.
  3. When the parcel is marked as delivered at the warehouse by the carrier, we stop the Tracking API webhook updates
  4. A Warehouse Receipt doc its created to link the received parcel:
    1. The Warehouse can fill parcel-related fields: Content, Dimensions, Weight, Receipt Date
  5. Cargo Shipment is created to export parcels in bulk:
    1. Warehouse Receipts are added to them.
    2. Related information: Transportation Type, Departure date, Est Arrival Date, Dimensions, Gross Weight
  6. Cargo Shipment Receipt is created to receive the Cargo Shipment:
    1. A Receipt loads the data of all related Parcels in the Cargo Shipment through the Warehouse Receipts
    2. All Parcels are sorted by Customer, and it's the moment to set all related data to Create Invoices.
    3. When all the Parcels have been processed, the Sales Invoices can be created.
      1. A Sales invoice will be created for the customer, it will contain all the related Parcels.

Customizations to Frappe and ERPNext:

WORK ON PROGRESS

  • Selling:
    • Quotation
    • Sales Invoices are used to invoice for Logistic services and items related to Business
    • Sales Orders are the only choice to make purchases online on behalf of the customer:
      • WORKING (We must link the sales order with the parcel and content, later we must invoice the order and service.)
  • Parcel can be linked in Issue:
    • WORKING (on the change of status)
  • The customizations allow us to:
    • Invoice a Customer for the Logistic Services and Products in Stock offered.
    • Link the Sales Invoice with a Parcel and update its statuses.

Helpers

  • Cargo Packing List: is a "Packing List" for the Cargo Shipment:
    1. Gets all the content declared by the Customer and the content declared by the Warehouse of the parcels in a Cargo Shipment
    2. It allows modifying the content and amount declared only for Print.
    3. WORKING

Work in progress. But it's stable for usage

  • WORKING
    1. Packing Slip for customs:
    2. Fetching data of prices and quotations from parcels to Cargo Shipment Receipt: WORKING
  • FUTURE:
    1. Setting data of prices in CSR to Sales Invoice
    2. Working in the Sales Orders!
Code-related TODO:
  1. Migrate SQL to QueryBuilder? using Pypika?

Contributing

This app uses pre-commit for code formatting and linting. Please install pre-commit and enable it for this repository:

cd apps/cargo_management
pre-commit install

Pre-commit is configured to use the following tools for checking and formatting your code:

  • ruff
  • eslint
  • prettier
  • pyupgrade

License

AGPLv3

About

ERPNext Cargo Management is a fully-fledged ERPNext solution designed for freight forwarding companies.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors