Schema
DeliveryPromise
The delivery promise, worked out with the Ghana working calendar (public holidays and network closures), cut-offs and region lanes.
Fields
| Field | Type | Description |
|---|---|---|
ruleRequired | enum | One of SAME_DAY_BEFORE_CUTOFF, DIRECT_SAME_DAY, WORKING_DAYS |
cutoffLocalTimeOptional | string or null | HH:MM in the market time zone (Africa/Accra for Ghana). |
beforeCutoffOptional | boolean | |
promisedByRequired | string (date-time) | End of the promised local day. |
labelRequired | string | |
timezoneRequired | string | |
engineVersionOptional | string | Promise engine version (NB19). |
marketOptional | string | |
promisedDateOptional | string (date) | Promised local date (YYYY-MM-DD). |
dateLabelOptional | string | |
summaryOptional | string | |
windowOptional | object | Service hours on the promised day. |
startRequired | string (date-time) | |
endRequired | string (date-time) | |
startDateOptional | string (date) | Local date the parcel starts moving (after cut-offs, closures and non-working days). |
cutoffSourceOptional | enum | One of PRODUCT, PROMISE_RULES, EXPRESS_AREA, EXPRESS_AREA_RULE, ORIGIN_POINT, POINT_CLOSING, NONE |
transitWorkingDaysOptional | integer | |
laneOptional | object or null | |
originOptional | string or null | |
destinationOptional | string or null | |
transitWorkingDaysRequired | integer | |
sourceRequired | enum | One of LANE, PRODUCT_DEFAULT |
originHubOptional | string or null | |
destinationHubOptional | string or null | |
expressAreaOptional | string or null | |
adjustedForDestinationOptional | boolean | Moved because the destination point is closed. |
checkpointsOptional | array of PromiseCheckpoint | Leg checkpoints the parcel must meet; missing one marks it at risk. |
ruleVersionOptional | object or null | |
idOptional | string | |
publicIdRequired | string | |
versionNumberRequired | integer |