u
This commit is contained in:
45
docs/api/routes/shipment/_id/shipping.get.md
Normal file
45
docs/api/routes/shipment/_id/shipping.get.md
Normal file
@@ -0,0 +1,45 @@
|
||||
# `GET /shipment/{id}/shipping`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List packages of a shipment
|
||||
|
||||
Lists all packages (shippings) belonging to the specified shipment manifest.
|
||||
|
||||
## Path parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `id` | yes | integer | Shipment ID |
|
||||
|
||||
## Response `200`
|
||||
|
||||
List of packages
|
||||
|
||||
```json
|
||||
{
|
||||
"shippings": [
|
||||
{
|
||||
"id": 1,
|
||||
"manifestId": 1,
|
||||
"number": "…",
|
||||
"trackingCode": "…",
|
||||
"carrier": "…",
|
||||
"type": "…",
|
||||
"state": "…"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | Invalid ID or no company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
| 404 | Shipment not found — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user