Developers
API referenceBusiness sign in

Schema

DeliveryPromise

The delivery promise, worked out with the Ghana working calendar (public holidays and network closures), cut-offs and region lanes.

Fields

DeliveryPromise fields
FieldTypeDescription
ruleRequiredenumOne of SAME_DAY_BEFORE_CUTOFF, DIRECT_SAME_DAY, WORKING_DAYS
cutoffLocalTimeOptionalstring or nullHH:MM in the market time zone (Africa/Accra for Ghana).
beforeCutoffOptionalboolean
promisedByRequiredstring (date-time)End of the promised local day.
labelRequiredstring
timezoneRequiredstring
engineVersionOptionalstringPromise engine version (NB19).
marketOptionalstring
promisedDateOptionalstring (date)Promised local date (YYYY-MM-DD).
dateLabelOptionalstring
summaryOptionalstring
windowOptionalobjectService hours on the promised day.
startRequiredstring (date-time)
endRequiredstring (date-time)
startDateOptionalstring (date)Local date the parcel starts moving (after cut-offs, closures and non-working days).
cutoffSourceOptionalenumOne of PRODUCT, PROMISE_RULES, EXPRESS_AREA, EXPRESS_AREA_RULE, ORIGIN_POINT, POINT_CLOSING, NONE
transitWorkingDaysOptionalinteger
laneOptionalobject or null
originOptionalstring or null
destinationOptionalstring or null
transitWorkingDaysRequiredinteger
sourceRequiredenumOne of LANE, PRODUCT_DEFAULT
originHubOptionalstring or null
destinationHubOptionalstring or null
expressAreaOptionalstring or null
adjustedForDestinationOptionalbooleanMoved because the destination point is closed.
checkpointsOptionalarray of PromiseCheckpointLeg checkpoints the parcel must meet; missing one marks it at risk.
ruleVersionOptionalobject or null
idOptionalstring
publicIdRequiredstring
versionNumberRequiredinteger

Used by