🏪 Vendors

Vendor and supplier management

List vendors

get
/api/v1.0/organisation/{org_uid}/vendors/

Get a paginated list of vendors with support for search, status, and category filters

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
Query parameters
categorystring · enumOptional

Filter by vendor category

Possible values:
entity_typestring · enumOptional

Filter by entity type

Possible values:
industrystring · enumOptional

Filter by industry

Possible values:
searchstringOptional

Search vendors by name or website

statusstring · enumOptional

Filter by vendor status

Possible values:
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_uid}/vendors/

Create vendor

post
/api/v1.0/organisation/{org_uid}/vendors/create/

Create a new vendor. Vendor name is required.

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
Body

Comprehensive serializer for Vendor model. Handles multilingual fields, nested relationships, computed fields, and vendor-specific metrics.

unique_idstring · max: 100 · nullableOptional
namestring · min: 1 · max: 300Required
descriptionstring · nullableOptional
entity_typestring · enumOptional
  • individual - Individual
  • company - Company
  • non_profit - Non-Profit Organization
  • government - Government Entity
  • partnership - Partnership
  • other - Other
Possible values:
vendor_statusstring · enumOptional
  • potential - Potential Vendor
  • active - Active Vendor
  • preferred - Preferred Vendor
  • on_hold - On Hold
  • inactive - Inactive
  • blacklisted - Blacklisted
Possible values:
vendor_categorystring · enumOptional
  • goods - Goods Supplier
  • services - Service Provider
  • both - Goods & Services
  • contractor - Contractor
  • consultant - Consultant
  • other - Other
Possible values:
industrystring · enum · nullableOptional
  • agriculture - Agriculture and Farming
  • cleaning - Cleaning Services
  • construction - Construction and Real Estate Services
  • consulting - Consulting and Freelancing
  • creative - Creative and Design Services
  • education - Education and Tutoring Services
  • events - Entertainment and Events Planning
  • handyman - Handyman and Home Repair Services
  • health - Health and Wellness
  • home_based - Home-Based Businesses
  • hospitality - Hospitality and Tourism
  • it_support - IT and Software Support Services
  • legal - Legal and Financial Services
  • logistics - Logistics and Delivery Services
  • manufacturing - Manufacturing and Small-Scale Production
  • marketing - Marketing and Advertising Services
  • music - Music and Entertainment Services
  • non_profit - Non-Profit and Social Enterprises
  • online_retail - Online Retail and E-commerce
  • photography - Photography and Videography Services
  • printing - Printing and Copy Services
  • professional - Professional Services
  • travel - Travel Agencies
  • utilities - Utilities and Renewable Energy Services
  • wholesale - Wholesale and Distribution
  • writing - Writing and Editing Services
  • virtual_assistance - Virtual Assistance and Admin Support
  • other - Other
Possible values:
websitestring · uri · max: 300 · nullableOptional
company_sizestring · max: 100 · nullableOptional
annual_revenuestring · decimal · nullableOptional

Annual revenue in USD

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
minimum_order_amountstring · decimal · nullableOptional

Minimum order amount required

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
default_currencystring · min: 1 · max: 3Optional

Default currency code (ISO 4217) for this entity's transactions

first_contact_datestring · date · nullableOptional
last_contact_datestring · date · nullableOptional
next_follow_up_datestring · date · nullableOptional
last_order_datestring · date · nullableOptional
contract_start_datestring · date · nullableOptional
contract_end_datestring · date · nullableOptional
quality_ratingstring · decimal · nullableOptional

Quality rating out of 5.00

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
delivery_ratingstring · decimal · nullableOptional

Delivery performance rating out of 5.00

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
Responses
post
/api/v1.0/organisation/{org_uid}/vendors/create/

Get vendor

get
/api/v1.0/organisation/{org_uid}/vendors/{unique_id}/

Retrieve a specific vendor by unique_id

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_uid}/vendors/{unique_id}/

Update vendor

put
/api/v1.0/organisation/{org_uid}/vendors/{unique_id}/update/

Update a specific vendor (full or partial update). For PATCH requests, only provided fields are updated.

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Body

Comprehensive serializer for Vendor model. Handles multilingual fields, nested relationships, computed fields, and vendor-specific metrics.

unique_idstring · max: 100 · nullableOptional
namestring · min: 1 · max: 300Required
descriptionstring · nullableOptional
entity_typestring · enumOptional
  • individual - Individual
  • company - Company
  • non_profit - Non-Profit Organization
  • government - Government Entity
  • partnership - Partnership
  • other - Other
Possible values:
vendor_statusstring · enumOptional
  • potential - Potential Vendor
  • active - Active Vendor
  • preferred - Preferred Vendor
  • on_hold - On Hold
  • inactive - Inactive
  • blacklisted - Blacklisted
Possible values:
vendor_categorystring · enumOptional
  • goods - Goods Supplier
  • services - Service Provider
  • both - Goods & Services
  • contractor - Contractor
  • consultant - Consultant
  • other - Other
