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>'
import requests

url = "https://staging-api.puppetvendors.com/v1/vendors/{vendorId}"

headers = {"x-access-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};

fetch('https://staging-api.puppetvendors.com/v1/vendors/{vendorId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://staging-api.puppetvendors.com/v1/vendors/{vendorId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://staging-api.puppetvendors.com/v1/vendors/{vendorId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-access-token", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://staging-api.puppetvendors.com/v1/vendors/{vendorId}")
.header("x-access-token", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.puppetvendors.com/v1/vendors/{vendorId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'

response = http.request(request)
puts response.read_body

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"