Rates

Query freight rates

Query freight rates from your Query Bank with flexible location and container filtering.

Location Filtering:

  • Use origins and destinations for door-to-door moves (inland points)
  • Use loadingPorts and dischargePorts for port-to-port moves
  • Combine both for door-to-port or port-to-door queries
  • Region codes like USWC, USEC are supported for broader searches

Rate Structure: Each rate includes:

  • Route information with all legs (pre-carriage, main, on-carriage)
  • Container rates with per-leg breakdown
  • Applicable surcharges with container-specific amounts

Pagination: Results are paginated with a default limit of 100 rates per request.

post/api/v1/external/rates/query

Request

Request body

originsstring[]

Inland origin codes or region codes (USWC, USEC, etc.) for door moves

destinationsstring[]

Inland destination codes or region codes for door moves

loadingPortsstring[]

Port of loading codes (UN/LOCODE format)

dischargePortsstring[]

Port of discharge codes (UN/LOCODE format)

effectiveDatestring date

Filter rates effective on or after this date

expiryDatestring date

Filter rates that haven't expired by this date

containerType'dry' | 'reefer' | 'nor'

Container type filter

containerSizesstring[]

Container size filter

carrierCodesstring[]

Filter by specific carrier SCAC codes

commodityTypestring

Filter by commodity type

limitinteger

Maximum number of rates to return

offsetinteger

Number of rates to skip for pagination

Example request

{
  "origins": [
    "USWC",
    "USCHI"
  ],
  "destinations": [
    "CNSHA",
    "CNNBO"
  ],
  "loadingPorts": [
    "CNSHA",
    "CNNBO"
  ],
  "dischargePorts": [
    "USLAX",
    "USLGB"
  ],
  "carrierCodes": [
    "MAEU",
    "MSCU",
    "COSU"
  ]
}

Response

Rates retrieved successfully

successboolean

Example response

{
  "success": true,
  "data": {
    "rates": [
      {
        "placeOfReceipt": {
          "code": "CNSHA",
          "name": "Shanghai"
        },
        "portOfLoading": {
          "code": "CNSHA",
          "name": "Shanghai"
        },
        "portOfDischarge": {
          "code": "CNSHA",
          "name": "Shanghai"
        },
        "placeOfDelivery": {
          "code": "CNSHA",
          "name": "Shanghai"
        },
        "viaPorts": [
          {
            "code": "CNSHA",
            "name": "Shanghai"
          }
        ],
        "legs": [
          {
            "origin": {
              "code": "CNSHA",
              "name": "Shanghai"
            },
            "destination": {
              "code": "CNSHA",
              "name": "Shanghai"
            },
            "rates": [
              {
                "currency": "USD"
              }
            ]
          }
        ],
        "containerRates": [
          {
            "currency": "USD"
          }
        ],
        "surcharges": [
          {
            "code": "BAF",
            "name": "Bunker Adjustment Factor",
            "basis": "per_container",
            "currency": "USD",
            "containerRates": [
              {
                "currency": "USD"
              }
            ]
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.