Skip to main content
PUT
Update a vendor

Authorizations

x-access-token
string
header
required

JWT minted from a merchant API key (mk_live_…) by POST /authenticate. Send the token value directly, with no "Bearer" prefix. Tokens last 14 days and can be renewed at POST /refresh-token; revoking the key refuses the next request made with any token minted from it.

Path Parameters

vendorId
string
required

Vendor ObjectId

Body

application/json
name
string
required

Vendor name

Example:

"Acme Corporation"

alias
string

Vendor alias/short name

Example:

"acme"

email
string<email>

Vendor email address

Example:

"vendor@acme.com"

commissionType
enum<string>

Commission type

Available options:
percentage,
flat
Example:

"percentage"

commissionRate
number

Commission rate

Example:

15

isHidden
boolean

Whether vendor is hidden

Example:

false

Response

Vendor updated successfully

success
enum<boolean>
Available options:
true
data
object