---
updatedAt: 2025-09-10T20:59:21.000Z
agentTools:
projectIndex: https://shipcars.readme.io/llms.txt
---
# Get RateEngine price suggestion
Shows price suggestions based on vehicles and route
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "User Management",
"description": "Ship.Cars User Management",
"contact": {
"url": "https://ship.cars",
"email": "support@ship.cars"
},
"version": "1.0.0"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "oauth2",
"flows": {
"password": {
"tokenUrl": "https://auth.ship.cars/auth/realms/master/protocol/openid-connect/token",
"scopes": {}
}
}
}
}
},
"servers": [
{
"url": "https://ship.cars/api"
}
],
"paths": {
"/shipperlite/posting/v3/rate-calculations": {
"post": {
"tags": [
"Rate Engine API"
],
"summary": "Get RateEngine price suggestion",
"description": "Shows price suggestions based on vehicles and route",
"operationId": "calculateRate_1",
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"route",
"useEnclosedTrailer",
"vehicles"
],
"type": "object",
"properties": {
"route": {
"required": [
"deliveryLocation",
"pickupDateDetail",
"pickupLocation"
],
"type": "object",
"properties": {
"pickupDateDetail": {
"required": [
"estimatedEndDate",
"estimatedStartDate",
"restriction"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the date",
"example": "YK41K"
},
"estimatedEndDate": {
"type": "string",
"description": "End date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-23"
},
"estimatedStartDate": {
"type": "string",
"description": "Start date in yyyy-mm-dd format",
"format": "date",
"example": "2022-03-21"
},
"restriction": {
"type": "string",
"description": " NO_RESTRICTIONS - No limitations.
\n NOT_EARLIER - Not earlier than a given date.
\n NOT_LATER - Not later than a given date.
\n NOT_EARLIER_NOT_LATER - Not earlier than a given date and not later than another date.
\n",
"example": "NO_RESTRICTIONS",
"default": "NO_RESTRICTIONS",
"enum": [
"NO_RESTRICTIONS",
"NOT_EARLIER",
"NOT_LATER",
"NOT_EARLIER_NOT_LATER"
]
}
},
"description": "Required details and restrictions for the load's estimated delivery date."
},
"deliveryLocation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
},
"longitude": {
"type": "string",
"description": "Auto-generated longitude coordinates of the location",
"example": "-94.2332754"
},
"latitude": {
"type": "string",
"description": "Auto-generated latitude coordinates of the location",
"example": "39.3514073"
}
},
"description": "Required details and restrictions for the load's requested pickup location."
},
"pickupLocation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Internal ID of the location",
"example": "YK41K"
},
"street": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,200}$",
"type": "string",
"description": "Street",
"example": "161 W Cherry St"
},
"city": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "City",
"example": "Albion"
},
"state": {
"pattern": "^{0}|[a-zA-Z]{2}$",
"type": "string",
"description": "Two-letter abbreviation of the state",
"example": "IL",
"enum": [
"AL",
"AK",
"AS",
"AZ",
"AR",
"AA",
"AE",
"AP",
"CA",
"CO",
"CT",
"DE",
"DC",
"FL",
"GA",
"GU",
"HI",
"ID",
"IL",
"IN",
"IA",
"KS",
"KY",
"LA",
"ME",
"MD",
"MA",
"MI",
"MN",
"MS",
"MO",
"MT",
"NE",
"NV",
"NH",
"NJ",
"NM",
"NY",
"NC",
"ND",
"MP",
"OH",
"OK",
"OR",
"PA",
"PR",
"RI",
"SC",
"SD",
"TN",
"TX",
"UT",
"VT",
"VI",
"VA",
"WA",
"WV",
"WI",
"WY"
]
},
"zipCode": {
"pattern": "^{0}|\\d{5}(-\\d{4})?$",
"type": "string",
"description": "Required US postal code of the area or district",
"example": "62806"
},
"locationId": {
"pattern": "^{0}|(?=.*\\S)[\\p{L}\\p{M}\\p{N}\\p{P}\\p{S}\\p{Z}\t]{1,100}$",
"type": "string",
"description": "Custom pickup location ID as set by the customer, if applicable",
"example": "XC223"
},
"longitude": {
"type": "string",
"description": "Auto-generated longitude coordinates of the location",
"example": "-94.2332754"
},
"latitude": {
"type": "string",
"description": "Auto-generated latitude coordinates of the location",
"example": "39.3514073"
}
},
"description": "Required details and restrictions for the load's requested pickup location."
}
}
},
"vehicles": {
"type": "array",
"items": {
"required": [
"operableType"
],
"type": "object",
"properties": {
"bodyType": {
"type": "string",
"description": "Body type of the vehicle (sedan, SUV, pickup, motorcycle, mini-van, van)",
"example": "Car"
},
"buyerNumber": {
"type": "string",
"description": "Number used to purchase the vehicle during an auction. Can be defined by the customer.",
"example": "123CXS23"
},
"color": {
"type": "string",
"description": "Color of the vehicle.",
"example": "red"
},
"lotNumber": {
"type": "string",
"description": "Parking number the vehicle was positioned during an auction. Can be defined by the customer.",
"example": "123CXS23"
},
"stockNumber": {
"type": "string",
"description": "Unique vehicle stock number. Can be defined by the customer.",
"example": "123CXS23"
},
"vin": {
"type": "string",
"description": "Unique vehicle identification number. Replaces year,make and model.",
"example": "1D4GP24R85B225747"
},
"year": {
"minimum": 1900,
"type": "integer",
"description": "Vehicle manufacture year.",
"format": "int32",
"example": 2022
},
"make": {
"type": "string",
"description": "Vehicle brand (manufacturer).",
"example": "BMW"
},
"model": {
"type": "string",
"description": "Vehicle model/brand series.",
"example": "218i"
},
"inventoryUnitId": {
"maxLength": 128,
"minLength": 0,
"type": "string",
"description": "Inventory unit ID",
"example": "IU-2VK5EDPDNVHGJHTYFSQ7USQYB4"
},
"id": {
"type": "string",
"description": "Internal ID of the vehicle",
"example": "YK41K"
},
"length": {
"type": "string",
"description": "Length size of the vehicle.",
"example": "4526"
},
"height": {
"type": "string",
"description": "Height size of the vehicle.",
"example": "1420"
},
"width": {
"type": "string",
"description": "Width size of the vehicle.",
"example": "1800"
},
"weight": {
"type": "string",
"description": "Weight of the vehicle.",
"example": "1325"
},
"logo": {
"type": "string",
"description": "URL of the vehicle make's logo.",
"example": "https://image.com/bmw.jpg"
},
"totalRate": {
"minimum": 0,
"type": "integer",
"description": "Rate of the vehicle, in cents.",
"format": "int64",
"example": 10000
},
"galleryUrl": {
"type": "string",
"description": "Gallery URL of the vehicle.",
"example": "https://ship.cars/app/gallery#eyJ..."
},
"operableType": {
"type": "string",
"description": "Required identifying whether the vehicle is operable or inoperable",
"example": "OPERABLE",
"default": "OPERABLE",
"enum": [
"OPERABLE",
"INOPERABLE"
]
},
"lbExternalId": {
"type": "string",
"description": "External ID of the vehicle as seen in the Load Board platform.",
"example": "123CXS23"
},
"customInformation": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Custom information for the vehicle.",
"example": "123CXS23"
}
},
"description": "Details and restrictions for the vehicle(s) included in the load."
}
},
"useEnclosedTrailer": {
"type": "boolean",
"description": "Shows whether to use or not enclosed trailer"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"rateId": {
"type": "string"
},
"distanceInMiles": {
"type": "string"
},
"carrierPayInCents": {
"type": "integer",
"format": "int64"
},
"autoTypeSurchargeInCents": {
"type": "integer",
"format": "int64"
},
"enclosedSurchargeInCents": {
"type": "integer",
"format": "int64"
},
"reverseRouteCarrierPayInCents": {
"type": "integer",
"format": "int64"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time"
},
"httpStatus": {
"type": "integer",
"format": "int32"
},
"errorCode": {
"type": "integer",
"format": "int32"
},
"errorMessage": {
"type": "string"
},
"errorDetails": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```