u

docs/api/routes/shipping/_id.md

@@ -0,0 +1,31 @@
+# `DELETE /shipping/{id}`
+
+Protected. Requires a valid session cookie (`credentials: 'include'`).
+
+Delete shipping
+
+Deletes a shipping of the selected company. Its packages are removed as well.
+
+## Path parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `id` | yes | integer | Shipping ID |
+
+## Response `204`
+
+Shipping deleted
+
+_No content_
+
+## Errors
+
+| Status | Description |
+|--------|-------------|
+| 400 | Invalid ID or no company selected — `{"error":"…"}` |
+| 401 | Unauthorized — `{"error":"…"}` |
+| 403 | Not authorized — `{"error":"…"}` |
+
+---
+
+_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

docs/api/routes/shipping/_id/package.get.md

@@ -0,0 +1,45 @@
+# `GET /shipping/{id}/package`
+
+Protected. Requires a valid session cookie (`credentials: 'include'`).
+
+List packages of a shipping
+
+Lists packages of the shipping for the selected company.
+
+## Path parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `id` | yes | integer | Shipping ID |
+
+## Response `200`
+
+List of packages
+
+```json
+{
+  "packages": [
+    {
+      "id": 1,
+      "shippingId": 1,
+      "entityaddressId": 1,
+      "number": "…",
+      "type": "…",
+      "state": "…",
+      "details": "…"
+    }
+  ]
+}
+```
+
+## Errors
+
+| Status | Description |
+|--------|-------------|
+| 400 | Invalid ID or no company selected — `{"error":"…"}` |
+| 401 | Unauthorized — `{"error":"…"}` |
+| 404 | Shipping not found — `{"error":"…"}` |
+
+---
+
+_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

docs/api/routes/shipping/_id/package.post.md

@@ -0,0 +1,64 @@
+# `POST /shipping/{id}/package`
+
+Protected. Requires a valid session cookie (`credentials: 'include'`).
+
+Create package for a shipping
+
+Creates a package for the shipping. The package number is allocated from the
+`package` number sequence. `entityaddressId` is required (target address).
+
+
+## Path parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `id` | yes | integer | Shipping ID |
+
+## Body (JSON)
+
+| Field | Required | Type | Description |
+|-------|----------|------|-------------|
+| `entityaddressId` | yes | integer |  |
+| `type` | yes | string |  |
+| `state` | yes | string |  |
+| `details` | no | string |  |
+
+```json
+{
+  "entityaddressId": 1,
+  "type": "…",
+  "state": "…",
+  "details": "…"
+}
+```
+
+## Response `201`
+
+Created package
+
+```json
+{
+  "package": {
+    "id": 1,
+    "shippingId": 1,
+    "entityaddressId": 1,
+    "number": "…",
+    "type": "…",
+    "state": "…",
+    "details": "…"
+  }
+}
+```
+
+## Errors
+
+| Status | Description |
+|--------|-------------|
+| 400 | Validation error or no company selected — `{"error":"…"}` |
+| 401 | Unauthorized — `{"error":"…"}` |
+| 403 | Not authorized — `{"error":"…"}` |
+| 404 | Shipping or entity address not found — `{"error":"…"}` |
+
+---
+
+_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._