RateQuote - Submit a quote request for multiple points

This API endpoint enables users to submit an LTL quote request that supports multiple origins or destinations for greater flexibility in logistics planning. The required input includes:

Multi-Location Support:

Zip1 specifies the primary origin or destination zip code, while Zip2 is an array allowing multiple zip codes for either origins or destinations.

ZipArrayisOrigin is a boolean indicating whether the Zip2 list represents origins (true) or destinations (false).

Item Specifications:

The Items array details each shipment item, including ItemClass (freight classification), Weight, Length, Width, Height, and the number of pieces (Pieces).

Accessorial Services:

Additional services, such as residential delivery, can be listed in the Accessorials array using ServiceCode.

Authentication & Shipment Details:

Username, ClientCode, and AuthenticationID authenticate the user.

PricingCode, PalletCount, Direction, and ShipmentDate provide shipment specifics and account settings.

This endpoint returns an LTL quote based on the shipment's details across multiple origins or destinations, tailored to the specified services and requirements.

Request

Body Params application/json

Zip1

object

required

ZipCode

string

required

Zip2

array [object {1}]

required

ZipCode

string

required

Items

array [object {6}]

required

ItemClass

string

required

Weight

integer

required

Length

integer

optional

Width

integer

optional

Height

integer

optional

Pieces

integer

optional

Accessorials

array [object {1}]

optional

ServiceCode

string

optional

ZipArrayisOrigin

boolean

required

Username

string

required

ClientCode

string

required

AuthenticationID

string

required

PricingCode

string

optional

PalletCount

integer

optional

Direction

string

optional

ShipmentDate

string

optional

Example

{
    "Zip1": {
        "ZipCode": "string"
    },
    "Zip2": [
        {
            "ZipCode": "string"
        }
    ],
    "Items": [
        {
            "ItemClass": "string",
            "Weight": 0,
            "Length": 0,
            "Width": 0,
            "Height": 0,
            "Pieces": 0
        }
    ],
    "Accessorials": [
        {
            "ServiceCode": "string"
        }
    ],
    "ZipArrayisOrigin": true,
    "Username": "string",
    "ClientCode": "string",
    "AuthenticationID": "string",
    "PricingCode": "string",
    "PalletCount": 0,
    "Direction": "string",
    "ShipmentDate": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

ErrorMessage

string

optional

ZipResults

array [object {5}]

optional

OriginZip

string

optional

DestinationZip

string

optional

ErrorMessage

string

optional

QuoteNumber

integer

optional

CarrierResults

array [object {5}]

optional

Example

{
    "ErrorMessage": "string",
    "ZipResults": [
        {
            "OriginZip": "string",
            "DestinationZip": "string",
            "ErrorMessage": "string",
            "QuoteNumber": 0,
            "CarrierResults": [
                {
                    "CarrierName": "string",
                    "NetCost": 0,
                    "ServiceDays": 0,
                    "FuelSurcharge": 0,
                    "AccessorialResults": [
                        {
                            "Service": "string",
                            "ServiceCode": "string",
                            "ChargeAmount": 0
                        }
                    ]
                }
            ]
        }
    ]
}