ZUzuper

Get Saved Supplier Branches

Changed on

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).

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

Path parameters

supplier_provider_uidstring required

UID of the supplier provider (from Get Supplier Providers).

Query parameters

pageinteger

Page number.

countinteger

Records per page.

sort_by'created_at' | 'updated_at' | 'vendor_name'
sort'ASC' | 'DESC'
filter.keywordstring

Searches vendor name, display name, contact name, tax identifier and description. A full email address matches the vendor email exactly; a number matches the vendor number.

filter.is_activeboolean

Return only active (true) or inactive (false) branches.

is_activeboolean

Alias of filter.is_active; ignored when filter.is_active is also sent.

filter.favorite_supplier_vendorboolean

Return only the favorite branch (true) or only the others (false).

filter.vendor_delivery_method'JOB_ADDRESS' | 'WAREHOUSE' | 'PICKUP'
filter.created_from_datestring date

Saved on or after this date (YYYY-MM-DD, company time zone). Applies only with filter.created_to_date.

filter.created_to_datestring date

Saved on or before this date (YYYY-MM-DD, company time zone). Applies only with filter.created_from_date.

Response

200

type'success'
message'success'
total_recordsinteger
current_pageinteger
total_pagesinteger

Changes