Get Rates

This method is used to check pricing for Freight Orders from all allowed providers. The method also automatically creates an order that isn't visible from the dashboard


Available carriers are [Carriers are only available to registered users]

Endpoint

Method URI Headers
POST freight-orders/get-rates default

Request

Field Required Type Description
pickup_date Yes String Proposed pickup date, in Y-m-d
vehicle_type No String One of dry_van, flatbed, reefer. Default is dry_van. Setting this to reefer would require reefer_details
reefer_details {} No* Object Temperature-controlled shipping instructions. Condition: only required when vehicle_type is reefer
+instruction No* String One of continuous, cycle. Condition: only required when reefer_details is used
+min_temperature No* Float Minimum temperature, must be less than max_temperature. Condition: only required when reefer_details is used
+max_temperature No* Float Maximum temperature, must be greater than min_temperature. Condition: only required when reefer_details is used
from_opening_time Yes String Opening time of pickup address, in H:i
from_closing_time Yes String Closing time of pickup address, in H:i
from_instructions No String Any special instructions for the pickup address
from_address {} Yes Object Sender address container, not required if a "from_address_id" was used
+name Yes String Name of the sender
+attention No String Attention of the sender
+street_1 Yes String Street line 1
+street_2 No String Street line 2
+street_3 No String Street line 3
+city Yes String City
+zip Yes String Postal Zip code
+state No* String State - This field is required for US or Canada addresses please refer to country-codes
+country Yes String Country (code) for the list please refer to country-codes
+telephone Yes String Telephone Number - This field will will avoid special characters (10-15 digits)
+email No String Email
+lift_gate No Boolean Default value is false
+residential No Boolean Default value is false
+inside No Boolean Default value is false
+limited_access No Boolean Default value is false
+appointment No Boolean Default value is false
to_opening_time Yes String Opening time of delivery address, in H:i
to_closing_time Yes String Closing time of delivery address, in H:i
to_address {} Yes Object Receiver address container
+name Yes String Name of the receiver
+attention No String Attention of the receiver
+street_1 Yes String Street line 1
+street_2 No String Street line 2
+street_3 No String Street line 3
+city Yes String City
+zip Yes String Postal Zip code
+state No* String State - This field is required for US or Canada addresses please refer to country-codes
+country Yes String Country (code) for the list please refer to country-codes
+telephone Yes String Telephone Number - This field will will avoid special characters (10-15 digits)
+email No String Email
+lift_gate No Boolean Default value is false
+residential No Boolean Default value is false
+inside No Boolean Default value is false
+limited_access No Boolean Default value is false
+appointment No Boolean Default value is false
items [] Yes Array An array containing all the information about items
+count Yes Integer Pieces count
+package_type No String Default value is "pallet_48x40". For a full list please check out freight packages
+length Yes Float Length (IN) - If selected package type has forced length this field will be overwritten with forced length
+width Yes Float Width (IN) - If selected package type has forced width this field will be overwritten with forced width
+height Yes Float Height (IN)
+weight Yes Float Weight (LBS)
+description Yes String Description of the item
+insurance No Boolean Default is false. Setting this to true would require price
+price No* Float Price (Commodity Value) of the item Condition:required only if insurance is selected
+is_hazmat No Boolean If the item is hazmat, default is false. Setting this to true would require hazmat_detail and the top-level emergency_contact
+hazmat_detail {} No* Object Hazmat classification for this item. Condition: only required when is_hazmat is true
++hazmat_matrix_id No* Integer ID of a known hazmat classification, see hazmat matrices for the full list and their UN/NA numbers. Condition: only required when hazmat_detail is used
++packing_group No* String One of I, II, III. Must be one of the packing groups allowed for the selected hazmat_matrix_id, some classifications allow none - see hazmat matrices. Condition: only required when allowed for the selected hazmat_matrix_id
++compatibility_group No* String One of A, B, C, D, E, F, G, H, J, K, L, N, S. Condition: only required when the selected hazmat_matrix_id is a Class 1 explosive (hazard class starting with 1, excluding 1.5/1.6)
+is_used_items No Boolean If the item is used or new, default is false
+is_stackable No Boolean If the item is stackable, default is false
+freight_class No String Preferred freight class, default is auto where we calculate the class automatically (recommended), for options please check freight classes
+sku No String PO number of the shipment
smart_detection_enabled No Boolean Default is true. The system will check if the address is residential and select the residential delivery and lift gate options automatically if set to true
emergency_contact {} No* Object 24-hour emergency contact for hazmat shipments. Condition: only required when any item has is_hazmat set to true
+name No* String Contact name. Condition: only required when emergency_contact is used
+phone No* String Contact phone number (10-15 digits, numeric). Condition: only required when emergency_contact is used

