---
title: "Generate prediction"
method: GET
path: "/v4/promise/prediction/predict/"
tags: ["Promise"]
---

# Generate prediction

`GET /v4/promise/prediction/predict/`

## Query parameters

- `account` integer, required
- `calibration` 'conservative' | 'balanced' | 'aggressive' | 'null', nullable
- `courier` string, nullable
- `destination_country_iso3` string, required
- `destination_postal_code` string, nullable
- `dispatch_now` boolean
- `draft` boolean, nullable
- `language_iso2` string, nullable
- `now_override` string, date-time, nullable
- `service_level` string, nullable
- `tag` string, nullable
- `warehouse` string, nullable

## Response `200`

- PredictionResponse
  - `request_id` string, required
  - `success` boolean, required
  - `prediction` Prediction[], required
    - `id` string, required — Delivery Method ID
    - `warehouse` string, required — Warehouse ID
    - `courier` string, required — parcelLab courier code, e.g. ups
    - `courier_name` string, required — Pretty courier name
    - `courier_alias` string[], required — Retailer internal courier code
    - `courier_service_level` string[], required — All specified aliases for the service level
    - `global_courier_service_level` 'standard' | 'unused' | 'express' | 'expedited' | 'unknown', required
    - `prediction` PredictionDetails, required
      - `min` integer, required — The minimum number of expected courier working days until delivery. Note: The value for minimum and maximum can be equal.
      - `max` integer, required — The maximum number of expected courier working days until delivery. Note: The value for minimum and maximum can be equal.
      - `likely` integer, required — The most likely number of expected courier working days until delivery.
      - `send_date` string, date, required — The date of dispatch as per warehouse configuration.
      - `earliest_date` string, date, required — The earliest expected delivery date taking into consideration working days of the courier, holidays in the destination, and warehouse cut-off and handling times.
      - `latest_date` string, date, required — The latest expected delivery date taking into consideration working days of the courier, holidays in the destination, and warehouse cut-off and handling times.
      - `most_likely_date` string, date, required — The most likely individual date of delivery.
      - `earliest_locale` string, required — Localized representations of the earliest expected delivery date in the specified format.
      - `latest_locale` string, required — Localized representations of the latest expected delivery date in the specified format.
      - `most_likely_locale` string, required — Localized representations of the most likely delivery date in the specified format.
      - `cutoff` integer, required — The time in minutes until cut-off for the estimated delivery dates.
      - `cutoff_locale` string, required — Localized representation of the cut-off time.

## Other responses

- `400`
- `404`

---

[API](https://skmtc.dev/parcellab/apis/parcellab-api.md) · [All operations](https://skmtc.dev/parcellab/apis/parcellab-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/parcellab/parcellab-api/revisions/163f2e4054e7/schema)