Create Supplier Branch

Changed on

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

post/supplier_provider/{supplier_provider_uid}/branches

Request

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

Path parameters

supplier_provider_uidstring required

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

Request body

update_catalogs_with_linked_productsboolean

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.

Response

200

type'success'
titlestring
messagestring

Changes