u
This commit is contained in:
50
docs/api/routes/warehouse/_id.put.md
Normal file
50
docs/api/routes/warehouse/_id.put.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# `PUT /warehouse/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Update warehouse
|
||||
|
||||
Updates specified fields of an existing warehouse for the selected company.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | Warehouse ID |
|
||||
|
||||
## Body (JSON)
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "…",
|
||||
"sort": 1
|
||||
}
|
||||
```
|
||||
|
||||
## Response `200`
|
||||
|
||||
Updated warehouse
|
||||
|
||||
```json
|
||||
{
|
||||
"warehouse": {
|
||||
"id": 1,
|
||||
"name": "…",
|
||||
"sort": 1
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid input — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 403 | Not authorized — `{"error":"…"}` |
|
||||
| 404 | Warehouse not found — `{"error":"…"}` |
|
||||
| 409 | Warehouse name conflict — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user