How to Configure Rates for External Rating Engine to Handle Multiple Responses
This page provides step-by-step instructions to configure the External Rating Engines (ERE) in your application to support multiple rate responses.
Setting up External Rating Engine to handle Multiple Responses
An ERE can return multiple responses based upon the different service providers, their corresponding rate services, and transport modes. The application supports only REST URL to which you can send JSON payload and receive the corresponding JSON response.
The following configurations are required to set up the ERE to handle multiple responses in the application:
The optional feature ENABLE ERE WITH MULTIPLE RESULTS must be turned on to enable the multiple response logic.
- Configure the Rate Offering Type
Go to Contract and Rate Management > Power Data > Contracts > Rate Offering Type.-
Add the following two rate attributes to the Rate Offering Type:
- EXTERNALRATINGENGINE: Specifies this Rate Offering uses an ERE. This should be added as both Rate Attribute as well as Costing Attribute. Whether the ERE supports single response or multiple, this attribute should be added at both Rate Attribute and Costing Attribute sections.
- ERE_RETURN_MULTIPLE_RESPONE: Enables the flow for multiple response handling in the ERE. This should be added as a Rate Attribute.
-
- Configure the External rating Engine Fieldset
The below steps you need to follow to configure the External Rating Engine Fieldset:
- You can set up the fieldset with the following fields:
- Valid External Rating Engine ID: GENERIC
- Connection Type: Web Service
- Implementing Java Class: glog.business.rate.rateengine.external.webservice.client.ExternalRatingWebServiceClient
- External System ID: Create an External System with the REST URL and its authentication information. Also ensures its Content Type is set to application/json for being able to send a JSON payload.
- Add all required Rate Basis Items (RBIs) that your ERE needs to the Fieldset. Based on the RBIS you added in ERE Fieldset, a JSON payload will be generated to be sent to the REST URL. The payload will be formed in a hierarchical structure with the root object representing the shipment and its properties based upon the shipment RBIs. All the related RBIs of stop, ship unit, ship unit line, equipment, and order are added as child objects to the parent object. Note that ship unit and ship unit line are added as child objects at a shipment level if you select shipment ship unit and shipment ship unit line related RBIs, and added as child object to stop, and equipment based on whether the RBIS corresponds to shipment stop or equipment.
- You can set up the fieldset with the following fields:
- Create a Rate Offering
When creating a Rate Offering, select the Rate Offering Type configured in Step 1.- The following fields become available only when both ERE_RETURN_MULTIPLE_RESPONSE and EXTERNALRATINGENGINE attributes are set for the Rate Offering Type:
- Rate Service Profile ID
- Service Provider Profile ID
- Mode Profile ID
Note: When the optional feature ENABLE ERE WITH MULTIPLE RESULTS is enabled, the two fields External Service Type and External Service Code will be visible for all types of Rate Services under the Rate Service Details section of the Rate Service screen.
- If any of these profile fields are configured, only the specified Rate Services, Service Providers, and Transport Modes will be considered for the request. Otherwise, all applicable values will be considered.
- The below required fields are as follows:
- The Transport Mode on the Rate Offering is mandatory and must always be included in the request.
- The Rate Service Profile ID, Service Provider Profile ID, and Mode Profile ID fields are optional.
- If you configure both individual field-level IDs (Rate Service ID, Service Provider ID) and the corresponding profile IDs (Rate Service Profile ID, Service Provider Profile ID, Mode Profile ID), all values are then merged and included together in the request sent to the ERE.
- If nothing is configured, the Transport Mode ID will still be included in the request as it is a mandatory field.
- Profile details in request and response validation:
- Rate Service Profile: Both the External Service Type and the External Service Code will be sent in the request. The ERE's response must contain at least one of these two values for the successful validation. Otherwise, the application will display an error.
- Service provider Profile: If the Service Provider Profile ID is configured on the Rate Offering, its corresponding Service Provider Alias, determined by the planning parameter SERVICE PROVIDER ALIAS QUALIFIER, will be sent in the request.
The following two conditions must be met to successfully validate the service providers returned in the ERE response against the service providers present in the application:- The values of Service Provider Alias must be present in the ERE response.
- The SERVICE PROVIDER ALIAS QUALIFIER planning parameter must be correctly configured.
If either the alias is missing from the response or the planning parameter is incorrectly configured, the application will trigger a validation error.
-
Mode Profile: The Transport Mode ID will be sent in request by default. If the Mode Profile ID is configured then all Transport Mode IDs defined in that mode profile will be included and sent in the request. In the response, the Transport Mode ID is mandatory. If this is not part of response, the application will throw an error.
- The following fields become available only when both ERE_RETURN_MULTIPLE_RESPONSE and EXTERNALRATINGENGINE attributes are set for the Rate Offering Type:
- External Rating and Validation:
- When the ERE returns multiple rate results, the application first checks that each combination of Service Provider, Rate Service
and Transport Mode is correctly associated within the application. - If the Rate Offering is constrained on the Order Release and there is no combination among the returned rates that matches with the existing data in the application, then the bulk plan will fail.
- When the ERE returns multiple rate results, the application first checks that each combination of Service Provider, Rate Service
Note: Enable the optional feature ADD SHIPMENT SHIP UNIT AND LINE COST REFERENCES to ensure shipmentShipUnitInterimID and shipmentShipUnitLineSeqNumber are sent in the request, received in the response, and subsequently used to accurately link the costs to the respective Ship Unit and Ship Unit Line.
You must select the following RBIs in the ERE fieldset to ensure the corresponding data is included in the JSON request:
- Shipment Total Weight
- Stop Ship Unit Line Item Weight
- Stop Ship Unit Line Item Volume
- Stop Ship Unit Line Item Packaged Item ID
- Ship Unit Line Item Weight
- Ship Unit Line Item Volume
- Ship Unit Line Item Packaged Item ID
{
"totalWeight": 105.94,"stops": {
"items": [
{
"shipUnits": {
"items": [
{
"shipUnitLines": {
"items": [
{
"weight": 4.41,
"volume": 35.31,
"packagedItemID": "PKG123"
}
]
}
}
]
}
},
{
"shipUnits": {
"items": [
{
"shipUnitLines": {
"items": [
{
"weight": 6.61,
"volume": 40.12,
"packagedItemID": "PKG124"
}
]
}
}
]
}
}
]
},
"shipUnits": {
"items": [
{
"shipUnitLines": {
"items": [
{
"weight": 4.41,
"volume": 35.31,
"packagedItemID": "PKG123"
}
]
}
}
]
}
}
Sample Request Payload and Response
The sample ERE with multiple rate request is as follows:
{
"destinationStop": {
"city": "DENVER",
"country": "USA",
"locationID": "GUEST.DENVER-STREET",
"selectedVolume": {
"value": 40.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 250.0,
"unit": "LB"
},
"shipUnits": {
"items": [
{
"shipmentShipUnitInterimID": "SShipUnit112",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"selectedVolume": {
"value": 30.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 150.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
},
{
"shipmentShipUnitInterimID": "SShipUnit113",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"selectedVolume": {
"value": 10.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 100.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
}
]
}
},
"selectedVolume": {
"value": 40.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 250.0,
"unit": "LB"
},
"shipUnits": {
"items": [
{
"shipmentShipUnitInterimID": "SShipUnit112",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"selectedVolume": {
"value": 30.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 150.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
},
{
"shipmentShipUnitInterimID": "SShipUnit113",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"selectedVolume": {
"value": 10.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 100.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
}
]
},
"sourceStop": {
"city": "CHICAGO",
"country": "USA",
"estimatedDepartureTime": {
"value": "2025-09-30T07:39:02-05:00"
},
"locationID": "GUEST.CHICAGO",
"shipUnits": {
"items": [
{
"shipmentShipUnitInterimID": "SShipUnit112",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"selectedVolume": {
"value": 30.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 150.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
},
{
"shipmentShipUnitInterimID": "SShipUnit113",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"selectedVolume": {
"value": 10.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 100.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
}
]
}
},
"stops": {
"items": [
{
"city": "CHICAGO",
"country": "USA",
"locationID": "GUEST.CHICAGO",
"postalCode": "60131",
"provinceCode": "IL",
"selectedVolume": {
"value": 40.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 250.0,
"unit": "LB"
},
"shipUnits": {
"items": [
{
"shipmentShipUnitInterimID": "SShipUnit112",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"shipUnitLines": {
"items": [
{
"shipmentShipUnitLineSeqNumber": 1,
"itemPackageCount": 3.0,
"packagedItemID": "GUEST.DEFAULT_PACKAGE",
"volume": {
"value": 30.0,
"unit": "CUFT"
},
"weight": {
"value": 150.0,
"unit": "LB"
}
}
]
},
"selectedNetVolume": {
"value": 30.0,
"unit": "CUFT"
},
"selectedNetWeight": {
"value": 150.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
},
{
"shipmentShipUnitInterimID": "SShipUnit113",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"shipUnitLines": {
"items": [
{
"shipmentShipUnitLineSeqNumber": 1,
"itemPackageCount": 1.0,
"packagedItemID": "GUEST.DEFAULT_PACKAGE",
"volume": {
"value": 10.0,
"unit": "CUFT"
},
"weight": {
"value": 100.0,
"unit": "LB"
}
}
]
},
"selectedNetVolume": {
"value": 10.0,
"unit": "CUFT"
},
"selectedNetWeight": {
"value": 100.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
}
]
},
"weight": {
"value": 250.0,
"unit": "LB"
}
},
{
"city": "DENVER",
"country": "USA",
"locationID": "GUEST.DENVER-STREET",
"postalCode": "80201",
"provinceCode": "CO",
"selectedVolume": {
"value": 40.0,
"unit": "CUFT"
},
"selectedWeight": {
"value": 250.0,
"unit": "LB"
},
"shipUnits": {
"items": [
{
"shipmentShipUnitInterimID": "SShipUnit112",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"shipUnitLines": {
"items": [
{
"shipmentShipUnitLineSeqNumber": 1,
"itemPackageCount": 3.0,
"packagedItemID": "GUEST.DEFAULT_PACKAGE",
"volume": {
"value": 30.0,
"unit": "CUFT"
},
"weight": {
"value": 150.0,
"unit": "LB"
}
}
]
},
"selectedNetVolume": {
"value": 30.0,
"unit": "CUFT"
},
"selectedNetWeight": {
"value": 150.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
},
{
"shipmentShipUnitInterimID": "SShipUnit113",
"deliveryStopLocationID": "GUEST.DENVER-STREET",
"shipUnitLines": {
"items": [
{
"shipmentShipUnitLineSeqNumber": 1,
"itemPackageCount": 1.0,
"packagedItemID": "GUEST.DEFAULT_PACKAGE",
"volume": {
"value": 10.0,
"unit": "CUFT"
},
"weight": {
"value": 100.0,
"unit": "LB"
}
}
]
},
"selectedNetVolume": {
"value": 10.0,
"unit": "CUFT"
},
"selectedNetWeight": {
"value": 100.0,
"unit": "LB"
},
"pickupStopLocationID": "GUEST.CHICAGO"
}
]
},
"weight": {
"value": 250.0,
"unit": "LB"
}
}
]
},
"totoalVolume": {
"value": 40.0,
"unit": "CUFT"
},
"totalWeight": {
"value": 250.0,
"unit": "LB"
},
"transportModes": {
"items": [
{
"transportModeId": "LTL"
},
{
"transportModeId": "TL"
}
]
},
"serviceProviders": {
"items": [
{
"SCAC": "FDXG",
"serviceProviderAlias": "FDXG - FEDEX GROUND"
},
{
"SCAC": "AALS",
"serviceProviderAlias": "UBER"
}
]
},
"rateServices": {
"items": [
{
"externalServiceType": "PRIORITY_SERVICE",
"externalServiceCode": "PRIORITY_CODE"
},
{
"externalServiceType": "OVERNIGHT_TYPE",
"externalServiceCode": "OVERNIGHT_CODE"
}
]
}
}
The sample ERE with multiple rate response is as follows:
{
"rateResults": {
"items": [
{
"costDetails": {
"items": [
{
"cost": {
"value": 17.64,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(17.640000 USD = 4.00 USD per 1 LB of ship unit weight (4.410000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit100",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 26.44,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(26.440000 USD = 4.00 USD per 1 LB of ship unit weight (6.610000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit101",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 22.04,
"currency": "USD"
},
"costType": "Discount",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(22.040000 USD = 0.5 USD discount per 1 LB of total weight (11.020000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": null,
"sShipUnitLineSeq": null
}
]
},
"serviceDetail": {
"serviceProviderAlias": "FDXG - FEDEX GROUND",
"SCAC": null,
"externalServiceType": "OVERNIGHT_TYPE",
"externalServiceCode": null,
"serviceDays": 6,
"transportModeId": "TL",
"pickupDateTimeStdFormat": "2025-11-12T09:54:26.555Z",
"deliveryDateTimeStdFormat": "2025-11-16T09:54:26.555Z"
},
"chargeableWeight": {
"value": 11.02,
"unit": "LB"
},
"dimensionalWeight": {
"value": 4.408,
"unit": "LB"
},
"shipmentRefnums": {
"items": [
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE",
"shipmentRefnumValue": "This is result 4, charter voyage"
},
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE STOWAGE",
"shipmentRefnumValue": "This is result 4, charter voyage stowage"
}
]
}
},
{
"costDetails": {
"items": [
{
"cost": {
"value": 4.41,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(4.410000 USD = 1.00 USD per 1 LB of ship unit weight (4.410000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit100",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 6.61,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(6.610000 USD = 1.00 USD per 1 LB of ship unit weight (6.610000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit101",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 33.06,
"currency": "USD"
},
"costType": "Discount",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(33.060000 USD = 0.5 USD discount per 1 LB of total weight (11.020000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": null,
"sShipUnitLineSeq": null
}
]
},
"serviceDetail": {
"serviceProviderQualifer": "GLOG",
"serviceProviderAlias": "GUEST.FDXG - FEDEX GROUND",
"SCAC": null,
"externalServiceType": "OVERNIGHT_TYPE",
"externalServiceCode": "OVERNIGHT_CODE",
"serviceDays": 7,
"transportModeId": "TL",
"pickupDateTimeStdFormat": "2025-11-12T09:54:26.555Z",
"deliveryDateTimeStdFormat": "2025-11-15T09:54:26.555Z"
},
"chargeableWeight": {
"value": 11.02,
"unit": "LB"
},
"dimensionalWeight": {
"value": 4.408,
"unit": "LB"
},
"shipmentRefnums": {
"items": [
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE",
"shipmentRefnumValue": "This is result 7, charter voyage"
},
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE STOWAGE",
"shipmentRefnumValue": "This is result 7, charter voyage stowage"
}
]
}
},
{
"costDetails": {
"items": [
{
"cost": {
"value": 4.41,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(4.410000 USD = 1.00 USD per 1 LB of ship unit weight (4.410000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit100",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 6.61,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(6.610000 USD = 1.00 USD per 1 LB of ship unit weight (6.610000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit101",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 5.51,
"currency": "USD"
},
"costType": "Discount",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(5.510000 USD = 0.5 USD discount per 1 LB of total weight (11.020000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": null,
"sShipUnitLineSeq": null
}
]
},
"serviceDetail": {
"serviceProviderQualifer": "GLOG",
"serviceProviderAlias": "GUEST.FDXG - FEDEX GROUND",
"SCAC": null,
"externalServiceType": "OVERNIGHT_TYPE",
"externalServiceCode": "OVERNIGHT_CODE",
"serviceDays": 3,
"transportModeId": "LTL",
"pickupDateTimeStdFormat": "2025-11-12T09:54:26.555Z",
"deliveryDateTimeStdFormat": "2025-11-15T09:54:26.555Z"
},
"chargeableWeight": {
"value": 11.02,
"unit": "LB"
},
"dimensionalWeight": {
"value": 4.408,
"unit": "LB"
},
"shipmentRefnums": {
"items": [
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE",
"shipmentRefnumValue": "This is result 1, charter voyage"
},
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE STOWAGE",
"shipmentRefnumValue": "This is result 1, charter voyage stowage"
}
]
}
},
{
"costDetails": {
"items": [
{
"cost": {
"value": 22.05,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(22.050000 USD = 5.00 USD per 1 LB of ship unit weight (4.410000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit100",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 33.050000000000004,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(33.050000 USD = 5.00 USD per 1 LB of ship unit weight (6.610000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit101",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 27.549999999999997,
"currency": "USD"
},
"costType": "Discount",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(27.550000 USD = 0.5 USD discount per 1 LB of total weight (11.020000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": null,
"sShipUnitLineSeq": null
}
]
},
"serviceDetail": {
"serviceProviderQualifer": "GLOG",
"serviceProviderAlias": "GUEST.FDXG - FEDEX GROUND",
"SCAC": null,
"externalServiceType": null,
"externalServiceCode": "OVERNIGHT_CODE",
"serviceDays": 2,
"transportModeId": "LTL",
"pickupDateTimeStdFormat": "2025-11-12T09:54:26.555Z",
"deliveryDateTimeStdFormat": "2025-11-14T09:54:26.555Z"
},
"chargeableWeight": {
"value": 11.02,
"unit": "LB"
},
"dimensionalWeight": {
"value": 4.408,
"unit": "LB"
},
"shipmentRefnums": {
"items": [
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE",
"shipmentRefnumValue": "This is result 5, charter voyage"
},
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE STOWAGE",
"shipmentRefnumValue": "This is result 5, charter voyage stowage"
}
]
}
},
{
"costDetails": {
"items": [
{
"cost": {
"value": 11.025,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(11.025000 USD = 2.50 USD per 1 LB of ship unit weight (4.410000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit100",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 16.525000000000002,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(16.525000 USD = 2.50 USD per 1 LB of ship unit weight (6.610000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit101",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 13.774999999999999,
"currency": "USD"
},
"costType": "Discount",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(13.775000 USD = 0.5 USD discount per 1 LB of total weight (11.020000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": null,
"sShipUnitLineSeq": null
}
]
},
"serviceDetail": {
"serviceProviderQualifer": "GLOG",
"serviceProviderAlias": "GUEST.UBER",
"SCAC": null,
"externalServiceType": "PRIORITY_SERVICE",
"externalServiceCode": null,
"serviceDays": 3,
"transportModeId": "TL",
"pickupDateTimeStdFormat": "2025-11-12T09:54:26.555Z",
"deliveryDateTimeStdFormat": "2025-11-15T09:54:26.555Z"
},
"chargeableWeight": {
"value": 11.02,
"unit": "LB"
},
"dimensionalWeight": {
"value": 4.408,
"unit": "LB"
},
"shipmentRefnums": {
"items": [
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE",
"shipmentRefnumValue": "This is result 6, charter voyage"
},
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE STOWAGE",
"shipmentRefnumValue": "This is result 6, charter voyage stowage"
}
]
}
},
{
"costDetails": {
"items": [
{
"cost": {
"value": 8.82,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(8.820000 USD = 2.00 USD per 1 LB of ship unit weight (4.410000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit100",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 13.22,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(13.220000 USD = 2.00 USD per 1 LB of ship unit weight (6.610000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit101",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 11.02,
"currency": "USD"
},
"costType": "Discount",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(11.020000 USD = 0.5 USD discount per 1 LB of 2otal weight (11.020000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": null,
"sShipUnitLineSeq": null
}
]
},
"serviceDetail": {
"serviceProviderQualifer": "GLOG",
"serviceProviderAlias": "GUEST.UBER",
"SCAC": null,
"externalServiceType": "PRIORITY_SERVICE",
"externalServiceCode": "PRIORITY_CODE",
"serviceDays": 4,
"transportModeId": "LTL",
"pickupDateTimeStdFormat": "2025-11-12T09:54:26.555Z",
"deliveryDateTimeStdFormat": "2025-11-16T09:54:26.555Z"
},
"chargeableWeight": {
"value": 11.02,
"unit": "LB"
},
"dimensionalWeight": {
"value": 4.408,
"unit": "LB"
},
"shipmentRefnums": {
"items": [
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE",
"shipmentRefnumValue": "This is result 2, charter voyage"
},
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE STOWAGE",
"shipmentRefnumValue": "This is result 2, charter voyage stowage"
}
]
}
},
{
"costDetails": {
"items": [
{
"cost": {
"value": 13.23,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(13.230000 USD = 3.00 USD per 1 LB of ship unit weight (4.410000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit100",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 19.830000000000002,
"currency": "USD"
},
"costType": "Base",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(19.830000 USD = 3.00 USD per 1 LB of ship unit weight (6.610000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": "SShipUnit101",
"sShipUnitLineSeq": null
},
{
"cost": {
"value": 16.53,
"currency": "USD"
},
"costType": "Discount",
"accessorialCode": null,
"costCode": null,
"specialServiceCode": null,
"calculationDetails": [
"(16.530000 USD = 0.5 USD discount per 1 LB of total weight (11.020000 LB)"
],
"isWeightedCostOnly": false,
"costCategoryGid": null,
"sShipUnitGid": null,
"sShipUnitLineSeq": null
}
]
},
"serviceDetail": {
"serviceProviderQualifer": "GLOG",
"serviceProviderAlias": "GUEST.UBER",
"SCAC": null,
"externalServiceType": "PRIORITY_SERVICE",
"externalServiceCode": "PRIORITY_CODE",
"serviceDays": 5,
"transportModeId": "LTL",
"pickupDateTimeStdFormat": "2025-11-12T09:54:26.555Z",
"deliveryDateTimeStdFormat": "2025-11-17T09:54:26.555Z"
},
"chargeableWeight": {
"value": 11.02,
"unit": "LB"
},
"dimensionalWeight": {
"value": 4.408,
"unit": "LB"
},
"shipmentRefnums": {
"items": [
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE",
"shipmentRefnumValue": "This is result 3, charter voyage"
},
{
"shipmentRefnumQualifierGid": "CHARTER VOYAGE STOWAGE",
"shipmentRefnumValue": "This is result 3, charter voyage stowage"
}
]
}
}
]
}
}
Data Type and Description for Response:
|
Field |
Data Type | Description |
|---|---|---|
|
rateResults |
Object with Array of items |
Root object containing rate results |
| items | Array | Array of rate result objects |
rateResults.items[ ]
|
Field |
Data Type | Description |
|---|---|---|
| costDetails (refer to costDetails.items) | Object with Array of Items | List of cost breakdown objects |
| serviceDetail (refer to serviceDetail below) | Object | Information about the offered service |
| chargeableWeight (refer to chargeableWeight & dimensionalWeight) | Object | The total chargeable weight for this rate result |
| dimensionalWeight (refer to chargeableWeight & dimensionalWeight) | Object | The dimensional weight for this rate result |
| shipmentRefnums (refer to shipmentRefnums.items) | Object with Array of Items | List of Reference numbers or tags for this shipment/rate |
costDetails.items[ ]
|
Field |
Data Type | Description |
|---|---|---|
| cost (refer to cost defined below) | Object | Cost details (value, currency) |
| costType | String | Type of cost ("Base", "Accessorial", "Discount", "SpecialService").
Only these four specific values are permitted. |
| accessorialCode | String | Optional accessorial code |
| costCode | String | Optional cost code |
| specialServiceCode | String | Special service code |
| calculationDetails | Array | List of strings explaining cost calculation |
| isWeightedCostOnly | Boolean | True if cost is based only on weighting |
| costCategoryGid | String | Category identifier for cost (if applicable) |
| sShipUnitGid | String | Identifier for the ship unit associated with this cost |
| sShipUnitLineSeq | Number | Sequence number for line in the ship unit |
cost (within costDetails.items[ ]): At least one cost is mandatory inside the costDetails.
|
Field |
Data Type | Description |
|---|---|---|
| value | Number | Cost amount |
| currency | String | Currency code |
serviceDetail (with in rateResults.items[ ]):
|
Field |
Data Type | Description |
|---|---|---|
| ServiceProviderAlias | String | Alias or description for the provider : Mandatory(Qualifier and alias are mandatory to match with service provider) |
| SCAC | String | Standard Carrier Alpha Code (optional) |
| externalServiceType | String | External service type (e.g. "OVERNIGHT_TYPE") or External service code any one is mandatory to match with Rate service in application |
| externalServiceCode | String | External service type or External service code are mandatory |
| serviceDays | Number | Service days required for delivery |
| transportModeId | String | Transport mode identifier (e.g., "TL") : Mandatory to match with transport mode in application |
| pickupDateTimeStdFormat | String | Pickup timestamp in standard format |
| deliveryDateTimeStdFormat | String | Delivery timestamp in standard format |
chargeableWeight & dimensionalWeight:
|
Field |
Data Type | Description |
|---|---|---|
| value | Number | Weight value |
| unit | String | Unit of measurement (e.g., "LB") |
shipmentRefnums.items[ ]
|
Field |
Data Type | Description |
|---|---|---|
| shipmentRefnumQualifierGid | String | Reference qualifier name |
| shipmentRefnumQualifierValue | String | Reference value/text |