LoadMate Provider Integration

Overview

Having multiple providers sending you quotes for the creation of a managed order increases your chances of taking advantage of the best possible offer. On this page, you’ll learn how to integrate a new provider into the Managed Services module. When booking an order, quotes will be listed accordingly.

Currently, only Montway is supported by default.

Required Services From The Integrating Provider

Quotes Creation API

The first step is to get your quotes. At minimum, you’ll need to specify a pickup and delivery location (via state and zip code) and provide basic vehicle data.

The response will generate different rates based on the request.

Sample POST request with body:

JSON

{
    "transport": {
        "origin_location": "2100 Glenview Ter,Altadena,CA,91001",
        "destination_location": "3640 Bunker Hill Dr,Algonquin,IL,60102",
        "trailer_type": "ENCLOSED"
    },
    "vehicle": [
        {
            "make": "Ford",
            "model": "Edge",
            "year": 2009,
            "condition": "running",
            "vin": "2FMDK39C99BA44676"
        }
    ]
}

Sample response:

JSON

{
    "rates": [
        {
            "identity": "7",
            "payment": "regular",
            "price": "1899.00",
            "label": "7 days pick up",
            "subcharges": null,
            "pickup_window": 7
        },
        {
            "identity": "4",
            "payment": "regular",
            "price": "2369.00",
            "label": "5 days pick up",
            "subcharges": null,
            "pickup_window": 5
        },
        {
            "identity": "3",
            "payment": "regular",
            "price": "2649.00",
            "label": "3 days pick up",
            "subcharges": null,
            "pickup_window": 3
        },
        {
            "identity": "2",
            "payment": "regular",
            "price": "2839.00",
            "label": "1 day pick up",
            "subcharges": null,
            "pickup_window": 1
        },
        {
            "identity": "1",
            "payment": "regular",
            "price": "1899.00",
            "label": "No load window",
            "subcharges": null,
            "pickup_window": 7
        }
    ],
    "vehicle": {
        "make": "Ford",
        "model": "Edge",
        "year": 2009,
        "condition": "RUNNING",
        "type": "suv midsize"
    },
    "quote_id": "xxxxxxxxxx",
    "quote_ref_id": "your_id",
    "expires_at": "2022-05-24T09:18:29-05:00",
    "transit_time": {
        "min": 5.0,
        "max": 7.0,
        "label": "Transit time: 5 - 7 days",
        "short_label": "5 - 7 days"
    }
}

---

Create Orders API

Having chosen and confirmed a quote (rate), the final step is to create the order.

Proceed to adding contact details required by the provider who offered the quote. These include pickup, delivery and customer data. Specified vehicle information and pickup/delivery address can’t be changed.

Sample POST request with body:

JSON

{
    "customer": {
        "first_name": "Martin",
        "last_name": "Smith",
        "phone_number": "1111111111",
        "email_address": "[email protected]"
    },
    "pickup": {
        "first_name": "Martin",
        "last_name": "Smith",
        "phone_number": "3123213213",
        "mobile_number": null,
        "work_number": "3123213213",
        "street_address": "abc"
    },
    "delivery": {
        "first_name": "Martin",
        "last_name": "Smith",
        "phone_number": "4243243243",
        "mobile_number": null,
        "work_number": "4243243243",
        "street_address": "cde"
    },
    "quote_id": "XXXXXXXXXXXXX",
    "rate_type": "regular",
    "rate_identity": "2",
    "pickup_date": "2022-05-17",
    "booking_source": "LOADMATE"
}

Sample response:

JSON

{
    "order_id": "XXXXXXXX",
    "order_ref_id": "your_id",
    "quote_id": "XXXXXX",
    "quote_ref_id": "your_id"
}

---

Authentication

Every provider must have their own client (client_id and client_secret) with which they would be able to authenticate and access LoadMate and its services.

More info: Authentication

Step by step guide