RateIt API v3 (Jbhunt internal clients only)
Calculate Rates
Calculate rates as per the contractual agreement. this end point have 2 type's of request body one for the FTL and othe for LTL. request discriminate by the shipmentType property.
Request
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
-
stringOAuth 2.0 access token obtained from JB Hunt OAuth 2.0 Test Provider (RHSSO - jbhcorp). Supported grant types: Authorization code.
Request body
{
"customerCode": "JBJA7",
"partyID": 100,
"rateRequestProcesses": [
"ALL"
],
"rateSource": [
"AGREEMENT"
],
"origin": {
"streetAddress": "615 J B Hunt Corporate Dr",
"adminArea1": "AR",
"adminArea2": "Benton",
"locality": "Lowell",
"neighborhood": "string",
"postalCode": "72745",
"postalExt": "1234",
"countryCode": "USA",
"locationCode": "ABC123",
"vendorID": "ABC"
},
"destination": {
"streetAddress": "615 J B Hunt Corporate Dr",
"adminArea1": "AR",
"adminArea2": "Benton",
"locality": "Lowell",
"neighborhood": "string",
"postalCode": "72745",
"postalExt": "1234",
"countryCode": "USA",
"locationCode": "ABC123",
"vendorID": "ABC"
},
"pickupDate": "string",
"intermediateStops": [
{
"sequenceNumber": 2,
"stopReason": "Pickup",
"streetAddress": "615 J B Hunt Corporate Dr",
"adminArea1": "AR",
"adminArea2": "Benton",
"locality": "Lowell",
"neighborhood": "string",
"postalCode": "72745",
"postalExt": "1234",
"countryCode": "USA",
"locationCode": "ABC123",
"vendorID": "ABC"
}
],
"shipmentType": "FTL",
"flexibleDays": "+-5",
"options": {
"transportationMode": [
"Truck"
],
"lowestRate": true,
"businessUnit": [
"JBT"
],
"serviceOffering": [
"Intermodal"
],
"serviceLevel": [
"STANDARD"
],
"serviceTypeCode": [
"DOOR2DOOR"
],
"equipmentClassificationCode": [
"CONTAINER"
],
"equipmentTypeCode": [
"REFRIGERTD"
],
"equipmentLengthSpecificationCode": [
53
],
"accessorials": [
{
"chargeCode": "LUMPLOAD",
"chargeCodeDescription": "FUEL SURGE CHARGE",
"stopSequenceNumber": 2,
"quantity": {
"unitText": "Miles",
"value": 100.0
},
"cost": {
"currencyCode": "USD",
"value": "10.00"
},
"overrideChargeIndicator": true
}
],
"pieceCount": 10,
"totalCarrierCharges": 50.7,
"hazmatPlacardedIndicator": true,
"borderCrossing": {
"streetAddress": "615 J B Hunt Corporate Dr",
"adminArea1": "AR",
"adminArea2": "Benton",
"locality": "Lowell",
"neighborhood": "string",
"postalCode": "72745",
"postalExt": "1234",
"countryCode": "USA",
"locationCode": "ABC123",
"vendorID": "ABC"
},
"weight": {
"unitText": "Pounds",
"value": 100.0
},
"carriers": [
{
"type": "string",
"id": "string"
}
],
"useProvidedDistance": {
"unitText": "Miles",
"value": 100.0
},
"fuelAverage": {
"fuelProvider": "DOE",
"currencyCode": "USD",
"value": 100.0
}
},
"products": [
{
"description": "FAK",
"fakClass": "300",
"weight": {
"unitText": "Pounds",
"value": 100.0
},
"dimension": {
"unitText": "Inches",
"value": 100
},
"itemPackageType": "Pieces",
"itemPackageQuantity": 1.0,
"stackable": true
}
]
}{
"anyOf": [
{
"title": "FTL Rate Request",
"allOf": [
{
"title": "Rate Request",
"required": [
"origin",
"destination",
"rateSource",
"shipmentType",
"options"
],
"type": "object",
"properties": {
"customerCode": {
"title": "Customer Code",
"type": "string",
"description": "J.B. Hunt-provided customer code. Required if partyID is not passed.",
"example": "JBJA7"
},
"partyID": {
"title": "PartyID",
"type": "integer",
"description": "Identifier representing an Organization or Bill To account. Required if Customer Code is not passed.",
"format": "int32",
"example": 100
},
"rateRequestProcesses": {
"title": "Rate Request Processes",
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"ALL",
"LINEHAUL",
"ACCESSORIAL",
"SPECIFICACCESSORIAL",
"FUEL"
],
"type": "string",
"example": "ALL"
},
"description": "Enum value array to search Linehaul, Accessorial, SpecificAccessorial and/or Fuel data in a Rate Request."
},
"rateSource": {
"title": "rateSource",
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"AGREEMENT",
"SPOT",
"MARKET",
"OFFER"
],
"type": "string",
"example": "AGREEMENT"
},
"description": "Source serviee for this rate to processed."
},
"origin": {
"title": "Postal Address",
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "address (eg. number, street, etc.).",
"example": "615 J B Hunt Corporate Dr"
},
"adminArea1": {
"type": "string",
"description": "Province, state, or [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision. Required if locationCode is not passed.",
"example": "AR"
},
"adminArea2": {
"type": "string",
"description": "Subdivision smaller than `adminArea1`. In the United States, this refers to county.",
"example": "Benton"
},
"locality": {
"type": "string",
"description": "City or town. Required if locationCode is not passed.",
"example": "Lowell"
},
"neighborhood": {
"type": "string",
"description": "The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place. A neighborhood is a subdivision of a city"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code. Required if locationCode is not passed.",
"example": "72745"
},
"postalExt": {
"type": "string",
"description": "A postal code extension, such as the United States Postal Service ZIP+4 code, provides finer resolution or higher accuracy when also passing postal.",
"example": "1234"
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code. Required if locationCode is not passed.",
"example": "USA"
},
"locationCode": {
"title": "locationCode",
"type": "string",
"description": "Code used to reference the location. Required if adminArea1, locality, postalCode and countryCode is not passed.",
"example": "ABC123"
},
"vendorID": {
"title": "vendorID",
"type": "string",
"description": "The ID of the vendor at the location",
"example": "ABC"
}
},
"description": "Postal Address"
},
"destination": {
"title": "Postal Address",
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "address (eg. number, street, etc.).",
"example": "615 J B Hunt Corporate Dr"
},
"adminArea1": {
"type": "string",
"description": "Province, state, or [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision. Required if locationCode is not passed.",
"example": "AR"
},
"adminArea2": {
"type": "string",
"description": "Subdivision smaller than `adminArea1`. In the United States, this refers to county.",
"example": "Benton"
},
"locality": {
"type": "string",
"description": "City or town. Required if locationCode is not passed.",
"example": "Lowell"
},
"neighborhood": {
"type": "string",
"description": "The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place. A neighborhood is a subdivision of a city"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code. Required if locationCode is not passed.",
"example": "72745"
},
"postalExt": {
"type": "string",
"description": "A postal code extension, such as the United States Postal Service ZIP+4 code, provides finer resolution or higher accuracy when also passing postal.",
"example": "1234"
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code. Required if locationCode is not passed.",
"example": "USA"
},
"locationCode": {
"title": "locationCode",
"type": "string",
"description": "Code used to reference the location. Required if adminArea1, locality, postalCode and countryCode is not passed.",
"example": "ABC123"
},
"vendorID": {
"title": "vendorID",
"type": "string",
"description": "The ID of the vendor at the location",
"example": "ABC"
}
},
"description": "Postal Address"
},
"pickupDate": {
"title": "Full Date",
"type": "string",
"description": "As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date"
},
"intermediateStops": {
"title": "Intermediate Stops",
"type": "array",
"items": {
"required": [
"sequenceNumber",
"stopReason"
],
"type": "object",
"allOf": [
{
"title": "Postal Address",
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "address (eg. number, street, etc.).",
"example": "615 J B Hunt Corporate Dr"
},
"adminArea1": {
"type": "string",
"description": "Province, state, or [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision. Required if locationCode is not passed.",
"example": "AR"
},
"adminArea2": {
"type": "string",
"description": "Subdivision smaller than `adminArea1`. In the United States, this refers to county.",
"example": "Benton"
},
"locality": {
"type": "string",
"description": "City or town. Required if locationCode is not passed.",
"example": "Lowell"
},
"neighborhood": {
"type": "string",
"description": "The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place. A neighborhood is a subdivision of a city"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code. Required if locationCode is not passed.",
"example": "72745"
},
"postalExt": {
"type": "string",
"description": "A postal code extension, such as the United States Postal Service ZIP+4 code, provides finer resolution or higher accuracy when also passing postal.",
"example": "1234"
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code. Required if locationCode is not passed.",
"example": "USA"
},
"locationCode": {
"title": "locationCode",
"type": "string",
"description": "Code used to reference the location. Required if adminArea1, locality, postalCode and countryCode is not passed.",
"example": "ABC123"
},
"vendorID": {
"title": "vendorID",
"type": "string",
"description": "The ID of the vendor at the location",
"example": "ABC"
}
},
"description": "Postal Address"
}
],
"properties": {
"sequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"stopReason": {
"enum": [
"Pickup",
"Delivery"
],
"type": "string",
"description": "Whether the stop is a pickup or a drop",
"example": "Pickup"
}
},
"description": "Stop details"
},
"description": "Stops that will be performed between the origin and destination"
},
"shipmentType": {
"type": "string",
"description": "Shipment Type. Full Truck Load (FTL) or Less-Than Truck Load (LTL) or Both FTL & LTL . Allowed values - FTL , LTL",
"example": "FTL"
},
"flexibleDays": {
"title": "flexibleDays",
"type": "string",
"description": "Number of days a rate can be requested before or after the pickup date in the following format. A + and or - followed by a number no greater than 5.",
"example": "+-5"
},
"options": {
"title": "Rate Request Options",
"required": [
"weight",
"businessUnit",
"serviceOffering"
],
"type": "object",
"properties": {
"transportationMode": {
"title": "Transportation mode",
"type": "array",
"items": {
"title": "Transportation Mode",
"enum": [
"Truck",
"Rail"
],
"type": "string",
"description": "Transportation Mode (allowed values - Truck , Rail)",
"example": "Truck"
},
"description": "The list transportation modes"
},
"lowestRate": {
"type": "boolean",
"description": "Indicates whether to retrieve only the lowest rate (`true`) or all available rates (`false`).\n"
},
"businessUnit": {
"title": "businessUnit",
"type": "array",
"items": {
"enum": [
"ALL",
"JBT",
"JBI",
"ICS",
"DCS"
],
"type": "string",
"example": "JBT"
},
"description": "Code representing the Financial Business Units. Allowed Values (ALL, JBT, JBI, ICS, DCS)"
},
"serviceOffering": {
"title": "serviceOffering",
"type": "array",
"items": {
"type": "string",
"example": "Intermodal"
},
"description": "Code representing different services offered by the Buisness Units. Allowed Values (ALL, BACKHAUL, BROKERAGE, DEDICATED, FLATBED, INTERMODAL, LTL, OTR, REEFER)"
},
"serviceLevel": {
"title": "serviceLevel",
"type": "array",
"items": {
"enum": [
"STANDARD",
"PREMIUM"
],
"type": "string",
"example": "STANDARD"
},
"description": "Code representing the level of service. Allowed values (STANDARD, PREMIUM)"
},
"serviceTypeCode": {
"title": "serviceTypeCode",
"type": "array",
"items": {
"type": "string",
"example": "DOOR2DOOR"
},
"description": "Code representing a type of service as defined in '360 Orders' system. Allowed values (ORGCUSDRAY, DSTCUSDRAY, SELFDRAY, TEAM, DOOR2DOOR)"
},
"equipmentClassificationCode": {
"title": "equipmentClassificationCode",
"type": "array",
"items": {
"enum": [
"CONTAINER",
"FLATBED",
"TRAILER"
],
"type": "string",
"example": "CONTAINER"
},
"description": "Code representing a type of Equipment classification as defined in AssetMDM database. Allowed Values (CONTAINER, FLATBED, TRAILER)"
},
"equipmentTypeCode": {
"title": "equipmentTypeCode",
"type": "array",
"items": {
"enum": [
"DRY VAN",
"REFRIGERTD",
"STANDARD"
],
"type": "string",
"example": "REFRIGERTD"
},
"description": "Code representing a type of Equipment as defined in AssetMDM database. Allowed values (DRY VAN, REFRIGERTD, STANDARD)"
},
"equipmentLengthSpecificationCode": {
"title": "equipmentLengthSpecificationCode",
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"example": 53
},
"description": "Code representing the specified length of a piece of Equipment in feet as defined in AssetMDM database. Allowed Values(28, 32, 36, 40, 42, 43, 45, 48, 53, 57)"
},
"accessorials": {
"title": "Accessorials Request Requirements",
"type": "array",
"items": {
"title": "Request Accessorial",
"required": [
"chargeCode"
],
"type": "object",
"properties": {
"chargeCode": {
"type": "string",
"description": "Accessorial charge code. Allowed values - [Charge Codes Share point excel]( https://jbhunt.sharepoint.com/:x:/r/sites/ProjectNEXTTeam/Shared%20Documents/Pricing,%20Rating,%20and%20Billing/Rating/JB%20Hunt%20Charge%20Codes.xlsx?d=wba3e4020bf2440c981c5aa35cf96e9f0&csf=1&web=1&e=AfFNJE)",
"example": "LUMPLOAD"
},
"chargeCodeDescription": {
"type": "string",
"description": "Information on description of accessorial charge code",
"example": "FUEL SURGE CHARGE"
},
"stopSequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"quantity": {
"title": "Accessorial Quantitative Value",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"title": "unitText",
"type": "string",
"description": "Unit of measure. Allowed values - Pounds, Kilograms, Flat, Days, Hours, Minutes, Pieces, Miles, Kilometers, Percent"
},
"value": {
"title": "value",
"type": "number",
"format": "double"
}
},
"description": "Quantitative value for an accessorial charge",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"cost": {
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
},
"overrideChargeIndicator": {
"title": "overrideChargeIndicator",
"type": "boolean",
"description": "Flag to determine if user provided amount should override any calculated total. Indicates whether to override the charge (`true`) or not override any charge caluclations (`false`)",
"example": true
}
},
"description": "Accessorials charges requested to be included."
},
"description": "Options for requesting accessorials charges to be included in the rate response."
},
"pieceCount": {
"title": "pieceCount",
"type": "integer",
"description": "Requested number of pieces for the products in the rate.",
"format": "int32",
"example": 10
},
"totalCarrierCharges": {
"type": "number",
"description": "User provided value used in Marketplace Linehaul calculations",
"example": 50.7
},
"hazmatPlacardedIndicator": {
"title": "hazmatPlacardedIndicator",
"type": "boolean",
"description": "Flag to determine if user provided hazmatPlacardedIndicator should apply on Hazmat charge code. Indicates whether Hazmat charge code apply hazmatPlacarded (`true`) or not apply hazmatPlacarded for Hazmat charge (`false`)",
"example": true
},
"borderCrossing": {
"title": "Postal Address",
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "address (eg. number, street, etc.).",
"example": "615 J B Hunt Corporate Dr"
},
"adminArea1": {
"type": "string",
"description": "Province, state, or [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision. Required if locationCode is not passed.",
"example": "AR"
},
"adminArea2": {
"type": "string",
"description": "Subdivision smaller than `adminArea1`. In the United States, this refers to county.",
"example": "Benton"
},
"locality": {
"type": "string",
"description": "City or town. Required if locationCode is not passed.",
"example": "Lowell"
},
"neighborhood": {
"type": "string",
"description": "The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place. A neighborhood is a subdivision of a city"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code. Required if locationCode is not passed.",
"example": "72745"
},
"postalExt": {
"type": "string",
"description": "A postal code extension, such as the United States Postal Service ZIP+4 code, provides finer resolution or higher accuracy when also passing postal.",
"example": "1234"
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code. Required if locationCode is not passed.",
"example": "USA"
},
"locationCode": {
"title": "locationCode",
"type": "string",
"description": "Code used to reference the location. Required if adminArea1, locality, postalCode and countryCode is not passed.",
"example": "ABC123"
},
"vendorID": {
"title": "vendorID",
"type": "string",
"description": "The ID of the vendor at the location",
"example": "ABC"
}
},
"description": "Postal Address"
},
"weight": {
"title": "Weight",
"required": [
"unitText",
"value"
],
"type": "object",
"properties": {
"unitText": {
"enum": [
"Pounds",
"Kilograms"
],
"type": "string",
"description": "weight units Alowed values - Pounds, Kilograms",
"example": "Pounds"
},
"value": {
"type": "number",
"description": "weight value in given units",
"format": "double",
"example": 100.0
}
},
"description": "Physical weight of a product or shipment"
},
"carriers": {
"title": "Carriers",
"type": "array",
"items": {
"title": "carrier type and identifer",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "carrier type Allowed values - SCAC , MC, DOT, JBHLEGACY, CARRIERMDM"
},
"id": {
"type": "string",
"description": "Id for the carrier type"
}
}
},
"description": "LTL rate request acceptes List of SCAC , MC, DOT, JBHLEGACY, CARRIERMDM request types. FTL rate request accepts only one carrier. if client requested list of carrier for FTL it acccepts first carrier only."
},
"useProvidedDistance": {
"title": "Distance",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Miles",
"example": "Miles"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "The value of the measurement for distance.",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"fuelAverage": {
"title": "Fuel Average",
"properties": {
"fuelProvider": {
"type": "string",
"description": "fuel caluclation base provider. Allowed values - DOE",
"example": "DOE"
},
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"title": "Double",
"type": "number",
"format": "double",
"example": 100.0
}
},
"description": "The fuel calculated by rating engine is based on the average fuel price provided.",
"example": {
"fuelProvider": "DOE",
"currencyCode": "USD",
"value": 100.0
}
}
},
"description": "More options in requesting rates"
},
"products": {
"title": "Products Request Requirements",
"type": "array",
"items": {
"title": "Product Request",
"required": [
"fakClass",
"weight",
"itemPackageType"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Commodity of the requested product.",
"example": "FAK"
},
"fakClass": {
"type": "string",
"description": "Freight of All Kinds (FAK). groups products of different classes at one standardized freight class so that they are billed or rated at the same class.",
"example": "300"
},
"weight": {
"title": "Weight",
"required": [
"unitText",
"value"
],
"type": "object",
"properties": {
"unitText": {
"enum": [
"Pounds",
"Kilograms"
],
"type": "string",
"description": "weight units Alowed values - Pounds, Kilograms",
"example": "Pounds"
},
"value": {
"type": "number",
"description": "weight value in given units",
"format": "double",
"example": 100.0
}
},
"description": "Physical weight of a product or shipment"
},
"dimension": {
"title": "Dimension",
"type": "object",
"properties": {
"length": {
"title": "Length",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Inches",
"example": "Inches"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "Physical length of a product.",
"example": {
"unitText": "Inches",
"value": 100.0
}
},
"width": {
"title": "Width",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Inches",
"example": "Inches"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "Physical width of a product.",
"example": {
"unitText": "Inches",
"value": 100.0
}
},
"height": {
"title": "Height",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Inches",
"example": "Inches"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "Physical height of a product.",
"example": {
"unitText": "Inches",
"value": 100.0
}
}
},
"description": "Physical dimension of a product",
"example": {
"unitText": "Inches",
"value": 100
}
},
"itemPackageType": {
"type": "string",
"description": "Packaging for item(s). Allowed Values - Bags, Barrels, Bins, Boxes, Buckets, Bundles, Case, Casks, Crates, Drums, Gaylords, Kegs, Pallets, Pieces, Reels, Rolls, Skids, Spools, Totes",
"example": "Pieces"
},
"itemPackageQuantity": {
"type": "number",
"description": "Quantity of items being shipped",
"example": 1.0
},
"stackable": {
"type": "boolean",
"description": "Indicates whether the product is stackable ('true') or non-stackable ('false').\n"
}
},
"description": "Products to be included as part of the rate request"
},
"description": "Product information used to determine product charges as part of the final rate"
}
},
"description": "Data provided for a rate to be calculated as per the contractual agreement"
}
],
"description": "Contains data for Full truck load (FTL) rates request as per the contractual agreement"
},
{
"title": "LTL Rate Request",
"required": [
"products"
],
"allOf": [
{
"title": "Rate Request",
"required": [
"origin",
"destination",
"rateSource",
"shipmentType",
"options"
],
"type": "object",
"properties": {
"customerCode": {
"title": "Customer Code",
"type": "string",
"description": "J.B. Hunt-provided customer code. Required if partyID is not passed.",
"example": "JBJA7"
},
"partyID": {
"title": "PartyID",
"type": "integer",
"description": "Identifier representing an Organization or Bill To account. Required if Customer Code is not passed.",
"format": "int32",
"example": 100
},
"rateRequestProcesses": {
"title": "Rate Request Processes",
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"ALL",
"LINEHAUL",
"ACCESSORIAL",
"SPECIFICACCESSORIAL",
"FUEL"
],
"type": "string",
"example": "ALL"
},
"description": "Enum value array to search Linehaul, Accessorial, SpecificAccessorial and/or Fuel data in a Rate Request."
},
"rateSource": {
"title": "rateSource",
"uniqueItems": true,
"type": "array",
"items": {
"enum": [
"AGREEMENT",
"SPOT",
"MARKET",
"OFFER"
],
"type": "string",
"example": "AGREEMENT"
},
"description": "Source serviee for this rate to processed."
},
"origin": {
"title": "Postal Address",
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "address (eg. number, street, etc.).",
"example": "615 J B Hunt Corporate Dr"
},
"adminArea1": {
"type": "string",
"description": "Province, state, or [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision. Required if locationCode is not passed.",
"example": "AR"
},
"adminArea2": {
"type": "string",
"description": "Subdivision smaller than `adminArea1`. In the United States, this refers to county.",
"example": "Benton"
},
"locality": {
"type": "string",
"description": "City or town. Required if locationCode is not passed.",
"example": "Lowell"
},
"neighborhood": {
"type": "string",
"description": "The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place. A neighborhood is a subdivision of a city"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code. Required if locationCode is not passed.",
"example": "72745"
},
"postalExt": {
"type": "string",
"description": "A postal code extension, such as the United States Postal Service ZIP+4 code, provides finer resolution or higher accuracy when also passing postal.",
"example": "1234"
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code. Required if locationCode is not passed.",
"example": "USA"
},
"locationCode": {
"title": "locationCode",
"type": "string",
"description": "Code used to reference the location. Required if adminArea1, locality, postalCode and countryCode is not passed.",
"example": "ABC123"
},
"vendorID": {
"title": "vendorID",
"type": "string",
"description": "The ID of the vendor at the location",
"example": "ABC"
}
},
"description": "Postal Address"
},
"destination": {
"title": "Postal Address",
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "address (eg. number, street, etc.).",
"example": "615 J B Hunt Corporate Dr"
},
"adminArea1": {
"type": "string",
"description": "Province, state, or [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision. Required if locationCode is not passed.",
"example": "AR"
},
"adminArea2": {
"type": "string",
"description": "Subdivision smaller than `adminArea1`. In the United States, this refers to county.",
"example": "Benton"
},
"locality": {
"type": "string",
"description": "City or town. Required if locationCode is not passed.",
"example": "Lowell"
},
"neighborhood": {
"type": "string",
"description": "The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place. A neighborhood is a subdivision of a city"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code. Required if locationCode is not passed.",
"example": "72745"
},
"postalExt": {
"type": "string",
"description": "A postal code extension, such as the United States Postal Service ZIP+4 code, provides finer resolution or higher accuracy when also passing postal.",
"example": "1234"
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code. Required if locationCode is not passed.",
"example": "USA"
},
"locationCode": {
"title": "locationCode",
"type": "string",
"description": "Code used to reference the location. Required if adminArea1, locality, postalCode and countryCode is not passed.",
"example": "ABC123"
},
"vendorID": {
"title": "vendorID",
"type": "string",
"description": "The ID of the vendor at the location",
"example": "ABC"
}
},
"description": "Postal Address"
},
"pickupDate": {
"title": "Full Date",
"type": "string",
"description": "As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date"
},
"intermediateStops": {
"title": "Intermediate Stops",
"type": "array",
"items": {
"required": [
"sequenceNumber",
"stopReason"
],
"type": "object",
"allOf": [
{
"title": "Postal Address",
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "address (eg. number, street, etc.).",
"example": "615 J B Hunt Corporate Dr"
},
"adminArea1": {
"type": "string",
"description": "Province, state, or [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision. Required if locationCode is not passed.",
"example": "AR"
},
"adminArea2": {
"type": "string",
"description": "Subdivision smaller than `adminArea1`. In the United States, this refers to county.",
"example": "Benton"
},
"locality": {
"type": "string",
"description": "City or town. Required if locationCode is not passed.",
"example": "Lowell"
},
"neighborhood": {
"type": "string",
"description": "The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place. A neighborhood is a subdivision of a city"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code. Required if locationCode is not passed.",
"example": "72745"
},
"postalExt": {
"type": "string",
"description": "A postal code extension, such as the United States Postal Service ZIP+4 code, provides finer resolution or higher accuracy when also passing postal.",
"example": "1234"
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code. Required if locationCode is not passed.",
"example": "USA"
},
"locationCode": {
"title": "locationCode",
"type": "string",
"description": "Code used to reference the location. Required if adminArea1, locality, postalCode and countryCode is not passed.",
"example": "ABC123"
},
"vendorID": {
"title": "vendorID",
"type": "string",
"description": "The ID of the vendor at the location",
"example": "ABC"
}
},
"description": "Postal Address"
}
],
"properties": {
"sequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"stopReason": {
"enum": [
"Pickup",
"Delivery"
],
"type": "string",
"description": "Whether the stop is a pickup or a drop",
"example": "Pickup"
}
},
"description": "Stop details"
},
"description": "Stops that will be performed between the origin and destination"
},
"shipmentType": {
"type": "string",
"description": "Shipment Type. Full Truck Load (FTL) or Less-Than Truck Load (LTL) or Both FTL & LTL . Allowed values - FTL , LTL",
"example": "FTL"
},
"flexibleDays": {
"title": "flexibleDays",
"type": "string",
"description": "Number of days a rate can be requested before or after the pickup date in the following format. A + and or - followed by a number no greater than 5.",
"example": "+-5"
},
"options": {
"title": "Rate Request Options",
"required": [
"weight",
"businessUnit",
"serviceOffering"
],
"type": "object",
"properties": {
"transportationMode": {
"title": "Transportation mode",
"type": "array",
"items": {
"title": "Transportation Mode",
"enum": [
"Truck",
"Rail"
],
"type": "string",
"description": "Transportation Mode (allowed values - Truck , Rail)",
"example": "Truck"
},
"description": "The list transportation modes"
},
"lowestRate": {
"type": "boolean",
"description": "Indicates whether to retrieve only the lowest rate (`true`) or all available rates (`false`).\n"
},
"businessUnit": {
"title": "businessUnit",
"type": "array",
"items": {
"enum": [
"ALL",
"JBT",
"JBI",
"ICS",
"DCS"
],
"type": "string",
"example": "JBT"
},
"description": "Code representing the Financial Business Units. Allowed Values (ALL, JBT, JBI, ICS, DCS)"
},
"serviceOffering": {
"title": "serviceOffering",
"type": "array",
"items": {
"type": "string",
"example": "Intermodal"
},
"description": "Code representing different services offered by the Buisness Units. Allowed Values (ALL, BACKHAUL, BROKERAGE, DEDICATED, FLATBED, INTERMODAL, LTL, OTR, REEFER)"
},
"serviceLevel": {
"title": "serviceLevel",
"type": "array",
"items": {
"enum": [
"STANDARD",
"PREMIUM"
],
"type": "string",
"example": "STANDARD"
},
"description": "Code representing the level of service. Allowed values (STANDARD, PREMIUM)"
},
"serviceTypeCode": {
"title": "serviceTypeCode",
"type": "array",
"items": {
"type": "string",
"example": "DOOR2DOOR"
},
"description": "Code representing a type of service as defined in '360 Orders' system. Allowed values (ORGCUSDRAY, DSTCUSDRAY, SELFDRAY, TEAM, DOOR2DOOR)"
},
"equipmentClassificationCode": {
"title": "equipmentClassificationCode",
"type": "array",
"items": {
"enum": [
"CONTAINER",
"FLATBED",
"TRAILER"
],
"type": "string",
"example": "CONTAINER"
},
"description": "Code representing a type of Equipment classification as defined in AssetMDM database. Allowed Values (CONTAINER, FLATBED, TRAILER)"
},
"equipmentTypeCode": {
"title": "equipmentTypeCode",
"type": "array",
"items": {
"enum": [
"DRY VAN",
"REFRIGERTD",
"STANDARD"
],
"type": "string",
"example": "REFRIGERTD"
},
"description": "Code representing a type of Equipment as defined in AssetMDM database. Allowed values (DRY VAN, REFRIGERTD, STANDARD)"
},
"equipmentLengthSpecificationCode": {
"title": "equipmentLengthSpecificationCode",
"type": "array",
"items": {
"type": "integer",
"format": "int32",
"example": 53
},
"description": "Code representing the specified length of a piece of Equipment in feet as defined in AssetMDM database. Allowed Values(28, 32, 36, 40, 42, 43, 45, 48, 53, 57)"
},
"accessorials": {
"title": "Accessorials Request Requirements",
"type": "array",
"items": {
"title": "Request Accessorial",
"required": [
"chargeCode"
],
"type": "object",
"properties": {
"chargeCode": {
"type": "string",
"description": "Accessorial charge code. Allowed values - [Charge Codes Share point excel]( https://jbhunt.sharepoint.com/:x:/r/sites/ProjectNEXTTeam/Shared%20Documents/Pricing,%20Rating,%20and%20Billing/Rating/JB%20Hunt%20Charge%20Codes.xlsx?d=wba3e4020bf2440c981c5aa35cf96e9f0&csf=1&web=1&e=AfFNJE)",
"example": "LUMPLOAD"
},
"chargeCodeDescription": {
"type": "string",
"description": "Information on description of accessorial charge code",
"example": "FUEL SURGE CHARGE"
},
"stopSequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"quantity": {
"title": "Accessorial Quantitative Value",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"title": "unitText",
"type": "string",
"description": "Unit of measure. Allowed values - Pounds, Kilograms, Flat, Days, Hours, Minutes, Pieces, Miles, Kilometers, Percent"
},
"value": {
"title": "value",
"type": "number",
"format": "double"
}
},
"description": "Quantitative value for an accessorial charge",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"cost": {
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
},
"overrideChargeIndicator": {
"title": "overrideChargeIndicator",
"type": "boolean",
"description": "Flag to determine if user provided amount should override any calculated total. Indicates whether to override the charge (`true`) or not override any charge caluclations (`false`)",
"example": true
}
},
"description": "Accessorials charges requested to be included."
},
"description": "Options for requesting accessorials charges to be included in the rate response."
},
"pieceCount": {
"title": "pieceCount",
"type": "integer",
"description": "Requested number of pieces for the products in the rate.",
"format": "int32",
"example": 10
},
"totalCarrierCharges": {
"type": "number",
"description": "User provided value used in Marketplace Linehaul calculations",
"example": 50.7
},
"hazmatPlacardedIndicator": {
"title": "hazmatPlacardedIndicator",
"type": "boolean",
"description": "Flag to determine if user provided hazmatPlacardedIndicator should apply on Hazmat charge code. Indicates whether Hazmat charge code apply hazmatPlacarded (`true`) or not apply hazmatPlacarded for Hazmat charge (`false`)",
"example": true
},
"borderCrossing": {
"title": "Postal Address",
"type": "object",
"properties": {
"streetAddress": {
"type": "string",
"description": "address (eg. number, street, etc.).",
"example": "615 J B Hunt Corporate Dr"
},
"adminArea1": {
"type": "string",
"description": "Province, state, or [ISO-3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision. Required if locationCode is not passed.",
"example": "AR"
},
"adminArea2": {
"type": "string",
"description": "Subdivision smaller than `adminArea1`. In the United States, this refers to county.",
"example": "Benton"
},
"locality": {
"type": "string",
"description": "City or town. Required if locationCode is not passed.",
"example": "Lowell"
},
"neighborhood": {
"type": "string",
"description": "The smallest administrative division associated with an address, typically, a neighborhood or a section of a larger populated place. A neighborhood is a subdivision of a city"
},
"postalCode": {
"type": "string",
"description": "ZIP, postcode, or postal code. Required if locationCode is not passed.",
"example": "72745"
},
"postalExt": {
"type": "string",
"description": "A postal code extension, such as the United States Postal Service ZIP+4 code, provides finer resolution or higher accuracy when also passing postal.",
"example": "1234"
},
"countryCode": {
"maxLength": 3,
"minLength": 3,
"pattern": "^[A-Z]{3}$",
"type": "string",
"description": "[ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country code. Required if locationCode is not passed.",
"example": "USA"
},
"locationCode": {
"title": "locationCode",
"type": "string",
"description": "Code used to reference the location. Required if adminArea1, locality, postalCode and countryCode is not passed.",
"example": "ABC123"
},
"vendorID": {
"title": "vendorID",
"type": "string",
"description": "The ID of the vendor at the location",
"example": "ABC"
}
},
"description": "Postal Address"
},
"weight": {
"title": "Weight",
"required": [
"unitText",
"value"
],
"type": "object",
"properties": {
"unitText": {
"enum": [
"Pounds",
"Kilograms"
],
"type": "string",
"description": "weight units Alowed values - Pounds, Kilograms",
"example": "Pounds"
},
"value": {
"type": "number",
"description": "weight value in given units",
"format": "double",
"example": 100.0
}
},
"description": "Physical weight of a product or shipment"
},
"carriers": {
"title": "Carriers",
"type": "array",
"items": {
"title": "carrier type and identifer",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "carrier type Allowed values - SCAC , MC, DOT, JBHLEGACY, CARRIERMDM"
},
"id": {
"type": "string",
"description": "Id for the carrier type"
}
}
},
"description": "LTL rate request acceptes List of SCAC , MC, DOT, JBHLEGACY, CARRIERMDM request types. FTL rate request accepts only one carrier. if client requested list of carrier for FTL it acccepts first carrier only."
},
"useProvidedDistance": {
"title": "Distance",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Miles",
"example": "Miles"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "The value of the measurement for distance.",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"fuelAverage": {
"title": "Fuel Average",
"properties": {
"fuelProvider": {
"type": "string",
"description": "fuel caluclation base provider. Allowed values - DOE",
"example": "DOE"
},
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"title": "Double",
"type": "number",
"format": "double",
"example": 100.0
}
},
"description": "The fuel calculated by rating engine is based on the average fuel price provided.",
"example": {
"fuelProvider": "DOE",
"currencyCode": "USD",
"value": 100.0
}
}
},
"description": "More options in requesting rates"
},
"products": {
"title": "Products Request Requirements",
"type": "array",
"items": {
"title": "Product Request",
"required": [
"fakClass",
"weight",
"itemPackageType"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Commodity of the requested product.",
"example": "FAK"
},
"fakClass": {
"type": "string",
"description": "Freight of All Kinds (FAK). groups products of different classes at one standardized freight class so that they are billed or rated at the same class.",
"example": "300"
},
"weight": {
"title": "Weight",
"required": [
"unitText",
"value"
],
"type": "object",
"properties": {
"unitText": {
"enum": [
"Pounds",
"Kilograms"
],
"type": "string",
"description": "weight units Alowed values - Pounds, Kilograms",
"example": "Pounds"
},
"value": {
"type": "number",
"description": "weight value in given units",
"format": "double",
"example": 100.0
}
},
"description": "Physical weight of a product or shipment"
},
"dimension": {
"title": "Dimension",
"type": "object",
"properties": {
"length": {
"title": "Length",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Inches",
"example": "Inches"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "Physical length of a product.",
"example": {
"unitText": "Inches",
"value": 100.0
}
},
"width": {
"title": "Width",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Inches",
"example": "Inches"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "Physical width of a product.",
"example": {
"unitText": "Inches",
"value": 100.0
}
},
"height": {
"title": "Height",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Inches",
"example": "Inches"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "Physical height of a product.",
"example": {
"unitText": "Inches",
"value": 100.0
}
}
},
"description": "Physical dimension of a product",
"example": {
"unitText": "Inches",
"value": 100
}
},
"itemPackageType": {
"type": "string",
"description": "Packaging for item(s). Allowed Values - Bags, Barrels, Bins, Boxes, Buckets, Bundles, Case, Casks, Crates, Drums, Gaylords, Kegs, Pallets, Pieces, Reels, Rolls, Skids, Spools, Totes",
"example": "Pieces"
},
"itemPackageQuantity": {
"type": "number",
"description": "Quantity of items being shipped",
"example": 1.0
},
"stackable": {
"type": "boolean",
"description": "Indicates whether the product is stackable ('true') or non-stackable ('false').\n"
}
},
"description": "Products to be included as part of the rate request"
},
"description": "Product information used to determine product charges as part of the final rate"
}
},
"description": "Data provided for a rate to be calculated as per the contractual agreement"
}
],
"properties": {
"products": {
"title": "Products Request Requirements",
"type": "array",
"items": {
"title": "Product Request",
"required": [
"fakClass",
"weight",
"itemPackageType"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Commodity of the requested product.",
"example": "FAK"
},
"fakClass": {
"type": "string",
"description": "Freight of All Kinds (FAK). groups products of different classes at one standardized freight class so that they are billed or rated at the same class.",
"example": "300"
},
"weight": {
"title": "Weight",
"required": [
"unitText",
"value"
],
"type": "object",
"properties": {
"unitText": {
"enum": [
"Pounds",
"Kilograms"
],
"type": "string",
"description": "weight units Alowed values - Pounds, Kilograms",
"example": "Pounds"
},
"value": {
"type": "number",
"description": "weight value in given units",
"format": "double",
"example": 100.0
}
},
"description": "Physical weight of a product or shipment"
},
"dimension": {
"title": "Dimension",
"type": "object",
"properties": {
"length": {
"title": "Length",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Inches",
"example": "Inches"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "Physical length of a product.",
"example": {
"unitText": "Inches",
"value": 100.0
}
},
"width": {
"title": "Width",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Inches",
"example": "Inches"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "Physical width of a product.",
"example": {
"unitText": "Inches",
"value": 100.0
}
},
"height": {
"title": "Height",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Inches",
"example": "Inches"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "Physical height of a product.",
"example": {
"unitText": "Inches",
"value": 100.0
}
}
},
"description": "Physical dimension of a product",
"example": {
"unitText": "Inches",
"value": 100
}
},
"itemPackageType": {
"type": "string",
"description": "Packaging for item(s). Allowed Values - Bags, Barrels, Bins, Boxes, Buckets, Bundles, Case, Casks, Crates, Drums, Gaylords, Kegs, Pallets, Pieces, Reels, Rolls, Skids, Spools, Totes",
"example": "Pieces"
},
"itemPackageQuantity": {
"type": "number",
"description": "Quantity of items being shipped",
"example": 1.0
},
"stackable": {
"type": "boolean",
"description": "Indicates whether the product is stackable ('true') or non-stackable ('false').\n"
}
},
"description": "Products to be included as part of the rate request"
},
"description": "Product information used to determine product charges as part of the final rate"
}
},
"description": "Contains data for Less-than truck load (LTL) rates request as per the contractual agreement"
}
]
}Responses
200 OK
Successfully retrieved rates
Representations
{
"guid": "12345",
"returnCode": "SUCCESS",
"statusCode": 200,
"returnMessage": [
{
"messageCode": "string",
"messageDescription": "string",
"messagePlaceHolders": {}
}
],
"rates": [
{
"baseRateHeader": {
"rateDetails": {
"sourceEngine": "360RATING",
"rateSource": "AGREEMENT",
"rateQuoteID": 10.0,
"contractID": 10.0,
"contractCode": "SP",
"contractName": "Sierra Papa",
"sectionID": 10.0,
"sectionCode": "B",
"sectionName": "Beta",
"itemCode": "ABC",
"financeBusinessUnitCode": "JBT",
"serviceOfferingCode": "OTR",
"serviceLevelCode": "STANDARD",
"serviceTypeCode": "TEAM",
"transportationMode": "Truck",
"equipmentClassificationCode": "Container",
"equipmentTypeCode": "REFRIGERTD",
"equipmentLengthSpecificationCode": "53Ft",
"mileageProgram": {
"mileageSystemCode": "PC Miler",
"mileageSystemVersion": "19",
"customMileageVersionID": 10,
"mileageCalculationType": "DIRECT",
"mileageRouteType": "PRACTICAL",
"geographicPointTypeCode": "City",
"borderStopIndicator": true,
"borderCrossingIndicator": false,
"decimalPrecisionIndicator": false,
"mileageSystemParameter": {}
},
"billableDistance": {
"unitText": "Miles",
"value": 100.0
},
"weight": {
"unitText": "Pounds",
"value": 100.0
},
"pickupDate": "2019-11-01T00:00:00Z",
"shipmentType": "FTL",
"transitDays": 2,
"carrierQuoteId": "LNKGB11381",
"customerCode": "XYZ",
"carrier": {
"type": "string",
"id": "string"
}
},
"rateMessages": [
{
"messageCode": "string",
"messageDescription": "string",
"messagePlaceHolders": {}
}
]
},
"customerRateDetail": {
"lineHaulCharge": {
"lineHaulChargeDetails": {
"rateID": 10.0,
"conditionalRuleID": 10.0,
"rateEffectiveDate": "2019-11-01T00:00:00Z",
"rateExpirationDate": "2019-11-02T00:00:00Z",
"minimumChargeAmount": 25.5,
"autoRateIndicator": false,
"lineHaulAwardStatusTypeCode": "PRIMARY",
"stopChargeIncludedIndicator": true,
"originVendorID": "ABC",
"shipperLocationCode": "ORIG",
"destinationVendorID": "DEF",
"receiverLocationCode": "DEST",
"unitCost": {
"unitText": "string",
"cost": {
"currencyCode": "USD",
"value": "10.00"
}
}
},
"totalCost": {
"currencyCode": "USD",
"value": "10.00"
}
},
"totalCharge": {
"currencyCode": "USD",
"value": "10.00"
},
"accessorialsCharge": {
"accessorialTotalCost": {
"currencyCode": "USD",
"value": "10.00"
},
"accessorials": [
{
"rateID": 10.0,
"rateType": "Flat",
"rateAmount": 0.32,
"conditionalRuleID": 10.0,
"rateEffectiveDate": "2019-11-01T00:00:00Z",
"rateExpirationDate": "2019-11-02T00:00:00Z",
"accesorialsMessage": [
{
"messageCode": "string",
"messageDescription": "string",
"messagePlaceHolders": {}
}
],
"chargeDisplayIndicator": true,
"passThroughIndicator": false,
"chargeCode": "LUMPLOAD",
"chargeCodeDescription": "FUEL SURGE CHARGE",
"stopSequenceNumber": 2,
"quantity": {
"unitText": "Miles",
"value": 100.0
},
"cost": {
"currencyCode": "USD",
"value": "10.00"
}
}
]
},
"fuelCharge": {
"fuelTotalCost": {
"currencyCode": "USD",
"value": "10.00"
},
"fuelCharges": [
{
"rateID": 10.0,
"rateType": "Flat",
"rateAmount": 0.32,
"conditionalRuleID": 10.0,
"rateEffectiveDate": "2019-11-01T00:00:00Z",
"rateExpirationDate": "2019-11-02T00:00:00Z",
"accesorialsMessage": [
{
"messageCode": "string",
"messageDescription": "string",
"messagePlaceHolders": {}
}
],
"chargeDisplayIndicator": true,
"passThroughIndicator": false,
"chargeCode": "LUMPLOAD",
"chargeCodeDescription": "FUEL SURGE CHARGE",
"stopSequenceNumber": 2,
"quantity": {
"unitText": "Miles",
"value": 100.0
},
"cost": {
"currencyCode": "USD",
"value": "10.00"
}
}
]
}
},
"carrierRateDetail": {
"lineHaulCharge": {
"lineHaulChargeDetails": {
"rateID": 10.0,
"conditionalRuleID": 10.0,
"rateEffectiveDate": "2019-11-01T00:00:00Z",
"rateExpirationDate": "2019-11-02T00:00:00Z",
"minimumChargeAmount": 25.5,
"autoRateIndicator": false,
"lineHaulAwardStatusTypeCode": "PRIMARY",
"stopChargeIncludedIndicator": true,
"originVendorID": "ABC",
"shipperLocationCode": "ORIG",
"destinationVendorID": "DEF",
"receiverLocationCode": "DEST",
"unitCost": {
"unitText": "string",
"cost": {
"currencyCode": "USD",
"value": "10.00"
}
}
},
"totalCost": {
"currencyCode": "USD",
"value": "10.00"
}
},
"totalCharge": {
"currencyCode": "USD",
"value": "10.00"
},
"accessorialsCharge": {
"accessorialTotalCost": {
"currencyCode": "USD",
"value": "10.00"
},
"accessorials": [
{
"rateID": 10.0,
"rateType": "Flat",
"rateAmount": 0.32,
"conditionalRuleID": 10.0,
"rateEffectiveDate": "2019-11-01T00:00:00Z",
"rateExpirationDate": "2019-11-02T00:00:00Z",
"accesorialsMessage": [
{
"messageCode": "string",
"messageDescription": "string",
"messagePlaceHolders": {}
}
],
"chargeDisplayIndicator": true,
"passThroughIndicator": false,
"chargeCode": "LUMPLOAD",
"chargeCodeDescription": "FUEL SURGE CHARGE",
"stopSequenceNumber": 2,
"quantity": {
"unitText": "Miles",
"value": 100.0
},
"cost": {
"currencyCode": "USD",
"value": "10.00"
}
}
]
},
"fuelCharge": {
"fuelTotalCost": {
"currencyCode": "USD",
"value": "10.00"
},
"fuelCharges": [
{
"rateID": 10.0,
"rateType": "Flat",
"rateAmount": 0.32,
"conditionalRuleID": 10.0,
"rateEffectiveDate": "2019-11-01T00:00:00Z",
"rateExpirationDate": "2019-11-02T00:00:00Z",
"accesorialsMessage": [
{
"messageCode": "string",
"messageDescription": "string",
"messagePlaceHolders": {}
}
],
"chargeDisplayIndicator": true,
"passThroughIndicator": false,
"chargeCode": "LUMPLOAD",
"chargeCodeDescription": "FUEL SURGE CHARGE",
"stopSequenceNumber": 2,
"quantity": {
"unitText": "Miles",
"value": 100.0
},
"cost": {
"currencyCode": "USD",
"value": "10.00"
}
}
]
}
},
"marginRateDetail": {
"lineHaulCharge": {
"totalCost": {
"currencyCode": "USD",
"value": "10.00",
"percentage": "3.00"
},
"unitCost": {
"unitText": "string",
"cost": {
"currencyCode": "USD",
"value": "10.00",
"percentage": "3.00"
}
}
},
"totalCharge": {
"currencyCode": "USD",
"value": "10.00",
"percentage": "3.00"
},
"accessorialsCharge": {
"accessorialTotalCost": {
"currencyCode": "USD",
"value": "10.00"
},
"accessorials": [
{
"chargeCode": "LUMPLOAD",
"chargeCodeDescription": "FUEL SURGE CHARGE",
"stopSequenceNumber": 2,
"quantity": {
"unitText": "Miles",
"value": 100.0
},
"cost": {
"currencyCode": "USD",
"value": "10.00",
"percentage": "3.00"
}
}
]
},
"fuelCharge": {
"accessorialTotalCost": {
"currencyCode": "USD",
"value": "10.00"
},
"accessorials": [
{
"chargeCode": "LUMPLOAD",
"chargeCodeDescription": "FUEL SURGE CHARGE",
"stopSequenceNumber": 2,
"quantity": {
"unitText": "Miles",
"value": 100.0
},
"cost": {
"currencyCode": "USD",
"value": "10.00",
"percentage": "3.00"
}
}
]
}
}
}
]
}{
"title": "Calculate Rates Response",
"type": "object",
"properties": {
"guid": {
"title": "The guid assigned to the response",
"type": "string",
"description": "GUID",
"example": "12345"
},
"returnCode": {
"title": "returnCode",
"enum": [
"SUCCESS",
"FAILURE"
],
"type": "string",
"description": "Enum stating if request was Success or Failure.",
"example": "SUCCESS"
},
"statusCode": {
"title": "statusCode",
"type": "integer",
"description": "The status code of the response",
"format": "int32",
"example": 200
},
"returnMessage": {
"title": "returnMessage",
"type": "array",
"items": {
"title": "Message",
"type": "object",
"properties": {
"messageCode": {
"type": "string",
"description": "Rating Message catalog code."
},
"messageDescription": {
"type": "string",
"description": "user readable message description from the rating."
},
"messagePlaceHolders": {
"type": "object",
"additionalProperties": {
"type": "string",
"properties": {
"placeHolderValue": {
"type": "string",
"description": "Place Holders Value"
}
}
},
"description": "place holder have map of string key and string values for the catalog dynamic messages."
}
},
"description": "Provides additional information about the rate"
},
"description": "Provides additional information about the response."
},
"rates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"baseRateHeader": {
"title": "Rate Header",
"type": "object",
"properties": {
"rateDetails": {
"title": "RateDetails",
"type": "object",
"properties": {
"sourceEngine": {
"title": "sourceEngine",
"type": "string",
"description": "origination of the rating Engine for the given rate.Allowed Values (360RATING, LEGACY)",
"example": "360RATING"
},
"rateSource": {
"title": "rateSource",
"type": "string",
"description": "origination of the given rate sourced.",
"example": "AGREEMENT"
},
"rateQuoteID": {
"title": "rateQuoteID",
"type": "integer",
"description": "Identifier for an individual rate in this response. combination of Guid and the rate quote Id will make a rate unique.",
"format": "int64",
"example": 10.0
},
"contractID": {
"title": "contractID",
"type": "integer",
"description": "Identifier for a customer contract (publication) the rate belongs to",
"format": "int64",
"example": 10.0
},
"contractCode": {
"title": "contractCode",
"type": "string",
"description": "Code referring to a customer contract (publication)",
"example": "SP"
},
"contractName": {
"title": "contractName",
"type": "string",
"description": "Full name description of a customer contract (publication)",
"example": "Sierra Papa"
},
"sectionID": {
"title": "sectionID",
"type": "integer",
"description": "Identifier for a section of a customer contract. A section is defined for a group of Bill-to codes that deal in same currency",
"format": "int64",
"example": 10.0
},
"sectionCode": {
"title": "sectionCode",
"type": "string",
"description": "Code referring to a section of a customer contract.",
"example": "B"
},
"sectionName": {
"title": "sectionName",
"type": "string",
"description": "Full name description of a section of a customer contract",
"example": "Beta"
},
"itemCode": {
"title": "itemCode",
"type": "string",
"description": "Code given to the Items within a Section. Items are defined based on Origin and Destination points.",
"example": "ABC"
},
"financeBusinessUnitCode": {
"title": "financeBusinessUnitCode",
"type": "string",
"description": "Code representing the Financial Business Units. Allowed Values (JBT, JBI, ICS, DCS)",
"example": "JBT"
},
"serviceOfferingCode": {
"title": "serviceOfferingCode",
"type": "string",
"description": "Code representing different services offered by the Buisness Units. Allowed Values (BACKHAUL, BROKERAGE, DEDICATED, FLATBED, INTERMODAL, LTL, OTR, REEFER)",
"example": "OTR"
},
"serviceLevelCode": {
"title": "serviceLevelCode",
"type": "string",
"description": "Code representing the level of service. Allowed values (STANDARD, PREMIUM)",
"example": "STANDARD"
},
"serviceTypeCode": {
"title": "serviceTypeCode",
"type": "string",
"description": "Code representing a type of service as defined in '360 Orders' system. Allowed values (ORGCUSDRAY, DSTCUSDRAY, SELFDRAY, TEAM)",
"example": "TEAM"
},
"transportationMode": {
"title": "Transportation Mode",
"enum": [
"Truck",
"Rail"
],
"type": "string",
"description": "Transportation Mode (allowed values - Truck , Rail)",
"example": "Truck"
},
"equipmentClassificationCode": {
"title": "equipmentClassificationCode",
"type": "string",
"description": "Code representing a type of Equipment classification as defined in AssetMDM database. Allowed Values (CONTAINER, FLATBED, TRAILER)",
"example": "Container"
},
"equipmentTypeCode": {
"title": "equipmentTypeCode",
"type": "string",
"description": "Code representing a type of Equipment as defined in AssetMDM database. Allowed values (DRY VAN, REFRIGERTD, STANDARD)",
"example": "REFRIGERTD"
},
"equipmentLengthSpecificationCode": {
"title": "equipmentLengthSpecificationCode",
"type": "string",
"description": "Code representing the specified length of a piece of Equipment in feet as defined in AssetMDM database. Allowed Values(28Ft, 32Ft, 36Ft, 40Ft, 42Ft, 43Ft, 45Ft, 48Ft, 53Ft, 57Ft)",
"example": "53Ft"
},
"mileageProgram": {
"title": "MileageProgram",
"type": "object",
"properties": {
"mileageSystemCode": {
"title": "mileageSystemCode",
"type": "string",
"description": "Mileage System used in distance calculations. Allowed Values(CUSTOM, PC MILER, RAND MCNAL)",
"example": "PC Miler"
},
"mileageSystemVersion": {
"title": "mileageSystemVersion",
"type": "string",
"description": "Version of the Mileage System used in distance calculation",
"example": "19"
},
"customMileageVersionID": {
"title": "customMileageVersionID",
"type": "integer",
"description": "The identifier of the mileage system version used in distance calculation",
"example": 10
},
"mileageCalculationType": {
"title": "mileageCalculationType",
"type": "string",
"description": "Type of distance calculation that should used. Allowed values(DIRECT, CONSTRUCT, OUTOFROUTE)",
"example": "DIRECT"
},
"mileageRouteType": {
"title": "mileageRouteType",
"type": "string",
"description": "Type of route that will be calulated. Allowed values (SHORTEST, PRACTICAL). Shortest will prioritize calculating the shortest route possible, practical will prioritize a route that is practical but possibly not the shortest route possible.",
"example": "PRACTICAL"
},
"geographicPointTypeCode": {
"title": "geographicPointTypeCode",
"type": "string",
"description": "Type of geographic points to be used in calculating the distance. Allowed Values (City, PostalCode)",
"example": "City"
},
"borderStopIndicator": {
"title": "borderStopIndicator",
"type": "boolean",
"description": "Indicator for a stop at a border crossing location along the route. Allowed Values (true, false)",
"example": true
},
"borderCrossingIndicator": {
"title": "borderCrossingIndicator",
"type": "boolean",
"description": "Indicator for a border crossing event present in the route. Allowed Values (true, false)",
"example": false
},
"decimalPrecisionIndicator": {
"title": "decimalPrecisionIndicator",
"type": "boolean",
"description": "Indicator for Decimal Precision being used in distance calculations. Allowed Values (true, false)",
"example": false
},
"mileageSystemParameter": {
"title": "mileageSysetmParameter",
"type": "object",
"additionalProperties": {
"title": "additionalProperties",
"type": "string",
"description": "A parameter utilized in distance calculation that is not specified otherwise",
"example": "Example Parameter"
},
"description": "Additional Mileage System Parameters utilized in the distance calculations"
}
},
"description": "Describes the distance calculated between two locations in a route"
},
"billableDistance": {
"title": "Distance",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - Miles",
"example": "Miles"
},
"value": {
"title": "Double",
"type": "number",
"format": "double"
}
},
"description": "The value of the measurement for distance.",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"weight": {
"title": "Weight",
"required": [
"unitText",
"value"
],
"type": "object",
"properties": {
"unitText": {
"enum": [
"Pounds",
"Kilograms"
],
"type": "string",
"description": "weight units Alowed values - Pounds, Kilograms",
"example": "Pounds"
},
"value": {
"type": "number",
"description": "weight value in given units",
"format": "double",
"example": 100.0
}
},
"description": "Physical weight of a product or shipment"
},
"pickupDate": {
"title": "pickupDate",
"type": "string",
"description": "As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-01T00:00:00Z"
},
"shipmentType": {
"type": "string",
"description": "Shipment Type. Full Truck Load (FTL) or Less-Than Truck Load (LTL).",
"example": "FTL"
},
"transitDays": {
"type": "integer",
"description": "The number of days, excluding weekends and holidays, that a package is in transit from pickup to delivery.",
"format": "int32",
"example": 2
},
"carrierQuoteId": {
"type": "string",
"description": "Carrier(capacity provider) rate assosiated quote id.",
"example": "LNKGB11381"
},
"customerCode": {
"title": "Customer Code",
"type": "string",
"description": "J.B. Hunt-provided customer code",
"example": "XYZ"
},
"carrier": {
"title": "carrier type and identifer",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "carrier type Allowed values - SCAC , MC, DOT, JBHLEGACY, CARRIERMDM"
},
"id": {
"type": "string",
"description": "Id for the carrier type"
}
}
}
},
"description": "An object containing data points for given rate."
},
"rateMessages": {
"title": "Messages",
"type": "array",
"items": {
"title": "Message",
"type": "object",
"properties": {
"messageCode": {
"type": "string",
"description": "Rating Message catalog code."
},
"messageDescription": {
"type": "string",
"description": "user readable message description from the rating."
},
"messagePlaceHolders": {
"type": "object",
"additionalProperties": {
"type": "string",
"properties": {
"placeHolderValue": {
"type": "string",
"description": "Place Holders Value"
}
}
},
"description": "place holder have map of string key and string values for the catalog dynamic messages."
}
},
"description": "Provides additional information about the rate"
},
"description": "Messages"
}
},
"description": "Contains header data for a rate"
},
"customerRateDetail": {
"title": "Customer Rate Detail",
"type": "object",
"allOf": [
{
"title": "Base Rate Detail",
"type": "object",
"properties": {
"lineHaulCharge": {
"title": "Line Haul Charge",
"type": "object",
"properties": {
"lineHaulChargeDetails": {
"title": "LineHaulChargeDetails",
"type": "object",
"properties": {
"rateID": {
"title": "rateID",
"type": "integer",
"description": "Identifier for a LineHaul Rate.",
"format": "int64",
"example": 10.0
},
"conditionalRuleID": {
"title": "conditionalRuleID",
"type": "integer",
"description": "Conditional Rule Identifier for Mixed Code List Rates. This value refers to LIS_I in RAT_QFR_LIS table in SIMON NOW.",
"format": "int64",
"example": 10.0
},
"rateEffectiveDate": {
"title": "rateEffectiveDate",
"type": "string",
"description": "The date the rate being calculated first becomes active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-01T00:00:00Z"
},
"rateExpirationDate": {
"title": "rateExpirationDate",
"type": "string",
"description": "The date the rate being calculated is no longer active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-02T00:00:00Z"
},
"minimumChargeAmount": {
"title": "minimumChargeAmount",
"type": "number",
"description": "Minimum amount that can be returned for this the rate total.",
"example": 25.5
},
"autoRateIndicator": {
"title": "autoRateIndicator",
"type": "boolean",
"description": "Indicator determining if the Line Haul rates are auto rated",
"example": false
},
"lineHaulAwardStatusTypeCode": {
"title": "lineHaulAwardStatusTypeCode",
"type": "string",
"description": "Code for the precedence role awarded by the customer for this linehaul rate. Allowed Values ( PRIMARY, SECONDARY, ROUTEGUIDE)",
"example": "PRIMARY"
},
"stopChargeIncludedIndicator": {
"title": "stopChargeIncludedIndicator",
"type": "boolean",
"description": "Indicator determining if STOPOFF charges will not be applied. Allowed Values (True, False)",
"example": true
},
"originVendorID": {
"title": "originVendorID",
"type": "string",
"description": "The ID of the vendor present at the Origin of the linehaul",
"example": "ABC"
},
"shipperLocationCode": {
"title": "shipperLocationCode",
"type": "string",
"description": "The location code of the origin of the linehaul",
"example": "ORIG"
},
"destinationVendorID": {
"title": "destinationVendorID",
"type": "string",
"description": "The ID of the vendor present at the Destination of the linehaul",
"example": "DEF"
},
"receiverLocationCode": {
"title": "receiverLocationCode",
"type": "string",
"description": "The location code of the destination of the linehaul",
"example": "DEST"
},
"unitCost": {
"title": "Discrete Charge",
"properties": {
"unitText": {
"type": "string",
"description": "Unit of measure. Allowed values - CWT, FLAT, PER LNF, PER MILE, PER PALLET, PERCENT"
},
"cost": {
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
},
"description": "Cost per unit of measurement"
}
},
"description": "Details of a calculated LineHaul Charge."
},
"totalCost": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Total cost for the charge"
}
},
"description": "Charges to move freight between point A to point B"
},
"totalCharge": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Sum of `lineHaul`, `Accessorial` and `Fuel charges`"
},
"accessorialsCharge": {
"title": "accessorialsCharge",
"type": "object",
"properties": {
"accessorialTotalCost": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Total cost for the Accesorial charges"
},
"accessorials": {
"title": "accessorials",
"type": "array",
"items": {
"title": "Base Accessorial",
"required": [
"chargeCode"
],
"type": "object",
"properties": {
"rateID": {
"title": "rateID",
"type": "integer",
"description": "Identifier for an Accessorial Rate.",
"format": "int64",
"example": 10.0
},
"rateType": {
"title": "rateType",
"type": "string",
"description": "Type of calculation being used for the Accessorial rate. Allowed values(%ENTERED, %LH FUEL, %MGN LH, %MGN PTE, %PTE, %TOTALCHRG, CWT, FLAT, PER DAY, PER HOUR, PER MILE, PER MINUTE, PER PIECE, PERCENT, PTE DIFF, QTY MILES)",
"example": "Flat"
},
"rateAmount": {
"title": "rateAmount",
"type": "number",
"description": "base rate calculation being used for the Accessorial rate.",
"example": 0.32
},
"conditionalRuleID": {
"title": "conditionalRuleID",
"type": "integer",
"description": "Conditional Rule Identifier for Mixed Code List Rates.",
"format": "int64",
"example": 10.0
},
"rateEffectiveDate": {
"title": "rateEffectiveDate",
"type": "string",
"description": "The date the rate being calculated first becomes active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-01T00:00:00Z"
},
"rateExpirationDate": {
"title": "rateExpirationDate",
"type": "string",
"description": "The date the rate being calculated is no longer active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-02T00:00:00Z"
},
"accesorialsMessage": {
"title": "message",
"type": "array",
"items": {
"title": "Message",
"type": "object",
"properties": {
"messageCode": {
"type": "string",
"description": "Rating Message catalog code."
},
"messageDescription": {
"type": "string",
"description": "user readable message description from the rating."
},
"messagePlaceHolders": {
"type": "object",
"additionalProperties": {
"type": "string",
"properties": {
"placeHolderValue": {
"type": "string",
"description": "Place Holders Value"
}
}
},
"description": "place holder have map of string key and string values for the catalog dynamic messages."
}
},
"description": "Provides additional information about the rate"
},
"description": "Provides additional information about the Accessorial charge"
},
"chargeDisplayIndicator": {
"title": "chargeDisplayIndicator",
"type": "boolean",
"description": "Indicator for whether the charge should be displayed to the user.",
"example": true
},
"passThroughIndicator": {
"title": "passThroughIndicator",
"type": "boolean",
"description": "Pass Through Indicator",
"example": false
},
"chargeCode": {
"type": "string",
"description": "Accessorial charge code. Allowed values - [Charge Codes Share point excel]( https://jbhunt.sharepoint.com/:x:/r/sites/ProjectNEXTTeam/Shared%20Documents/Pricing,%20Rating,%20and%20Billing/Rating/JB%20Hunt%20Charge%20Codes.xlsx?d=wba3e4020bf2440c981c5aa35cf96e9f0&csf=1&web=1&e=AfFNJE)",
"example": "LUMPLOAD"
},
"chargeCodeDescription": {
"type": "string",
"description": "Information on description of accessorial charge code",
"example": "FUEL SURGE CHARGE"
},
"stopSequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"quantity": {
"title": "Accessorial Quantitative Value",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"title": "unitText",
"type": "string",
"description": "Unit of measure. Allowed values - Pounds, Kilograms, Flat, Days, Hours, Minutes, Pieces, Miles, Kilometers, Percent"
},
"value": {
"title": "value",
"type": "number",
"format": "double"
}
},
"description": "Quantitative value for an accessorial charge",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"cost": {
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
},
"description": "Accessorial charges returned as part of the rate response"
},
"description": "The list of accessorials Charges found"
}
},
"description": "Accessorials Charges with total accessorials amount"
},
"fuelCharge": {
"title": "fuelCharge",
"type": "object",
"properties": {
"fuelTotalCost": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Total cost for the charge"
},
"fuelCharges": {
"title": "fuelCharges",
"type": "array",
"items": {
"title": "Base Accessorial",
"required": [
"chargeCode"
],
"type": "object",
"properties": {
"rateID": {
"title": "rateID",
"type": "integer",
"description": "Identifier for an Accessorial Rate.",
"format": "int64",
"example": 10.0
},
"rateType": {
"title": "rateType",
"type": "string",
"description": "Type of calculation being used for the Accessorial rate. Allowed values(%ENTERED, %LH FUEL, %MGN LH, %MGN PTE, %PTE, %TOTALCHRG, CWT, FLAT, PER DAY, PER HOUR, PER MILE, PER MINUTE, PER PIECE, PERCENT, PTE DIFF, QTY MILES)",
"example": "Flat"
},
"rateAmount": {
"title": "rateAmount",
"type": "number",
"description": "base rate calculation being used for the Accessorial rate.",
"example": 0.32
},
"conditionalRuleID": {
"title": "conditionalRuleID",
"type": "integer",
"description": "Conditional Rule Identifier for Mixed Code List Rates.",
"format": "int64",
"example": 10.0
},
"rateEffectiveDate": {
"title": "rateEffectiveDate",
"type": "string",
"description": "The date the rate being calculated first becomes active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-01T00:00:00Z"
},
"rateExpirationDate": {
"title": "rateExpirationDate",
"type": "string",
"description": "The date the rate being calculated is no longer active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-02T00:00:00Z"
},
"accesorialsMessage": {
"title": "message",
"type": "array",
"items": {
"title": "Message",
"type": "object",
"properties": {
"messageCode": {
"type": "string",
"description": "Rating Message catalog code."
},
"messageDescription": {
"type": "string",
"description": "user readable message description from the rating."
},
"messagePlaceHolders": {
"type": "object",
"additionalProperties": {
"type": "string",
"properties": {
"placeHolderValue": {
"type": "string",
"description": "Place Holders Value"
}
}
},
"description": "place holder have map of string key and string values for the catalog dynamic messages."
}
},
"description": "Provides additional information about the rate"
},
"description": "Provides additional information about the Accessorial charge"
},
"chargeDisplayIndicator": {
"title": "chargeDisplayIndicator",
"type": "boolean",
"description": "Indicator for whether the charge should be displayed to the user.",
"example": true
},
"passThroughIndicator": {
"title": "passThroughIndicator",
"type": "boolean",
"description": "Pass Through Indicator",
"example": false
},
"chargeCode": {
"type": "string",
"description": "Accessorial charge code. Allowed values - [Charge Codes Share point excel]( https://jbhunt.sharepoint.com/:x:/r/sites/ProjectNEXTTeam/Shared%20Documents/Pricing,%20Rating,%20and%20Billing/Rating/JB%20Hunt%20Charge%20Codes.xlsx?d=wba3e4020bf2440c981c5aa35cf96e9f0&csf=1&web=1&e=AfFNJE)",
"example": "LUMPLOAD"
},
"chargeCodeDescription": {
"type": "string",
"description": "Information on description of accessorial charge code",
"example": "FUEL SURGE CHARGE"
},
"stopSequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"quantity": {
"title": "Accessorial Quantitative Value",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"title": "unitText",
"type": "string",
"description": "Unit of measure. Allowed values - Pounds, Kilograms, Flat, Days, Hours, Minutes, Pieces, Miles, Kilometers, Percent"
},
"value": {
"title": "value",
"type": "number",
"format": "double"
}
},
"description": "Quantitative value for an accessorial charge",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"cost": {
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
},
"description": "Accessorial charges returned as part of the rate response"
},
"description": "The list of fuel Charges found"
}
},
"description": "Fuel Charges with total Fuel amount"
}
},
"description": "Contains rate details data as per the contractual agreement"
}
],
"description": "Primary customer rate details."
},
"carrierRateDetail": {
"title": "Carrier Rate Detail",
"type": "object",
"allOf": [
{
"title": "Base Rate Detail",
"type": "object",
"properties": {
"lineHaulCharge": {
"title": "Line Haul Charge",
"type": "object",
"properties": {
"lineHaulChargeDetails": {
"title": "LineHaulChargeDetails",
"type": "object",
"properties": {
"rateID": {
"title": "rateID",
"type": "integer",
"description": "Identifier for a LineHaul Rate.",
"format": "int64",
"example": 10.0
},
"conditionalRuleID": {
"title": "conditionalRuleID",
"type": "integer",
"description": "Conditional Rule Identifier for Mixed Code List Rates. This value refers to LIS_I in RAT_QFR_LIS table in SIMON NOW.",
"format": "int64",
"example": 10.0
},
"rateEffectiveDate": {
"title": "rateEffectiveDate",
"type": "string",
"description": "The date the rate being calculated first becomes active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-01T00:00:00Z"
},
"rateExpirationDate": {
"title": "rateExpirationDate",
"type": "string",
"description": "The date the rate being calculated is no longer active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-02T00:00:00Z"
},
"minimumChargeAmount": {
"title": "minimumChargeAmount",
"type": "number",
"description": "Minimum amount that can be returned for this the rate total.",
"example": 25.5
},
"autoRateIndicator": {
"title": "autoRateIndicator",
"type": "boolean",
"description": "Indicator determining if the Line Haul rates are auto rated",
"example": false
},
"lineHaulAwardStatusTypeCode": {
"title": "lineHaulAwardStatusTypeCode",
"type": "string",
"description": "Code for the precedence role awarded by the customer for this linehaul rate. Allowed Values ( PRIMARY, SECONDARY, ROUTEGUIDE)",
"example": "PRIMARY"
},
"stopChargeIncludedIndicator": {
"title": "stopChargeIncludedIndicator",
"type": "boolean",
"description": "Indicator determining if STOPOFF charges will not be applied. Allowed Values (True, False)",
"example": true
},
"originVendorID": {
"title": "originVendorID",
"type": "string",
"description": "The ID of the vendor present at the Origin of the linehaul",
"example": "ABC"
},
"shipperLocationCode": {
"title": "shipperLocationCode",
"type": "string",
"description": "The location code of the origin of the linehaul",
"example": "ORIG"
},
"destinationVendorID": {
"title": "destinationVendorID",
"type": "string",
"description": "The ID of the vendor present at the Destination of the linehaul",
"example": "DEF"
},
"receiverLocationCode": {
"title": "receiverLocationCode",
"type": "string",
"description": "The location code of the destination of the linehaul",
"example": "DEST"
},
"unitCost": {
"title": "Discrete Charge",
"properties": {
"unitText": {
"type": "string",
"description": "Unit of measure. Allowed values - CWT, FLAT, PER LNF, PER MILE, PER PALLET, PERCENT"
},
"cost": {
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
},
"description": "Cost per unit of measurement"
}
},
"description": "Details of a calculated LineHaul Charge."
},
"totalCost": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Total cost for the charge"
}
},
"description": "Charges to move freight between point A to point B"
},
"totalCharge": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Sum of `lineHaul`, `Accessorial` and `Fuel charges`"
},
"accessorialsCharge": {
"title": "accessorialsCharge",
"type": "object",
"properties": {
"accessorialTotalCost": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Total cost for the Accesorial charges"
},
"accessorials": {
"title": "accessorials",
"type": "array",
"items": {
"title": "Base Accessorial",
"required": [
"chargeCode"
],
"type": "object",
"properties": {
"rateID": {
"title": "rateID",
"type": "integer",
"description": "Identifier for an Accessorial Rate.",
"format": "int64",
"example": 10.0
},
"rateType": {
"title": "rateType",
"type": "string",
"description": "Type of calculation being used for the Accessorial rate. Allowed values(%ENTERED, %LH FUEL, %MGN LH, %MGN PTE, %PTE, %TOTALCHRG, CWT, FLAT, PER DAY, PER HOUR, PER MILE, PER MINUTE, PER PIECE, PERCENT, PTE DIFF, QTY MILES)",
"example": "Flat"
},
"rateAmount": {
"title": "rateAmount",
"type": "number",
"description": "base rate calculation being used for the Accessorial rate.",
"example": 0.32
},
"conditionalRuleID": {
"title": "conditionalRuleID",
"type": "integer",
"description": "Conditional Rule Identifier for Mixed Code List Rates.",
"format": "int64",
"example": 10.0
},
"rateEffectiveDate": {
"title": "rateEffectiveDate",
"type": "string",
"description": "The date the rate being calculated first becomes active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-01T00:00:00Z"
},
"rateExpirationDate": {
"title": "rateExpirationDate",
"type": "string",
"description": "The date the rate being calculated is no longer active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-02T00:00:00Z"
},
"accesorialsMessage": {
"title": "message",
"type": "array",
"items": {
"title": "Message",
"type": "object",
"properties": {
"messageCode": {
"type": "string",
"description": "Rating Message catalog code."
},
"messageDescription": {
"type": "string",
"description": "user readable message description from the rating."
},
"messagePlaceHolders": {
"type": "object",
"additionalProperties": {
"type": "string",
"properties": {
"placeHolderValue": {
"type": "string",
"description": "Place Holders Value"
}
}
},
"description": "place holder have map of string key and string values for the catalog dynamic messages."
}
},
"description": "Provides additional information about the rate"
},
"description": "Provides additional information about the Accessorial charge"
},
"chargeDisplayIndicator": {
"title": "chargeDisplayIndicator",
"type": "boolean",
"description": "Indicator for whether the charge should be displayed to the user.",
"example": true
},
"passThroughIndicator": {
"title": "passThroughIndicator",
"type": "boolean",
"description": "Pass Through Indicator",
"example": false
},
"chargeCode": {
"type": "string",
"description": "Accessorial charge code. Allowed values - [Charge Codes Share point excel]( https://jbhunt.sharepoint.com/:x:/r/sites/ProjectNEXTTeam/Shared%20Documents/Pricing,%20Rating,%20and%20Billing/Rating/JB%20Hunt%20Charge%20Codes.xlsx?d=wba3e4020bf2440c981c5aa35cf96e9f0&csf=1&web=1&e=AfFNJE)",
"example": "LUMPLOAD"
},
"chargeCodeDescription": {
"type": "string",
"description": "Information on description of accessorial charge code",
"example": "FUEL SURGE CHARGE"
},
"stopSequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"quantity": {
"title": "Accessorial Quantitative Value",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"title": "unitText",
"type": "string",
"description": "Unit of measure. Allowed values - Pounds, Kilograms, Flat, Days, Hours, Minutes, Pieces, Miles, Kilometers, Percent"
},
"value": {
"title": "value",
"type": "number",
"format": "double"
}
},
"description": "Quantitative value for an accessorial charge",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"cost": {
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
},
"description": "Accessorial charges returned as part of the rate response"
},
"description": "The list of accessorials Charges found"
}
},
"description": "Accessorials Charges with total accessorials amount"
},
"fuelCharge": {
"title": "fuelCharge",
"type": "object",
"properties": {
"fuelTotalCost": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Total cost for the charge"
},
"fuelCharges": {
"title": "fuelCharges",
"type": "array",
"items": {
"title": "Base Accessorial",
"required": [
"chargeCode"
],
"type": "object",
"properties": {
"rateID": {
"title": "rateID",
"type": "integer",
"description": "Identifier for an Accessorial Rate.",
"format": "int64",
"example": 10.0
},
"rateType": {
"title": "rateType",
"type": "string",
"description": "Type of calculation being used for the Accessorial rate. Allowed values(%ENTERED, %LH FUEL, %MGN LH, %MGN PTE, %PTE, %TOTALCHRG, CWT, FLAT, PER DAY, PER HOUR, PER MILE, PER MINUTE, PER PIECE, PERCENT, PTE DIFF, QTY MILES)",
"example": "Flat"
},
"rateAmount": {
"title": "rateAmount",
"type": "number",
"description": "base rate calculation being used for the Accessorial rate.",
"example": 0.32
},
"conditionalRuleID": {
"title": "conditionalRuleID",
"type": "integer",
"description": "Conditional Rule Identifier for Mixed Code List Rates.",
"format": "int64",
"example": 10.0
},
"rateEffectiveDate": {
"title": "rateEffectiveDate",
"type": "string",
"description": "The date the rate being calculated first becomes active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-01T00:00:00Z"
},
"rateExpirationDate": {
"title": "rateExpirationDate",
"type": "string",
"description": "The date the rate being calculated is no longer active. As defined by `full-date` in [Section 5.6 of RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date",
"example": "2019-11-02T00:00:00Z"
},
"accesorialsMessage": {
"title": "message",
"type": "array",
"items": {
"title": "Message",
"type": "object",
"properties": {
"messageCode": {
"type": "string",
"description": "Rating Message catalog code."
},
"messageDescription": {
"type": "string",
"description": "user readable message description from the rating."
},
"messagePlaceHolders": {
"type": "object",
"additionalProperties": {
"type": "string",
"properties": {
"placeHolderValue": {
"type": "string",
"description": "Place Holders Value"
}
}
},
"description": "place holder have map of string key and string values for the catalog dynamic messages."
}
},
"description": "Provides additional information about the rate"
},
"description": "Provides additional information about the Accessorial charge"
},
"chargeDisplayIndicator": {
"title": "chargeDisplayIndicator",
"type": "boolean",
"description": "Indicator for whether the charge should be displayed to the user.",
"example": true
},
"passThroughIndicator": {
"title": "passThroughIndicator",
"type": "boolean",
"description": "Pass Through Indicator",
"example": false
},
"chargeCode": {
"type": "string",
"description": "Accessorial charge code. Allowed values - [Charge Codes Share point excel]( https://jbhunt.sharepoint.com/:x:/r/sites/ProjectNEXTTeam/Shared%20Documents/Pricing,%20Rating,%20and%20Billing/Rating/JB%20Hunt%20Charge%20Codes.xlsx?d=wba3e4020bf2440c981c5aa35cf96e9f0&csf=1&web=1&e=AfFNJE)",
"example": "LUMPLOAD"
},
"chargeCodeDescription": {
"type": "string",
"description": "Information on description of accessorial charge code",
"example": "FUEL SURGE CHARGE"
},
"stopSequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"quantity": {
"title": "Accessorial Quantitative Value",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"title": "unitText",
"type": "string",
"description": "Unit of measure. Allowed values - Pounds, Kilograms, Flat, Days, Hours, Minutes, Pieces, Miles, Kilometers, Percent"
},
"value": {
"title": "value",
"type": "number",
"format": "double"
}
},
"description": "Quantitative value for an accessorial charge",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"cost": {
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
},
"description": "Accessorial charges returned as part of the rate response"
},
"description": "The list of fuel Charges found"
}
},
"description": "Fuel Charges with total Fuel amount"
}
},
"description": "Contains rate details data as per the contractual agreement"
}
],
"description": "Rate details relating to the freight carrier."
},
"marginRateDetail": {
"title": "Margin Rate Detail",
"type": "object",
"allOf": [
{
"title": "Margin Rate Detail",
"type": "object",
"properties": {
"lineHaulCharge": {
"title": "Margin Rate Line Haul Charge",
"type": "object",
"properties": {
"totalCost": {
"allOf": [
{
"title": "Discrete Monetary Amount",
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
},
{
"properties": {
"percentage": {
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "percentage used to calculate Monetary Amount",
"example": "3.00"
}
}
}
],
"description": "A monetary value with percent"
}
],
"description": "Total cost for the charge"
},
"unitCost": {
"allOf": [
{
"title": "Margin Rate Discrete Charge",
"properties": {
"unitText": {
"type": "string",
"description": "Unit of Measure. Allowed values - PerMile, Flat"
},
"cost": {
"title": "Discrete Monetary Amount",
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
},
{
"properties": {
"percentage": {
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "percentage used to calculate Monetary Amount",
"example": "3.00"
}
}
}
],
"description": "A monetary value with percent"
}
},
"description": "Cost per unit of measurement"
}
],
"description": "Cost per unit of measurement"
}
},
"description": "Charges to move freight between point A to point B"
},
"totalCharge": {
"allOf": [
{
"title": "Discrete Monetary Amount",
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
},
{
"properties": {
"percentage": {
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "percentage used to calculate Monetary Amount",
"example": "3.00"
}
}
}
],
"description": "A monetary value with percent"
}
],
"description": "Sum of `lineHaulCharge`, `accessorials` and `Fuel`"
},
"accessorialsCharge": {
"title": "marginAccessorialsCharge",
"type": "object",
"properties": {
"accessorialTotalCost": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Total margin for the accesorial charges"
},
"accessorials": {
"title": "accessorials",
"type": "array",
"items": {
"title": "Margin Rate Response Accessorial",
"required": [
"chargeCode"
],
"type": "object",
"properties": {
"chargeCode": {
"type": "string",
"description": "Accessorial charge code.",
"example": "LUMPLOAD"
},
"chargeCodeDescription": {
"type": "string",
"description": "Information on description of accessorial charge code",
"example": "FUEL SURGE CHARGE"
},
"stopSequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"quantity": {
"title": "Accessorial Quantitative Value",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"title": "unitText",
"type": "string",
"description": "Unit of measure. Allowed values - Pounds, Kilograms, Flat, Days, Hours, Minutes, Pieces, Miles, Kilometers, Percent"
},
"value": {
"title": "value",
"type": "number",
"format": "double"
}
},
"description": "Quantitative value for an accessorial charge",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"cost": {
"title": "Discrete Monetary Amount",
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
},
{
"properties": {
"percentage": {
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "percentage used to calculate Monetary Amount",
"example": "3.00"
}
}
}
],
"description": "A monetary value with percent"
}
},
"description": "Accessorial charge Margin returned as part of the rate response"
},
"description": "The list of Accessorial charge Margin returned as part of the rate response"
}
},
"description": "Accessorial charge Margins with total accessorials margin amount"
},
"fuelCharge": {
"title": "marginAccessorialsCharge",
"type": "object",
"properties": {
"accessorialTotalCost": {
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
}
],
"description": "Total margin for the accesorial charges"
},
"accessorials": {
"title": "accessorials",
"type": "array",
"items": {
"title": "Margin Rate Response Accessorial",
"required": [
"chargeCode"
],
"type": "object",
"properties": {
"chargeCode": {
"type": "string",
"description": "Accessorial charge code.",
"example": "LUMPLOAD"
},
"chargeCodeDescription": {
"type": "string",
"description": "Information on description of accessorial charge code",
"example": "FUEL SURGE CHARGE"
},
"stopSequenceNumber": {
"type": "integer",
"description": "The stop number",
"format": "int32",
"example": 2
},
"quantity": {
"title": "Accessorial Quantitative Value",
"required": [
"unitText",
"value"
],
"properties": {
"unitText": {
"title": "unitText",
"type": "string",
"description": "Unit of measure. Allowed values - Pounds, Kilograms, Flat, Days, Hours, Minutes, Pieces, Miles, Kilometers, Percent"
},
"value": {
"title": "value",
"type": "number",
"format": "double"
}
},
"description": "Quantitative value for an accessorial charge",
"example": {
"unitText": "Miles",
"value": 100.0
}
},
"cost": {
"title": "Discrete Monetary Amount",
"allOf": [
{
"title": "Monetary Amount",
"type": "object",
"properties": {
"currencyCode": {
"maxLength": 3,
"minLength": 3,
"type": "string",
"description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.",
"example": "USD"
},
"value": {
"maxLength": 32,
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "The value, which can be anything from:\n* An integer. For currencies that are not typically fractional, such as `JPY`.\n* A three-place decimal fraction. For currencies that are subdivided into thousandths, such as `TND`.\n* An eight-place decimal fraction. For currencies such as Bitcoin.\n* For the required number of decimal places for a currency code, see ISO 4217.\n",
"example": "10.00"
}
},
"description": "A monetary value."
},
{
"properties": {
"percentage": {
"pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$",
"type": "string",
"description": "percentage used to calculate Monetary Amount",
"example": "3.00"
}
}
}
],
"description": "A monetary value with percent"
}
},
"description": "Accessorial charge Margin returned as part of the rate response"
},
"description": "The list of Accessorial charge Margin returned as part of the rate response"
}
},
"description": "Accessorial charge Margins with total accessorials margin amount"
}
},
"description": "Contains rate margin rate details data as per the contractual agreement"
}
],
"description": "Margin rate used in rate calculations."
}
},
"description": "Rate as per the contractual agreement"
},
"description": "All rates requested as per the contractual agreement"
}
},
"description": "Rates as per the contractual agreement"
}400 Bad Request
Cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). See RFC 7231, Section 6.5.1.
Representations
{
"returnCode": "FAILURE",
"statusCode": 400,
"guid": "d3ba38b8-54c1-4d20-b9f8-c6b81bb1913b",
"dateTime": "2021-01-15T19:48:06.120217Z",
"returnMessage": {
"returnMessage": [
{
"messageCode": "Origin_City_must_provided",
"messageDescription": "Origin City must be provided"
}
]
}
}{
"title": "Bad Request Problem Details",
"allOf": [
{
"title": "Bad Request Problem Details",
"type": "object",
"properties": {
"returnCode": {
"enum": [
"SUCCESS",
"FAILURE"
],
"type": "string",
"description": "return code stated status of the response. this have 2 values \"SUCCESS\" or \"FAILURE\"",
"default": "FAILURE",
"example": "FAILURE"
},
"statusCode": {
"maximum": 600.0,
"exclusiveMaximum": true,
"minimum": 100.0,
"type": "integer",
"description": "The [HTTP status code](https://tools.ietf.org/html/rfc7231#section-6) generated by the origin server for this occurrence of the problem.",
"format": "int32",
"example": 400
},
"guid": {
"type": "string",
"description": "GUID represent a unique identification for the request response in the rating service this will allow the auditing for the rates. A universally unique identifier as defined in [RFC 4122](https://tools.ietf.org/html/rfc4122)",
"example": "d3ba38b8-54c1-4d20-b9f8-c6b81bb1913b"
},
"dateTime": {
"type": "string",
"description": "The date and time that the problem occurred. As defined by `date-time` in [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6)",
"format": "date-time",
"example": "2021-01-15T19:48:06.120217Z"
},
"returnMessage": {
"title": "returnMessage",
"allOf": [
{
"title": "Messages",
"type": "array",
"items": {
"title": "Message",
"type": "object",
"properties": {
"messageCode": {
"type": "string",
"description": "Rating Message catalog code."
},
"messageDescription": {
"type": "string",
"description": "user readable message description from the rating."
},
"messagePlaceHolders": {
"type": "object",
"additionalProperties": {
"type": "string",
"properties": {
"placeHolderValue": {
"type": "string",
"description": "Place Holders Value"
}
}
},
"description": "place holder have map of string key and string values for the catalog dynamic messages."
}
},
"description": "Provides additional information about the rate"
},
"description": "Messages"
}
],
"description": "An array of issues related to specific fields in the HTTP request message",
"example": {
"returnMessage": [
{
"messageCode": "Origin_City_must_provided",
"messageDescription": "Origin City must be provided"
}
]
}
}
}
}
],
"description": "The [Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807) format with extensions."
}401 Unauthorized
The request has not been applied because it lacks valid authentication credentials for the target resource. See RFC 7235, Section 3.1.
Representations
{
"timestamp": "about:blank",
"status": 401,
"error": "Unauthorized",
"message": "Unable to authenticate using the Authorization header",
"path": "/ws_pricing_compositerates/api/v3/calculate-rates"
}{
"title": "Authentication Problem Details",
"allOf": [
{
"title": "Authentication Problem Details",
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "Create Timestamp (used for display purposes)",
"default": "about:blank"
},
"status": {
"maximum": 600.0,
"exclusiveMaximum": true,
"minimum": 100.0,
"type": "integer",
"description": "The [HTTP status code](https://tools.ietf.org/html/rfc7231#section-6) generated by the origin server for this occurrence of the problem.",
"format": "int32",
"example": 401
},
"error": {
"type": "string",
"description": "Error type of the problem.",
"example": "Unauthorized"
},
"message": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem.",
"example": "Unable to authenticate using the Authorization header"
},
"path": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem.",
"example": "/ws_pricing_compositerates/api/v3/calculate-rates"
}
}
}
],
"description": "The [Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807) format with extensions."
}403 Forbidden
The server understood the request but refuses to authorize it. See RFC 7231, Section 6.5.3.
Representations
{
"timestamp": "about:blank",
"status": 401,
"error": "Unauthorized",
"message": "Unable to authenticate using the Authorization header",
"path": "/ws_pricing_compositerates/api/v3/calculate-rates"
}{
"title": "Forbidden Problem Details",
"allOf": [
{
"title": "Forbidden Problem Details",
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "Create Timestamp (used for display purposes)",
"default": "about:blank"
},
"status": {
"maximum": 600.0,
"exclusiveMaximum": true,
"minimum": 100.0,
"type": "integer",
"description": "The [HTTP status code](https://tools.ietf.org/html/rfc7231#section-6) generated by the origin server for this occurrence of the problem.",
"format": "int32",
"example": 401
},
"error": {
"type": "string",
"description": "Error type of the problem.",
"example": "Unauthorized"
},
"message": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem.",
"example": "Unable to authenticate using the Authorization header"
},
"path": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem.",
"example": "/ws_pricing_compositerates/api/v3/calculate-rates"
}
}
}
],
"description": "The [Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807) format with extensions."
}500 Internal Server Error
The server encountered an unexpected condition that prevented it from fulfilling the request. See RFC 7231, Section 6.6.1.
Representations
{
"timestamp": "about:blank",
"status": 500,
"error": "Internal Server Error",
"message": "No message available",
"path": "/ws_pricing_compositerates/api/v3/calculate-rates"
}{
"title": "Internal Server Problem Details",
"allOf": [
{
"title": "Internal Server Problem Details",
"type": "object",
"properties": {
"timestamp": {
"type": "string",
"description": "Create Timestamp (used for display purposes)",
"default": "about:blank"
},
"status": {
"maximum": 600.0,
"exclusiveMaximum": true,
"minimum": 100.0,
"type": "integer",
"description": "The [HTTP status code](https://tools.ietf.org/html/rfc7231#section-6) generated by the origin server for this occurrence of the problem.",
"format": "int32",
"example": 500
},
"error": {
"type": "string",
"description": "Error type of the problem.",
"example": "Internal Server Error"
},
"message": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem.",
"example": "No message available"
},
"path": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem.",
"example": "/ws_pricing_compositerates/api/v3/calculate-rates"
}
}
}
],
"description": "The [Problem Details for HTTP APIs](https://tools.ietf.org/html/rfc7807) format with extensions."
}Code samples
@ECHO OFF
curl -v -X POST "https://api.nonprod.jbhunt.com/rating/v3/calculate-rates"
-H "Content-Type: application/json"
-H "Api-Key: {subscription key}"
-H "Authorization: {access token}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Api-Key", "{subscription key}");
client.DefaultRequestHeaders.Add("Authorization", "{access token}");
var uri = "https://api.nonprod.jbhunt.com/rating/v3/calculate-rates?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.nonprod.jbhunt.com/rating/v3/calculate-rates");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
request.setHeader("Api-Key", "{subscription key}");
request.setHeader("Authorization", "{access token}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://api.nonprod.jbhunt.com/rating/v3/calculate-rates?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Api-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.nonprod.jbhunt.com/rating/v3/calculate-rates";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Api-Key"];
[_request setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.nonprod.jbhunt.com/rating/v3/calculate-rates');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Api-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Api-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('api.nonprod.jbhunt.com')
conn.request("POST", "/rating/v3/calculate-rates?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'application/json',
'Api-Key': '{subscription key}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('api.nonprod.jbhunt.com')
conn.request("POST", "/rating/v3/calculate-rates?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.nonprod.jbhunt.com/rating/v3/calculate-rates')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Api-Key'] = '{subscription key}'
# Request headers
request['Authorization'] = '{access token}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body