v1

latestOpenAPI 3.1.02026-07-231108.5 KB

Promise

Generate prediction

get/v4/promise/prediction/predict/

Query parameters

accountinteger required

Account ID

calibration'conservative' | 'balanced' | 'aggressive' | 'null' nullable

Set to true, to indicate that the prediction should be done based on the current, not yet published, promise configuration

conservative - conservative
balanced - balanced
aggressive - aggressive

courierstring nullable

The logistics courier to be used. Defaults to returning all configured couriers.

destination_country_iso3string required

ISO 3166-1 alpha-3 code of destination country

destination_postal_codestring nullable

Postal code of destination

dispatch_nowboolean

Forces the forecasted delivery date to skip any warehouse calculation and generate a prediction if the parcel is shipped at the moment of the API call, if set to 'true'

draftboolean nullable

Set to true, to indicate that the prediction should be done based on the current, not yet published, promise configuration

language_iso2string nullable

Language code to use for localization. Plain language codes such as en or es are supported. Locale codes with country suffixes such as es_US or es-US are also accepted.

now_overridestring date-time nullable

Locks the prediction for a specified request date as a ISO 8601 date and time in UTC format like 2022-06-10T06:42:00Z. Defaults now to the current time if omitted, which is required for production usage.

service_levelstring nullable

The courier service level mapped in your Promise configuration (for example: express delivery). Defaults to returning all courier service levels.

tagstring nullable

Tag to target prediction adjustment rule

warehousestring nullable

The warehouse the delivery shipped from (input field: key). Defaults to the default warehouse for the destination.

Response

request_idstring required

successboolean required

All 1 operations