u
This commit is contained in:
32
docs/api/routes/shipment/_id.delete.md
Normal file
32
docs/api/routes/shipment/_id.delete.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# `DELETE /shipment/{id}`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
Delete shipment
|
||||
|
||||
Deletes an unshipped shipment manifest. Shipped shipments cannot be deleted.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | Shipment ID |
|
||||
|
||||
## Response `204`
|
||||
|
||||
Shipment deleted
|
||||
|
||||
_No content_
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid ID or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 404 | Shipment not found — `{"error":"…"}` |
|
||||
| 409 | Shipped shipment cannot be deleted — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user