Fuel, Zones, and Tariffs
Overview
These three topics are linked throughout your Rose Rocket process. Fuel information, zones, and tariffs are central elements for shipping and receiving goods. Use the information throughout these objects to further track and share data about your logistics.
- Fuel information - View pricing for fuel and set price range behavior
- Fuel index tables
- Fuel tables
- Fuel table breakpoints
- Zones - Establish pricing based on specific locations
- Tariffs - Overview of logistics in process of rating and quoting
- Tariff lanes
- Tariff dimensions
- Tariff conversions
These modules work together for a comprehensive overview of the costs and revenue associated with transporting goods from one location to another. Altogether, these functions provide an effective strategy for entering costs and revenue on loads. They are connected to objects on a customer and partner level then evaluate the parameters of any respective orders, quotes, and manifests.
API configuration
When using the API to make requests, see the pages below for the process. These guides walk through the requirements and setup to access the Rose Rocket API with your application.
- Authentication - Access Rose Rocket with OAuth 2.0
- Object operations - Configure your requests
Fuel index group
This object is the historical record of the price of fuel as set by the Federal Motor Carrier Safety Administration. Information about the fuel prices cannot be changed and are based in five regions.
NOTE: Canadian customers are bound to regulatory pricing based in the United States of America.
Object structure
Use the table below for information about the fuel index group objects.
| Fields | Label | Type | Description |
|---|---|---|---|
| name | Name | string | Area name for fuel price index |
| indexes | Indexes | FuelIndex connected object array *See Connected object section | Collection of regional fuel prices |
| price | Price | money | Fuel price NOTE: This field is derived from the fuelIndex attribute. *See Read-only fields. |
| effectiveDate | Effective Date | date | Date fuel data was published NOTE: This field is derived from the fuelIndex attribute. *See Read-only fields. |
| priceDateLabel | Price date label | string | Historical price data label, constant view history information |
| source | Source | string | Source of data NOTE: This field is derived from the fuelIndex attribute. *See Read-only fields. |
Fuel Table
The fuel table is for associating pricing with specific fuel index regions.
Object structure
Use the table below for information about the fuel table objects.
| Fields | Label | Type | Description |
|---|---|---|---|
| fullId | Full id | string | Full ID for fuel table |
| name | Name | string | Name of fuel table |
| fuelIndex | Fuel index | FuelIndexGroup connected object *See Connected object section | Fuel index group associated with Fuel Table |
| breakpoints | Breakpoints | FuelTableBreakpoint connected object array *See Connected object section | Breakpoints associated to Fuel Table |
| sourceLabel | Source label | string | Returns source of fuel table NOTE: This field is derived from the fuelIndexGroup attribute. *See Read-only fields. |
Fuel Table Breakpoint
This object is for establishing pricing ranges on the fuel index. Use the price to and price from fields to set specific rates. Each range of pricing must be exclusive of one another.
NOTE: The values for
priceFromandpriceTomust not overlap. Any overlapping values cause errors with the request. For example, a breakpoint pricing for $1-10 cannot have another pricing at $10-20. The other pricing must be $11 or more and cannot fall within the range of values.
Object structure
Use the table below for information about the fuel table breakpoint objects.
| Fields | Label | Type | Description |
|---|---|---|---|
| priceFrom | Price from | money | Start of price range breakpoint |
| priceTo | Price to | money | End of price range breakpoint |
| rateType | Rate type method | string, enumerated | Defines rate calculation, valid values: Per mile, percentage |
| rate | Rate | money | Breakpoint rate |
| percentage | Percentage | float | Holds percentage value if calculation method is percentage |
| formattedBaseRate | Formatted base rate | string | Returns formatted rate for breakpoint NOTE: This field is derived from the rate type’s percentage and current rate. *See Read-only fields. |
| fuelTable | Fuel table | FuelTable connected object *See Connected object section | Connection to fuel table |
Fuel Purchase
Fuel purchases represent purchased fuel at specific locations.
Object structure
Use the table below for information about the fuel purchase objects.
| Fields | Label | Type | Description |
|---|---|---|---|
| purchaseAmount | Purchase amount | money | Amount of fuel purchased |
| purchaseState | Purchase state | string | State fuel was purchased in, must be lowercase for state or province |
| purchaseCity | Purchase city | string | City fuel was purchased in |
| fuelType | Fuel type | string, enumerated | Type of fuel purchased, valid values: diesel, biodiesel, gasoline |
| quantity | Quantity | integer | Amount of fuel purchased |
| unit | Unit | string, enumerated | Volumetric unit of fuel purchase, valid values: gallons, litres |
| provider | Provider | string | Fuel provider |
| purchaseDate | Purchase date | date | Purchase date for fuel |
Zone
Zones are for establishing location pricing based on the travel. Set up various locations with the help of the Google API and addresses. Zones are a collection of these addresses for pricing reference.
The Rose Rocket API uses the Google Maps API information to collect addresses. Postal codes and zip codes are also supported.
Object structure
Use the table below for information about the zone objects.
| Fields | Label | Type | Description |
|---|---|---|---|
| fullId | Full ID | string | Full ID for zone |
| name | Name | string | Name of zone |
| description | Description | string | Description of zone |
| locations | Locations | Address connected object array *See Connected object section | List of Google API responses as addresses |
| locationStrings | Locations | string | Locations joined as single string NOTE: This field is derived from the list concatenating address information from all locations in the zone. *See Read-only fields. |
| locationCountLabel | Locations count | string | Number of locations in zone NOTE: This field is derived from the number of locations in the zone. *See Read-only fields. |
Tariff
Tariffs contain all of the information from the other objects. This object functions to set up pricing for each lane. Lanes are logistics configurations for origin, destination, cost, transit, and rates.
When rating an order or inputting information, tariffs can be set as a different time. This provides flexibility for preparing tariffs in advance with specific pricing to use.
Object structure
Use the table below for information about the tariff objects.
| Fields | Label | Type | Description |
|---|---|---|---|
| fullId | Full Id | string | Full ID of tariff |
| name | Name | string | Tariff name |
| type | Type | TariffType connected object *See Connected object section | Type of object for rating tariffs, valid values: customer, partner |
| notes | Notes | string | Notes |
| status | Status | TariffStatus connected object *See Connected object section | Active status of tariff, valid values: active, inactive |
| effectiveStartDate | Effective start date | date | Date tariff is effective, can represent a date rate |
| effectiveEndDate | Effective end date | date | Date tariff expires, can represent a date rate |
| conversions | Conversions | TariffConversion connected object array *See Connected object section | Unit conversions related to tariff |
| dimensionOne | Dimension one | TariffDimension connected object *See Connected object section | First dimension unit for rating |
| dimensionTwo | Dimension two | TariffDimension connected object *See Connected object section | Second dimension unit for rating |
| lanes | Lanes | TariffLane connected object array *See Connected object section | Connection field to tariff lanes for defining rates |
| fuelTable | Fuel table | FuelTable connected object *See Connected object section | Connection field to fuel tables for fuel surcharge |
| fuelTableCount | Fuel table count | integer | Returns number of active fuel tables, can be undefined NOTE: This field is derived from the number of fuel tables. *See Read-only fields. |
| customers | Customers | Customer connected object array *See Connected object section | Connection field to customers for defining rates |
| partners | Partners | Partner connected object array *See Connected object section | Connection field to Partners for defining rates |
| accessorials | Accessorial | TariffAccessorial connected object array *See Connected object section | Connection field to accessorial records for defining rates |
Tariff Lane
Tariff lanes are for categorizing transportation logistics according to locations traveled.
Object structure
Use the table below for information about the tariff dimension objects.
| Fields | Label | Type | Description |
|---|---|---|---|
| fullId | Full Id | string | Full ID of tariff lane |
| name | Name | string | Tariff lane name |
| originZone | Origin zone | Zone connected object | Origin address zone, mutually exclusive to originAddress |
| originAddress | Origin Address | Address connected object | Origin address, mutually exclusive to originZone |
| originLabel | Origin Label | string | Label of origin as zone or address NOTE: This field is derived from the origin. *See Read-only fields. |
| destinationZone | Destination zone | Zone connected object | Destination address zone, mutually exclusive to destinationAddress |
| destinationAddress | Destination Address | Address connected object | Destination address, mutually exclusive to destinationZone |
| destinationLabel | Destination Label | string | Label of destination as zone or address NOTE: This field is derived from the destination. *See Read-only fields. |
| minCost | Min cost | float | Minimum cost of lane |
| maxCost | Max cost | float | Maximum cost of lane |
| minTransit | Min transit | integer | Minimum transit time in days |
| maxTransit | Max transit | integer | Maximum transit time in days |
| rates | Rates | Two-dimensional array, float | Rating mapping to dimensions, tied through tariffs, can be null |
| tariff | Tariff | Tariff connected object *See Connected object section | Tariff associated to lane |
| ratesLabel | Rates label | string | Label of rates |
Tariff Dimension
The tariff dimension object confirms specific dimensions for logistics reference. These units are supported in Rose Rocket. Use the same dimensions as the related order. Each range for the dimension must be exclusive of one another.
NOTE: The values for ranges must not overlap. Any overlapping values cause errors with the request. For example, ranges for 1-1000 cannot have another pricing at 1000-2000. The other range must be 1001 or greater and cannot fall within the range of values.
Object structure
Use the table below for information about the tariff dimension objects.
| Fields | Label | Type | Description |
|---|---|---|---|
| dimensionUnitType | Dimension unit type | string, enumerated | Dimension unit for tariff, valid values: gallons, litres, cubicFeet, kilograms, pounds, tons, miles, kilometers, quantity, linearFeet, stops |
| calculationMethod | Calculation method | string, enumerated | Calculation method applied to tariff, valid values: flatRate, percentage |
| ranges | Ranges | Range connected object | Ranges considered when applying tariff |
Tariff Conversion
Tariff conversion objects are for converting specific dimensions for logistics reference.
Object structure
Use the table below for information about the tariff conversion objects.
| Fields | Label | Type | Description |
|---|---|---|---|
| fromDimension | From dimension | string | Source dimension of tariff conversion NOTE: The list is the same information as Rose Rocket rating dimensions. |
| fromValue | From value | integer | Source value of tariff conversion |
| toDimension | To dimension | string | Destination dimension of tariff conversion NOTE: The list is the same information as Rose Rocket rating dimensions. |
| toValue | To value | integer | Destination value of tariff conversion |
| tariff | Tariff | Tariff connected object *See Connected object section | Conversion applied to tariff |
Updated 5 months ago