---
title: "Get Live Supplier Branches"
method: GET
path: "/supplier_provider/{supplier_provider_uid}/supplier_branches"
---

# Get Live Supplier Branches

`GET /supplier_provider/{supplier_provider_uid}/supplier_branches`

## Request

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

Fetches the branches available to your supplier account live from the supplier, so you can pick which ones to save with Create Supplier Branch. Branches already saved in Zuper have `branch_imported: true` and their linked job account, and are always listed first; the rest are sorted by branch name in `sort_order`. SRS returns only the branches your SRS customer account can order from; ABC Supply lists the branches behind your Ship-To accounts and includes each branch's `job_accounts`, status and manager; QXO returns one entry per QXO account, prefixes `branch_name` with the account number and leaves `job_accounts` empty (use Get Branch Job Accounts). SRS and ABC Supply branch lists are reused for up to 12 hours, so a branch the supplier just added may take that long to appear. 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
- `limit` integer
- `sort_order` 'ASC' | 'DESC'
- `filter.keyword` string
- `keyword` string

## Response `200`

200

- object
  - `type` 'success'
  - `title` string
  - `message` string
  - `data` object[]
    - `branch_imported` boolean: `true` when this branch is already saved in Zuper for this provider.
    - `branch_code` string: Send as `branch_code` when saving the branch.
    - `branch_name` string: QXO: `<account number>-<branch name>`.
    - `brand_name` string, nullable: SRS only; `null` for ABC Supply and QXO.
    - `branch_email` string, nullable: Branch order email. `null` for QXO.
    - `branch_contact_no` object
      - `work` string: Branch phone.
      - `mobile` string: Always empty.
    - `branch_delivery_method` unknown
    - `branch_job_account_no` union: Job account linked to the saved branch. Only set when `branch_imported` is `true`.
      - string
      - integer
    - `branch_job_account_name` string, nullable: Only set when `branch_imported` is `true`.
    - `branch_address` object: Send as `branch_address` when saving the branch.
      - `street` string
      - `city` string
      - `state` string
      - `zip_code` string: ABC Supply and QXO only.
      - `country` string: ABC Supply and QXO only.
      - `email` string, nullable
      - `phone_number` string
      - `geo_cordinates` number[]: ABC Supply and QXO only, when the supplier provides it. `[latitude, longitude]`.
    - `geo_cordinates` number[]: `[latitude, longitude]`. ABC Supply: from the supplier. SRS: only for saved branches, from the saved address. Not returned for QXO.
    - `job_accounts` object[]: ABC Supply: the Ship-To accounts that can order from this branch. Always empty for QXO; not returned for SRS.
      - `job_account_number` string
      - `job_account_name` string
      - `job_account_status` string
      - `job_account_is_sellable` boolean
      - `job_account_bill_to` object
        - `bill_to_number` string
        - `bill_to_name` string
      - `job_account_sold_to` object
        - `sold_to_number` string
        - `sold_to_name` string
    - `branch_storefront` string: ABC Supply only.
    - `branch_status` string: ABC Supply only.
    - `branch_type` string: ABC Supply only.
    - `branch_timezone_code` string: ABC Supply only.
    - `branch_timezone_description` string: ABC Supply only.
    - `branch_manager` object: ABC Supply only.
      - `first_name` string
      - `last_name` string
      - `email` string
      - `title` string
      - `picture_url` string
  - `current_page` integer
  - `current_records` integer
  - `total_records` 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/supplier_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)