G
Not authenticated — log in first
VendorProducts

List Products

List Products — vendor REST API endpoint.

GET/vendor/productsVendor bearer token required

List Products

List all products belonging to your vendor.

What this means in plain English

Returns your vendor catalog. Supports filtering by status, search term, category, and more.

When to use this

  • Syncing your product catalog to an external system.
  • Auditing published vs draft products.

Query parameters

NameTypeRequiredDescription
searchstringNoSearch by name or SKU.
statusstringNoFilter by product status.
categoryIdstring (UUID)NoFilter by category.

Headers

NameTypeRequiredDescription
X-Vendor-Idstring (UUID)YesUUID 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/products?search=widget&status=ACTIVE&categoryId=550e8400-e29b-41d4-a716-446655440070' \
  -H 'X-Vendor-Id: 550e8400-e29b-41d4-a716-446655440010'

Response examples

200Success
[{
  "id": "550e8400-e29b-41d4-a716-446655440020",
  "name": "Widget Pro",
  "sku": "WIDGET-001",
  "status": "ACTIVE",
  "vendorId": "550e8400-e29b-41d4-a716-446655440010"
}]

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.