Schema
ShipmentPromise
The promise frozen at booking (original) and the one in force (current). Changes are revisions with a reason; the booked promise never changes.
Fields
| Field | Type | Description |
|---|---|---|
originalRequired | PromiseRevision | |
currentRequired | PromiseRevision | |
revisedRequired | boolean | |
statusRequired | object | AT_RISK is shown to merchants only; consumers see ON_TIME until the promise is missed. |
codeRequired | enum | One of ON_TIME, AT_RISK, RUNNING_LATE, DELIVERED_ON_TIME, DELIVERED_LATE, NOT_APPLICABLE |
labelRequired | string | |
historyOptional | array of object | |
revisionRequired | integer | |
promisedByRequired | string (date-time) | |
reasonCodeRequired | string | |
reasonLabelOptional | string | |
createdAtOptional | string (date-time) |