Skip to main content

Vendor

Class name: Vendor

PropertyTypeDescriptionRequired
businessNamestringThe name of the vendor's businessYes
businessTypeenumThe type of business the vendor is in. Possible values: soleProprietorship, partnership, limitedLiabilityCompanyYes
emailstringThe email address of the vendor. Passed down from the user accountYes
businessAddressAddressThe address of the vendor's businessYes
idTypeenumThe type of ID the vendor has. Possible values: nationalId, passport, drivingLicenseYes
taxIdstringThe tax ID of the vendorYes
bankDetailsBankDetailsThe bank account number of the vendorYes
payoutMethodenumThe payout method of the vendor. Possible values: bankTransfer, mobileMoneyYes
descriptionstringA description of the vendor. 300 characters maxNo
linksLinks[]An array of external links related to the vendorNo
emergencyContactContactThe emergency contact of the vendorNo
ratingnumberThe rating of the vendor. A double valueNo
statusenumThe status of the vendor. Possible values: pending, approved, rejected. Defaults to pendingNo
logostringThe ID of the vendor's logoNo
coverImagestringThe ID of the vendor's cover imageNo