Skip to main content
PUT
/
v1
/
vendors
/
{vendorId}
Update Vendor
curl --request PUT \
  --url https://staging-api.puppetvendors.com/v1/vendors/{vendorId} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "vendorName": "<string>",
  "commissionType": "<string>",
  "commissionAmount": 123
}
'

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

Update a vendor’s name, commission type, or commission amount. Only the fields you include in the request body will be changed.

​
Use Cases

  • Adjust commission rates for seasonal promotions or renegotiated terms
  • Rename a vendor after a rebrand
  • Sync vendor settings from an external system

​
Path Parameters

​
vendorId
string
required
The vendor’s unique ID.

​
Request Body

All fields are optional. Only provided fields will be updated.
​
vendorName
string
Updated vendor name.
​
commissionType
string
"percentage" or "flat".
​
commissionAmount
number
Updated commission value.

​
Response

200
{
  "message": "Vendor updated successfully.",
  "vendor": { ... }
}

​
Example

curl -X PUT "https://api.puppetvendors.com/v1/vendors/6157faecbebcf01bf49097d9" \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_JWT_TOKEN" \
  -d '{
    "commissionAmount": 12
  }'