Estimated delivery dates

The estimated delivery dates API returns estimated delivery times for different service levels based on origin and destination postcodes.

Retrieve estimated delivery dates

POST /api/v3/estimated_delivery_dates

Submits a request to get estimated delivery dates for different service levels between specified postcodes.

At minimum, a request requires origin and destination postcodes. However, you can optionally filter by specific couriers, service levels, or provide additional context like fulfilment time or pickup schedules to get more accurate estimates.

The API returns delivery estimates in days for each available service level.

To perform this operation, you must be authenticated with an authentication token.

Body

{
  "from_postcode": "2000",
  "to_postcode": "3000",
  "couriers": ["CouriersPlease", "eParcelExpress"],
  "service_levels": ["standard", "express", "on_demand"],
  "preparation_time": "00:01:05",
  "pickup_days_per_courier": [
    {
      "courier": "eParcelExpress",
      "pickup_days": ["monday", "tuesday"],
      "pickup_time": "16:00"
    },
    {
      "courier": "CouriersPlease",
      "pickup_days": ["monday", "friday"],
      "pickup_time": "09:00"
    }
  ],
  "store_operating_hours": [
    {
      "day": "monday",
      "open_time": "09:00",
      "close_time": "17:00"
    },
    {
      "day": "tuesday",
      "open_time": "09:00",
      "close_time": "17:00"
    }
  ]
}