Developers
API referenceBusiness sign in

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

ShipmentPromise fields
FieldTypeDescription
originalRequiredPromiseRevision
currentRequiredPromiseRevision
revisedRequiredboolean
statusRequiredobjectAT_RISK is shown to merchants only; consumers see ON_TIME until the promise is missed.
codeRequiredenumOne of ON_TIME, AT_RISK, RUNNING_LATE, DELIVERED_ON_TIME, DELIVERED_LATE, NOT_APPLICABLE
labelRequiredstring
historyOptionalarray of object
revisionRequiredinteger
promisedByRequiredstring (date-time)
reasonCodeRequiredstring
reasonLabelOptionalstring
createdAtOptionalstring (date-time)

Used by