Developers
API referenceBusiness sign in

Schema

Tracking

An object of the Qoene Delivery API.

Fields

Tracking fields
FieldTypeDescription
shipmentIdRequiredstringLIVE shipments use QDSHP or QD-SHP-. TEST shipments use QDTST or QD-TST-.Pattern ^(?:QD-SHP-[A-F0-9]{24}|QDSHP[A-Z0-9]{3,31}|QD-TST-[A-F0-9]{24}|QDTST[A-Z0-9]{3,31})$
trackingNumberRequiredstring
serviceOptionalenumOne of EXPRESS, RELAY
statusRequiredstring
createdAtOptionalstring (date-time)
simulatedOptionalboolean
eventsRequiredarray of object
statusRequiredstring
atRequiredstring (date-time)
serviceCodeOptionalServiceCodeStable product code (NB02).
milestoneRequiredstring
milestoneLabelOptionalstring
viewModeRequiredenumOne of IN_TRANSIT, OUT_FOR_DELIVERY, READY_AT_POINT, READY_IN_LOCKER, DELIVERED, EXCEPTION, RETURNING
milestonesRequiredarray of MilestoneStep
exceptionOptionalobject or null
codeRequiredstring
titleOptionalstring
nextStepsOptionalstring
atOptionalstring (date-time) or null
returnTrackOptionalarray of MilestoneStep or null
promiseOptionalShipmentPromise or null
receiverChangesOptionalarray of ReceiverChange
overstayOptionalOverstay or null

Used by