Supplier Integrations

Supplier Integrations connect Zuper to roofing material suppliers so you can browse their catalog, check supplier prices and branch availability, and keep your Zuper products and vendor catalogs in step with the supplier. Three suppliers are supported, identified by supplier_provider_type:

supplier_provider_typeSupplier
SRSSRS Distribution
ABC_SUPPLYABC Supply
QXOQXO

Before you start

  • Supplier integration must be enabled for your company. Until it is, the provider and product-catalog endpoints return 400 with the title "Supplier integration is not enabled".
  • Branch, order template, pricing, availability and catalog mapping endpoints need a provider whose connection_status is CONNECTED; otherwise they return 403 with the title "Supplier provider is not connected".
  • Endpoints that create, change, or delete data are admin only: the API key must belong to an admin user.
  • Read-only API keys can call the GET endpoints only.

Typical flow

  1. Connect a supplier. Create a supplier provider with your supplier account details, then check its connection_status is CONNECTED.
  2. Save branches. List the supplier's live branches and save the ones you order from. Each saved branch becomes a Zuper vendor linked to the provider.
  3. Map your catalog. Find products in the supplier catalog and map them to your Zuper products, so vendor catalog rows and prices are kept up to date.
  4. Price and availability. Fetch the supplier's prices (an answer can be reused for up to 15 minutes), and check which branches stock a product using the availability Zuper syncs from the supplier.
  5. Order templates. Optionally save reusable material lists, or read the templates already set up in your supplier account.