OrderFulfillment
Where the order stands in the store, as CompuDime last read it from the store's POS. It appears once the order landed (dispatchState dispatched) and the store answered at least once, and is read again on a fixed schedule (every few minutes, set per deployment) until it is final (delivered, completed or canceled) or two weeks after the order was created. The store answers only when its CompuDime agent reads orders for the platform and the store has turned per-item data on at its POS; otherwise the order simply has no fulfillment. It never names a person (no picker, no driver) and carries no customer, address or money.
Type: object.
| Name | Type | Description |
|---|---|---|
checkedAt required | string (date-time) | When CompuDime last read the order's status from the store. |
state required | string | received: the invoice is in the POS and no step is recorded yet. picking: the store started picking. picked: picking is done (every line marked picked, the picker app marked the order complete, or the order screen's Filled box is ticked). out_for_delivery: a driver took the order. delivered: the store recorded the delivery as done (final). completed: an order that is not a delivery was rung up at the register, the customer checked out (final). canceled: the store deleted the order from its POS after CompuDime had seen it there, which is how the POS cancels an order (final). A state can move back when the store undoes a step (for example unticks Filled); a milestone already announced is not announced again. One of: received, picking, picked, out_for_delivery, delivered, completed, canceled. |
updatedAt required | string (date-time) | When the order reached state: the time the POS recorded for that step when it recorded one, else when CompuDime first saw the order in that state. |
canceledAt | string (date-time) | When CompuDime found the order gone from the POS. Absent unless canceled. |
completedAt | string (date-time) | When CompuDime first saw an order that is not a delivery rung up at the register. Absent until then. |
deliveredAt | string (date-time) | When the store recorded the delivery as done. Absent until then. |
eta | string | The delivery ETA the store recorded, a time of day on the store's own clock (HH:MM:SS, no date, no zone). Absent when there is none and once the order is final. Pattern: ^[0-9]{2}:[0-9]{2}:[0-9]{2}$ |
outForDeliveryAt | string (date-time) | When a driver took the order. Absent until then. |
pickedAt | string (date-time) | When picking was done. Absent until then. |
picking | OrderPickingProgress | Picking progress over the order's lines as the POS keeps them. Absent when the store does not record it per line. |
Other fields can appear later. Ignore the ones you do not know.