Price Calculator

Developing

POST

https://app.gotreek.com/api/calculate

Last modified:2026-02-18 11:47:05

Calculate shipping rates between two cities for one or more boxes. This endpoint is a public price calculator that does not require an order or authentication and can be used to estimate shipping costs.

💡

Authentication

No authentication is required for this endpoint.

Any client can call this API to estimate shipping prices based on city names and box dimensions.

💡

Behavior

Accepts origin and destination city names (from_city, to_city) and an array of boxes (length, width, height, weight).

Calculates shipping rates using the configured pricing rules.

Returns the calculated rates along with a summary of the input parameters (from_city, to_city, boxes) and the currency (SAR).

If one of the cities cannot be resolved, returns a 400 error with error = city_not_found and a descriptive message.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://app.gotreek.com/api/auth/login

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://app.gotreek.com/api/calculate' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "from_city": "string",
    "to_city": "string",
    "boxes": [
        {
            "length": 0,
            "width": 0,
            "height": 0,
            "weight": 0,
            "box_id": 0
        }
    ]
}'

Response Example

{
    "data": [
        {
            "service_id": 0,
            "courier_name": "string",
            "service_name": "string",
            "identifier": "string",
            "price_cents": 0,
            "price_sar": 0,
            "delivery_time": "string",
            "logo": "string",
            "logo_big": "string"
        }
    ],
    "request_params": {
        "from_city": "string",
        "to_city": "string",
        "boxes_count": 0,
        "is_cod": true
    },
    "currency": "string"
}

Modified at 2026-02-18 11:47:05

warehouse Details

Packaging Types List