List All Vendors

This endpoint allows you to retrieve a list of all vendors (sellers) in your Venddor marketplace.

GET /api/vendors/

This request returns a list of vendors with their details.

Response Example

{
  "vendors": [
    {
      "company_id": "2",
      "lang_code": "en",
      "email": "acme_corp@example.com",
      "company": "ACME Corp",
      "timestamp": "1712345461",
      "status": "A",
      "seo_name": "acme-corp",
      "seo_path": "",
      "average_rating": null,
      "company_thread_ids": "2_0"
    },
    {
      "company_id": "3",
      "lang_code": "en",
      "email": "techgadgets@example.com",
      "company": "Tech Gadgets Inc",
      "timestamp": "1712349875",
      "status": "A",
      "seo_name": "tech-gadgets",
      "seo_path": "",
      "average_rating": "4.7",
      "company_thread_ids": "3_0"
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 2
  }
}

Response Fields

Field	Type	Description
`vendors`	array	Array of vendor objects
`company_id`	string	Unique identifier of the vendor
`lang_code`	string	Two-letter language code used by the vendor (e.g., "en")
`email`	string	Vendor's email address
`company`	string	Vendor's company name
`timestamp`	string	Unix timestamp when the vendor was created
`status`	string	Vendor status: `N` — new `A` — active `P` — pending `D` — disabled
`seo_name`	string	SEO-friendly name used in URLs
`seo_path`	string	SEO path for nested categories (if applicable)
`average_rating`	string/null	Average rating of the vendor (null if no ratings)
`company_thread_ids`	string	Internal thread IDs for discussions related to the vendor

Pagination, Sorting, and Filtering

Add these parameters to customize your request:

Parameter	Default value	Description
`page`	1	Page number to retrieve
`items_per_page`	10	Number of vendors per page
`sort_by`	name	Field to sort by. Available options: `name`, `timestamp`, `email`, `status`
`sort_order`	desc	Sort direction: `asc` (ascending) or `desc` (descending)
`email`		Filter vendors by email address
`timestamp`		Filter vendors by creation timestamp
`status`		Filter vendors by status (`N`, `A`, `P`, `D`)
`company`		Filter vendors by company name

Examples

GET /api/vendors/?page=2&items_per_page=2

This example retrieves the second page with 2 vendors per page.

GET /api/vendors/?email=techgadgets@example.com

This example retrieves the vendor with the specified email address.

List All Vendors - Venddor API

Endpoint Details

Response Example

Response Fields

Pagination, Sorting, and Filtering

Examples

Common Use Cases