ParcelFly - The Parcel Delivery Merchant App Documentation

ParcelFly Documentation: This tab contains the merchant app documentation.

Getting Started

Introduction

ParcelFly Merchant App

ParcelFly Merchant App is a dedicated mobile application built for merchants, courier businesses, and parcel-based operations. It provides a clean and practical workflow for creating parcels, managing shops, requesting pickups, handling payment accounts, reviewing reports, and tracking delivery progress in real time. Designed for day-to-day business use, the Merchant App helps merchants manage parcel operations quickly and accurately without depending on the web panel for every action. Whether you handle a few deliveries per day or manage high-volume parcel activity, ParcelFly Merchant App keeps merchant operations organized, efficient, and easy to manage.

Version: V1.0

Author: Bugbuild-Labs

Microsoft Teams: [email protected]

WhatsApp: +8801811843300

Requirements

Flutter (Channel stable, 3.35.5, on macOS 14.5 23F79 darwin-x64, locale en-US)
Flutter version 3.35.5
Upstream repository https://github.com/flutter/flutter.git
Framework revision ac4e799d23 (10 days ago) • 2025-09-26 12:05:09 -0700
Engine revision 0274ead41f6265309f36e9d74bc8c559becd5345 (revision d3d45dcf25) • 2025-09-26 16:45:18 UTC
Dart version 3.9.2
DevTools version 2.48.0

Installation

Android Studio Installation (Windows)

Android Studio Installation (Mac)

Flutter Environment

Flutter Installation on Windows

Flutter Installation on Mac

If you have updated your Mac to Catalina and face issues, follow this video:

Change API Endpoint

Download and unzip the downloaded file.
Then go to the unziped folder & use your preferred IDE (Android Studio / Visual Code / IntelliJ) to open the source_code folder for project.
project/lib/services/urls.dart and change the _baseUrl to connect your mobile app with your admin panel & website

Android Configuration

Change App Name

Select Project > go to android > app > src > main > AndroidManifest.xml then change the android:label name

Change android luncher icon

For Flutter Android & iOS launcher icons,
prepare an app icon image with a size of 1024 × 1024 px in PNG format.
Then run the command: flutter pub run flutter_launcher_icons
This will automatically generate all required launcher icon sizes for Android and iOS.

Get Dependencies

And just run the following command

flutter pub get

Change Package Name

If you want to change the package name following the next steps

Open /android/app/build.gradle and change the package name

android {
                        defaultConfig {
                            // Specify the unique package name (e.g., com.example.myapp)
                            applicationId "com.example.myapp"
                    
                            // Minimum Android version your app supports
                            minSdkVersion 21
                    
                            // Target Android version for which your app is optimized
                            targetSdkVersion 32
                    
                            // Version code for your app (used for versioning in the Play Store)
                            versionCode flutterVersionCode.toInteger()
                    
                            // Version name for your app (visible to users in the Play Store)
                            versionName flutterVersionName
                    
                            // Instrumentation runner for testing (used in Android UI tests)
                            testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
                        }
                    }

Generate Debug APK

open terminal then write command flutter build apk --debug
An APK will be build

Generate Signed APK

First create a key-store file by this link Click
Then Copy your key.jks file to Project » keys » key.jks

User Guide

Splash

The splash screen shows your brand logo while the app initializes settings and cached data.

Onboarding

Intro slides that explain ParcelFly’s core features (parcel creation, tracking, pickup requests, payments).

Merchants sign in using email/phone and password to access the dashboard and tools.

New merchants can register with basic business details and start creating parcels.

OTP Verification

Secure verification step for registration and password recovery flows.

Home

Overview of parcel stats, quick actions, and shortcuts to common merchant tasks.

Parcel List

Browse all parcels with search and filters (status, shop, date range).

Parcel List with Pagination

Paginated list view for large datasets to keep performance smooth.

Create Parcel

Add new parcels with recipient info, weight, COD, and value-added services.

Parcel Banklist Clone

Quickly duplicate parcel data from a template or banked record for faster entry.

Parcel Clone

Duplicate an existing parcel entry (same customer/order) to save time.

Parcel Details

View full parcel information, charges breakdown, and current status.

Parcel Log

Chronological activity log of parcel status updates and actions taken.

Payment Request List

List of COD settlements or payout requests submitted to the courier/admin.

Payment Request Invoice

View the generated invoice or statement for a payment request.

Pickup Request List

Manage requested pickups — statuses, scheduled times, and assigned riders.

Create Pickup Request

Schedule a new pickup with address, preferred time, and parcel count.

Support List

Ticketing/helpdesk view to contact support and track issues.

Shop List

Manage your shops/branches to attribute parcels and pickups correctly.

Create Payment Account

Add bank or mobile money accounts to receive settlements.

General Charges

View standard delivery charges by coverage, weight slabs, and service type.

My Charges

Your negotiated/custom rates applied to your merchant account.

COD / Others

Cash-on-Delivery settings and related service options for parcels.

Closing Report

End-of-day summary with totals for delivered, returned, and COD.

Transaction Report

Detailed ledger of settlements, payouts, and COD reconciliations.

Parcel Report

Generate date-wise or shop-wise parcel performance reports.

Change Password

Update your account password with validation and OTP if enabled.

Example additional menu area for quick links or tools (customizable).

Secondary menu section — can house settings, FAQs, or policy pages.

Logout

Confirm to securely sign out and clear cached auth data.

Run & Build

Run Android Application

In the target selector, select an Android device for running the app. If none are listed as available, select Tools> Android > AVD Manager and create one there. For details, see Managing AVDs. Click the run icon in the toolbar, or invoke the menu item Run > Run. Locate the main Android Studio toolbar:

If you don't use Android Studio or IntelliJ you can use the command line to run your application using the following command

                        
                          flutter run

Build And Install App

After you make all your changes and customizations save all your project, Open the console, navigate to your project folder and execute the following command to build your app flutter build apk --release
If you are deploying the app to the Play Store, it's recommended to use app bundles or split the APK to reduce the APK size.
To generate an app bundle, run: flutter build appbundle --target-platform android-arm,android-arm64,android-x64
Learn more on https://developer.android.com/guide/app-bundle
To split the APKs per ABI, run: flutter build apk --target-platform android-arm,android-arm64,android-x64 --split-per-abi
Learn more on https://developer.android.com/studio/build/configure-apk-splits#configure-abi-split
You should get the APK file in the build/output/apk folder, to install your application on your connected device run the following command