← API Index
/api/client/addpause2
Add a delivery pause for the authenticated user
Parameters
| Name |
Description |
Type |
| von |
pause start date |
date |
| bis |
pause end date |
date |
| info |
optional comment/reason |
string |
| type |
pause type: 0=normal, 1=address, 2=assortment, 3=item |
int |
| aboid |
reference id depending on pause type |
int |
| autocancel |
if 1, automatically cancel orders within the pause period |
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 |
stored |
Pause successfully stored |
| 409 |
error |
General error storing pause |
| 409 |
range |
Date range invalid |
| 409 |
order |
Conflicting order exists |
| 409 |
cancelfailed |
Auto-cancel of conflicting order failed |
| 409 |
orderlate |
Order is too late to cancel |
| 403 |
not_auth |
User is not authenticated |
| 403 |
security |
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 addpause2.yaml