Prices - Endpoints

The following table lists down the available endpoints that you can integrate with for our prices.

# EndpointName Endpoint Description
1 Rate Calculator GET /CalculatePriceRate This endpoint can be used to calculate the shipment's cost as per the customer's rate card.

Endpoints Details

This endpoint can be used to calculate the shipment's cost as per the customer's rate card.

1 Rate Calculator

GET /CalculatePriceRate

Description

This API can be used to get the prices of a certain shipment, allowing customers to get the shipment's price including VAT.

URL: https://osbtest.epg.gov.ae/ebs/genericapi/ratecalculator/rest/CalculatePriceRate

Required Headers
  • Content-Type: application/json
  • AccountNo: YOUR_CLIENT_ID
  • Password: YOUR_GENERATED_TOKEN
Sample Body

{
    "RateCalculationRequest": {
        "ShipmentType": "Express",
        "ServiceType": "Domestic",
        "ContentTypeCode": "NonDocument",
        "OriginState": null,
        "OriginCity": "1",
        "DestinationCountry": "971",
        "DestinationState": null,
        "DestinationCity": "1",
        "Height": "25",
        "Width": "20",
        "Length": "30",
        "DimensionUnit": "Centimetre",
        "Weight": "100",
        "WeightUnit": "Grams",
        "CalculationCurrencyCode": "USD",
        "IsRegistered": "No",
        "ProductCode": "EPG-22"
    }
}
                                    

The following tables contain the full structure of the RateCalculationRequest object including the properties names', data types, and other useful information. Make sure to review these tables before you build your object.

RateCalculationRequest Object
Property Name Data Type Mandatory Allowed Values
ShipmentType String Yes Express, Premium
ServiceType String Yes Domestic, International
ContentTypeCode String Yes NonDocument, Document
OriginState String Yes null
OriginCity String Yes 1
DestinationCountry String Yes 971
DestinationState String No null
DestinationCity String No 1
Height String Yes
Width Numeric Yes
Length String Yes
DimensionUnit String No Centimetre, Metre
Weight String Yes
WeightUnit Numeric Yes
CalculationCurrencyCode String Yes AED
IsRegistered String Yes No
ProductCode String Yes Default EPG-21
Sample Response

{
    "RateCalculation": {
        "RateList": [
            {
                "ShipmentType": "Express",
                "ContentType": null,
                "TotalPrice": "43",
                "TotalPriceAED": "157.50",
                "CalculationCurrencyCode": "USD",
                "Remarks": null,
                "BasicVATPercentage": "0",
                "BasicVATAmount": 7.50
            }
        ]
    },
    "serviceResult": {
        "success": true
    }
}