Skip to main content
GET
/
v2
/
vendor
/
profile
Get Profile
curl --request GET \
  --url https://api.puppetvendors.com/v2/vendor/profile \
  --header 'x-access-token: <api-key>'
V2 Alpha — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Retrieve the custom profile fields for the authenticated vendor. Profile fields are key-value pairs configured by the shop admin. No parameters are needed as the vendor is automatically determined from the JWT token.
Vendor Token Required — This endpoint requires a vendor-scoped JWT token. Merchant tokens will receive a 403 error.

Use Cases

  • Display vendor profile in a self-service settings page
  • Pre-fill forms for vendor profile editing

Response

200
{
  "success": true,
  "data": {
    "companyName": "Acme Supplies Ltd",
    "contactPerson": "Jane Smith",
    "website": "https://acme-supplies.com",
    "taxId": "GB123456789",
    "description": "Premium wholesale supplier of office supplies"
  }
}

Error Responses

404
{
  "success": false,
  "error": "Vendor not found"
}

Example

curl -X GET "https://api.puppetvendors.com/v2/vendor/profile" \
  -H "x-access-token: YOUR_VENDOR_JWT_TOKEN"