Skip to content

Glossary

Term Meaning
Merchant You: the retailer whose stores and orders an API key sees.
Location A store or warehouse goods are picked up at. Named by Delivr’s id or your externalStoreId. See Store locations.
Quote The priced options for one delivery from a store to an address. Offered for 5 minutes (expiresAt). See Quotes and orders.
Option One way to deliver in a quote: on_demand or a window.
Option key An option’s stable name, such as on_demand or window:<start>/<end>. You book an option by its key.
On demand A driver now, timed to arrive when your goods are ready. Has an eta band.
Window A delivery in a time slot, such as 17:00 to 19:00, on a transport partner’s route.
Cutoff (cutoffAt) The last time a window can be booked and cancelled free.
ETA band (eta) When the recipient can expect an on-demand delivery, as a from and to time.
Order A booked delivery. Its id equals the quoteId it was placed on.
reference The order’s short id for people, such as DD-482913. Paths accept it in place of id.
externalRef Your own order id, unique among your live orders.
version A number that increases with every change to an order. Keep the highest you have seen.
readyBy When the goods are due at the latest. See Goods ready signals.
readyAt When the goods are, or are assumed to be, ready.
Ready signal How a store tells Delivr the goods are ready: assumed (after prepMinutes) or required (you send processing or ready).
Release The moment an on-demand order’s goods count as ready and the driver search starts (searching).
Held order An on-demand order placed with sale: "pending", waiting for a sale at your till. See Assisted checkout.
Checkout budget How long you have to complete a held order’s sale after a driver accepts (sale.completeBy).
Fallback policy What happens when an on-demand order fails: recipient_choice, rebook_window or cancel. See Fallbacks.
Successor order The window order a fallback creates for a failed on-demand order (successorId, predecessorId).
Recipient Who receives the delivery (delivery.contact). Gets the SMS and the tracking page.
Minor units Money as an integer in the currency’s smallest unit: 14900 is NOK 149.00.
Idempotency key A UUID you send with a write so a retry never does it twice. See Idempotency.
Event One webhook, with a stable id. See Event types.
Delivery attempt One try at posting an event to your endpoint, in the delivery log.
Robo driver A test driver in the sandbox that delivers on-demand orders by itself. See Sandbox and testing.
Directive A sandbox:… instruction in pickup.note that tells robo drivers which failure to play.