---
title: "Get Saved Supplier Branches"
method: GET
path: "/supplier_provider/{supplier_provider_uid}/local_branches"
---

# Get Saved Supplier Branches

`GET /supplier_provider/{supplier_provider_uid}/local_branches`

## Request

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

Lists the supplier branches already saved in Zuper for this provider. Each saved branch is a Zuper vendor linked to the provider, so the list is read from Zuper without calling the supplier, and every record carries a `supplier_provider_details` block with the branch code and the job account used for orders. Results are paginated with `page` and `count` and ordered with `sort_by` and `sort` (newest first by default); this endpoint does not use `limit` or `sort_order`. Unlike most endpoints, the response has no `title`, `message` is always `success`, and there is no `current_records`. Use Get Live Supplier Branches to see branches you have not saved yet. The provider must exist and be `CONNECTED`; otherwise the request fails with 404 (unknown provider) or 403 (not connected or reconnect required).

## Path parameters

- `supplier_provider_uid` string, required

## Query parameters

- `page` integer
- `count` integer
- `sort_by` 'created_at' | 'updated_at' | 'vendor_name'
- `sort` 'ASC' | 'DESC'
- `filter.keyword` string
- `filter.is_active` boolean
- `is_active` boolean
- `filter.favorite_supplier_vendor` boolean
- `filter.vendor_delivery_method` 'JOB_ADDRESS' | 'WAREHOUSE' | 'PICKUP'
- `filter.created_from_date` string, date
- `filter.created_to_date` string, date

## Response `200`

200

- object
  - `type` 'success'
  - `message` 'success'
  - `data` object[]
    - `vendor_uid` string: Use as `branch_uid` in Get Supplier Branch Details and Update Supplier Branch.
    - `vendor_id` integer: Zuper vendor number.
    - `vendor_id_string` string
    - `vendor_name` string: The branch name.
    - `vendor_display_name` string
    - `vendor_contact_name` string
    - `vendor_email` string: Empty string when the supplier has no order email for the branch.
    - `vendor_description` string
    - `vendor_contact_no` object
      - `work` string
      - `mobile` string
    - `vendor_delivery_method` 'JOB_ADDRESS' | 'WAREHOUSE' | 'PICKUP'
    - `vendor_address` object
      - `street` string
      - `city` string
      - `state` string
      - `zip_code` string
      - `country` string
      - `email` string, nullable
      - `phone_number` string
      - `geo_cordinates` number[]: `[latitude, longitude]`, when known.
      - `point_coordinates` object: Geo point for the address. `coordinates` is `[longitude, latitude]` and can be empty.
        - `coordinates` number[]
      - `landmark` string: Landmark for the address; may be empty.
    - `vendor_billing_address` object: Same as `vendor_address` for supplier branches.
      - `street` string
      - `city` string
      - `state` string
      - `zip_code` string
      - `country` string
      - `email` string, nullable
      - `phone_number` string
      - `geo_cordinates` number[]: `[latitude, longitude]`, when known.
      - `point_coordinates` object: Geo point for the address. `coordinates` is `[longitude, latitude]` and can be empty.
        - `coordinates` number[]
      - `landmark` string: Landmark for the address; may be empty.
    - `catalog_count` integer: Number of catalog entries on this vendor.
    - `vendor_lead_time` integer
    - `last_ordered_date` string, date-time, nullable
    - `custom_fields` object[]
    - `is_integrated_vendor` boolean: Always `true` for supplier branches.
    - `favorite_supplier_vendor` boolean: `true` for the favorite (default) branch of this supplier.
    - `supplier_provider_details` object: Link between this vendor and the supplier branch.
      - `supplier_provider_uid` string
      - `supplier_provider_type` 'SRS' | 'ABC_SUPPLY' | 'QXO'
      - `supplier_provider_name` string
      - `branch_code` string: The supplier's branch code.
      - `branch_name` string
      - `linked_job_account_no` union: Job account used when ordering from this branch.
        - string
        - integer
      - `linked_job_account_name` string
      - `account_id` string: QXO only. The QXO account that owns this branch.
      - `synced_at` string, date-time: When the branch was last saved from the supplier's data.
    - `vendor_type` 'VENDOR'
    - `created_by` object: User who saved the branch.
      - `user_uid` string
      - `first_name` string
      - `last_name` string
      - `email` string
      - `designation` string, nullable
      - `emp_code` string, nullable
      - `prefix` string, nullable
      - `home_phone_number` string, nullable
      - `work_phone_number` string, nullable
      - `mobile_phone_number` string, nullable
      - `profile_picture` string, nullable
      - `external_login_id` string, nullable
      - `hourly_labor_charge` number, nullable
      - `is_billable` boolean
      - `license_type` string, nullable
      - `is_active` boolean
      - `is_deleted` boolean
      - `last_login_at` string, date-time, nullable
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `role` object
        - `role_uid` string
        - `role_name` string
        - `role_key` string
    - `is_active` boolean
    - `is_deleted` boolean
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `associations` object
      - `notes` integer: Number of notes on the vendor.
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## Other responses

- `400`: 400
- `403`: 403
- `404`: 404

## Changes

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

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/supplier_provider/:supplier_provider_uid/local_branches/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)