delivery.command_failed (v1.0.0)

Produced when a command is sent to a delivery and it fails

Event

Info

Kafka topic: deliveries.out

Details

This event can be considered an snapshot of the current state of the delivery and its related ones

Payload

53 properties
id string
required

delivery id

status
required
Allowed values: pending pre_processed processed picking canceled delivered ready on_the_way arrived in_manual_analysis
eta string <date-time>
required

estimated time to arrive

hub object
required

hub object

customer object
required

customer object

order object
required
status_history array [object]
required
rider object
shopper object
suggested_modality
Allowed values: bicycle motorcycle
dispatch boolean
required

true if this delivery should be dispatched to a rider, false otherwise

related_deliveries array [string]
required

Stacked delivery identifiers. If array empty then this delivery is not stacked with other deliveries

eta_min string <date-time>
required

Scheduled delivery eta_min (slotBeginDate) or the same value as confirmed_at in case is not Scheduled delivery

eta_max string <date-time>
required

Scheduled delivery eta_max (slotEndDate) or confirmed_at + eta_max of hub in case is not Scheduled delivery

assortment_type
required
Allowed values: core plus
delivery_type
required
Allowed values: instant scheduled
created_at string <date-time>
required

timestamp indicating the moment the delivery was created

finished_at string <date-time>

timestamp indicating the moment the delivery was finished

Edit this page