Get Vendor Details

Changed on

Operates on Vendors. In the Zuper client app this module is labeled "Vendor" for most companies, and "Supplier" for companies in the roofing industry — the API and data shape are identical either way. Vendors and Subcontractors share the exact same underlying schema and endpoints; they're distinguished only by the vendor_type field (VENDOR here) and the /vendors vs /subcontractors route prefix.

get/vendors/{vendor_uid}

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/vendors/{vendor_uid}
  • Auth
    API key in header x-api-key

Path parameters

vendor_uidstring required

Response

200

type'SUCCESS'
dataobject

Full vendor document (minus _id, company_id, __v, and internal supplier-integration IDs), with accounts.payment_term/accounts.tax_group and created_by populated.

Changes