Skip to main content

Configure a Priority Supplier

This guide describes the operational steps required to configure a supplier as a Priority Supplier in the system, or to remove the priority configuration when no longer required.

When a supplier is configured as a Priority Supplier:

  • They are prioritized at the top of the supplier list during proximity searches in ViSN for eligible customer networks.
  • A Recommended Supplier badge is displayed alongside the garage name during the garage selection steps in the Book-In Enquiry and Web-Link garage selection steps.

Pre-requisites & Access​

  1. Supplier Identifiers:
    • Account Object ID (<accountObjectID>): The unique identifier for the supplier account document in Firestore.
    • Service Unit Object ID (<serviceUnitObjectID>): The unique identifier for the specific supplier service unit document in Firestore.

Steps to Configure a Priority Supplier​

1. Locate the Supplier Service Unit Document​

Navigate to the target Service Unit document using the following collection path:

/accounts/<accountObjectID>/serviceUnits/<serviceUnitObjectID>
  • Replace <accountObjectID> with the supplier's Account ID.
  • Replace <serviceUnitObjectID> with the specific Service Unit ID for the garage branch.

2. Add or Update isPrioritySupplier​

  1. Inside the Service Unit document, check if the isPrioritySupplier field exists.
  2. If the field does not exist, click Add field.
  3. Configure the field with the following properties:
    • Field name: isPrioritySupplier
    • Type: boolean
    • Value: true
isPrioritySupplier: true // type: boolean
  1. Click Save to apply the change.

How to Verify the Configuration​

1. Database Verification​

  • In Firestore, refresh the document at /accounts/<accountObjectID>/serviceUnits/<serviceUnitObjectID>.
  • Confirm that the isPrioritySupplier field exists, has type boolean, and is set to true.

2. Application UI Verification (ViSN)​

  1. Open ViSN and begin creating a Book-In Enquiry or access the Web-Link garage selection step.
  2. Enter a postcode located within the serving radius of the configured supplier.
  3. In the garage selection list:
    • Confirm that the supplier is promoted to the top of the search results.
    • Confirm that the Recommended Supplier badge is visible next to the garage name.
Search Criteria Requirement

The supplier must still satisfy all standard search criteria (e.g., postcode proximity radius, service type eligibility, and vehicle type requirements) to appear in the results list. Marking a supplier with isPrioritySupplier: true does not bypass matching criteria; it promotes eligible matching suppliers to the top of the search ranking and adds the Recommended Supplier badge.

How to Remove Priority Supplier Status​

To remove the Priority Supplier status from a supplier:

  1. In Firestore, navigate to the Service Unit document: 
    /accounts/<accountObjectID>/serviceUnits/<serviceUnitObjectID>
  2. Locate the isPrioritySupplier field.
  3. Edit the field and set its value to false.
  4. Click Save.
  5. Verification: In ViSN garage selection, perform a postcode search within the supplier's proximity. Confirm that the supplier appears in standard distance order and the Recommended Supplier badge is no longer displayed.
Status: Approved
Category: Protected
Authored By: Kushwanth Reddy on Aug 31, 2026
Revisions
31 Aug, 2026 - Initial creation of How to Configure a Priority Supplier guide