FM_APIs
  1. Shipment Order
FM_APIs
  • Shipment Order
    • /shipmentorder
      POST
  • Shipment Processing
    • /RTS/markRTS
      POST
    • /shipmentDetails/labelLink
      POST
    • /RTS/bulkMarkRTS
      POST
    • /ShipmentCancellation/markCancellation
      POST
    • /orderProcessing/printLabel
      POST
    • /orderProcessing/printInvoice
      POST
    • /orderProcessing/searchOrders
      POST
  • Shipment Tracking
    • /ClientOrderIn/orderTrackingDetails
      GET
    • /ClientOrderIn/eventDetails
      GET
    • /api/shipmentTracking/{awbNumber}
      GET
  1. Shipment Order

/shipmentorder

POST
/shipmentorder
The API allows to create shipment order for given input parameters

Request

Body Params application/json

Example
{
    "clientRefId": "332992272-4",
    "shipmentType": "FORWARD",
    "destinationDetails": {
        "gstRegNumber": "NA",
        "destinationAddress": {
            "addressLine1": "RAMAMURTHY NAGAR",
            "addressLine2": null,
            "pincode": "560016",
            "city": "Banglore",
            "state": "Karnataka",
            "addressType": "HOME"
        },
        "destinationContactDetails": {
            "contactPersonName": "Ravikiran",
            "primaryContactNumber": "9518793421",
            "email": "sontakker5@gmail.com"
        }
    },
    "shipmentDimension": {
        "length": 10,
        "breadth": 10,
        "height": 10,
        "weight": 0.42,
        "volumetricWeight": 0.2
    },
    "serviceType": "ECONOMY",
    "paymentMode": "PREPAID",
    "collectAmount": 0,
    "shipmentValue": 603.82,
    "itemDetails": [
        {
            "orderID": "testlogistiex04",
            "orderTime": 1738754406000,
            "orderChannel": "Manual",
            "essential": false,
            "invoiceNumber": 332992272,
            "itemClassification": [],
            "itemName": "Mixer",
            "itemReferenceNumber": "12541",
            "itemType": "Electical",
            "itemHsnCode": "14875241",
            "itemQuantity": 2,
            "itemUnitPrice": 77.93,
            "itemTaxableAmount": 155.93,
            "itemTaxAmount": 28.06,
            "itemCGSTAmount": 14.03,
            "itemSGSTAmount": 14.03,
            "itemIGSTAmount": 0,
            "itemDiscount": 0,
            "itemValue": 183.99,
            "itemCGST": 9,
            "itemSGST": 9,
            "itemIGST": 0,
            "taxInclusive": true
        },
        {
            "orderID": "testlogistiex",
            "orderTime": 1738754406000,
            "orderChannel": "Manual",
            "essential": false,
            "invoiceNumber": 332992272,
            "itemClassification": [],
            "itemName": "DLV-COMBO2",
            "itemReferenceNumber": "DLV-COMBO2",
            "itemType": "Clothes",
            "itemHsnCode": null,
            "itemQuantity": 2,
            "itemUnitPrice": 169.44,
            "itemTaxableAmount": 338.98,
            "itemTaxAmount": 61.01,
            "itemCGSTAmount": 30.50,
            "itemSGSTAmount": 30.50,
            "itemIGSTAmount": 0,
            "itemDiscount": 0,
            "itemValue": 399.99,
            "itemCGST": 9,
            "itemSGST": 9,
            "itemIGST": 0,
            "taxInclusive": true
        }
    ],
    "shipmentGrossValue": 603.82,
    "shipmentTotalTaxAmount": 92.10,
    "shipmentCGSTAmount": 44.54,
    "shipmentSGSTAmount": 44.54,
    "shipmentIGSTAmount": 0,
    "shipmentTotalDiscount": 0,
    "skuCount": 2,
    "consignorGroupCode": "CGJAI001",
    "sellerDetails": {
        "sellerName": "Gugris",
        "gstRegNumber": "29AADCE8914H1ZE",
        "sellerContactNumber": "8808528338",
        "sellerAddress": {
            "addressLine1": "RAMAMURTHY NAGAR",
            "pincode": "560016",
            "city": "Karnataka",
            "state": "Karnataka",
            "addressType": "OFFICE"
        }
    },
    "originDetails": {
        "pickupCode": "CGJAI001-1"
    },
    "returnDetails": {
        "returnAddressCode": "CGJAI001-1"
    },
    "shippingCharges": 19.83,
    "originHandoverMode": "PICKUP",
    "shipmentPurposeType": "SALE",
    "consignorLocationCode": "",
    "rtsFlag": false,
    "shipmentClass": "B2C"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/shipmentorder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientRefId": "332992272-4",
    "shipmentType": "FORWARD",
    "destinationDetails": {
        "gstRegNumber": "NA",
        "destinationAddress": {
            "addressLine1": "RAMAMURTHY NAGAR",
            "addressLine2": null,
            "pincode": "560016",
            "city": "Banglore",
            "state": "Karnataka",
            "addressType": "HOME"
        },
        "destinationContactDetails": {
            "contactPersonName": "Ravikiran",
            "primaryContactNumber": "9518793421",
            "email": "sontakker5@gmail.com"
        }
    },
    "shipmentDimension": {
        "length": 10,
        "breadth": 10,
        "height": 10,
        "weight": 0.42,
        "volumetricWeight": 0.2
    },
    "serviceType": "ECONOMY",
    "paymentMode": "PREPAID",
    "collectAmount": 0,
    "shipmentValue": 603.82,
    "itemDetails": [
        {
            "orderID": "testlogistiex04",
            "orderTime": 1738754406000,
            "orderChannel": "Manual",
            "essential": false,
            "invoiceNumber": 332992272,
            "itemClassification": [],
            "itemName": "Mixer",
            "itemReferenceNumber": "12541",
            "itemType": "Electical",
            "itemHsnCode": "14875241",
            "itemQuantity": 2,
            "itemUnitPrice": 77.93,
            "itemTaxableAmount": 155.93,
            "itemTaxAmount": 28.06,
            "itemCGSTAmount": 14.03,
            "itemSGSTAmount": 14.03,
            "itemIGSTAmount": 0,
            "itemDiscount": 0,
            "itemValue": 183.99,
            "itemCGST": 9,
            "itemSGST": 9,
            "itemIGST": 0,
            "taxInclusive": true
        },
        {
            "orderID": "testlogistiex",
            "orderTime": 1738754406000,
            "orderChannel": "Manual",
            "essential": false,
            "invoiceNumber": 332992272,
            "itemClassification": [],
            "itemName": "DLV-COMBO2",
            "itemReferenceNumber": "DLV-COMBO2",
            "itemType": "Clothes",
            "itemHsnCode": null,
            "itemQuantity": 2,
            "itemUnitPrice": 169.44,
            "itemTaxableAmount": 338.98,
            "itemTaxAmount": 61.01,
            "itemCGSTAmount": 30.50,
            "itemSGSTAmount": 30.50,
            "itemIGSTAmount": 0,
            "itemDiscount": 0,
            "itemValue": 399.99,
            "itemCGST": 9,
            "itemSGST": 9,
            "itemIGST": 0,
            "taxInclusive": true
        }
    ],
    "shipmentGrossValue": 603.82,
    "shipmentTotalTaxAmount": 92.10,
    "shipmentCGSTAmount": 44.54,
    "shipmentSGSTAmount": 44.54,
    "shipmentIGSTAmount": 0,
    "shipmentTotalDiscount": 0,
    "skuCount": 2,
    "consignorGroupCode": "CGJAI001",
    "sellerDetails": {
        "sellerName": "Gugris",
        "gstRegNumber": "29AADCE8914H1ZE",
        "sellerContactNumber": "8808528338",
        "sellerAddress": {
            "addressLine1": "RAMAMURTHY NAGAR",
            "pincode": "560016",
            "city": "Karnataka",
            "state": "Karnataka",
            "addressType": "OFFICE"
        }
    },
    "originDetails": {
        "pickupCode": "CGJAI001-1"
    },
    "returnDetails": {
        "returnAddressCode": "CGJAI001-1"
    },
    "shippingCharges": 19.83,
    "originHandoverMode": "PICKUP",
    "shipmentPurposeType": "SALE",
    "consignorLocationCode": "",
    "rtsFlag": false,
    "shipmentClass": "B2C"
}'

