Get Freight

This method is used to find bol number and bol document of a freight order.

Please note that this end-point has rate-limiting, therefore, it will only allow 20 requests per minute.

If you are using this endpoint within a loop we highly recommend adding a gap/delay between each iteration.

Endpoint

Method URI Headers
GET freight-orders/{shipment_order_id} default
GET freight-orders/bol-number/{bol_number} default

Response

Field Type Description
shipment_order_id Integer Related Shipment Order bol_number
String BOL Number pro_number
String Provider Number (nullable) final_price
Float Final price carrier
String Carrier label
String Label Url pod
String Url to the pod document when it is available confirmed_pickup_window_start
String Confirmed time window start of pickup returned by the provider (nullable) confirmed_pickup_window_end
String Confirmed time window end of pickup returned by the provider (nullable)

Response Examples

Successful

{
    "success": true,
    "data": {
        "shipment_order_id": 123123123,
        "bol_number": "123123123",
        "pro_number": "132123",
        "final_price": "11.11",
        "carrier": "amazon_freight",
        "service": "Amazon Freight",
        "label": "/label/url/12355",
        "pod": null,
        "confirmed_pickup_window_start": "08:00",
        "confirmed_pickup_window_end": "10:00"
    },
    "message": "Parcel Order label ready"
}

Failed

{
    "success": false,
    "message": "This shipment is in Processing stage and the label can not be viewed right now."
}
{
    "success": false,
    "message": "Too Many Requests! Please slow down"
}