---
title: "Get Preferred Supplier Provider"
method: GET
path: "/supplier_provider/preferred"
---

# Get Preferred Supplier Provider

`GET /supplier_provider/preferred`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/supplier_provider/preferred`
- Auth: API key in header `x-api-key`

Returns the company's preferred supplier provider together with its favorite branch. While the provider is connected, that branch is the Zuper vendor used to price and pre-fill supplier materials on proposals. `data` is `null` (with the message `No preferred supplier set`) when no provider is preferred, and `favorite_supplier_vendor` is `null` when the provider has no active favorite branch. The preferred provider is returned even after it loses its connection, so check `connection_status` before relying on it. Credentials are never returned. Requires supplier integration to be enabled for the company; otherwise the request fails with 400.

## Response `200`

200

- object
  - `type` 'success'
  - `title` string
  - `message` string
  - `data` object, nullable
    - `supplier_provider_uid` string
    - `supplier_provider_name` string
    - `supplier_provider_type` 'SRS' | 'ABC_SUPPLY' | 'QXO'
    - `connection_status` 'CONNECTED' | 'NOT_CONNECTED' | 'RECONNECT_REQUIRED': `RECONNECT_REQUIRED` means the supplier rejected the stored credentials or an admin deactivated the provider; reconnect before ordering.
    - `connection_error_message` string, nullable: Why the provider was last disconnected, such as the supplier's authentication error or a manual deactivation. Absent, empty or `null` when there is nothing to report.
    - `is_preferred_supplier` boolean: At most one provider per company is preferred.
    - `is_deleted` boolean: Always `false`; deleted providers are not returned.
    - `is_active` boolean: `false` when an admin has deactivated the provider.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `favorite_supplier_vendor` object, nullable: The provider's active branch marked as favorite, saved in Zuper as a vendor.
      - `vendor_uid` string
      - `vendor_name` string
      - `vendor_display_name` string
      - `supplier_provider_details` object
        - `branch_code` string: Supplier's code for the branch.
        - `branch_name` string
    - `last_synced_at` string, date-time: When Zuper last refreshed the saved catalog prices for this provider from the supplier (scheduled sync). Absent until the first sync.

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/supplier_provider/preferred/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)