Responses

🟢200OK
application/json
Order Placed Successfully
Body

Example
{
    "success": true,
    "msg": "Order Placed Successfully",
    "data": {
        "clientCode": "fm-api",
        "shipmentType": "FORWARD",
        "clientRefId": "1332992272-4",
        "destinationDetails": {
            "gstRegNumber": "NA",
            "destinationAddress": {
                "addressLine1": "RAMAMURTHY NAGAR",
                "addressLine2": null,
                "state": "Karnataka",
                "city": "Banglore",
                "pincode": "560016",
                "addressType": "HOME",
                "_id": "67a8ddc8bb87b9c90fc31762"
            },
            "destinationContactDetails": {
                "contactPersonName": "Ravikiran",
                "primaryContactNumber": "9518793421",
                "email": "sontakker5@gmail.com",
                "_id": "67a8ddc8bb87b9c90fc31763"
            }
        },
        "shipmentDimension": {
            "length": 10,
            "breadth": 10,
            "height": 10,
            "weight": 0.42,
            "_id": "67a8ddc8bb87b9c90fc3176d",
            "volumetricWeight": 0.2
        },
        "serviceType": "ECONOMY",
        "paymentMode": "PREPAID",
        "collectAmount": 0,
        "shipmentValue": 603.82,
        "itemDetails": [
            {
                "orderID": "testlogistiex04",
                "orderTime": 1738754406000,
                "orderChannel": "Manual",
                "essential": false,
                "invoiceNumber": "332992272",
                "itemClassification": [],
                "itemName": "Mixer",
                "itemReferenceNumber": "12541",
                "itemType": "Electical",
                "itemHsnCode": "14875241",
                "itemQuantity": 2,
                "itemUnitPrice": 77.93,
                "itemTaxableAmount": 155.93,
                "itemTaxAmount": 28.06,
                "itemCGSTAmount": 14.03,
                "itemSGSTAmount": 14.03,
                "itemIGSTAmount": 0,
                "itemDiscount": 0,
                "itemValue": 183.99,
                "itemCGST": 9,
                "itemSGST": 9,
                "itemIGST": 0,
                "taxInclusive": true,
                "_id": "67a8ddc8bb87b9c90fc31765",
                "invoiceDate": "5/2/2025"
            },
            {
                "orderID": "testlogistiex",
                "orderTime": 1738754406000,
                "orderChannel": "Manual",
                "essential": false,
                "invoiceNumber": "332992272",
                "itemClassification": [],
                "itemName": "DLV-COMBO2",
                "itemReferenceNumber": "DLV-COMBO2",
                "itemType": "Clothes",
                "itemHsnCode": null,
                "itemQuantity": 2,
                "itemUnitPrice": 169.44,
                "itemTaxableAmount": 338.98,
                "itemTaxAmount": 61.01,
                "itemCGSTAmount": 30.5,
                "itemSGSTAmount": 30.5,
                "itemIGSTAmount": 0,
                "itemDiscount": 0,
                "itemValue": 399.99,
                "itemCGST": 9,
                "itemSGST": 9,
                "itemIGST": 0,
                "taxInclusive": true,
                "_id": "67a8ddc8bb87b9c90fc31766",
                "invoiceDate": "5/2/2025"
            }
        ],
        "shipmentGrossValue": 603.82,
        "shipmentTotalTaxAmount": 92.1,
        "shipmentCGSTAmount": 44.54,
        "shipmentSGSTAmount": 44.54,
        "shipmentIGSTAmount": 0,
        "skuCount": 2,
        "consignorGroupCode": "CGJAI001",
        "sellerDetails": {
            "sellerCode": "",
            "sellerName": "Gugris",
            "gstRegNumber": "29AADCE8914H1ZE",
            "sellerAddress": {
                "addressLine1": "RAMAMURTHY NAGAR",
                "addressLine2": "",
                "latitude": "26.91681706377075",
                "longitude": "75.82038156650398",
                "state": "Karnataka",
                "city": "Karnataka",
                "pincode": "560016",
                "addressType": "HOME",
                "addressConfidenceScore": null,
                "_id": "67a8ddc8bb87b9c90fc31767"
            },
            "sellerContactNumber": "8808528338"
        },
        "originDetails": {
            "pickupCode": "CGJAI001-1",
            "gstRegNumber": "22AAAAA0000A1Z5",
            "originAddress": {
                "addressLine1": "Shop no 22",
                "addressLine2": "",
                "latitude": "26.91681706377075",
                "longitude": "75.82038156650398",
                "state": "Rajasthan",
                "city": "Jaipur",
                "pincode": "110001",
                "addressType": "HOME",
                "addressConfidenceScore": null,
                "_id": "67a8ddc8bb87b9c90fc31768"
            },
            "originContactDetails": {
                "contactPersonName": "Tarun",
                "primaryContactNumber": "9910939792",
                "secondaryContactNumber": "",
                "email": "wejimap340@ubinert.com",
                "_id": "67a8ddc8bb87b9c90fc31769"
            }
        },
        "returnDetails": {
            "returnAddressCode": "CGJAI001-1",
            "returnAddress": {
                "addressLine1": "Shop no 22",
                "addressLine2": "",
                "latitude": "26.91681706377075",
                "longitude": "75.82038156650398",
                "state": "Rajasthan",
                "city": "Jaipur",
                "pincode": "110001",
                "addressType": "HOME",
                "addressConfidenceScore": null
            },
            "returnContactDetails": {
                "contactPersonName": "Tarun",
                "primaryContactNumber": "9910939792",
                "secondaryContactNumber": "",
                "email": "wejimap340@ubinert.com"
            }
        },
        "originHandoverMode": "PICKUP",
        "destinationHandoverMode": "DROPOFF",
        "isOffLoad": false,
        "packagingScanAction": 0,
        "shipmentReferenceNumber": "250209-4615-9789",
        "shipmentPurposeType": "SALE",
        "rtsFlag": false,
        "labelStatus": 0,
        "invoiceStatus": 0,
        "orderStatus": 100,
        "shipmentReturnDetails": {
            "qcDetails": []
        },
        "consignorLocationCode": "",
        "shipmentClass": "B2C",
        "shippingCharges": 19.83,
        "_id": "67a8ddc8bb87b9c90fc31761",
        "creationTime": 1739120071127,
        "requestedServiceType": "ECONOMY",
        "assignedCourierCode": "DELHIVERY",
        "shipmentRefId": "ece63fb1-4867-4e39-9969-0d4c6ba325be",
        "awbNo": "6677112024400",
        "assignedAWBNumber": "6677112024400",
        "integrationMode": "api",
        "labelLink": "",
        "courierRouteCode": ""
    }
}
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Modified at 2025-02-09 16:45:03
Next
/RTS/markRTS
Built with