← API Index
/api/client/settour5
Set the active delivery date and tour for the current shopping session
Parameters
| Name |
Description |
Type |
| ddateid |
delivery date id from ddates table (ShopDate.dateReference). Legacy alias: tourid — despite its name it carries this ddate id, not a tour id; kept for classic clients |
int |
| tour |
tour id |
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 |
string |
| adrid |
address id |
int |
| oid |
existing order id if editing |
int |
| clear |
if 1, clear any existing server-side cart |
int |
| auto |
if 1, automatically load existing server-side cart for given day |
int |
| 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 |
| 409 |
no_did |
No delivery date id provided or found |
| 409 |
wrong_param |
Invalid parameter value |
| 409 |
already_order |
Order already exists for this date |
| 409 |
too_late |
Ordering deadline has passed |
| 409 |
not_possible |
Tour/date combination not possible |
| 409 |
locked |
Delivery date is locked |
| 409 |
cart_modified |
Cart was modified during tour change |
| 403 |
not_auth |
User is not authenticated |
| 403 |
security |
Security violation |
Response Types
| Type |
Version |
Description |
| ActionResult |
0 |
Result of a backend action |
| 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 settour5.yaml
Referenced in skills