try out ↗

← API Index


/api/driver/assign1

Assign a reusable box to a customer. Box-level rejections (box_not_existing, box_locked) are returned as result codes with HTTP 200, see the DriverAssignResult type.

Parameters

Name Description Type
cid customer id the box is assigned to int
boxname box identification, e.g. Q1453 string
oid order id used to resolve the packing group; alternative to tourid int
tourid tour id; alternative to oid int
tid alternative name for tourid int
force assign even when the box is locked on another tour; defaults to true (backwards compatible) bool
dt timestamp as ISO8601 datetime; defaults to now string
dupcheck uuid guarding against duplicate submissions; a repeated uuid returns result assignduplicate 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 or missing box assignment permission
400 parameter_error Missing cid or boxname, or neither oid nor tourid given

Response Types

Type Version Description
DriverAssignResult 1 Result of a driver box (de-)assignment

OpenAPI

See assign1.yaml

Referenced in skills