VendorShipments
List Shipments
List Shipments — vendor REST API endpoint.
GET
/vendor/shipmentsVendor bearer token requiredList Shipments
List shipments for a vendor suborder.
What this means in plain English
Returns all shipments associated with a specific suborder ID for your vendor.
When to use this
- Checking existing shipments before creating a new one.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| suborderId | string (UUID) | Yes | The vendor suborder ID to list shipments for. |
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 GET 'http://localhost:8080/api/v1/vendor/shipments?suborderId=550e8400-e29b-41d4-a716-446655440031' \
-H 'X-Vendor-Id: 550e8400-e29b-41d4-a716-446655440010'Response examples
200Success
[{
"id": "550e8400-e29b-41d4-a716-446655440040",
"suborderId": "550e8400-e29b-41d4-a716-446655440031",
"carrier": "UPS",
"trackingNumber": "1Z999AA10123456784",
"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.