Get Vendor Catalogs
Changed onOperates 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. Vendor catalog rows record which products a vendor supplies, at what cost. This sub-resource exists only under /vendors — there is no /subcontractors/:uid/catalog route, even though the underlying schema and controller don't discriminate by vendor_type at all. Either filter.product or filter.vendor is required unless group_by is set.
Request
- Base URLhttps://dc-region.zuperpro.com/api
- URLhttps://dc-region.zuperpro.com/api/vendor_catalogs
- AuthAPI key in header x-api-key
Query parameters
category uid
PARTS, PRODUCT
Response
200
Changes
- breaking
the
queryrequest parametergroup_bywas restricted to a list of enum values - warning
deleted the
queryrequest parametersort - info
added the new optional
queryrequest parameterfetch_availability_from_provider - info
added the new optional
queryrequest parameterfilter.supplier_product - info
added the new optional
queryrequest parameterfilter.supplier_product_option - info
added the new optional
queryrequest parameterfilter.uom - info
added the new optional
queryrequest parametersort - info
added the new enum value
PRODUCTto thequeryrequest parametergroup_by - info
added the new enum value
VENDORto thequeryrequest parametergroup_by - info
added the media type
application/jsonfor the response with the status
- breaking