GetCarrierRate API is integrated in LogixERP to get the rate of the carrier.
These are form parameters:
consignorCountry: US
consignorState: NY
consignorCity: New York
consignorZipcode: 10018
consigneeCountry: US
consignorState :TX
consignorCity: Texas City
consignorZipcode: 77591
numberofPackages: 1
actualWeight: 5
chargedWieght:5
packageLength: 2
packageBreadth: 2
packageHeight: 2
carrierCodes: xxxx
carrierServices: xx
| Parameter | Data Type | Required | Description |
|---|---|---|---|
| SecureKey | string | Required | It is a Unique key for accessing the API. For secure key email to support team. |
| consignorCountry | string | Required | Consignor Country code. It should be two digits country code (IN, EG, etc.). Reference is given here. https://goo.gl/wgg9s |
| consignorState | string | Required | Consignee State code should be same as available in the ERP. Refer to the annexure State List for the correct values. |
| consignorCity | string | Required | Consignee City code should be same as available in the ERP. Refer to the annexure City List for the correct values. |
| consignorZipcode | string | Required | Consignor's area Zip Code from where the shipment will get pick. |
| consigneeCountry | string | Required | Consignee Country code. It should be two digits country code (IN, EG, etc.). Reference is given here. https://goo.gl/wgg9s |
| consigneeState | string | Required | Consignee State code should be same as available in the ERP. Refer to the annexure State List for the correct values. |
| consigneeCity | string | Required | Consignee City code should be same as available in the ERP. Refer to the annexure City List for the correct values. |
| consigneeZipcode | string | Required | Consignee's area Zip Code where the shipment will get deliver. |
| numberOfPackages | string | Required | Number of Packages |
| actualWeight | string | Required | Actual Weight of the package |
| chargedWeight | string | Required | It is always same or greater than Actual weight as per contract of client. |
| packageLength | string | Required | Length of the package. It is always numeric values from 0 to 99999 |
| packageBreadth | string | Required | Breadth of the package. It is always numeric values from 0 to 99999 |
| packageHeight | string | Required | Height of the package. It is always numeric values from 0 to 99999 |
| carrierCodes | string | Optional | Carrier Code as same as available in ERP |
| carrierServices | string | Optional | Carrier Service as same as available in ERP |
| addressType | string | Optional | Valid values- COMMERCIAL, RESIDENTIAL |
| insuranceOpted | boolean | optional | This parameters defines options for insurance |
| cargoAmount | string | Conditionally Required- if insurance opted is true | Amount of the shipment |
ON SUCCESS
{
"carrierRatesArray": [
{
"UID": "f5a00536-10fc-42c4-a7b9-b4b228734f47",
"additionalCharges": null,
"apiLink3pl": "USPS",
"baseServiceCharges": null,
"carrierCode": "USPSTEST",
"carrierId": 4989984,
"carrierLogo": "https://URL/layouts/static/image/usps_img.png",
"carrierName": "USPSTEST",
"liveRates": true,
"rate": "11.01",
"serviceCode": "MEDIA MAIL",
"serviceId": 1489,
"serviceName": "Media Mail",
"serviceOptionsCharges": null,
"transportationCharges": null
},
{
"UID": "8db6db91-7c57-46c8-9ff9-7330a503297f",
"additionalCharges": null,
"apiLink3pl": "USPS",
"baseServiceCharges": null,
"carrierCode": "USPSTEST",
"carrierId": 4989984,
"carrierLogo": "http://URL/layouts/static/image/usps_img.png",
“carrierName”: “USPSTEST”,
"liveRates": true,
"rate": "21.86",
"serviceCode": "PARCEL SELECT GROUND",
"serviceId": 1569,
"serviceName": "Parcel Select Ground",
"serviceOptionsCharges": null,
"transportationCharges": null ,
},
{
"UID": "105a129f-6da6-45df-8cca-a89493fed699",
"additionalCharges": "{\"FUEL\":1.37}",
"apiLink3pl": "FEDEX",
"baseServiceCharges": "24.86",
"carrierCode": "FEDEXDNC",
"carrierId": 4978594,
"carrierLogo": "http://URL/layouts/static/image/fedex_image.png",
“carrierName”: "FEDEXDNC",
"liveRates": true,
"rate": "26.23",
"serviceCode": "FEDEX_GROUND",
"serviceId": 1409,
"serviceName": "FEDEX_GROUND",
“serviceOptionsCharges”: “1.37”,
"transportationCharges": "0.0"
}
{
"UID": "c6157588-b125-4df4-a401-54946d800d68",
"additionalCharges": null,
"apiLink3pl": "DHL",
"baseServiceCharges": null,
"carrierCode": "DHLTEST1",
"carrierId": 5001363,
"carrierLogo": "http://URL/layouts/static/image/dhl_image.png",
"carrierName": "DHLTEST1",
"liveRates": true,
"rate": "410105: Requested product(s) not available, C/-",
"serviceCode": "C",
"serviceId": 1452,
"serviceName": "MEDICAL EXPRESS(CMX, Doc)",
"serviceOptionsCharges": null,
"transportationCharges": null
}
],
"message": "Data found",
"messageType": "Success"
}
ON ERROR
{
"message": "Carrier does not exist",
"messageType": "Error"
}