Request Example

{
    "pickup_date": "2022-05-25",
    "from_opening_time": "08:00",
    "from_closing_time": "17:00",
    "from_instructions": "Walk in",

    "from_address": {
        "name": "Acme Corp",
        "attention": "Jane Doe",
        "city": "Los Angeles",
        "street_1": "123 S Main St",
        "zip": "90012",
        "state": "CA",
        "country": "US",
        "telephone": "9999999999"
    },

    "to_opening_time": "08:00",
    "to_closing_time": "17:00",
    "to_instructions": "Wait at the gate",
    "to_address": {
        "name": "Example Corp",
        "attention": "John Doe",
        "city": "Flushing",
        "street_1": "123 Main St",
        "zip": "11354",
        "state": "NY",
        "country": "US",
        "telephone": "9999999999"
    },
    "items": [
        {
            "package_type": "pallet_48x40",
            "count": 1,
            "length": "48",
            "width": "40",
            "height": "50",
            "weight": "100",
            "sku": null,
            "description": "Some Description"
        },
        {
            "package_type": "pallet_48x40",
            "count": 1,
            "length": "48",
            "width": "40",
            "height": "50",
            "weight": "150",
            "sku": null,
            "description": "Flammable liquid sample",
            "is_hazmat": true,
            "hazmat_detail": {
                "hazmat_matrix_id": 42,
                "packing_group": "II"
            }
        }
    ],
    "emergency_contact": {
        "name": "Jane Doe",
        "phone": "9999999999"
    }
}

{info} hazmat_matrix_id: 42 above is an example only - look up the real ID for your item's UN/NA number in the Hazmat Matrices table.

Response

Field Type Description
success Boolean true or false
message String Error message (only exists if success is false)
data Array An array containing received rates or if request has failed an object containing validation errors
+id Integer This is the ID (rate_id) that you will need to use to ship this specific rate
+carrier String Carrier of this rate
+service String Service of this rate
+service_code String Service code of this rate, please refer to service names
+final_price Float Final price of the shipment including all costs
+fuel_price Float Fuel price
+restrictions Array Any extra information about this particular rate
+miscellaneous_charges Array Any miscellaneous surcharges
+freight_class String Only shown when the provider is UPS GFP type
+has_enough_credits Boolean Shows if organisation has enough credits for this particular rate
+is_guaranteed Boolean Shows if this particular rate is guaranteed
+load_type String Shows load type of freight either "ltl" or "ftl"

Response Examples

Successful

{
    "success": true,
    "data": [
        {
            "id": 123123123,
            "carrier": "forward_air",
            "service": "Forward Air",
            "service_code": "FORWARD_AIR-0",
            "final_price": 111.1,
            "fuel_price": 22.22,
            "discount_from": null,
            "restrictions": [],
            "miscellaneous_charges": [],
            "has_enough_credits": true,
            "eta": "4",
            "is_guaranteed": true,
            "load_type": "ltl"
        },
        {
            "id": 1212121212,
            "carrier": "forward_air",
            "service": "Forward Air",
            "service_code": "FORWARD_AIR-0",
            "final_price": 111.1,
            "fuel_price": 22.22,
            "discount_from": null,
            "restrictions": [],
            "miscellaneous_charges": [],
            "has_enough_credits": true,
            "eta": "4",
            "is_guaranteed": false,
            "load_type": "ftl"
        }
    ]
}

Failed

{
    "success": false,
    "message": "The given data was invalid.",
    "data": {
        "to_address.city": [
            "The to address.city field is required."
        ]
    }
}

Failed - Hazmat Detail Required

{
    "success": false,
    "message": "The given data was invalid.",
    "data": {
        "items.1.hazmat_detail": [
            "Hazmat detail is required when package is marked as hazmat."
        ]
    }
}

Failed - Packing Group Not Allowed

{
    "success": false,
    "message": "The given data was invalid.",
    "data": {
        "items.1.hazmat_detail.packing_group": [
            "The packing group 'III' is not valid for UN1203 (Gasoline). Allowed packing groups: II."
        ]
    }
}

Freight Packages

