---
title: "Get Supplier Branch Details"
method: GET
path: "/supplier_provider/{supplier_provider_uid}/branches/{branch_uid}"
---

# Get Supplier Branch Details

`GET /supplier_provider/{supplier_provider_uid}/branches/{branch_uid}`

## Request

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

Returns one supplier branch saved in Zuper for this provider, identified by its `vendor_uid`. The record is read from Zuper, not the supplier, and includes the `supplier_provider_details` block with the branch code, the job account used for orders and, for QXO, the owning QXO account. Payment-term settings (`accounts`), bank details, contacts, attachments and `created_by` are not returned. A `branch_uid` that is not saved under this provider returns 404. 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
- `branch_uid` string, required

## Response `200`

200

- object
  - `type` 'success'
  - `title` string
  - `message` string
  - `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.
      - `associated_job_accounts` object[]: Normally empty.
      - `synced_at` string, date-time: When the branch was last saved from the supplier's data.
    - `vendor_type` 'VENDOR'
    - `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.

## 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/branches/:branch_uid/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)