# Estimation

# Introduction

Users can get estimates for delivery fees and times from origin to destination through our endpoints. This allows you to provide customers with cost and delivery time estimates without creating an actual order.

# Real-Time Estimation

Get delivery estimates based on the current locations of nearby drivers, providing the most accurate real-time estimates for pickup and delivery times.

To try it, send an HTTP POST request to this endpoint:

POST
https://api.armadadelivery.com/v1/deliveries/estimate

# Request Parameters

The body of the request should be in JSON format and include the following parameters:

origin_format: Format type of the origin, can be "branch_format" or "location_format" String - Required
origin: Contains information about the origin, depends on origin_format Object - Required
- branch_id: Branch ID (24-character hexadecimal) String - Required
- latitude: Latitude coordinate Number - Required
- longitude: Longitude coordinate Number - Required
destination_format: Format type of the destination, must be "location_format" String - Required
destination: Contains the destination information Object - Required
- latitude: Latitude coordinate Number - Required
- longitude: Longitude coordinate Number - Required

# Request Examples

Remember to include your Armada-Access-Token in the request headers. If you don't have one, please refer to the Authentication page to learn how to obtain it.

curl --location --request POST 'https://api.armadadelivery.com/v1/deliveries/estimate' \
--header 'Armada-Access-Token: [YOUR ACCESS TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
  "origin_format": "branch_format",
  "origin": {
    "branch_id": "682473e10313f6003826e5d7"
  },
  "destination_format": "location_format",
  "destination": {
    "latitude": 29.355,
    "longitude": 47.8046
  }
}'

curl --location --request POST 'https://api.armadadelivery.com/v1/deliveries/estimate' \
--header 'Armada-Access-Token: [YOUR ACCESS TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
  "origin_format": "location_format",
  "origin": {
    "latitude": 29.255,
    "longitude": 47.7046
  },
  "destination_format": "location_format",
  "destination": {
    "latitude": 29.355,
    "longitude": 47.8046
  }
}'

# Response Schema

{
	"delivery_fee": Number,
	"estimated_pickup_at": ISODATE || null,
	"estimated_delivery_at": ISODATE || null,
}

Field	Description
delivery_fee	The cost of the delivery in your country's currency
estimated_pickup_at	Expected ISO date/time for the driver to pick up the order
estimated_delivery_at	Expected ISO date/time for the driver to deliver the order

# Response Example

{
	"delivery_fee": 3.5,
	"estimated_pickup_at": "2026-01-05T20:05:08.816Z",
	"estimated_delivery_at": "2026-01-05T20:41:34.949Z"
}

The estimated_pickup_at and estimated_delivery_at might be null if no driver is available. Please try again later.

To get better results, use real data.

# Static Estimation

Get delivery estimates without relying on real-time driver locations. This endpoint provides consistent estimates based on distance and historical data.

Backward Compatibility: This endpoint was previously named "timeless estimation" and is maintained for backward compatibility.

To try it, send an HTTP POST request to this endpoint:

POST
https://api.armadadelivery.com/v1/deliveries/estimate/static

# Request Parameters

The request parameters are identical to the Real-Time Estimation endpoint above.

# Request Examples

Remember to include your Armada-Access-Token in the request headers. If you don't have one, please refer to the Authentication page to learn how to obtain it.

curl --location --request POST 'https://api.armadadelivery.com/v1/deliveries/estimate/static' \
--header 'Armada-Access-Token: [YOUR ACCESS TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
  "origin_format": "branch_format",
  "origin": {
    "branch_id": "682473e10313f6003826e5d7"
  },
  "destination_format": "location_format",
  "destination": {
    "latitude": 29.355,
    "longitude": 47.8046
  }
}'

curl --location --request POST 'https://api.armadadelivery.com/v1/deliveries/estimate/static' \
--header 'Armada-Access-Token: [YOUR ACCESS TOKEN]' \
--header 'Content-Type: application/json' \
--data-raw '{
  "origin_format": "location_format",
  "origin": {
    "latitude": 29.255,
    "longitude": 47.7046
  },
  "destination_format": "location_format",
  "destination": {
    "latitude": 29.355,
    "longitude": 47.8046
  }
}'

# Response Schema

{
	"delivery_fee": Number,
	"estimated_pickup_duration": Number,
	"estimated_delivery_duration": Number
}

Field	Description
delivery_fee	The cost of the delivery in your country's currency
estimated_pickup_duration	Duration from order creation to driver pickup in seconds
estimated_delivery_duration	Total duration of delivery from order creation to drop-off in seconds

# Response Example

{
	"delivery_fee": 3.5,
	"estimated_pickup_duration": 975,
	"estimated_delivery_duration": 3161
}