Create Supplier Branch

Saves one or more supplier branches as Zuper vendors linked to this provider so you can order from them; send the branches picked from Get Live Supplier Branches. A branch code already saved for this provider is updated in place (name, email, address, job account, favorite flag) instead of duplicated, and branches that can't be created, for example because a vendor with the same name exists, are listed in failed_branches while the request still returns 200. SRS and QXO check each branch_code and preferred_job_account_number with the supplier and return 400 on a mismatch, whereas ABC Supply does not check the branch code but requires both preferred_job_account_number and preferred_job_account_name (a Ship-To account). With update_catalogs_with_linked_products (default true), newly created branches get the catalog of the provider's existing saved branches copied to them, with fresh supplier pricing, in the background. Admin only: the API key must belong to an admin user; other roles receive 405 Access Denied. 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).

Body Params
branches
array of objects
required
length ≥ 1

Required. Branches to save.

branches*
string
required

Required. The supplier's branch code from Get Live Supplier Branches. SRS and QXO reject codes your supplier account can't order from; ABC Supply codes are not checked.

string
required

Required. Saved as the vendor name. A new branch whose name matches an existing vendor (case-insensitive) is not created and is listed in failed_branches.

string

Saved as the vendor display name. Defaults to branch_name.

string

Saved as the vendor contact name. Defaults to branch_name.

string

Saved as the vendor description.

string

Accepted but not stored.

string | null

Saved as the vendor email.

branch_address
object

Saved as both the vendor address and billing address.

branch_contact_no
object

New branches only; not changed when an existing branch is re-sent.

accounts
object | null

New branches only.

string
enum

Default delivery method for orders from this branch. New branches only. No default is applied when omitted, so send it explicitly.

Allowed:
string

Job account used when ordering from this branch (a number is also accepted). SRS and QXO: must be one of the branch's job accounts from Get Branch Job Accounts; defaults to the first one when omitted. ABC Supply: required, the Ship-To account number.

string

ABC Supply: required, the Ship-To account name. SRS and QXO: filled in from the default job account when preferred_job_account_number is omitted.

boolean
Defaults to false

Make this the favorite (default) branch for this provider. At most one branch per request; setting it clears the flag on the provider's other branches. Re-sending an already saved branch without it clears its flag.

boolean
Defaults to true

Copy the catalog of the provider's existing saved branches to the newly created ones. Runs in the background and only when at least one branch is created and the provider already has other saved branches.

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