Get Saved Supplier Branches

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Query Params
integer
Defaults to 1

Page number.

integer
Defaults to 10

Records per page.

string
enum
Defaults to created_at
Allowed:
string
enum
Defaults to DESC
Allowed:
string

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.

boolean

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

boolean

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

boolean

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

string
enum
Allowed:
date

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

date

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

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json