try out ↗

← API Index


/api/driver/boxexchange1

Report the number of boxes delivered to and returned by a customer. At least one of delivered/returned must be non-zero.

Parameters

Name Description Type
cid customer id int
delivered number of boxes delivered int
returned number of boxes returned int
dt timestamp as ISO8601 datetime; defaults to now string
dupcheck uuid guarding against duplicate submissions; a repeated uuid returns result boxexchangeduplicate 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 cid, or both delivered and returned are zero

Response Types

Type Version Description
DriverActionResult 1 Acknowledgement of a driver action

OpenAPI

See boxexchange1.yaml

Referenced in skills