u

docs/api/routes/order/_id/payment.get.md

@@ -0,0 +1,43 @@
+# `GET /order/{id}/payment`
+
+Protected. Requires a valid session cookie (`credentials: 'include'`).
+
+List payments of an order
+
+Lists payments of the order (manifest) for the selected company.
+
+## Path parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `id` | yes | integer | Order ID |
+
+## Response `200`
+
+List of payments
+
+```json
+{
+  "payments": [
+    {
+      "id": 1,
+      "accountId": 1,
+      "manifestId": 1,
+      "type": "…",
+      "amount": 1
+    }
+  ]
+}
+```
+
+## Errors
+
+| Status | Description |
+|--------|-------------|
+| 400 | Invalid ID or no company selected — `{"error":"…"}` |
+| 401 | Unauthorized — `{"error":"…"}` |
+| 404 | Order not found — `{"error":"…"}` |
+
+---
+
+_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

docs/api/routes/order/_id/payment.post.md

@@ -0,0 +1,58 @@
+# `POST /order/{id}/payment`
+
+Protected. Requires a valid session cookie (`credentials: 'include'`).
+
+Add payment to an order
+
+Adds a payment to the order using an account of the selected company.
+
+## Path parameters
+
+| Param | Required | Type | Description |
+|-------|----------|------|-------------|
+| `id` | yes | integer | Order ID |
+
+## Body (JSON)
+
+| Field | Required | Type | Description |
+|-------|----------|------|-------------|
+| `accountId` | yes | integer |  |
+| `type` | yes | string |  |
+| `amount` | yes | number |  |
+
+```json
+{
+  "accountId": 1,
+  "type": "…",
+  "amount": 1
+}
+```
+
+## Response `201`
+
+Created payment
+
+```json
+{
+  "payment": {
+    "id": 1,
+    "accountId": 1,
+    "manifestId": 1,
+    "type": "…",
+    "amount": 1
+  }
+}
+```
+
+## Errors
+
+| Status | Description |
+|--------|-------------|
+| 400 | Validation error or no company selected — `{"error":"…"}` |
+| 401 | Unauthorized — `{"error":"…"}` |
+| 403 | Not authorized — `{"error":"…"}` |
+| 404 | Order or account not found — `{"error":"…"}` |
+
+---
+
+_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._

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

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

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

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