try out ↗

← API Index


/api/client/cancelorder7

Cancel an existing order

Parameters

Name Description Type
oid order id to cancel int
tour tour id int
adrid address id for partial pause int
ddate_iso delivery date: yyyy-MM-dd, or an ISO 8601 timestamp (2026-10-13T22:00:00.000Z as sent by the JS client, or 2026-10-14T00:00:00+02:00); a timestamp is resolved to its day in the shop's time zone (with tour, when no oid is given: the day to pause subscriptions on) 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
404 empty No matching order found
409 parameter_error Invalid parameters
409 ORDER Order error during cancellation
409 error General error cancelling order
403 not_auth User is not authenticated
403 security_error Security violation

Response Types

Type Version Description
ChangeOrderResult 1 Optional Result of a order mutation action (order submission, cancellation, etc.)
ShopDate 8 A delivery date with order, tour, shipping, and address information
Pause 1 A delivery pause period
Subscription 4 A standing subscription (item or assortment box)
Favourite 1 A shelf favourite (bookmarked item or menu level)
AuxDate 1 An auxiliary calendar event or notice
DeselectedItem 1 An item preferably excluded from a customer's assortment
DeselectedGroup 1 A category preferably excluded from a customer's assortment

OpenAPI

See cancelorder7.yaml

Referenced in skills