Home

Rate Request

View and create rate quotes based on the parameters outlined below. Include appropriate contract charge types and freight classes. After creation, quotes can be dispatched using rate dispatch.

list [get]

Method: GET
URL: https://vsa.savtrans.com/api.php/rest/rate_request
Response: Returns 200 and the collection of resources, which could be empty.
Resource Notes: Returns the 250 most recently created rate requests.

pickup_postal: Origin Postal/Zip Code (US or Canada)
delivery_postal: Destination Postal/Zip Code (US or Canada)
total_miles: Distance Between Origin and Destination
insured_value: Insured Value (Optional)
insured_charge: Insured Charge (If Insured Value)
bol_num: Bill of Lading (BOL) Number (If Dispatched)
contract_charge_types: List of Additional Charges (Contract Charge Types)
is_complete: 0 for Not Dispatched, 1 for Dispatched
items
- index
  - weight: Weight (Pounds)
  - pallets: Pallet Count
  - pieces: Pieces (Must be greater than or equal to pallet_count.)
  - class: Freight Class Number (freight class value)
  - length: Length (Inches, Optional)
  - width: Width (Inches, Optional)
  - height: Height (Inches, Optional)
  - is_hazmat: 0 for Non-hazmat, 1 for Hazmat
  - description: Item Description
  - nmfc: National Motor Freight Classification (NMFC) Number (Optional)
rate_results
- index
  - total_charge: Total Shipment Charge Amount
  - transit_time: Transit Time (Minimum if transit_time_max is specified.)
  - transit_time_max: Max Transit Time (if specified)
  - contract: See contract documentation for fields.
  - is_dispatched: 0 for Not Dispatched, 1 for Dispatched
  - rate_dispatch

Method: POST
URL: https://vsa.savtrans.com/api.php/rest/rate_request?pickup_postal=PICKUP_POSTAL&delivery_postal=DELIVERY_POSTAL&add_charges=ADD_CHARGES...
Response: A successful creation returns 201 and redirects to the retrieve action. An unsuccessful creation returns 400 and displays a list of validation errors.
Action Notes: All fields are supplied in query string format.
Resource Notes: Items are specified as "...&items[0][weight]=250&items[0][pallets]=1&items[1][weight]=500&..." Item weight, pallets, pieces, and class are required.

pickup_postal: Origin Postal/Zip Code (US or Canada)
delivery_postal: Destination Postal/Zip Code (US or Canada)
add_charges: List of Additional Charges (Contract Charge Types) Specified as "...&add_charges[]=1&add_charges[]=2&..."
insured_value: Insured Value (Optional)
items
- index
  - weight: Weight (Pounds)
  - pallets: Pallet Count
  - pieces: Pieces (Must be greater than or equal to pallet_count.)
  - ltl_freight_class_id: Specify freight class identifier or specify freight class value instead.
  - ltl_catalog_id: Commodity (Optional)
  - is_hazmat: 0 for Non-hazmat, 1 for Hazmat
  - length: Length (Inches, Optional)
  - width: Width (Inches, Optional)
  - height: Height (Inches, Optional)
  - description: Item Description
  - nmfc: National Motor Freight Classification (NMFC) Number (Optional)
  - class: Freight Class Number (freight class value)