Docs β€Ί Orders

Proof & requirements

Signature, photo, ID/age check, PIN, barcodes, item checklists.

Any stop can require proof or checks. The driver app enforces them: the stop can't be completed until they're met, and the result is in the proof of delivery and webhooks.

FieldTypeEffect
requiresSignaturebooleanRecipient signs on the driver's device.
photoRequiredNONE, OPTIONAL or REQUIREDA photo of the delivered order.
notesRequiredbooleanThe driver must enter a completion note.
minimumAgeinteger 0–120The driver scans the recipient's ID and checks their age (for example, 21 for alcohol or 18 for some prescriptions).
pincodeRequiredbooleanA 4-digit code is shown only on the recipient's tracking page; the driver must enter it.
barcodes[{ data, blockCompletion }] (≀100)Packages the driver must scan. With blockCompletion: true, the stop can't complete until they are scanned.
barcodeRequiredbooleanRequires at least one scan, without a list.
quantityintegerNumber of packages or bags.
items[{ name, quantity?, sku?, barcode?, notes? }] (≀200)A checklist shown to the driver.
checklistRequiredbooleanEvery item must be ticked off before the stop completes.

Example: prescription delivery

json
{
  "address": "742 Evergreen Ter, Alameda, CA 94501",
  "contactName": "M. Chen",
  "contactPhone": "+14155550123",
  "requiresSignature": true,
  "minimumAge": 18,
  "photoRequired": "REQUIRED",
  "items": [{ "name": "Rx bag #4471", "quantity": 1 }],
  "checklistRequired": true
}

Example: tamper-evident packages

json
{
  "address": "233 S Wacker Dr, Chicago, IL 60606",
  "contactPhone": "+13125550111",
  "barcodes": [{ "data": "PKG-88412-1", "blockCompletion": true }, { "data": "PKG-88412-2", "blockCompletion": true }]
}

The captured photo, signature, scans and ID result arrive in the delivery.proof_of_delivery, delivery.barcode_scanned and delivery.id_verification webhooks.

Something unclear or missing? Tell us.