Shipment
Base path: /api/data/shipment
All shipment CRUD endpoints are registered but not yet implemented — handlers are empty stubs.
POST /api/data/shipment
Create a new shipment record.
Auth: Session cookie required
Tenant: Scoped via x-tenant-id header
Not yet implemented — returns no response.
Shipment Schema Reference
| Field | Type | Required | Description |
|---|---|---|---|
| tenantId | string | Yes | Tenant identifier |
| orderId | string | Yes | Associated order ID |
| carrier | string | No | Shipping carrier name |
| service | string | No | Shipping service level |
| trackingNumber | string | No | Tracking number |
| labelUrl | string | No | Shipping label URL (must be valid URL) |
| status | enum | No | PENDING (default), LABEL_CREATED, SHIPPED, DELIVERED, FAILED |
| shipFrom | object | No | Origin address (see Address schema) |
| shipTo | object | No | Destination address (see Address schema) |
| shippedAt | date | No | Shipment date |
| deliveredAt | date | No | Delivery date |
| createdAt | date | Yes | Creation timestamp |
| updatedAt | date | Yes | Last update timestamp |
Address object (used by shipFrom and shipTo):
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Recipient name |
| line1 | string | Yes | Street address line 1 |
| line2 | string | No | Street address line 2 |
| city | string | Yes | City |
| state | string | Yes | State / province |
| postalCode | string | Yes | ZIP / postal code |
| country | string | Yes | Country code (min 2 chars) |
| phone | string | No | Phone number |
GET /api/data/shipment/:id
Retrieve a shipment by ID.
Auth: Session cookie required
Tenant: Scoped via x-tenant-id header
Not yet implemented — returns no response.
PATCH /api/data/shipment/:id
Update a shipment by ID.
Auth: Session cookie required
Tenant: Scoped via x-tenant-id header
Not yet implemented — returns no response.
DELETE /api/data/shipment/:id
Delete a shipment by ID.
Auth: Session cookie required
Tenant: Scoped via x-tenant-id header
Not yet implemented — returns no response.