try out ↗

← API Index


/api/driver/dlvr1

Mark an order as delivered. Logs the delivery, updates the tour delivery state and may trigger delivery notifications (mail, SMS, push) to the customer and to customers whose delivery is announced as upcoming.

Parameters

Name Description Type
oid order id of the delivered order int
dt delivery time as ISO8601 datetime; defaults to now string
boxname name of the delivered box string
note delivery place related note; included in the delivery notification to the customer string
info arbitrary driver info for the office, logged separately string
dupcheck uuid guarding against duplicate submissions; a repeated uuid returns result dlvrduplicate string
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Error Responses

HTTP Status Error Code Description
403 access_error Not authenticated as driver
400 parameter_error Missing oid

Response Types

Type Version Description
DriverActionResult 1 Acknowledgement of a driver action

OpenAPI

See dlvr1.yaml

Referenced in skills