Create Vendor Catalog

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.

post/vendors/{vendor_uid}/catalog

Request

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

Path parameters

vendor_uidstring required

Request body

Response

200

type'SUCCESS'
titlestring
messagestring

Changes

    • breaking

      the // request property type changed from string to number

    • warning

      the // request property's maxLength was set to 2000

    • info

      added the new optional request property //

    • info

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