Get List of Created Schemes

The getCourierPartnerSchemes FDK method retrieves the list of schemes created for a partner. This method enables developers to access and manage various delivery schemes configured for different shipment types, regions, and transport modes.

API: getCourierPartnerSchemes

Request

In the below example request, this FDK method fetches all available schemes for an organization.

basicRouter.get('/', async function view(req, res, next) {
    console.log("---------------------------------------------")
    console.log("basicRouterr.get")
    try {
        const partnerClient = await fdkExtension.getPartnerClient(organizationId);
        const response = await partnerClient.logistics.getCourierPartnerSchemes({
            "organizationId": organizationId,
          });
        console.log(JSON.stringify(response))
        res.json(response);
    } catch (err) {
        console.error(err);
        res.status(404).json({ success: false });
    }
});

Response

The response lists detailed information about each scheme, including the scheme name, delivery type, transport type, and supported payment modes (like COD or prepaid). Each scheme is unique and identified by a scheme_id, which can be used for further operations or modifications. The response contains two sample schemes, both for shipments weighing 0-5 kg. These schemes are apply to inter-city deliveries. They support features like doorstep quality checks (doorstep_qc: true). Each scheme can handle quality check (QC) and non-QC shipments, indicated by the item quantities.

{
    "items": [
        {
            "extension_id": "656f216f9117f06286a7c6f7",
            "name": "Bluedart Surface  0-5kg",
            "volumetric_weight": {
                "lte": null,
                "gte": null
            },
            "weight": {
                "lte": null,
                "gte": null
            },
            "stage": "enabled",
            "status_updates": "delayed",
            "transport_type": "surface",
            "created_by": {},
            "created_on": "2024-01-03T11:16:15.347224",
            "non_qc_shipment_item_quantity": 1,
            "company_id": "_all_",
            "payment_mode": [
                "PREPAID",
                "COD"
            ],
            "region": "inter-city",
            "modified_on": "2024-12-12T12:08:30.289549",
            "feature": {
                "cold_storage_goods": false,
                "doorstep_qc": true,
                "dangerous_goods": false,
                "restricted_goods": false,
                "doorstep_exchange": false,
                "doorstep_return": false,
                "openbox_delivery": false,
                "qr": true,
                "product_installation": false,
                "single_pick_multi_drop": false,
                "multi_pick_single_drop": false,
                "ewaybill": false,
                "ndr": false,
                "mps": false,
                "fragile_goods": false,
                "multi_pick_multi_drop": false
            },
            "qc_shipment_item_quantity": 1,
            "scheme_id": "65952d8db8ac58febb890bee",
            "ndr_attempts": 0,
            "modified_by": {
                "id": "4a5d09cd93b8f5ab02248856"
            },
            "delivery_type": "two-day",
            "logo": {
                "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/misc/pictures/free-icon/original/JUPI0e9uE-logo.png",
                "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/misc/pictures/free-icon/original/JUPI0e9uE-logo.png"
            }
        },
        {
            "extension_id": "656f216f9117f06286a7c6f7",
            "name": "Bluedart Express 0-5kg",
            "volumetric_weight": {
                "lte": null,
                "gte": null
            },
            "weight": {
                "lte": null,
                "gte": null
            },
            "stage": "enabled",
            "status_updates": "delayed",
            "transport_type": "surface",
            "created_by": {},
            "created_on": "2024-01-03T11:16:15.347224",
            "non_qc_shipment_item_quantity": 1,
            "company_id": "_all_",
            "payment_mode": [
                "PREPAID",
                "COD"
            ],
            "region": "inter-city",
            "modified_on": "2024-12-12T12:07:57.414773",
            "feature": {
                "cold_storage_goods": false,
                "doorstep_qc": true,
                "dangerous_goods": false,
                "restricted_goods": false,
                "doorstep_exchange": false,
                "doorstep_return": false,
                "openbox_delivery": false,
                "qr": true,
                "product_installation": false,
                "single_pick_multi_drop": false,
                "multi_pick_single_drop": false,
                "ewaybill": false,
                "ndr": false,
                "mps": false,
                "fragile_goods": false,
                "multi_pick_multi_drop": false
            },
            "qc_shipment_item_quantity": 1,
            "scheme_id": "65952d8eb8ac58febb890c04",
            "ndr_attempts": 0,
            "modified_by": {
                "id": "4a5d09cd93b8f5ab02248856"
            },
            "delivery_type": "two-day",
            "logo": {
                "small": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/misc/pictures/free-icon/original/JUPI0e9uE-logo.png",
                "large": "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/misc/pictures/free-icon/original/JUPI0e9uE-logo.png"
            }
        },
    ],
    "page": {
        "current": 1,
        "has_previous": false,
        "has_next": true,
        "type": "number",
        "size": 2,
        "item_total": 154
    }
}