VendorShipments
Update Shipment Status
Update Shipment Status — vendor REST API endpoint.
PATCH
/vendor/shipments/:id/statusVendor bearer token requiredUpdate Shipment Status
Update the status of a shipment.
What this means in plain English
Updates shipment status. Requires OWNER, ADMIN, or EDITOR role. Valid statuses: PENDING, PACKED, SHIPPED, DELIVERED, RETURNED.
When to use this
- Marking a shipment as shipped or delivered.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| id | string (UUID) | Yes | Shipment ID. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| status | string | Yes | New shipment status. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
| X-Vendor-Id | string (UUID) | Yes | UUID of the vendor context. Required for vendor-scoped endpoints when your account has multiple vendor memberships. Use the vendor.id from the login response. |
Request example
curl -X PATCH 'http://localhost:8080/api/v1/vendor/shipments/550e8400-e29b-41d4-a716-446655440040/status' \
-H 'X-Vendor-Id: 550e8400-e29b-41d4-a716-446655440010' \
-H 'Content-Type: application/json' \
-d '{
"status": "SHIPPED"
}'Response examples
200Success
{ ...shipment, "status": "SHIPPED" }Status codes
200
OK
Request succeeded.
401
Unauthorized
Missing or invalid bearer token.
403
Forbidden
Insufficient permissions for this action.
400
Bad Request
Validation failed or invalid parameters.
404
Not Found
Resource not found.
500
Internal Server Error
Unexpected server error.
403
Forbidden
Invalid X-Vendor-Id, no vendor membership, or insufficient vendor role (requires OWNER, ADMIN, or EDITOR for write operations).
Try it
Uses your saved session from login. Edit values and send a live request, or copy the cURL command.