Name Code Forced Length Forced Width
Pallet (48" x 40") pallet_48x40 48 40
Pallet (48" x 48") pallet_48x48 48 48
Pallet (Custom Dimensions) pallet_custom - -
Bag bag - -
Bale bale - -
Box box - -
Crate crate - -
Cylinder cylinder - -
Drum drum - -
Pail pail - -
Reel reel - -
Roll roll - -
Loose loose - -

Freight Classes

Code Description
50
55
60
65
70
85
92.5
100
125
175
250
300
400
auto This the default recommended value. When this is chosen we will calculate the class automatically for your dimensions and weight

Hazmat Matrices

Every hazmat_detail.hazmat_matrix_id you submit must reference one of the classifications below. "Allowed Packing Groups" lists every valid value for packing_group for that classification - if it says "None", omit packing_group entirely for that item. "Compatibility Group" shows whether hazmat_detail.compatibility_group is required for that classification.

ID UN/NA Number Proper Shipping Name Hazard Class Allowed Packing Groups Compatibility Group
1 UN0027 Black powder 1.1 None — omit packing_group Required
2 UN0081 Explosive, blasting, type A 1.1 None — omit packing_group Required
3 UN0160 Cord, detonating 1.1 None — omit packing_group Required
4 UN0332 Explosive, blasting, type B 1.1 None — omit packing_group Required
5 UN0454 Charges, bursting 1.1 None — omit packing_group Required
6 UN0241 Ammunition, illuminating 1.2 None — omit packing_group Required
7 UN0312 Cartridges, signal 1.2 None — omit packing_group Required
8 UN0191 Flares, signal 1.3 None — omit packing_group Required
9 UN0335 Fireworks 1.3 None — omit packing_group Required
10 UN0482 Charges, propelling 1.3 None — omit packing_group Required
11 UN0336 Fireworks 1.4 None — omit packing_group Required
12 UN0337 Fireworks 1.4 None — omit packing_group Required
13 UN0432 Cartridges for weapons, small arms 1.4 None — omit packing_group Required
14 UN0500 Detonators, electric 1.4 None — omit packing_group Required
15 UN0501 Detonators, non-electric 1.4 None — omit packing_group Required
16 UN0331 Explosive, blasting, type E 1.5 None — omit packing_group Not applicable
17 UN3223 Articles, explosive, extremely insensitive 1.6 None — omit packing_group Not applicable
18 UN1001 Acetylene, dissolved 2.1 None — omit packing_group Not applicable
19 UN1011 Butane 2.1 None — omit packing_group Not applicable
20 UN1035 Propane 2.1 None — omit packing_group Not applicable
21 UN1075 Petroleum gases, liquefied 2.1 None — omit packing_group Not applicable
23 UN1002 Air, compressed 2.2 None — omit packing_group Not applicable
24 UN1013 Carbon dioxide 2.2 None — omit packing_group Not applicable
25 UN1066 Nitrogen, compressed 2.2 None — omit packing_group Not applicable
97 UN1070 Nitrous oxide 2.2 None — omit packing_group Not applicable
26 UN1072 Oxygen, compressed 2.2 None — omit packing_group Not applicable
22 UN1950 Aerosols, non-flammable 2.2 None — omit packing_group Not applicable
27 UN1956 Gas, compressed, n.o.s. 2.2 None — omit packing_group Not applicable
28 UN1017 Chlorine 2.3 None — omit packing_group Not applicable
29 UN1040 Ethylene oxide 2.3 None — omit packing_group Not applicable
30 UN2190 Phosgene 2.3 None — omit packing_group Not applicable
45 NA1993 Combustible liquid, n.o.s. 3 III Not applicable
46 NA1999 Combustible liquid, n.o.s. 3 III Not applicable
31 UN1090 Acetone 3 I, II, III Not applicable
32 UN1105 Acrylonitrile, stabilized 3 I, II Not applicable
50 UN1114 Benzene 3 II Not applicable
33 UN1170 Ethanol 3 II, III Not applicable
34 UN1203 Gasoline 3 II Not applicable
35 UN1219 Isopropanol 3 II, III Not applicable
36 UN1230 Methanol 3 II Not applicable
37 UN1263 Paint 3 II, III Not applicable
47 UN1294 Toluene 3 II Not applicable
48 UN1300 Turpentine 3 III Not applicable
49 UN1307 Xylenes 3 III Not applicable
38 UN1863 Fuel, aviation, turbine engine 3 II Not applicable
39 UN1866 Resin solution, flammable 3 II, III Not applicable
40 UN1987 Alcohols, n.o.s. 3 II, III Not applicable
41 UN1992 Flammable liquid, toxic, n.o.s. 3 I, II, III Not applicable
42 UN1993 Flammable liquid, n.o.s. 3 I, II, III Not applicable
43 UN3028 Ethyl acetate 3 II Not applicable
44 UN3256 Elevated temperature liquid, flammable, n.o.s. 3 III Not applicable
51 UN1325 Flammable solids, organic, n.o.s. 4.1 II, III Not applicable
52 UN1944 Matches 4.1 III Not applicable
54 UN2254 Nitrocellulose, wet 4.1 II, III Not applicable
53 UN3175 Solids containing flammable liquid, n.o.s. 4.1 II, III Not applicable
57 UN1328 Zirconium powder, dry 4.2 I, II Not applicable
55 UN1361 Carbon, activated 4.2 III Not applicable
56 UN1380 Phosphorus, white 4.2 I, II Not applicable
58 UN1402 Calcium carbide 4.3 I, II, III Not applicable
59 UN1415 Lithium aluminum hydride 4.3 I Not applicable
60 UN1855 Sodium sulfide, anhydrous 4.3 II, III Not applicable
61 UN1479 Oxidizing solid, n.o.s. 5.1 II, III Not applicable
63 UN1486 Potassium permanganate 5.1 II Not applicable
62 UN1498 Sodium nitrate 5.1 III Not applicable
65 UN2014 Hydrogen peroxide, aqueous solution, >60% 5.1 I Not applicable
64 UN2465 Hydrogen peroxide, aqueous solution, 20-60% 5.1 II Not applicable
66 UN3101 Organic peroxide Type B, liquid 5.2 None — omit packing_group Not applicable
67 UN3105 Organic peroxide Type D, liquid 5.2 None — omit packing_group Not applicable
68 UN3109 Organic peroxide Type F, liquid 5.2 None — omit packing_group Not applicable
69 UN1098 Allyl alcohol 6.1 I, II Not applicable
70 UN1239 Nitrobenzene 6.1 II Not applicable
71 UN2810 Toxic liquid, organic, n.o.s. 6.1 I, II, III Not applicable
72 UN2922 Corrosive liquid, toxic, n.o.s. 6.1 I, II, III Not applicable
74 UN2814 Infectious substance, affecting humans 6.2 None — omit packing_group Not applicable
73 UN3373 Biological substance, Category B 6.2 None — omit packing_group Not applicable
75 UN2915 Radioactive material, Type A package, non-special form 7 None — omit packing_group Not applicable
76 UN3321 Radioactive material, low specific activity (LSA-I) 7 None — omit packing_group Not applicable
81 UN1760 Corrosive liquid, n.o.s. 8 I, II, III Not applicable
77 UN1789 Hydrochloric acid 8 II Not applicable
82 UN1791 Hypochlorite solutions 8 III Not applicable
79 UN1805 Phosphoric acid solution 8 III Not applicable
80 UN1824 Sodium hydroxide solution 8 II, III Not applicable
78 UN1830 Sulfuric acid 8 II Not applicable
83 UN1903 Disinfectant, liquid, corrosive, n.o.s. 8 II, III Not applicable
84 UN1906 Disinfectant, solid, corrosive, n.o.s. 8 II, III Not applicable
86 UN2794 Batteries, wet, filled with acid 8 None — omit packing_group Not applicable
87 UN2795 Batteries, wet, filled with alkali 8 None — omit packing_group Not applicable
85 UN2796 Battery fluid, acid 8 II Not applicable
88 UN2800 Batteries, wet, non-spillable 8 None — omit packing_group Not applicable
89 UN1845 Carbon dioxide, solid (Dry ice) 9 None — omit packing_group Not applicable
90 UN3077 Environmentally hazardous substance, solid, n.o.s. 9 None — omit packing_group Not applicable
91 UN3082 Environmentally hazardous substance, liquid, n.o.s. 9 None — omit packing_group Not applicable
95 UN3090 Lithium metal batteries 9 None — omit packing_group Not applicable
96 UN3091 Lithium metal batteries contained in equipment 9 None — omit packing_group Not applicable
92 UN3257 Elevated temperature liquid, n.o.s. 9 None — omit packing_group Not applicable
93 UN3480 Lithium ion batteries 9 None — omit packing_group Not applicable
94 UN3481 Lithium ion batteries contained in equipment 9 None — omit packing_group Not applicable