7x Developer Portal & API Documentation

Loading developer portal

Preparing the API reference and documentation.

EP.Retail.PoBox.Shipping.BackEnd.API EndPoints/RateCalculator//api/v1/RateCalculator/rates

Overview

Validates the request payload and calculates available shipping rates. Pricing options are returned based on origin, destination, service type, and parcel attributes. Validation errors are returned when required fields or values are invalid.

Request builder

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/RateCalculator/rates" \  -H "Content-Type: application/json" \  -d '{    "weight": {},    "serviceType": "string"  }'

{  "pricingOptions": [    {      "contentTypeCodeEn": "string",      "contentTypeCodeAr": "string",      "productCode": "string",      "productLabal": "string",      "productLabalAr": "string",      "estimateDeliveryDateEn": "string",      "estimateDeliveryDateAr": "string",      "shippingMethod": {        "code": "string",        "nameAr": "string",        "nameEn": "string",        "type": "POSTAL",        "transitTimeEn": "string",        "transitTimeAr": "string",        "isDropOff": true,        "isPickUp": true      },      "totalVAT": 0.1,      "totalPrice": 0.1,      "basePrice": 0.1,      "extraCharges": [        {          "titleEn": "string",          "titleAr": "string",          "vat": 0.1,          "amount": 0.1,          "total": 0.1        }      ],      "additionalServices": [        {          "title": "string",          "vat": 0.1,          "price": 0.1,          "total": 0.1        }      ],      "insuredPrice": 0.1,      "insuredVat": 0.1,      "insured": "string",      "cashPrice": 0.1    }  ]}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Overview

Request builder

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

origin?

destination?

dimensions?

weight*

serviceType*string

Length1 <= length

shipmentType?string

returnService?boolean

declaredAmount?

contentTypeCode?string

isInsured?boolean

pickUpOption?PickUpOption

Value in

"Any"
"DoorPickUp"
"BranchDropOff"

poBoxNumber?string

poBoxCityId?string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/RateCalculator/rates" \  -H "Content-Type: application/json" \  -d '{    "weight": {},    "serviceType": "string"  }'

{  "pricingOptions": [    {      "contentTypeCodeEn": "string",      "contentTypeCodeAr": "string",      "productCode": "string",      "productLabal": "string",      "productLabalAr": "string",      "estimateDeliveryDateEn": "string",      "estimateDeliveryDateAr": "string",      "shippingMethod": {        "code": "string",        "nameAr": "string",        "nameEn": "string",        "type": "POSTAL",        "transitTimeEn": "string",        "transitTimeAr": "string",        "isDropOff": true,        "isPickUp": true      },      "totalVAT": 0.1,      "totalPrice": 0.1,      "basePrice": 0.1,      "extraCharges": [        {          "titleEn": "string",          "titleAr": "string",          "vat": 0.1,          "amount": 0.1,          "total": 0.1        }      ],      "additionalServices": [        {          "title": "string",          "vat": 0.1,          "price": 0.1,          "total": 0.1        }      ],      "insuredPrice": 0.1,      "insuredVat": 0.1,      "insured": "string",      "cashPrice": 0.1    }  ]}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`