Merchant API v1.0

Integrate FlutterXpress shipping services directly into your application. Use these endpoints to manage parcels, track shipments, and oversee your transactions.

Base URL: https://flutterxpress.com/api/v10
API List

Merchant Login

Authenticate and obtain an access token.

POST /signin
Request Parameters
Parameter Type Required Description
username string Yes Registered username.
password string Yes Account password (min 6 characters).
Response Example
{
    "success": true,
    "message": "Signin successfully",
    "data": {
        "token": "1|qXyZ...",
        "user": {
            "id": 1,
            "name": "Merchant Name",
            "email": "merchant@example.com",
            "mobile": "1234567890"
        }
    }
}

Warehouses

Manage your pickup locations/warehouses.

1. List Warehouses
GET /warehouses/index

Retrieves all registered pickup locations for your account.

2. Create Warehouse
POST /warehouses/store
Required Parameters:
FieldTypeDesc
namestringWarehouse/Shop Name
contact_nostringPickup Phone Number
addressstringFull Address
pincodestringPickup Pincode
citystringCity
statestringState

Create Parcel

Store a new shipment in the system.

POST /parcel/store
Auth Required: Include Authorization: Bearer {token} in headers.
Comprehensive Parameters
Parameter Type Required Description
pickup_phone string Yes Contact number for the pickup location.
pickup_address string Yes Full address of the pickup location.
pickup_pincode string Yes Pincode of the pickup location.
pickup_city string Yes City for pickup.
pickup_state string Yes State for pickup.
order_id string Yes Your internal order ID (must be unique).
customer_name string Yes Recipient's full name.
customer_phone string Yes Recipient's mobile number.
customer_address string Yes Detailed delivery address.
customer_city string Yes Delivery city.
customer_state string Yes Delivery state.
customer_pincode string Yes Recipient's Pincode/Zipcode.
weight decimal Yes Actual weight of the parcel in Kg.
mode string Yes Payment mode: prepaid or cod.
collect_value decimal No Amount to be collected for COD (0 for prepaid).
total_value decimal Yes Consignment/Invoice value for insurance.
order_type string Yes Service type: air, surface, or normal.
item_name string Yes Description of items.
quantity integer Yes Number of items in the package.
courier_type integer No Provider: 1 for Xpress, 2 for Delhivery.
awb_no string No Optional manual AWB number.
is_premium integer No Set 1 for premium service.
Service Charges (Automated)

Note: Starting from v1.0, all service charges are automatically calculated by the backend based on your merchant account settings. You do not need to pass these unless you want to override them with manual values (Admin approval may be required).

Field Type Default Behavior
total_delivery_chargesdecimalSystem auto-calculates grand total.
cod_chargesdecimalAuto-calculated based on your COD % or Min flat fee.
gst_chargesdecimalAuto-applied based on your GST configured rate.
fsc_chargesdecimalAuto-calculated Fuel Surcharge.
insu_chargesdecimalAuto-calculated Insurance (FOV) fee.

Parcel Listing

Retrieve all parcels assigned to your account.

GET /parcel/index

Returns a paginated list of all parcels with their current statuses, customer details, and shipping charges.

Parcel Details

Get full information and history of a specific parcel.

GET /parcel/details/{id}

Replace {id} with the unique parcel ID. The response includes status history (logs) and deliveryman info if assigned.

Wallet & Balance

Check transaction history and current available balance.

1. Transaction History
GET /account-transaction/index

Returns list of all financial movements including payouts and recharges.

2. Balance Details
GET /dashboard/balance-details

Returns a detailed breakdown of your funds.

{
    "amount_delivered": "5000.00",
    "available_balance": "4250.00",
    "clearable_parcels": 12
}

Parcel Tracking

Public endpoint to track shipments by tracking ID.

GET /parcel/tracking/{tracking_id}

Track shipment progress without authentication. Useful for integrating a tracking widget on your own website.

Merchant Profile

Fetch current merchant account settings and information.

GET /profile