Skip to content
RentADriver
Glossary

Delivery API vocabulary

Every term the API, the console and the driver app use, in one sentence each, with a link to where it matters.

Address bookSee →
Saved pickup and drop-off places with contacts, usable from the console and the API.
Auto-acceptSee →
Rules a driver sets (distance, sizes, hours, zones) so matching offers are accepted for them within seconds.
City to citySee →
Same-day delivery from a launch city to a neighbouring launch city up to 160 km away by road, with one dedicated driver.
ConfirmSee →
Your acceptance of the proof, which captures the funds; if you never call it the delivery auto-confirms 24 hours after drop-off.
Declared valueSee →
value_cents you set on an item: recorded with the delivery so a loss or damage claim can be assessed.
DeliverySee →
One booked job from a pickup to one or more drop-offs, with a status timeline, proof and a tracking link.
Dispatch waveSee →
One round of offers pushed to on-shift drivers near the pickup; the radius widens wave by wave until a driver accepts.
Drive back allowanceSee →
The part of a city-to-city price that covers the driver's empty drive home: half the one-way distance and driving time.
Hold and captureSee →
The full price is held on your prepaid wallet at booking and captured when the delivery is confirmed; cancellations release the hold.
MCP serverSee →
rentadriver-mcp, the Model Context Protocol server that exposes every API capability as tools an agent can call.
MilestoneSee →
A recorded step of a delivery, such as goods on board at pickup, that changes what can still be cancelled.
OfferSee →
A job proposed to a driver in RentADriver Go with its details; accepted with one tap or automatically by the driver's rules.
OTP handoverSee →
A one-time code you put in the delivery metadata; the recipient reads it to the driver and the job cannot complete without it.
Proof of deliverySee →
Geo-stamped photos, a signature or a one-time code captured at handover and returned by get_proof_of_delivery.
QuoteSee →
A priced, routed offer for a delivery, returned by POST /v1/quotes with a breakdown and ETAs; free, no key needed, valid for 15 minutes.
quote_idSee →
The identifier of a quote; pass it to create_delivery to book at exactly that price.
Recipient ratingSee →
The 1 to 5 rating a recipient leaves on the tracking page after handover; drivers see their aggregate.
Recurring deliverySee →
A template that books itself on chosen days and times; managed in the console and by the recurring worker.
Same-day cut-offSee →
A city-to-city delivery must arrive by 21:00 local time; a booking too late for that is collected the next morning.
Sandbox keySee →
A test-mode API key you can mint from the pricing page or the console to try the full flow without spending anything.
Service areaSee →
A launch city with a centre, a radius and its own tariff; quotes outside every area are refused by check_coverage.
Size classSee →
S (envelope or bag), M (shoebox to backpack), L (suitcase) or XL (needs a van); it scales the price and filters which drivers are offered the job.
StopSee →
A pickup or drop-off address with contact details; a local delivery takes up to 8 drop-offs, a city-to-city one up to 3.
SurgeSee →
A live multiplier applied when demand exceeds nearby supply; always visible in the quote breakdown.
Test modeSee →
Keys marked test create is_test deliveries against simulated drivers with no wallet movement; the console shows them under a sandbox banner.
TurnstileSee →
The optional human check on browser signups; agents, the MCP server and curl are exempt.
UrgencySee →
asap, today or scheduled; it sets the dispatch window and one of the price multipliers.
WalletSee →
The prepaid balance a delivery is funded from; top up by card or USDC, see every movement in the console.
Webhook signatureSee →
An HMAC header on every webhook so you can verify the event came from RentADriver; test sends are available from the console.
Support