Get Vendor Catalogs

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. 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.

get/vendor_catalogs

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/vendor_catalogs
  • Auth
    API key in header x-api-key

Query parameters

pagestring
countstring
sort'ASC' | 'DESC'
group_by'VENDOR' | 'PRODUCT'
fetch_availability_from_providerboolean
filter.productstring
filter.vendorstring
filter.product_categorystring

category uid

filter.product_typestring

PARTS, PRODUCT

filter.keywordstring
filter.supplier_productstring
filter.supplier_product_optionstring
filter.uomstring

Response

200

type'SUCCESS'
dataobject[]

When group_by is set, each item is {uid, total_items, catalogs: [...], vendor|product} instead of a flat catalog row.

total_recordsinteger
current_pageinteger
total_pagesinteger

Changes

    • breaking

      the query request parameter group_by was restricted to a list of enum values

    • warning

      deleted the query request parameter sort

    • info

      added the new optional query request parameter fetch_availability_from_provider

    • info

      added the new optional query request parameter filter.supplier_product

    • info

      added the new optional query request parameter filter.supplier_product_option

    • info

      added the new optional query request parameter filter.uom

    • info

      added the new optional query request parameter sort

    • info

      added the new enum value PRODUCT to the query request parameter group_by

    • info

      added the new enum value VENDOR to the query request parameter group_by

    • info

      added the media type application/json for the response with the status