Skip to main content
GET
/
v1
/
vendors
/
{vendorId}
Get Vendor
curl --request GET \
  --url https://staging-api.puppetvendors.com/v1/vendors/{vendorId} \
  --header 'x-access-token: <api-key>'

Documentation Index

Fetch the complete documentation index at: https://dev.puppetvendors.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Fetch detailed information about a specific vendor, including commission settings and profile data.

​
Use Cases

  • Look up vendor details before creating a payout
  • Display vendor info in a custom dashboard or storefront widget
  • Verify vendor existence before assigning products

​
Path Parameters

​
vendorId
string
required
The vendor’s unique ID.

​
Query Parameters

​
users
string
Set to "true" to include associated user accounts.

​
Response

200
{
  "vendor": [
    {
      "_id": "6157faecbebcf01bf49097d9",
      "vendorName": "acme supplies",
      "commissionType": "percentage",
      "commissionAmount": 10,
      "createdAt": "2024-01-15T08:00:00.000Z",
      "profile": []
    }
  ]
}

​
Example

curl -X GET "https://api.puppetvendors.com/v1/vendors/6157faecbebcf01bf49097d9" \
  -H "x-access-token: YOUR_JWT_TOKEN"