Files
dashback/docs/api/routes/customergroup/order.md
2026-09-30 19:29:13 +02:00

53 lines
981 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# `PUT /customergroup/order`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Reorder customer groups
Sets `sort` to each id’s index `0…n-1` in one transaction.
`customergroupIds` must be exactly the company’s groups (same set, no dups)
else `Invalid customer group order`.
## Body (JSON)
| Field | Required | Type | Description |
|-------|----------|------|-------------|
| `customergroupIds` | yes | integer[] | |
```json
{
"customergroupIds": [
4,
3,
1,
2
]
}
```
## Response `200`
New order
```json
{
"customergroupIds": [
1
]
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Invalid customer group order or no company selected — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 403 | Not authorized — `{"error":"…"}` |
| 404 | Company not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._