Get a Specific Vendor

GET /api/vendors/{company_id}

This endpoint allows you to retrieve detailed information about a specific vendor by their unique company ID.

Request Example

GET /api/vendors/1

Response Format

Success Response

Error Response

When the vendor exists, you'll receive HTTP/1.1 200 OK and JSON with the vendor details:

{
  "company_id": "1",
  "lang_code": "en",
  "email": "simtech@example.com",
  "company": "Simtech",
  "timestamp": "1269610461",
  "status": "A",
  "seo_name": "simtech",
  "seo_path": "",
  "average_rating": null,
  "company_thread_ids": "1_0"
}

When the vendor doesn't exist, you'll receive HTTP/1.1 404 Not Found.

Response Fields

Field	Type	Description
company_id	string	The unique identifier of the vendor
lang_code	string	The ISO language code (e.g., "en" for English)
email	string	The email address of the vendor
company	string	The name of the vendor
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 for the vendor's microstore (added by SEO add-on)
seo_path	string	SEO path for the vendor's microstore (added by SEO add-on)
average_rating	float/null	Average customer rating of the vendor (added by Comments and Reviews add-on)
company_thread_ids	string	Thread ID for vendor reviews in format "company_id_thread_id" (added by Comments and Reviews add-on)

Tip: You can use the status field to determine if a vendor is active and available for customers. Only vendors with status "A" (Active) will be shown in the storefront.

Note: Some fields like seo_name, average_rating, and company_thread_ids are only available when certain add-ons (SEO, Comments and Reviews) are installed and active.