Possible values:
industrystring · enum · nullableOptional
  • agriculture - Agriculture and Farming
  • cleaning - Cleaning Services
  • construction - Construction and Real Estate Services
  • consulting - Consulting and Freelancing
  • creative - Creative and Design Services
  • education - Education and Tutoring Services
  • events - Entertainment and Events Planning
  • handyman - Handyman and Home Repair Services
  • health - Health and Wellness
  • home_based - Home-Based Businesses
  • hospitality - Hospitality and Tourism
  • it_support - IT and Software Support Services
  • legal - Legal and Financial Services
  • logistics - Logistics and Delivery Services
  • manufacturing - Manufacturing and Small-Scale Production
  • marketing - Marketing and Advertising Services
  • music - Music and Entertainment Services
  • non_profit - Non-Profit and Social Enterprises
  • online_retail - Online Retail and E-commerce
  • photography - Photography and Videography Services
  • printing - Printing and Copy Services
  • professional - Professional Services
  • travel - Travel Agencies
  • utilities - Utilities and Renewable Energy Services
  • wholesale - Wholesale and Distribution
  • writing - Writing and Editing Services
  • virtual_assistance - Virtual Assistance and Admin Support
  • other - Other
Possible values:
websitestring · uri · max: 300 · nullableOptional
company_sizestring · max: 100 · nullableOptional
annual_revenuestring · decimal · nullableOptional

Annual revenue in USD

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
minimum_order_amountstring · decimal · nullableOptional

Minimum order amount required

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
default_currencystring · min: 1 · max: 3Optional

Default currency code (ISO 4217) for this entity's transactions

first_contact_datestring · date · nullableOptional
last_contact_datestring · date · nullableOptional
next_follow_up_datestring · date · nullableOptional
last_order_datestring · date · nullableOptional
contract_start_datestring · date · nullableOptional
contract_end_datestring · date · nullableOptional
quality_ratingstring · decimal · nullableOptional

Quality rating out of 5.00

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
delivery_ratingstring · decimal · nullableOptional

Delivery performance rating out of 5.00

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
Responses
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{org_uid}/vendors/{unique_id}/update/

Update vendor

patch
/api/v1.0/organisation/{org_uid}/vendors/{unique_id}/update/

Update a specific vendor (full or partial update). For PATCH requests, only provided fields are updated.

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Body

Comprehensive serializer for Vendor model. Handles multilingual fields, nested relationships, computed fields, and vendor-specific metrics.

unique_idstring · max: 100 · nullableOptional
namestring · min: 1 · max: 300Optional
descriptionstring · nullableOptional
entity_typestring · enumOptional
  • individual - Individual
  • company - Company
  • non_profit - Non-Profit Organization
  • government - Government Entity
  • partnership - Partnership
  • other - Other
Possible values:
vendor_statusstring · enumOptional
  • potential - Potential Vendor
  • active - Active Vendor
  • preferred - Preferred Vendor
  • on_hold - On Hold
  • inactive - Inactive
  • blacklisted - Blacklisted
Possible values:
vendor_categorystring · enumOptional
  • goods - Goods Supplier
  • services - Service Provider
  • both - Goods & Services
  • contractor - Contractor
  • consultant - Consultant
  • other - Other
Possible values:
industrystring · enum · nullableOptional
  • agriculture - Agriculture and Farming
  • cleaning - Cleaning Services
  • construction - Construction and Real Estate Services
  • consulting - Consulting and Freelancing
  • creative - Creative and Design Services
  • education - Education and Tutoring Services
  • events - Entertainment and Events Planning
  • handyman - Handyman and Home Repair Services
  • health - Health and Wellness
  • home_based - Home-Based Businesses
  • hospitality - Hospitality and Tourism
  • it_support - IT and Software Support Services
  • legal - Legal and Financial Services
  • logistics - Logistics and Delivery Services
  • manufacturing - Manufacturing and Small-Scale Production
  • marketing - Marketing and Advertising Services
  • music - Music and Entertainment Services
  • non_profit - Non-Profit and Social Enterprises
  • online_retail - Online Retail and E-commerce
  • photography - Photography and Videography Services
  • printing - Printing and Copy Services
  • professional - Professional Services
  • travel - Travel Agencies
  • utilities - Utilities and Renewable Energy Services
  • wholesale - Wholesale and Distribution
  • writing - Writing and Editing Services
  • virtual_assistance - Virtual Assistance and Admin Support
  • other - Other
Possible values:
websitestring · uri · max: 300 · nullableOptional
company_sizestring · max: 100 · nullableOptional
annual_revenuestring · decimal · nullableOptional

Annual revenue in USD

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
minimum_order_amountstring · decimal · nullableOptional

Minimum order amount required

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$
default_currencystring · min: 1 · max: 3Optional

Default currency code (ISO 4217) for this entity's transactions

first_contact_datestring · date · nullableOptional
last_contact_datestring · date · nullableOptional
next_follow_up_datestring · date · nullableOptional
last_order_datestring · date · nullableOptional
contract_start_datestring · date · nullableOptional
contract_end_datestring · date · nullableOptional
quality_ratingstring · decimal · nullableOptional

Quality rating out of 5.00

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
delivery_ratingstring · decimal · nullableOptional

Delivery performance rating out of 5.00

Pattern: ^-?\d{0,1}(?:\.\d{0,2})?$
Responses
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{org_uid}/vendors/{unique_id}/update/

Delete vendor

delete
/api/v1.0/organisation/{org_uid}/vendors/{unique_id}/delete/

Delete a specific vendor by unique_id

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Responses
delete
/api/v1.0/organisation/{org_uid}/vendors/{unique_id}/delete/

No content

Last updated